Miscellaneous Procedures
  • These are general purpose procedures.
QxmlInit
QxmlTerm
QxmlTerm_rtnHandleCount
QxmlTranscode
QxmlCloseOutputStream
QxmlWriteOutputStream
QxmlGenPrint
QxmlGenPrintLn
QxmlDelete_allocstr
QxmlisXMLEmptyString

XMLCh Related Procedures:
  • An XML Character - a unicode character
  • XMLCh * is a unicode string , use Qxml_UNICODE for string indicator
(none)

DOMParser - C++ Class DocumentationRelated Procedures:
  • A DOMParser - Document Object Model ( DOM ) parser interface
QxmlDOMParser_new
QxmlDOMParser_delete
QxmlDOMParser_parse_SystemId
QxmlDOMParser_parse_InputSource
QxmlDOMParser_reset
QxmlDOMParser_getValidationScheme
QxmlDOMParser_setDoValidation
QxmlDOMParser_setValidationScheme
QxmlDOMParser_getErrorHandler
QxmlDOMParser_resetErrorHandler
QxmlDOMParser_setErrorHandler
QxmlDOMParser_ErrorHandlerExists
QxmlDOMParser_getEntityResolver
QxmlDOMParser_resetEntityResolver
QxmlDOMParser_setEntityResolver
QxmlDOMParser_EntityResolverExists
QxmlDOMParser_getDoNamespaces
QxmlDOMParser_setDoNamespaces
QxmlDOMParser_setDoSchema
QxmlDOMParser_setValidationSchemaFullChecking
QxmlDOMParser_getExitOnFirstFatalError
QxmlDOMParser_setExitOnFirstFatalError
QxmlDOMParser_getExpandEntityReferences
QxmlDOMParser_setExpandEntityReferences
QxmlDOMParser_getCreateEntityReferenceNodes
QxmlDOMParser_setCreateEntityReferenceNodes
QxmlDOMParser_getIncludeIgnorableWhitespace
QxmlDOMParser_setIncludeIgnorableWhitespace
QxmlDOMParser_getToCreateXMLDeclTypeNode
QxmlDOMParser_setToCreateXMLDeclTypeNode
QxmlDOMParser_parseReset
QxmlDOMParser_parseFirst_SystemId
QxmlDOMParser_parseFirst_InputSource
QxmlDOMParser_parseNext
QxmlDOMParser_getDocument

DOMString - C++ Class DocumentationRelated Procedures:
  • A DOMString type - generic string object. Although this string object is used throughout the DOM C++ apis , the XML4PR interface does allow other options on input ( see stringind option on some API requests )
QxmlDOMString_new
QxmlDOMString_null
QxmlDOMString_delete
QxmlDOMString_appendData
QxmlDOMString_deleteData
QxmlDOMString_insertData
QxmlDOMString_substringData
QxmlDOMString_length
QxmlDOMString_clone
QxmlDOMString_print
QxmlDOMString_println
QxmlDOMString_compareString
QxmlDOMString_equals
QxmlDOMString_isNull
QxmlDOMString_transcode

DOM_Node - C++ Class DocumentationRelated Procedures:
  • A DOM_Node type - primary datatype for entire Document Object Model
QxmlDOM_Node_new
QxmlDOM_Node_delete
QxmlDOM_Node_cloneNode
QxmlDOM_Node_hasChildNodes
QxmlDOM_Node_isNull
QxmlDOM_Node_getNodeName
QxmlDOM_Node_getNodeValue
QxmlDOM_Node_getNodeType
QxmlDOM_Node_getParentNode
QxmlDOM_Node_getChildNodes
QxmlDOM_Node_getFirstChild
QxmlDOM_Node_getLastChild
QxmlDOM_Node_getPreviousSibling
QxmlDOM_Node_getNextSibling
QxmlDOM_Node_getAttributes
QxmlDOM_Node_insertBefore
QxmlDOM_Node_replaceChild
QxmlDOM_Node_removeChild
QxmlDOM_Node_appendChild
QxmlDOM_Node_setNodeValue
QxmlDOM_Node_equal

DOM_Attr - C++ Class DocumentationRelated Procedures:
  • A DOM_Attr type - refers to attributes of an XML element
