GETUI

Contents


Getui is used to query a property of the client workstation and to retrieve it.

Syntax

   getui retour = "" with id_param

Parameters

Element

Description

Restrictions

return

returns information in the form of a string of characters

id_param

character string

The expressions must be alphanumerical and are limited to 255.

Examples

# Example 1: retrieval and display of the client workstation
Getui RETOUR = "" with "ComputerName"
K = instr(1,RETOUR,"=")
Infbox "ComputerName= " + right$(RETOUR,K+2)

Description and comments

Getui is used to retrieve a property of the Client workstation. A single property can be specified at a time.

2 parameters need to be entered: id_param and retour

id_param:

This parameter is used to identify the property to be queried

The available parameters are the following:

Parameter

Description

Example

ComputerName

Network name of the client workstation

UserName

Name of the connected user

X3Version

Version of the X3 Client

0,1,3,0

X3FileVersion

Build no. of the X3. exe executable in the form of a character string

2,2002,4,15

CnxHostName

Name of the connection server

 

AppHostName

Name of the application server

 

ClientRptDevRDir

Development directory of the Crystal Report reports on the client

 

IDate

Date format

1

SShortDate

Short date format string

dd/mm/yy

SDate

Date separator character (4 char. max)

/

Sdecimal

Decimal separator character (4 char. max)

,

Sthousand

Thousand separator character (4 char. max)

. or nothing

detail of the IDate parameter:

Value

Meaning

0

Month - Day -Year

1

Day - Month - Year

2

Year - Month - Day

value returned by SShortDate for the day definition:

Value

Meaning

d

no. of the day in the month, not preceded by a zero for days 1 to 9.

dd

no. of the day in the month, preceded by a zero for days 1 to 9.

ddd

day of the week, abbreviation over 3 characters

dddd

day of the week; integer name

value returned by SShortDate for the month definition:

Value

Meaning

M

no. of the month, not preceded by a zero for days 1 to 9.

MM

no. of the month, preceded by a zero for days 1 to 9.

MMM

abbreviation of the month over 3 characters

MMMM

Integer name of the month

value returned by SShortDate for the year definition:

Value

Meaning

y

last digit of the year

yy

the last 2 digits of the year

yyyy

the full year over 4 characters

value returned by SShortDate for the definition of the reference year that determines the century:

Value

Meaning

gg

a reference year is specified to determine the century

return :

This parameter contains the name of the variable that will contain, at the feedback of the instruction, the value of the requested property.

This value is expressed in the form "id_param=" "value"

New to version 130

This is a new instruction.

Associated errors

Error

Description

 

 

Associated keywords

  CALLUI - ASKUI


CONTENTS

Copyright © Sage 1999 - 2007