GetStringParameter

This function retrieves the value of a string type output parameter in the array returned by the function which is executed by the Execute function. The first parameter is located at index 0.

Where the length of the string to be retrieved is longer than the specified length, the StringLn parameter is set to the length of the string, which is not retrieved.

Context

Windows client,
Windows server.

Parameters

NUM_BIN_4

MainIndex

Index of the element in the main array

Input parameter

NUM_BIN_4

Index

Index of the element in the sub-array

Input parameter

ALPHA(n)

String

Value of a string type output parameter

Output parameter

NUM_BIN_4

StringLn

Maximum length for the string variable

Input/Output parameter

NUM_BIN_4

ReturnCode

Return code for the operation

Possible values:

0	The operation was completed successfully.
1	An unspecified error occurred.
2	The type returned by the function is not a variant or variant array.
4	The function returned no parameters.
5	The value of Index is incorrect.
6	The DLL has not been initialized.
7	The output string is too long.
8	The parameter located at the specified position is not a long integer variant.

Output parameter

Example

NUM_BIN_4 ReturnCode

ALPHA(50) String1

ALPHA(100) String2

NUM_BIN_4 StringLn

/* Read both strings in the ReturnArr array which is described in the GetParameterSize function

StringLg = 50

CALL_DLL 'VaToCom' 'GetStringParameter' 1 0 String1 StringLn ReturnCode

StringLg = 100

CALL_DLL 'VaToCom' 'GetStringParameter' 1 1 String2 StringLn ReturnCode

↑ Top of page