QxmlDOM_Attr_new
QxmlDOM_Attr_delete
QxmlDOM_Attr_getSpecified
QxmlDOM_Attr_getName
QxmlDOM_Attr_getValue
QxmlDOM_Attr_setValue
QxmlDOM_Attr_getOwnerElement

DOM_CharacterData - C++ Class DocumentationRelated Procedures:
  • A DOM_CharacterData type
QxmlDOM_CharacterData_new
QxmlDOM_CharacterData_delete
QxmlDOM_CharacterData_getData
QxmlDOM_CharacterData_getLength
QxmlDOM_CharacterData_substringData
QxmlDOM_CharacterData_appendData
QxmlDOM_CharacterData_insertData
QxmlDOM_CharacterData_deleteData
QxmlDOM_CharacterData_replaceData
QxmlDOM_CharacterData_setData

DOM_Text - C++ Class DocumentationRelated Procedures:
  • A DOM_Text type
QxmlDOM_Text_new
QxmlDOM_Text_delete
QxmlDOM_Text_splitText

DOM_Comment - C++ Class DocumentationRelated Procedures:
  • A DOM_Comment type
QxmlDOM_Comment_new
QxmlDOM_Comment_delete

DOM_CDATASection - C++ Class DocumentationRelated Procedures:
  • A DOM_CDATASection type
QxmlDOM_CDATASection_new
QxmlDOM_CDATASection_delete

DOM_Document - C++ Class DocumentationRelated Procedures:
  • A DOM_Document type
QxmlDOM_Node_getOwnerDocument
QxmlDOM_Document_new
QxmlDOM_Document_delete
QxmlDOM_Document_createDocument
QxmlDOM_Document_createEntity
QxmlDOM_Document_createElement
QxmlDOM_Document_createDocumentFragment
QxmlDOM_Document_createTextNode
QxmlDOM_Document_createComment
QxmlDOM_Document_createCDATASection
QxmlDOM_Document_createDocumentType
QxmlDOM_Document_createNotation
QxmlDOM_Document_createProcessingInstruction
QxmlDOM_Document_createXMLDecl
QxmlDOM_Document_createAttribute
QxmlDOM_Document_createEntityReference
QxmlDOM_Document_getDoctype
QxmlDOM_Document_getImplementation
QxmlDOM_Document_getDocumentElement
QxmlDOM_Document_getElementsByTagName
QxmlDOM_Document_getElementById
QxmlDOM_Document_importNode
QxmlDOM_Document_createNodeIterator
QxmlDOM_Document_createTreeWalker
QxmlDOM_Document_createRange
QxmlDOM_Document_createElementNS
QxmlDOM_Document_createAttributeNS

DOM_DocumentFragment - C++ Class DocumentationRelated Procedures:
  • A DOM_DocumentFragment type
QxmlDOM_DocumentFragment_new
QxmlDOM_DocumentFragment_delete

DOM_DocumentType - C++ Class DocumentationRelated Procedures:
  • A DOM_DocumentType type
QxmlDOM_DocumentType_new
QxmlDOM_DocumentType_delete
QxmlDOM_DocumentType_getName
QxmlDOM_DocumentType_getEntities
QxmlDOM_DocumentType_getNotations
QxmlDOM_DocumentType_getPublicId
QxmlDOM_DocumentType_getSystemId
QxmlDOM_DocumentType_getInternalSubset

DOM_Element - C++ Class DocumentationRelated Procedures:
  • A DOM_Element type - the most common node type during parsing
QxmlDOM_Element_new
QxmlDOM_Element_delete
QxmlDOM_Element_getTagName
QxmlDOM_Element_getAttribute
QxmlDOM_Element_getAttributeNS
QxmlDOM_Element_getAttributeNode
QxmlDOM_Element_getAttributeNodeNS
QxmlDOM_Element_getElementsByTagName
QxmlDOM_Element_getElementsByTagNameNS
QxmlDOM_Element_setAttribute
QxmlDOM_Element_setAttributeNS
QxmlDOM_Element_setAttributeNode
QxmlDOM_Element_removeAttributeNode
QxmlDOM_Element_removeAttribute
QxmlDOM_Element_removeAttributeNS

