| GetSymstrArg | Function (Macro)

args.h

SYM_STR GetSymstrArg (CESI &ap);

Returns a pointer to the terminating zero byte of the current argument of string type.

GetSymstrArg does the same task as GetStrnArg but returns a pointer to the terminating zero byte of the string, instead of a pointer to the first byte of the string. This function is implemented because nearly all functions for TIOS VAT handling need just the pointer to the terminating byte of the string. As the arguments are stored in memory as strings which are bounded with zero bytes from both sides, the result of GetSymstrArg may be directly passed to TIOS VAT routines. See vat.h for more info.