|
Options |
Name |
Purpose |
|
|
|
AddNumberedArg (character)
|
Appends a numbered include argument
Notes :
@param pcValue The argument value
*/
|
|
|
|
DefineName (character, character)
|
Defines a scoped preprocessor name in this scope
Notes :
@param pcName The (lowercased) name
@param pcValue The value
*/
|
|
|
|
DefineNamedArg (character, character)
|
Defines a named include argument
Notes : Named include arguments can also be referenced by number, so
they are appended to the numbered argument list as well.
@param pcName The argument name
@param pcValue The argument value
*/
|
|
|
|
CHARACTER GetAllNamedArgs ()
|
Returns all named argument definitions (&name="value" ...)
Notes : Corresponds to the {&*} reference.
@return The concatenated named argument definitions
*/
|
|
|
|
CHARACTER GetAllNumberedArgs ()
|
Returns all numbered arguments (from {1}) space delimited
Notes : Corresponds to the {*} reference.
@return The space-delimited argument values
*/
|
|
|
|
CHARACTER GetName (character)
|
Returns the value of a scoped name, or the unknown value
Notes :
@param pcName The name to look up
@return The value, or ? if not defined
*/
|
|
|
|
CHARACTER GetNamedArg (character)
|
Returns a named argument value, or the unknown value
Notes : If the name is blank, the first blank (undefined) named
argument is returned. The first definition wins.
@param pcName The argument name
@return The argument value, or ? if not found
*/
|
|
|
|
CHARACTER GetNumberedArg (integer)
|
Returns a numbered argument value ("" if out of range)
Notes :
@param piArgNum The 0-based argument number
@return The argument value, or the empty string
*/
|
|
|
|
LOGICAL HasName (character)
|
Returns whether a scoped name is defined in this scope
Notes :
@param pcName The name to check
@return Logical value indicating if the name is defined
*/
|
|
|
|
INTEGER NumberedArgCount ()
|
Returns the count of numbered arguments (including {0})
Notes :
@return The number of numbered arguments
*/
|
|
|
|
LOGICAL RemoveName (character)
|
Removes a scoped name from this scope
Notes :
@param pcName The name to remove
@return Logical value indicating if the name was found and removed
*/
|
|
|
|
LOGICAL UndefineNamedArg (character)
|
Undefines the first matching named include argument
Notes : Blanks the name of the first matching entry, which is what
Progress does, so a later definition of the same name becomes
the active one.
@param pcName The argument name
@return Logical value indicating if a matching argument was found
*/
|