DOM_Entity - C++ Class DocumentationRelated Procedures:
  • A DOM_Entity type
QxmlDOM_Entity_new
QxmlDOM_Entity_delete
QxmlDOM_Entity_getPublicId
QxmlDOM_Entity_getSystemId
QxmlDOM_Entity_getNotationName

DOM_EntityReference - C++ Class DocumentationRelated Procedures:
  • A DOM_EntityReference type
QxmlDOM_EntityReference_new
QxmlDOM_EntityReference_delete

DOM_Notation - C++ Class DocumentationRelated Procedures:
  • A DOM_Notation type
QxmlDOM_Notation_new
QxmlDOM_Notation_delete
QxmlDOM_Notation_getPublicId
QxmlDOM_Notation_getSystemId

DOM_ProcessingInstruction - C++ Class DocumentationRelated Procedures:
  • A DOM_ProcessingInstruction type
QxmlDOM_ProcessingInstruction_new
QxmlDOM_ProcessingInstruction_delete
QxmlDOM_ProcessingInstruction_getTarget
QxmlDOM_ProcessingInstruction_getData
QxmlDOM_ProcessingInstruction_setData

DOM_NamedNodeMap - C++ Class DocumentationRelated Procedures:
  • A DOM_NamedNodeMap type
QxmlDOM_NamedNodeMap_new
QxmlDOM_NamedNodeMap_delete
QxmlDOM_NamedNodeMap_setNamedItem
QxmlDOM_NamedNodeMap_setNamedItemNS
QxmlDOM_NamedNodeMap_item
QxmlDOM_NamedNodeMap_getNamedItem
QxmlDOM_NamedNodeMap_getNamedItemNS
QxmlDOM_NamedNodeMap_getLength
QxmlDOM_NamedNodeMap_removeNamedItem
QxmlDOM_NamedNodeMap_removeNamedItemNS

DOM_NodeList - C++ Class DocumentationRelated Procedures:
  • A DOM_NodeList type - provides an iterator for ordered list of nodes
QxmlDOM_NodeList_new
QxmlDOM_NodeList_delete
QxmlDOM_NodeList_item
QxmlDOM_NodeList_getLength

DOM_DOMImplementation - C++ Class DocumentationRelated Procedures:
  • A DOM_DOMImplementation type
QxmlDOM_DOMImplementation_new
QxmlDOM_DOMImplementation_delete
QxmlDOM_DOMImplementation_hasFeature
QxmlDOM_DOMImplementation_getImplementation
QxmlDOM_DOMImplementation_createDocument

DOM_TreeWalker - C++ Class DocumentationRelated Procedures:
  • A DOM_TreeWalker type
QxmlDOM_TreeWalker_new
QxmlDOM_TreeWalker_delete
QxmlDOM_TreeWalker_getWhatToShow
QxmlDOM_TreeWalker_getExpandEntityReferences
QxmlDOM_TreeWalker_getCurrentNode
QxmlDOM_TreeWalker_parentNode
QxmlDOM_TreeWalker_firstChild
QxmlDOM_TreeWalker_lastChild
QxmlDOM_TreeWalker_previousSibling
QxmlDOM_TreeWalker_nextSibling
QxmlDOM_TreeWalker_nextNode
QxmlDOM_TreeWalker_previousNode
QxmlDOM_TreeWalker_setCurrentNode
QxmlDOM_TreeWalker_equal

DOM_NodeIterator - C++ Class DocumentationRelated Procedures:
  • A DOM_NodeIterator type
QxmlDOM_NodeIterator_new
QxmlDOM_NodeIterator_delete
QxmlDOM_NodeIterator_detach
QxmlDOM_NodeIterator_getWhatToShow
QxmlDOM_NodeIterator_getExpandEntityReferences
QxmlDOM_NodeIterator_nextNode
QxmlDOM_NodeIterator_previousNode
QxmlDOM_NodeIterator_equal

DOM_NodeFilter - C++ Class DocumentationRelated Procedures:
  • A DOM_NodeFilter type - currently has no implementation
(none)

DOM_Range - C++ Class DocumentationRelated Procedures:
  • A DOM_Range type
