Command Line Functions

The $FARGC Function

$\textbf{{\char36}FARGC}\textbf{(}\icamhsp{0.707mm}\Bigl[\,\mathtt{\char39}\mathit{param}\,\mathtt{\char39}\,\bigl[,\mathtt{\char39}\mathit{sep}\,\mathtt{\char39}\,\bigr]\,\Bigr]\icamhsp{0.707mm}\textbf{)}$

Returns count of arguments

Returns: Numeric

The $FARGC function returns the number of arguments in the GENER command line (as can be found in the $PARAM macro variable). If a param string is given, the $FARGC function will instead return the number of arguments contained within the param string. The sep string contains the character used as the argument separator. The default value for the separator is a blank. When using a blank as a separator, those within matching " quote characters are not treated as separators.

The $FARGV Function

$\textbf{{\char36}FARGV}\textbf{(}\icamhsp{0.707mm}\mathit{n}\Bigl[,\mathtt{\char39}\mathit{param}\,\mathtt{\char39}\,\bigl[,\mathtt{\char39}\mathit{sep}\,\mathtt{\char39}\,\bigr]\,\Bigr]\icamhsp{0.707mm}\textbf{)}$

Returns nth argument

Returns: Numeric

The $FARGV function extracts the nth argument of the GENER command line (as can be found in the $PARAM macro variable). If a param string is given, the $FARGV function will instead extract the argument from this string. The sep string contains the character used as the argument separator. The default value for the separator is a blank. When using a blank as a separator, those within matching " quote characters are not treated as separators.

The $FPNAME and $FPVALUE Functions

$\textbf{{\char36}FPNAME}\textbf{(}\icamhsp{0.707mm}\mathtt{\char39}\mathit{param}\,\mathtt{\char39}\icamhsp{0.707mm}\textbf{)}$

Return name portion of command line qualifier

Returns: String

$\textbf{{\char36}FPVALUE}\textbf{(}\icamhsp{0.707mm}\mathtt{\char39}\mathit{param}\,\mathtt{\char39}\icamhsp{0.707mm}\textbf{)}$

Return value portion of command line qualifier

Returns: String

The $FPNAME function returns the parameter name portion of a command line qualifier stored in the param string. The $FPVALUE function returns the parameter value portion. These functions are intended to work with the results of the $FARGV function described above. Command line qualifiers take the following form:
/name=value
For example, calling $FPNAME('/ABC="D E F"') returns the string ABC, whereas calling $FPVALUE('/ABC="D E F"') returns the string D E F. If the input string does not contain a / delimited qualifier, then a blank string is returned for the parameter name function and the entire string is returned for the parameter value function.

The following example will list all of the command line arguments passed to GENER:
DO/I=1,$FARGC()
  STR=$FARGV(I)
  PPRINT/'!(*): Name "!(*)", Value "!(*)"',I,$FPNAME(STR),$FPVALUE(STR)
ENDOF/DO