GetStrnArg Function (Macro)

args.h

const char *GetStrnArg (CESI &ap);

Returns the current argument of string type.

GetStrnArg is a macro which returns the current string argument (pointed to by ap) and modifies ap to point to the next argument in the argument list. So, each successive time GetStrnArg is used, it returns the next argument in the argument list. See InitArgPtr for an example of usage. Note that GetStrnArg assumes that the current argument IS a string (this may be checked using GetArgType). If this is not true, the effect of GetStrnArg is unpredictable.