XML for RPG and Procedural Languages Documentation

Readme
Installation
API Docs
Samples
Programming
License

API Documentation for DOM and SAX

XML Constructs:

    The XML for RPG and other Procedural Languages (XML4PR) parser has API documentation for both DOM and SAX APIs, the two most common programming interfaces for XML.

    Because XML for RPG and other Procedural Languages is a procedural interface that wrappers the XML4C parser, there are C++ objects being instantiated and manipulated under the covers through the use of the XML4PR parser. Your application will be given pointers, also referred to as handles, that represent these parser constructs. These handles are maintained by your application as procedure return values or as input to SAX event handlers. You also provide these handles as input parameters on various procedure calls. These handles are in the form of void * in C, pointers (*) in RPG or as type HANDLE in COBOL. To aid in the readability of both the API documentation and the C header file and sample source, we have provided typedefs to reference these parser constructs. In the RPG and COBOL COPY files the type of parser construct returned on a method call or provided as an input parameter is specified in the comment lines of the included files.

    Associated with a HANDLE is the underlying parser construct or object type. Before issuing any function call using a particular handle, the XML procedural parser support will do the necessary verification that the type of underlying object included in the handle is valid for that particular procedure call. If your application provides the wrong type of object handle or the underlying object cannot be cast to the appropriate object type, an exception is generated and an error return code of '99' or Qxml_INVLOBJHDL will be returned in the DOM exception area. See the API Usage Exceptions section under the Programming link for an explanation of how to check for errors caused by passing the wrong object type on a procedure or other incorrect uses of the APIs.

    See the XML4PR API list to view a list of DOM and SAX parser constructs and their descriptions.

XML Parser Procedures:

    Most of the XML4PR parser APIs documented correspond to method calls on the underlying XML4C parser objects (parser constructs) provided by the XML for C++ parser. To aid in that mapping, the naming convention for the exported functions in the XML4PR service program is as follows:

      Qxml<parser construct>_method_<qualifying input parameters>

    See the list of supported procedures for more details. To go directly to the documentation for all procedures, see the procedure descriptions page. For each procedure that directly maps to a corresponding XML4C method call, a link to the C++ documentation has been provided. This link is labled More Documentation. Using these links provides additional information about the procedure: what it does, what it requires as input, and what it returns.


XML4PR - XML4C Interface Wrapper for RPG, C and COBOL
Copyright 2000,2001,2002 International Business Machines. All Rights Reserved.