SPF_PARSE

num-var = SPF_PARSE(TextLit-num, NumLit-Num, LinRef-num, TagOp-Num,

[ keyword-set, ]

... )

Operands:

TextLit-Num

Specifies the number of Text Literals allowed along with optional validation flags (see Special Notes below). If no special options are provided, the value specifies the fixed number of this operand which must be entered.

NumLit-Num

Specifies the number of Numeric Literals allowed along with optional validation flags (see Special Notes below). If no special options are provided, the value specifies the fixed number of this operand which must be entered.

LinRef-Num

Specifies the number of Line References allowed along with optional validation flags (see Special Notes below). If no special options are provided, the value specifies the fixed number of this operand which must be entered.

TagOp-Num

Specifies the number of Tag Operands allowed along with optional validation flags (see Special Notes below). If no special options are provided, the value specifies the fixed number of this operand which must be entered.

Keyword-set

Defines a set of allowable keywords. The format of a Keyword set is:

"[list-name:]keyword,keyword,(kwalias,kwalias),keyword,..."

list-name	a name to refer to this set of keywords, to be used in the SPF_Arg_KWGroup function.
keyword	an allowable keyword. If only one keyword is specified, it is treated as a 'present' or 'not present' keyword type.
keyword list	If multiple keywords are specified, they are treated as a set of mutually exclusive keywords.
alias list	if a keyword entry is a bracketed list of keywords, the bracketed list are treated as aliases of each other. When retrieving information about these keywords, the left-most one in the bracketed list is treated as the preferred, normalized answer desired.

Returns:

Both num-var and RC will be 0 and Msg$ will be "" (Null) for successful parse where no errors are detected.

Both num-var and RC will be 8 and Msg$ set to an error message on failure (e.g. invalid operand, missing operand, etc.)

Special Notes:

A full discussion of using SPF_Parse will be found in Full Parse Access

Validation Flags

Validation flags, when used, are entered by adding then to the specified numeric value. e.g. If 0 to 3 entries are desired, it would be entered as

3 + ARG_VAR

if these were tag entries which should be validated, it would be

3 + ARG_VAR + ARG_DEF

When none of the following flags are used, the number entered becomes the required number of that particular operand.

ARG_VAR When this is specified, Parse will allow from 0 to the specified number to be entered.

ARG_OPT When this is specified, Parse will allow either 0 or the exact specified number of operands

ARG_DEF When this is specified, the Line Reference and Tag Operands are validated to ensure they are valid, defined references.

Created with the Personal Edition of HelpNDoc: Revolutionize Your Documentation Review with HelpNDoc's Project Analyzer