All of these functions must return a BYVALUE FIXED BIN(31)
value that is a return code to the parser.
If any value other than zero is returned, the parser will terminate.
All of these functions will be passed as the first argument a
BYVALUE POINTER that is the token value passed originally as the
second argument to the built-in function.
With the following exceptions, all of the functions will also
be passed a BYVALUE POINTER and a BYVALUE FIXED BIN(31) that supply
the address and length of the text element for the event. The functions/events
that are different are:
- start_of_document
- No argument other than the user token is passed.
- end_of_document
- No argument other than the user token is passed.
- start_of_CDATA
- No argument other than the user token is passed.
- end_of_CDATA
- No argument other than the user token is passed.
- start_of_element
- In addition to the usual 3 parameters, four additional arguments are
passed:
- a BYVALUE POINTER that is the address of the namespace prefix
- a BYVALUE FIXED BIN(31) that is the length of the namespace prefix
- a BYVALUE POINTER that is the address of the namespace uri
- a BYVALUE FIXED BIN(31) that is the length of the namespace uri
- end_of_element
- In addition to the usual 3 parameters, four additional arguments are
passed:
- a BYVALUE POINTER that is the address of the namespace prefix
- a BYVALUE FIXED BIN(31) that is the length of the namespace prefix
- a BYVALUE POINTER that is the address of the namespace uri
- a BYVALUE FIXED BIN(31) that is the length of the namespace uri
- attribute_name
- In addition to the usual 3 parameters, four additional arguments are
passed:
- a BYVALUE POINTER that is the address of the namespace prefix
- a BYVALUE FIXED BIN(31) that is the length of the namespace prefix
- a BYVALUE POINTER that is the address of the namespace uri
- a BYVALUE FIXED BIN(31) that is the length of the namespace uri
- namespace_declare
- In addition to the user token, four additional arguments
passed:
- a BYVALUE POINTER that is the address of the namespace prefix
- a BYVALUE FIXED BIN(31) that is the length of the namespace prefix
- a BYVALUE POINTER that is the address of the namespace uri
- a BYVALUE FIXED BIN(31) that is the length of the namespace uri
- content_characters
- In addition to the usual 3 parameters, one additional argument is
passed:
- a BYADDR ALIGNED BIT(8) flag byte that indicates
- if more content charcaters will be presented in the next event -
this is true if the first bit is on, i.e.
this is true if this field anded with '80'BX is non-null
- if there are no characters that need to be escaped if converted back to XML -
this is true if the second bit is on, i.e.
this is true if this field anded with '40'BX is non-null
Note that this entry must also be declared with OPTIONS( NODESCRIPTOR ).
- end_of_input
- In addition to the user token, two additional arguments
are passed:
- a BYADDR POINTER that is the address of the next input buffer
- a BYADDR FIXED BIN(31) that is the length of the next input buffer
- processing_instruction
- In addition to the user token, four additional arguments are
passed:
- a BYVALUE POINTER that is the address of the target text
- a BYVALUE FIXED BIN(31) that is the length of the target text
- a BYVALUE POINTER that is the address of the data text
- a BYVALUE FIXED BIN(31) that is the length of the data text
- exception
- In addition to the user token, three additional arguments
are passed:
- a BYVALUE FIXED BIN(31) that is the byte offset of the offending
text within the document
- a BYVALUE FIXED BIN(31) that is the return code for the exception
- a BYVALUE FIXED BIN(31) that is the reason code for the exception
|
This information center is powered by Eclipse technology. (http://www.eclipse.org)