xpfGetLongString

FUNCTION xpfGetLongString(longStringId         : INTEGER;   
                          firstCharIndex       : INTEGER;
                          lastCharIndex        : INTEGER;
                          VAR longStringLength : INTEGER;
                          deletingLongString   : BOOLEAN)
                          longString           : STRING;

This functions returns part of or the full specified EDMlongString. The xpfGetLongString() function may be invoked with variable number of arguments, i.e., it can be invoked with 1 to 5 arguments.

Arguments

1	Type	Name	Comment
2	INTEGER	longStringId	An longStringId that defines the actual EDMlongString to get. This longStringId is returned from a xpfDefineLongString()function when the actual EDMlongString is defined.
3	INTEGER	firstCharIndex	Optional argument. Default value is firstCharIndex = 1, i.e., specifies first character in the actual EDMlongString This argument specifies the first character in the actual EDMlongString to be fetched.
4	INTEGER	lastCharIndex	Optional argument. Default value is INDETERMINATE, meaning last character in the actual EDMlongString. This argument specifies the last character in the EDMlongString to be fetched. This argument is only valid when the argument "firstCharIndex" is specified, i.e., the "firstCharIndex : lastCharIndex" specifies the substring of the actual EDMlongString to be fetched.
5	INTEGER	VAR longStringLength	Optional argument. When this argument is specified, the length of the specified EDMlongString will be returned in this argument.
6	BOOLEAN	deletingLongString	Optional argument. Default value is FALSE. When this argument is set to TRUE, the specified EDMlongString will be deleted. An EDMlongString should be deleted as soon as it is not longer used in order to release the virtual memory the EDMlongString occupies.

Return Value

Type	Name	Comment
STRING	longString	This function returns the full specified EDMIlongString or part of the specified EDMIlongString when the function is successfully performed. When the function fails, INDETERMINATE (?) will be returned. Exception handling should be used to handle error conditions in the actual xpfGetLongString() operation.

Options

Example

<Missing Example>

EDMsix

xpfGetLongString

Arguments

Return Value

Options

Example

See also

Filter by label