QxmlDOM_Range_new
QxmlDOM_Range_delete
QxmlDOM_Range_equal
QxmlDOM_Range_getStartContainer
QxmlDOM_Range_getEndContainer
QxmlDOM_Range_getStartOffset
QxmlDOM_Range_getEndOffset
QxmlDOM_Range_getCollapsed
QxmlDOM_Range_getCommonAncestorContainer
QxmlDOM_Range_setStart
QxmlDOM_Range_setEnd
QxmlDOM_Range_setStartBefore
QxmlDOM_Range_setStartAfter
QxmlDOM_Range_setEndBefore
QxmlDOM_Range_setEndAfter
QxmlDOM_Range_collapse
QxmlDOM_Range_selectNode
QxmlDOM_Range_selectNodeContents
QxmlDOM_Range_compareBoundaryPoints
QxmlDOM_Range_deleteContents
QxmlDOM_Range_extractContents
QxmlDOM_Range_cloneContents
QxmlDOM_Range_insertNode
QxmlDOM_Range_surroundContents
QxmlDOM_Range_cloneRange
QxmlDOM_Range_detach
QxmlDOM_Range_toString

SAXParser - C++ Class DocumentationRelated Procedures:
  • A SAXParser - SAX ( event-driven ) parser interface
QxmlSAXParser_new
QxmlSAXParser_delete
QxmlSAXParser_setDoValidation
QxmlSAXParser_setEntityResolver
QxmlSAXParser_setDTDHandler
QxmlSAXParser_setDocumentHandler
QxmlSAXParser_setErrorHandler
QxmlSAXParser_resetEntityResolver
QxmlSAXParser_resetDTDHandler
QxmlSAXParser_resetDocumentHandler
QxmlSAXParser_resetErrorHandler
QxmlSAXParser_parse_SystemId
QxmlSAXParser_parse_InputSource
QxmlSAXParser_parseFirst_SystemId
QxmlSAXParser_parseFirst_InputSource
QxmlSAXParser_parseNext
QxmlSAXParser_getDocumentHandler
QxmlSAXParser_getEntityResolver
QxmlSAXParser_getErrorHandler
QxmlSAXParser_getValidationScheme
QxmlSAXParser_setValidationScheme
QxmlSAXParser_getDoNamespaces
QxmlSAXParser_setDoNamespaces
QxmlSAXParser_setDoSchema
QxmlSAXParser_setValidationSchemaFullChecking
QxmlSAXParser_getExitOnFirstFatalError
QxmlSAXParser_setExitOnFirstFatalError

XMLPScanToken Related Procedures:
  • A token used by XML scanner while doing a progressive parse
QxmlXMLPScanToken_new
QxmlXMLPScanToken_delete

AttributeList - C++ Class DocumentationRelated Procedures:
  • An AttributeList type - returns attributes for specific startElement SAX Event
QxmlAttributeList_delete
QxmlAttributeList_getLength
QxmlAttributeList_getName_byindex
QxmlAttributeList_getType_byindex
QxmlAttributeList_getValue_byindex
QxmlAttributeList_getType_byname
QxmlAttributeList_getValue_byname

DocumentHandler - C++ Class DocumentationRelated Procedures:
  • A DocumentHandler type - handler that receives SAX general document events such as startDocument , endDocument , startElement , endElement , etc
QxmlDocumentHandler_new
QxmlDocumentHandler_delete
QxmlDocumentHandler_setCallback
Qxml_COBOL_DocumentHandler_setCallback

ErrorHandler - C++ Class DocumentationRelated Procedures:
  • An ErrorHandler type - handler for SAX parse error events such as warning , error , fatalError
QxmlErrorHandler_new
QxmlErrorHandler_delete
QxmlErrorHandler_setCallback
Qxml_COBOL_ErrorHandler_setCallback

EntityResolver - C++ Class DocumentationRelated Procedures:
  • An EntityResolver type - handler for SAX entity resolver events
QxmlEntityResolver_new
QxmlEntityResolver_delete
QxmlEntityResolver_setCallback
Qxml_COBOL_EntityResolver_setCallback

