xpxAddToLongString

FUNCTION xpxAddToLongString(longStringId            : INTEGER;
                            stringOrValueToBeString : STRING;
                            position                : INTEGER)
                            rstat                   : INTEGER;

This xpxAddToLongString() function add a string to the specified EDMlongString. This function has variable number of arguments, i.e., it can be invoked with 2 or 3 arguments.

Arguments

1	Type	Name	Comment
2	INTEGER	longStringId	An longStringId that defines the actual EDMlongString to add a string to. This longStringId is returned from a xpfDefineLongString() function when the actual EDMlongString is defined.
3	STRING	stringOrValueToBeString	This argument defines the actual string value to add to the specified EDMlongString. This argument may be a STRING, INTEGER or INSTANCE value. When the value is an INTEGER it will be transferred to a string by a "printf" operation. An INSTANCE value can be handled exactly like an INTEGER value, or by specifying an attributeName or attributeId in the "attributeIdOrAttributeName" argument in the xpfDefineLongString() function that defined the EDMlongString, the actual instance attribute value will be used to make a string. The legal data types of such an attribute are STRING, INSTANCE and INTEGER. When an INTEGER or INSTANCE value is transferred to a string, the actual "format specification" can be specified in the "integerAndInstancePrintFormat" argument in the xpfDefineLongString() function that defined the EDMlongString. The default for this "format specification" is "%lu";
4	INTEGER	position	Optional argument. Default value is INDETERMINATE (?). Specifies in what position the actual string will be inserted before. The default value INDETERMINATE means append actual string at end of EDMlongString (string concatenation). The first character in a string has position = 1;

Return Value

Type	Name	Comment
INTEGER	rstat	The function return the integer value xpxOK ( = 0) when the function is successfully performed. When the function fails,an error code is returned. Exception handling should be used to handle error conditions in the actual xpxAddToLongString() operation.

Options

Example

<Missing Example>

xpxAddToLongString

Arguments

Return Value

Options

Example

See also

Filter by label