General Functions
General FunctionsGeneral Functions
This topic defines language for the flex parser general functions.
General Functions Language DefinitionGeneral Functions Language Definition
- Node Name: apptype
- Attribute Name:
- Description: Gets the currently defined service type for the current session.
- Node Name:
- Attribute Name: name
- Description: A number variable to receive the current service type.
- Node Name: identify
- Attribute Name:
- Description: Marks the session with the parser’s service type if the service type has not already been identified.
- Node Name: assign
- Attribute Name:
- Description: Assigns a value to a variable.
- Node Name:
- Attribute Name: name
- Description: The unique identifier assigned to the item in the declaration section.
- Node Name:
- Attribute Name: value
- Description: Optional. If specified, the action defined in the match is only applied when the declaration matches the given value.
- Node Name: getmeta
- Attribute Name:
- Description: Retrieves the value of meta that generated a callback. This function will return empty results (0, zero length string) if called when there was no meta callback.
- Node Name:
- Attribute Name: name
- Description: The variable to receive the value of the meta key that generated the callback.
- Node Name: gettoken
- Attribute Name:
- Description: Returns the current matched token.
- Node Name:
- Attribute Name: name
- Description: A string variable to receive the current matched token. If there is no current token, the variable is assigned an empty string.
- Node Name: end
- Attribute Name:
- Description: This terminates the execution of the current match section.
- Node Name: if
- Attribute Name:
- Description: Compares two values. If the comparison is true, executes any sub-actions. Comparisons can be number or string types, as long as both values are the same type.
- Node Name:
- Attribute Name: name
- Description: The unique variable identifier assigned to the item in the declaration section.
- Node Name:
- Attribute Name: equal
notequal
less
lessequal
greater
greaterequal
and
or - Description: The operation value to compare. If true, any sub-actions are executed.
- Node Name: register
- Attribute Name:
- Description: Adds metadata to the session.
- Node Name:
- Attribute Name: name
- Description: The unique identifier of a meta variable to be created, as defined in the declaration section.
- Node Name:
- Attribute Name: value
- Description: The value of the metadata to be created.
- Node Name: while
- Attribute Name:
- Description: Compares two values and executes any sub-actions if the comparison is true. Comparisons can be number or string types, as long as both values are the same type.
- Node Name:
- Attribute Name: name
- Description: The unique variable identifier assigned to the item in the declaration section.
- Node Name:
- Attribute Name: equal
notequal
less
lessequal
greater
greaterequal
and
or - Description: Specifies the operation value to compare. If true, any sub-action is executed. The and and or attributes signify bitwise operations and can only be applied to number variables.
- Node Name: call
- Attribute Name:
- Description: Executes the specified match element. This can be any match element defined in the same flex parser regardless of how it was declared.
- Node Name:
- Attribute Name: value
- Description: The name of the match element, or a string variable containing the name of a match element.
- If the match element name is specified, the parser will not load if the named matched element doesn't exist.
- If a string variable is specified, the call element will execute any child elements that it may have if the string value resolves to a match element after executing the named match element.
- If no match element can be found matching the string value, no action is taken.