DTDHandler - C++ Class DocumentationRelated Procedures:
  • A DTDHandler type - handler that SAX DTD-related events
QxmlDTDHandler_new
QxmlDTDHandler_delete
QxmlDTDHandler_setCallback
Qxml_COBOL_DTDHandler_setCallback

SAXException - C++ Class DocumentationRelated Procedures:
  • A SAXException type
QxmlSAXException_new
QxmlSAXException_delete
QxmlSAXException_message
QxmlSAXException_getMessage

SAXParseException - C++ Class DocumentationRelated Procedures:
  • A SAXParseException type
QxmlThrow
QxmlSAXParseException_new_message_locator
QxmlSAXParseException_new_SystemId
QxmlSAXParseException_delete
QxmlSAXParseException_getColumnNumber
QxmlSAXParseException_getLineNumber
QxmlSAXParseException_getPublicId
QxmlSAXParseException_getSystemId

InputSource - C++ Class DocumentationRelated Procedures:
  • An InputSource type - requires one of the specific input sources LocalFileInputSource , MemBufInputSource or StdInInputSourse
(none)

LocalFileInputSource - C++ Class DocumentationRelated Procedures:
  • A LocalFileInputSource type - references local IFS file
QxmlLocalFileInputSource_new
QxmlLocalFileInputSource_delete
QxmlLocalFileInputSource_setEncoding

MemBufInputSource - C++ Class DocumentationRelated Procedures:
  • A MemBufInputsource type - reference memory buffer
QxmlMemBufInputSource_new
QxmlMemBufInputSource_delete
QxmlMemBufInputSource_setEncoding

StdInInputSource - C++ Class DocumentationRelated Procedures:
  • A StdInInputSource type - references standard input
QxmlStdInInputSource_new
QxmlStdInInputSource_delete
QxmlStdInInputSource_setEncoding

Locator - C++ Class DocumentationRelated Procedures:
  • A Locator type - represents document location during SAX parser events
QxmlLocator_delete
QxmlLocator_getPublicId
QxmlLocator_getSystemId
QxmlLocator_getLineNumber
QxmlLocator_getColumnNumber

FileDescriptor Related Procedures:
  • A local file descriptor used to output to stream files in local IFS
QxmlOpenNewOutputStream
QxmlOpenAppendOutputStream

DOM_XMLDecl - C++ Class DocumentationRelated Procedures:
  • An XMLDecl type
QxmlDOM_XMLDecl_new
QxmlDOM_XMLDecl_delete
QxmlDOM_XMLDecl_getVersion
QxmlDOM_XMLDecl_getStandalone
QxmlDOM_XMLDecl_getEncoding

XMLFormatter - C++ Class DocumentationRelated Procedures:
  • An XMLFormatter provides the basic formatting capabilities that are required to turn the Unicode based XML data from the parsers into a form that can be used in non-Unicode based systems. Such as for printing or generating XML documents in local or generic text encodings. A number of flags are provided to control the various formatting options.
QxmlXMLFormatter_new
QxmlXMLFormatter_delete
QxmlXMLFormatter_formatBuf
QxmlXMLFormatter_streamoutXMLString
QxmlXMLFormatter_streamoutXMLCh
QxmlXMLFormatter_streamoutDOMString
QxmlXMLFormatter_getEncodingName
QxmlXMLFormatter_setEscapeFlags
QxmlXMLFormatter_setUnRepFlags

XMLFormatTarget - C++ Class DocumentationRelated Procedures:
  • An XMLFormatTarget type allows the redirection of XMLFormatter output to an IFS file.
QxmlFileFormatTarget_new
QxmlFileFormatTarget_delete

XMLAttr - C++ Class DocumentationRelated Procedures:
  • An XMLAttr type
(none)

XMLElementDecl - C++ Class DocumentationRelated Procedures:
  • An XML ElementDeclaration type
(none)

XMLEntityDecl - C++ Class DocumentationRelated Procedures:
  • An XML Entity Declaration type
(none)

SAX2XMLReader - C++ Class DocumentationRelated Procedures:
  • A SAX2 ( event-driven ) parser handle
