reqGetUCS2Value()

This procedure returns parameter value as UCS2 string.

ParameterTypeDescription
baseNode1024C VARYING, VARSIZEMandatoryThis parameter is used to pass base node. Currently following base nodes are supproted: “IptorAPI”, “method”, “params”, “messages”, “control”, “id”
node1024C VARYING, VARSIZEOptional, can be omitedNode name. This parameter is optional. If the structure is more complex then nodes must be divided by colon “:”
valueType1AOptional, can be omitedReturns type of value (see types of value)
existsNOptional, can be omitedReturns *ON if value exists, *OFF if value does not exit
valuePtrPOINTEROptional, can be omitedReturns pointer in memory where value resides
valueLength10U 0Optional, can be omitedReturns length of value in bytes
unescapeNOptional*ON or *OFF (Default = *ON) Indicates if value must be “unescaped” means removed ‘' escape character

NOTE : The node strings are UCS2. The result value is also UCS2. The procedure returns value as UCS2 string even if the value is numeric (1024C). It is up to programmer to convert string to numeric later.

Types of value:

typeDescription
OObject
CCharacter
NNumeric
Ttrue
Ffalse
0null
Eerror
BLANKValue does not exist

Examples:

X_UCS2_SROM = reqGetUCS2Value(%UCS2('params'): %UCS2('warehouse'));

X_UCS2_SROM = reqGetUCS2Value(%UCS2('params'): %UCS2('warehouse'): xxValueType);

X_UCS2_SROM = reqGetUCS2Value(%UCS2('params'): %UCS2('warehouse'): xxvalueType : xxExist);

X_UCS2Text = reqGetUCS2Value(%UCS2('params'): %UCS2('myText'): *omit: *omit: *omit: *omit: *OFF);