GetStrArg Function

Returns a string argument.

Syntax

XcallBlock.GetStrArg(Argument)

Parameters

Argument

An Integer value indicating the number of the XCALL argument to read. The first argument is argument number one.

Return Value

A String value containing the value of the numbered XCALL argument. The GetStrArg function will read string and unformatted type AlphaBASIC arguments.

Remarks

AlphaBASIC unformatted arguments will be returned as strings of the same length as the mapped size of the unformatted argument, and may contain ‘\0’ or null characters. AlphaBASIC string arguments will be returned terminating at the first ‘\0’ or null character.

The related PutStrArg method should be used to return string argument values to the calling AlphaBASIC program.