QxmlXMLReaderFactory_createXMLReader
QxmlSAX2XMLReader_delete
QxmlSAX2XMLReader_getContentHandler
QxmlSAX2XMLReader_resetContentHandler
QxmlSAX2XMLReader_setContentHandler
QxmlSAX2XMLReader_getEntityResolver
QxmlSAX2XMLReader_resetEntityResolver
QxmlSAX2XMLReader_setEntityResolver
QxmlSAX2XMLReader_getDTDHandler
QxmlSAX2XMLReader_resetDTDHandler
QxmlSAX2XMLReader_setDTDHandler
QxmlSAX2XMLReader_getErrorHandler
QxmlSAX2XMLReader_resetErrorHandler
QxmlSAX2XMLReader_setErrorHandler
QxmlSAX2XMLReader_getFeature
QxmlSAX2XMLReader_enableFeature
QxmlSAX2XMLReader_disableFeature
QxmlSAX2XMLReader_parse_InputSource
QxmlSAX2XMLReader_parse_SystemId

ContentHandler - C++ Class DocumentationRelated Procedures:
  • A Content Handler type - handler that receives SAX2 general document events such as startDocument , endDocument , startElement , endElement , etc
Qxml_COBOL_ContentHandler_setCallback
QxmlContentHandler_new
QxmlContentHandler_delete
QxmlContentHandler_setCallback

Attributes - C++ Class DocumentationRelated Procedures:
  • An Attributes Handler type
QxmlAttributes_delete
QxmlAttributes_getLength
QxmlAttributes_getURI
QxmlAttributes_getLocalName
QxmlAttributes_getQName
QxmlAttributes_getType_byIndex
QxmlAttributes_getIndex_byName
QxmlAttributes_getIndex_byQName
QxmlAttributes_getType_byName
QxmlAttributes_getType_byQName
QxmlAttributes_getValue_byName
QxmlAttributes_getValue_byQName

QxmlXML_env_t Related Procedures:
  • General purpose DOM exception return structure. Any use of a XML4PR API resulting in an internal DOM exception will be recorded here. A user copy of this return area should be provide as part of the QxmlInit. The QxmlInit function saves a pointer to this structure on a per-thread basis. Viewing this structure will identify the last DOM exception found. Note that the return code is zero on the initialize request but is not set to zero before each subsequent API operation. If you are getting unexpected failure or results , you should determine if there is an API problem by monitoring this return code. A common error is using an object handle that is of the wrong type for the API request , see 99.
  • Possible return codes are:
  • 0 or Qxml_DOMNOERROR for no error
  • 1 or Qxml_INDXSIZERR for index size error
  • 2 or Qxml_DMSTSIZERR for DOMString size error
  • 3 or Qxml_HIERREQERR for Hierarchy request error
  • 4 or Qxml_WRNGDOCERR for wrong document error
  • 5 or Qxml_INVLCHRERR for invalid character error
  • 6 or Qxml_NODALOWERR for no data allowed error
  • 7 or Qxml_NOMODFYALW for no modification allowed error
  • 8 or Qxml_NOTFOUNDER for not found error
  • 9 or Qxml_NOTSUPPERR for not supported error
  • 10 or Qxml_INUSEATRER for in use attribute error
  • 11 or Qxml_INVLSTATE for invalid state error
  • 12 or Qxml_SYNTAXERR for syntax error
  • 13 or Qxml_INVLMODERR for invalid modification error
  • 14 or Qxml_NAMESPCERR for namespace error
  • 15 or Qxml_INVLACCERR for invalid access error
  • 98 or Qxml_UNEXPCTERR for unexpected error caught by SAX APIs
  • 99 or Qxml_INVLOBJHDL for invalid handle type on XML4PR function call
  • 10001 or Qxml_BADBDYPTS for bad range boundary points ( DOM_Range error )
  • 10002 or Qxml_INVNODET for invalid node type ( DOM_Range error )
(none)

QxmlParser_env_t Related Procedures:
  • Structure for returning Parser Exceptions: error type , line number , column number , error message and input source
  • Possible error types are the following
  • 0 or Qxml_NOERROR for no error
  • 1 or Qxml_WARNING for a warning
  • 2 or Qxml_ERROR for an error
  • 3 or Qxml_FATAL for a fatal error
(none)