PLISAXC XML Parser event function parameters

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 terminates.

All of these functions are passed as the first argument a POINTER. This pointer is the token value that is passed originally as the second argument to the built-in.

With the following exceptions, all of the functions have a POINTER and a FIXED BIN(31) passed to them that provide the address and length of the text element for the event. The following functions and events are different:

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 parameters, these additional arguments are passed.

  • a POINTER that is the address of the namespace prefix
  • a FIXED BIN(31) that is the length of the namespace prefix
  • a POINTER that is the address of the namespace URI
  • a FIXED BIN(31) that is the length of the namespace URI
end_of_element

In addition to the usual parameters, these additional arguments are passed.

  • a POINTER that is the address of the namespace prefix
  • a FIXED BIN(31) that is the length of the namespace prefix
  • a POINTER that is the address of the namespace URI
  • a FIXED BIN(31) that is the length of the namespace URI
attribute_name

In addition to the usual parameters, these additional arguments are passed.

  • a POINTER that is the address of the namespace prefix
  • a FIXED BIN(31) that is the length of the namespace prefix
  • a POINTER that is the address of the namespace URI
  • a FIXED BIN(31) that is the length of the namespace URI
namesace_declare

In addition to the user token, these additional arguments are passed.

  • a POINTER that is the address of the namespace prefix
  • a FIXED BIN(31) that is the length of the namespace prefix
  • a POINTER that is the address of the namespace URI
  • a FIXED BIN(31) that is the length of the namespace URI
content_characters In addition to the usual three parameters, a BYVALUE ALIGNED BIT(8) flag byte is passed which indicates:
  • If more content characters are in the next event. This is true if the first bit is on (if the 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(if the field ANDed with '40'BX is non-null).
end_of_input

In addition to the user token, these additional arguments are passed.

  • a POINTER that is the address of the next input buffer
  • a 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 POINTER that is the address of the target text
  • a FIXED BIN(31) that is the length of the target text
  • a POINTER that is the address of the data text
  • a FIXED BIN(31) that is the length of the data text
exception In addition to the user token, three additional arguments are passed:
  • a POINTER that is the address of the offending text
  • a FIXED BIN(31) that is the return code for the exception
  • a FIXED BIN(31) that is the reason code for the exception