Functions | |
int | mdlXMLDom_createWithParameters (XmlDomRef *pDomRef, bool bFreeThreaded, bool bAsync, bool bValidate, bool bResolveExtern, bool bPreserveWhiteSpace) |
Creates an instance of a DOM Class with given parameters. More... | |
int | mdlXMLDom_create (XmlDomRef *pDomRef) |
Creates an instance of a DOM Class. More... | |
int | mdlXMLDom_createFreeThreaded (XmlDomRef *pDomRef) |
Creates a free threaded instance of a DOM Class. More... | |
int | mdlXMLDom_createFromText (XmlDomRef *pDomRef, bool bFreeThreaded, WChar const *pXmlText) |
Creates an instance of a DOM Class from a well-formed XML text string. More... | |
int | mdlXMLDom_createFromNode (XmlDomRef *pDomRef, bool bFreeThreaded, XmlNodeRef sourceNodeRef, bool deepClone) |
Creates an instance of a DOM Class from an existing DOM using XPath criteria. More... | |
int | mdlXMLDom_createFromFragment (XmlDomRef *pDomRef, bool bFreeThreaded, XmlDomRef sourceDomRef, WChar const *pXpath, bool deepClone) |
Creates an instance of a DOM Class from an existing DOM using XPath criteria. More... | |
int | mdlXMLDom_free (XmlDomRef domRef) |
Frees an instance of a DOM Class. More... | |
int | mdlXMLDom_getParameter (XmlDomRef domRef, int parameterType, bool *parameterValue) |
Sets Parameters on the given DOM. More... | |
int | mdlXMLDom_setParameter (XmlDomRef domRef, int parameterType, bool parameterValue) |
Sets parameters from the given DOM. More... | |
int | mdlXMLDom_setProperty (XmlDomRef domRef, WChar const *propertyName, WChar const *propertyValue) |
Sets a property from the given DOM to the given value. More... | |
int | mdlXMLDom_getProperty (XmlDomRef domRef, WChar const *propertyName, WChar *propertyValue) |
Get a property from the given DOM with the given name. More... | |
int | mdlXMLDom_load (XmlDomRef domRef, int fileSpecType, WChar const *pFileSpec, WChar const *pStorageSpec, WChar const *pStreamSpec) |
Loads a XML Dom Class using the given file spec. More... | |
int | mdlXMLDom_save (XmlDomRef domRef, int fileSpecType, WChar const *pFileSpec, WChar const *pStorageSpec, WChar const *pStreamSpec, WChar const *pEncoding, bool bCompress, bool bOverwrite, bool bFormat) |
Saves the give DOM out to the given file spec. More... | |
int | mdlXMLDom_getParseError (long *pErrorCode, long *pFilepos, long *pLine, long *pLinepos, WCharP pReason, int maxReasonLength, WCharP pSrcText, int maxSrcTextLength, WCharP pUrl, int maxUrlLength, XmlDomRef domRef) |
Returns the last Parse Error if one of the dom creation function fails. More... | |
int | mdlXMLDom_getRootNode (XmlNodeRef *pNodeRef, XmlDomRef domRef) |
Returns the given root node for the given DOM. More... | |
int | mdlXMLDom_getRootElement (XmlNodeRef *pNodeRef, XmlDomRef domRef) |
Gets the root element (document element) from the given DOM. More... | |
int | mdlXMLDom_setRootElement (XmlDomRef domRef, XmlNodeRef nodeRef) |
Sets the current node as the root (document) element for the given DOM. More... | |
int | mdlXMLDom_createCDataSection (XmlNodeRef *pNodeRef, XmlDomRef domRef, WChar const *pCData) |
Creates a new XML CDATA node, but does not insert it. More... | |
int | mdlXMLDom_createComment (XmlNodeRef *pNodeRef, XmlDomRef domRef, WChar const *pComment) |
Creates a new XML Comment node, but does not insert it. More... | |
int | mdlXMLDom_createDocumentFragment (XmlNodeRef *pNodeRef, XmlDomRef domRef, WChar const *pDocumentFragment) |
Creates a new XML Document Fragment node, but does not insert it. More... | |
int | mdlXMLDom_createDocumentFragmentExt (XmlNodeRef *pNodeRef, XmlDomRef domRef, WChar const *pDocumentFragment, bool bFreeThreaded) |
Creates a new XML Document Fragment node, but does not insert it. More... | |
int | mdlXMLDom_createDocumentFragmentFromFile (XmlNodeRef *pNodeRef, XmlDomRef domRef, WChar const *pFilename, bool bIncludeRootNode) |
Creates a new XML Document Fragment node from a given file, but does not append it to a DOM. More... | |
int | mdlXMLDom_createElement (XmlNodeRef *pNodeRef, XmlDomRef domRef, WChar const *pTagName) |
Creates a new XML Element node, but does not append it to a DOM. More... | |
int | mdlXMLDom_createNode (XmlNodeRef *pNodeRef, XmlDomRef domRef, int nodeType, WChar const *pName, WChar const *pNamespaceURI) |
Creates a new XML node of type nodeType, but does not append it to a DOM. More... | |
int | mdlXMLDom_createProcessingInstruction (XmlNodeRef *pNodeRef, XmlDomRef domRef, WChar const *pTarget, WChar const *pData) |
Creates a new XML Processing Instruction node, but does not append it to a DOM. More... | |
int | mdlXMLDom_createTextNode (XmlNodeRef *pNodeRef, XmlDomRef domRef, WChar const *pTextData) |
Creates a new XML Processing Instruction node, but does not append it to a DOM. More... | |
int | mdlXMLDom_appendChild (XmlDomRef domRef, XmlNodeRef nodeRef) |
Appends an XML node as the last child to the XML Dom. More... | |
int | mdlXMLDom_removeChild (XmlDomRef domRef, XmlNodeRef nodeRef) |
Removes a node from an XML DOM. More... | |
int | mdlXMLDom_replaceChild (XmlDomRef domRef, XmlNodeRef nodeToReplaceRef, XmlNodeRef replacementNodeRef) |
Replaces a node in an XML DOM. More... | |
int | mdlXMLDom_insertElement (XmlNodeRef *pNodeRef, XmlDomRef domRef, XmlNodeRef beforeNodeRef, int tagValueType, WChar const *pTagName, const void *pTagValue) |
Adds a new XML element to an existing XML DOM. More... | |
int | mdlXMLDom_addElement (XmlNodeRef *pNodeRef, XmlDomRef domRef, XmlNodeRef parentNodeRef, int tagValueType, WChar const *pTagName, const void *pTagValue) |
Adds a new XML element to an existing XML DOM. More... | |
int | mdlXMLDom_addElementUsingNamespace (XmlNodeRef *pNodeRef, XmlDomRef domRef, XmlNodeRef parentNodeRef, int tagValueType, WChar const *pNamespaceURI, WChar const *pTagName, const void *pTagValue) |
Adds a new XML namespaced element to an existing XML DOM. More... | |
int | mdlXMLDom_replaceOrAppendNodesByXPath (XmlNodeRef *pNodeRef, XmlDomRef domRef, XmlNodeRef startNodeRef, WChar const *pXpath, int tagValueType, const void *pTagValue, int appendFlags) |
Adds a series of XML elements and/or an attribute to an existing XML DOM starting at startNode. More... | |
int | mdlXMLDom_selectSingleNode (XmlNodeRef *pNodeRef, XmlDomRef sourceDomRef, WChar const *pXpath) |
Selects the first Node that matches the XPath Criteria. More... | |
int | mdlXMLDom_select (XmlNodeListRef *pNodeListRef, XmlDomRef sourceDomRef, WChar const *pXpath) |
Returns a list of XML Nodes that match the given XPath Criteria. More... | |
int | mdlXMLDom_validate (XmlDomRef domRef) |
Validates the XML Dom against the previous set schema cache. More... | |
int | mdlXMLDom_getValidateError (long *pErrorCode, long *pFilepos, long *pLine, long *pLinepos, WCharP pReason, int maxReasonLength, WCharP pSrcText, int maxSrcTextLength, WCharP pUrl, int maxUrlLength, XmlDomRef domRef) |
Returns the last validate error if one of the dom creation function fails. More... | |
int | mdlXMLDom_validateAgainstSchemaCache (XmlDomRef domRef, XmlSchemaCacheRef schemaCacheRef) |
Validates the XML Dom against the given schema cache. More... | |
int | mdlXMLDom_validateAgainstSchema (XmlDomRef domRef, WChar const *pXMLNSTarget, WChar const *pSchemaFilename) |
Validates the XML DOM against the given schema file name. More... | |
int | mdlXMLDom_setSchemaCache (XmlDomRef domRef, XmlSchemaCacheRef schemaCacheRef) |
Associates the schema cache to the given XML DOM. More... | |
int | mdlXMLDomNode_insertBefore (XmlNodeRef nodeBeforeRef, XmlNodeRef nodeToInsertRef) |
Inserts XML node before another XML Node. More... | |
int | mdlXMLDomNode_cloneNode (XmlNodeRef *pClonedNodeRef, XmlNodeRef nodeRef, bool deepClone) |
Clones the given XML Node. More... | |
int | mdlXMLDomNode_selectSingleNode (XmlNodeRef *pNodeRef, XmlNodeRef sourceNodeRef, WChar const *pXpath) |
Returns first XML NOde that matches the given XPath Criteria. More... | |
int | mdlXMLDomNode_select (XmlNodeListRef *pNodeListRef, XmlNodeRef sourceNodeRef, WChar const *pXpath) |
Returns a list of XML Nodes that matches the given XPath Criteria. More... | |
int | mdlXMLDomElement_removeAttribute (XmlNodeRef nodeRef, WChar const *pAttributeName) |
Remove the specified XML attribute from the given XML Element Node. More... | |
int | mdlXMLDomElement_addAttribute (XmlNodeRef nodeRef, int attributeType, WChar const *pAttributeName, const void *pAttributeValue) |
Adds an XML attribute to the given XML Element Node. More... | |
int | mdlXMLDomElement_addAttributeUsingNamespace (XmlDomRef domRef, XmlNodeRef nodeRef, int attributeType, WChar const *pNamespaceURI, WChar const *pAttributeName, const void *pAttributeValue) |
Adds an XML attribute to the given XML Element Node using namespaces. More... | |
int | mdlXMLDomElement_appendAttributeNode (XmlNodeRef nodeRef, XmlNodeRef attributeNodeRef) |
Adds an XML attribute to the given XML Element Node. More... | |
int | mdlXMLDomElement_getAttributeExt (void *pValue, int *pMaxChars, XmlNodeRef nodeRef, WChar const *pAttributeName, int attributeType, bool bFailIfAttributeMissing) |
Returns the attribute value of the given name on the given XML element. More... | |
int | mdlXMLDomElement_getAttribute (void *pValue, int *pMaxChars, XmlNodeRef nodeRef, WChar const *pAttributeName, int attributeType) |
Returns the attribute value of the given name on the given XML element. More... | |
int | mdlXMLDomElement_getValue (void *pValue, int *pMaxChars, XmlNodeRef nodeRef, int attributeType) |
Returns the text value for the given XML Element. More... | |
int | mdlXMLDomElement_setValue (XmlNodeRef nodeRef, WChar const *pValueString) |
Set the given XML Element value to be pValue. More... | |
int | mdlXMLDomElement_appendChild (XmlNodeRef nodeToAppendAfterRef, XmlNodeRef nodeToAppendRef) |
Appends a XML Node as a Child to the give XML Element Node. More... | |
int | mdlXMLDomElement_getAllAttributes (XmlNamedNodeMapRef *pNodeMapRef, XmlNodeRef nodeRef) |
Returns an XML Named Nop Map with all attributes for the given XML Element. More... | |
int | mdlXMLDomNodeList_getNextChildElement (XmlNodeRef *childNodeP, WChar *childNodeNameP, XmlNodeListRef *childNodeListP, XmlNodeRef parentNode) |
Returns the next child element from the current XML Node List. More... | |
void | mdlXMLDomNodeList_initProcessChildren (XmlNodeRef *childNodeP, XmlNodeListRef *childNodeListP) |
Initializes a XML Node and XML Node List for use with mdlXMLDomNodeList_getNextChildElement. More... | |
int | mdlXMLDomNodeList_select (XmlNodeListRef *pNodeListRef, XmlDomRef domRef, WChar const *pXpath) |
Returns a list of XML Nodes that match the given XPath Criteria. More... | |
long | mdlXMLDomNodeList_getNumChildren (XmlNodeListRef nodeListRef) |
Returns the number in given XML Node List. More... | |
int | mdlXMLDomNodeList_getFirstChild (XmlNodeRef *pNodeRef, XmlNodeListRef nodeListRef) |
Returns the first XML Child Node in given XML Node List. More... | |
int | mdlXMLDomNodeList_getNextChild (XmlNodeRef *pNodeRef, XmlNodeListRef nodeListRef) |
Returns the next XML Child Node in given XML Node List. More... | |
int | mdlXMLDomNodeList_getChild (XmlNodeRef *pNodeRef, XmlNodeListRef nodeListRef, long index) |
Returns the XML Child Node at the given index in the XML Node List. More... | |
int | mdlXMLDomNodeList_traverse (XmlNodeListRef nodeListRef, int options, int(*userFuncNodeListTraverse)(XmlNodeRef node, void *userArgs), void *userArg) |
Transverses the given XML Dom Node List and calls the user function for each XML Node in the list. More... | |
int | mdlXMLDomNodeList_free (XmlNodeListRef nodeListRef) |
Frees the given XML Node List. More... | |
void | mdlXMLDomNode_verboseElement (XmlNodeRef nodeRef) |
Prints out the XML Element Node Name for debugging purposes only. More... | |
bool | mdlXMLDomNode_hasChildNodes (XmlNodeRef nodeRef) |
Returns true if the given XML Node has child nodes. More... | |
int | mdlXMLDomNode_getChildNodes (XmlNodeListRef *pNodeListRef, XmlNodeRef nodeRef) |
Returns a XML node list of child nodes of the given XML Node. More... | |
int | mdlXMLDomNode_getName (WChar *pNodeName, int *pMaxChars, XmlNodeRef nodeRef) |
Gets the node name of the current Xml Node. More... | |
int | mdlXMLDomNode_getNodeType (long *pNodeType, XmlNodeRef nodeRef) |
Returns the node type for the given XML Node. More... | |
int | mdlXMLDomNode_getXmlText (WChar *pValueString, int *pMaxChars, XmlNodeRef nodeRef) |
Returns the XML Text of the given XML Node. More... | |
int | mdlXMLDomNode_getValue (WChar *pValueString, int *pMaxChars, XmlNodeRef nodeRef) |
Returns the value of given XML Node. More... | |
int | mdlXMLDomNode_setValue (XmlNodeRef nodeRef, WChar const *pValueString) |
Sets the value for the given XML Node. More... | |
int | mdlXMLDomNode_replaceChild (XmlNodeRef parentNodeRef, XmlNodeRef nodeToReplaceRef, XmlNodeRef replacementNodeRef) |
Replaces a node in an XML DOM. More... | |
int | mdlXMLDomNode_getParentNode (XmlNodeRef *parentNodeRef, XmlNodeRef nodeToGetParentRef) |
Gets the parent node of the given element. More... | |
int | mdlXMLDomNode_free (XmlNodeRef nodeRef) |
Frees the XML Dom Node. More... | |
long | mdlXMLDomAttrList_getNumChildren (XmlNamedNodeMapRef nodeMapRef) |
Returns the number of attributes in the attribute list. More... | |
int | mdlXMLDomAttrList_getFirstChild (XmlNodeRef *pNodeRef, XmlNamedNodeMapRef nodeMapRef) |
Returns the first attribute in the attribute list. More... | |
int | mdlXMLDomAttrList_getNextChild (XmlNodeRef *pNodeRef, XmlNamedNodeMapRef nodeMapRef) |
Returns the next attribute in the attribute list. More... | |
int | mdlXMLDomAttrList_getChildByName (XmlNodeRef *pNodeRef, XmlNamedNodeMapRef nodeMapRef, WChar const *pAttrName) |
Returns an XML Attribute node by name. More... | |
int | mdlXMLDomAttrList_getChild (XmlNodeRef *pNodeRef, XmlNamedNodeMapRef nodeMapRef, int index) |
Returns an XML Attribute node by index. More... | |
int | mdlXMLDomAttrList_free (XmlNamedNodeMapRef nodeMapRef) |
Frees the attribute list. More... | |
int | mdlXMLDomAttr_getName (WChar *pAttrNodeName, int *pMaxChars, XmlNodeRef attrNodeRef) |
Returns the name of the given XML Attribute Node. More... | |
int | mdlXMLDomAttr_getValue (WChar *pAttrValueString, int *pMaxChars, XmlNodeRef attrNodeRef) |
Returns the value of the given XML Attribute Node. More... | |
int | mdlXMLDomAttr_setValue (XmlNodeRef attrNodeRef, WChar const *pAttrValueString) |
Sets the values of the XML Attribute Node. More... | |
int mdlXMLDom_addElement | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
XmlNodeRef | parentNodeRef, | ||
int | tagValueType, | ||
WChar const * | pTagName, | ||
const void * | pTagValue | ||
) |
Adds a new XML element to an existing XML DOM.
[out] | pNodeRef | Returned newly created XML Element Node, can be NULL |
[in] | domRef | Reference to DOM class |
[in] | parentNodeRef | Parent XML Node to be appended to |
[in] | tagValueType | XMLDATATYPE_EMPTY, _T32, _UT32, _STRG, _WIDESTRG, _BOOLEAN, _DATETIME |
[in] | pTagName | Tag name for element node |
[in] | pTagValue | Tag value for element node or NULL for an empty element |
int mdlXMLDom_addElementUsingNamespace | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
XmlNodeRef | parentNodeRef, | ||
int | tagValueType, | ||
WChar const * | pNamespaceURI, | ||
WChar const * | pTagName, | ||
const void * | pTagValue | ||
) |
Adds a new XML namespaced element to an existing XML DOM.
[out] | pNodeRef | Returned newly created XML Element Node, can be NULL |
[in] | domRef | Reference to DOM class |
[in] | parentNodeRef | Parent XML Node to be appended to |
[in] | tagValueType | XMLDATATYPE_EMPTY, _T32, _UT32, _STRG, _WIDESTRG, _BOOLEAN, _DATETIME |
[in] | pNamespaceURI | Namespace for element node |
[in] | pTagName | Tag name for element node |
[in] | pTagValue | Tag value for element node or NULL for an empty element |
int mdlXMLDom_appendChild | ( | XmlDomRef | domRef, |
XmlNodeRef | nodeRef | ||
) |
Appends an XML node as the last child to the XML Dom.
[in] | domRef | Reference to DOM class |
[in] | nodeRef | node to append |
int mdlXMLDom_create | ( | XmlDomRef * | pDomRef | ) |
Creates an instance of a DOM Class.
[out] | pDomRef | Newly created DOM |
int mdlXMLDom_createCDataSection | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
WChar const * | pCData | ||
) |
Creates a new XML CDATA node, but does not insert it.
[out] | pNodeRef | returned newly created CDATA Node |
[in] | domRef | Reference to DOM class |
[in] | pCData | string to create CDATA node from |
int mdlXMLDom_createComment | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
WChar const * | pComment | ||
) |
Creates a new XML Comment node, but does not insert it.
[out] | pNodeRef | returned newly created XML Comment Node |
[in] | domRef | Reference to DOM class |
[in] | pComment | string to create Comment node from |
int mdlXMLDom_createDocumentFragment | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
WChar const * | pDocumentFragment | ||
) |
Creates a new XML Document Fragment node, but does not insert it.
[out] | pNodeRef | returned newly created XML Document Fragment Node |
[in] | domRef | Reference to DOM class |
[in] | pDocumentFragment | string to create Document Fragment node from |
int mdlXMLDom_createDocumentFragmentExt | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
WChar const * | pDocumentFragment, | ||
bool | bFreeThreaded | ||
) |
Creates a new XML Document Fragment node, but does not insert it.
[out] | pNodeRef | returned newly created XML Document Fragment Node |
[in] | domRef | Reference to DOM class |
[in] | pDocumentFragment | string to create Document Fragment node from |
[in] | bFreeThreaded | is domRef freethreaded DOM? |
int mdlXMLDom_createDocumentFragmentFromFile | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
WChar const * | pFilename, | ||
bool | bIncludeRootNode | ||
) |
Creates a new XML Document Fragment node from a given file, but does not append it to a DOM.
[out] | pNodeRef | returned newly created XML Document Fragment Node |
[in] | domRef | Reference to DOM class |
[in] | pFilename | file to create a document fragment file |
[in] | bIncludeRootNode | Include root node when creating document fragment |
int mdlXMLDom_createElement | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
WChar const * | pTagName | ||
) |
Creates a new XML Element node, but does not append it to a DOM.
[out] | pNodeRef | Returned newly created XML Element Node |
[in] | domRef | Reference to DOM class |
[in] | pTagName | Tag name for element node |
int mdlXMLDom_createFreeThreaded | ( | XmlDomRef * | pDomRef | ) |
Creates a free threaded instance of a DOM Class.
[out] | pDomRef | Newly created DOM |
int mdlXMLDom_createFromFragment | ( | XmlDomRef * | pDomRef, |
bool | bFreeThreaded, | ||
XmlDomRef | sourceDomRef, | ||
WChar const * | pXpath, | ||
bool | deepClone | ||
) |
Creates an instance of a DOM Class from an existing DOM using XPath criteria.
[out] | pDomRef | Newly created DOM |
[in] | bFreeThreaded | Use Free Threaded model |
[in] | sourceDomRef | DOM to create new DOM from |
[in] | pXpath | Xpath criteria to generate DOM from |
[in] | deepClone | true for deep clone, false for shallow clone |
int mdlXMLDom_createFromNode | ( | XmlDomRef * | pDomRef, |
bool | bFreeThreaded, | ||
XmlNodeRef | sourceNodeRef, | ||
bool | deepClone | ||
) |
Creates an instance of a DOM Class from an existing DOM using XPath criteria.
[out] | pDomRef | Newly created DOM |
[in] | bFreeThreaded | Use Free Threaded model |
[in] | sourceNodeRef | Node to create new DOM from |
[in] | deepClone | true for deep clone, false for shallow clone |
int mdlXMLDom_createFromText | ( | XmlDomRef * | pDomRef, |
bool | bFreeThreaded, | ||
WChar const * | pXmlText | ||
) |
Creates an instance of a DOM Class from a well-formed XML text string.
[out] | pDomRef | Newly created DOM |
[in] | bFreeThreaded | Use Free Threaded model |
[in] | pXmlText | Text to generate DOM from |
int mdlXMLDom_createNode | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
int | nodeType, | ||
WChar const * | pName, | ||
WChar const * | pNamespaceURI | ||
) |
Creates a new XML node of type nodeType, but does not append it to a DOM.
[out] | pNodeRef | Returned newly created XML Node |
[in] | domRef | Reference to DOM class |
[in] | nodeType | Type of node to create (see mdlxmltools.h for values) |
[in] | pName | Name of node |
[in] | pNamespaceURI | Namespace URI |
int mdlXMLDom_createProcessingInstruction | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
WChar const * | pTarget, | ||
WChar const * | pData | ||
) |
Creates a new XML Processing Instruction node, but does not append it to a DOM.
[out] | pNodeRef | Returned newly created XML Processing Instruction (PI) Node |
[in] | domRef | Reference to DOM class |
[in] | pTarget | Target (node name) for PI node |
[in] | pData | Data (node value) for PI node |
int mdlXMLDom_createTextNode | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
WChar const * | pTextData | ||
) |
Creates a new XML Processing Instruction node, but does not append it to a DOM.
[out] | pNodeRef | Returned newly created XML Text Node |
[in] | domRef | Reference to DOM class |
[in] | pTextData | Text for Text Node |
int mdlXMLDom_createWithParameters | ( | XmlDomRef * | pDomRef, |
bool | bFreeThreaded, | ||
bool | bAsync, | ||
bool | bValidate, | ||
bool | bResolveExtern, | ||
bool | bPreserveWhiteSpace | ||
) |
Creates an instance of a DOM Class with given parameters.
This group of functions is a simplified API wrapper around Microsoft's XML Core Services API, also known as MSXML6. It is geared to the creation/manipulation of XML Data, and not optimized for XML Mixed Content. Access is process to MSXML6 Smart Pointers for more Advanced Use.
Include files
To use the API you include the following:
Linking
To use the API you link the following:
Function Sets
This group of functions is used to creation, and saving XML Documents by using the XML DOM. It can be used to navigate, or modifying nodes in an XML DOM. It can also be used to transform and validate an XML DOM.
This group of functions is used to read/writing XML Documents use the XML SAX2 (Simple API for XML (SAX2) methods.
This group of functions is usefult for navigating an W3C XML Schema definition language (XSD) document. These functions walk the XML Schema Document (.xsd), obtains properties and declartations, and the relationships between schema items.
It uses the MSXML4 Schema Object Model (SOM). See Microsoft's documentation for more information about the SOM.
This group of functions is useful for transform XML DOMs to other formats, such as HTML, XML, or other text file formats (such as another XML DOM, stream, string. It is based on the Extensible Stylesheet Language Transformations (XSLT).
This group of functions does not map directly to the Microsoft's XML Core Services API and are provided only as a convenience. Currently there is only one function in this group.
[out] | pDomRef | Newly created DOM |
[in] | bFreeThreaded | Use Free Threaded model |
[in] | bAsync | Set ASYNC? |
[in] | bValidate | Validate on parse? |
[in] | bResolveExtern | Resolve externs on parse? |
[in] | bPreserveWhiteSpace | Preserve whitespace on parse? |
int mdlXMLDom_free | ( | XmlDomRef | domRef | ) |
Frees an instance of a DOM Class.
[in] | domRef | DOM class to free |
int mdlXMLDom_getParameter | ( | XmlDomRef | domRef, |
int | parameterType, | ||
bool * | parameterValue | ||
) |
Sets Parameters on the given DOM.
[in] | domRef | Reference to DOM class |
[in] | parameterType | DOM_PARAMETER_* in mdlxmltools.h |
[out] | parameterValue | true or false, value of parameterType for this DOM |
int mdlXMLDom_getParseError | ( | long * | pErrorCode, |
long * | pFilepos, | ||
long * | pLine, | ||
long * | pLinepos, | ||
WCharP | pReason, | ||
int | maxReasonLength, | ||
WCharP | pSrcText, | ||
int | maxSrcTextLength, | ||
WCharP | pUrl, | ||
int | maxUrlLength, | ||
XmlDomRef | domRef | ||
) |
Returns the last Parse Error if one of the dom creation function fails.
[out] | pErrorCode | Contains the error code of the last parse error, or NULL if NOT wanted |
[out] | pFilepos | Contains the absolute file position where the error occurred, or NULL if NOT wanted |
[out] | pLine | Specifies the line number that contains the error, or NULL if NOT wanted |
[out] | pLinepos | Contains the character position within the line where the error occurred, or NULL if NOT wanted |
[out] | pReason | Describes the reason for the error, or NULL if NOT wanted |
[in] | maxReasonLength | Max length of pReason to return, if pReason is not NULL |
[out] | pSrcText | Returns the text of the line containing the error, or NULL if NOT wanted |
[in] | maxSrcTextLength | Max length of pSrcText to return, if pSrcText is not NULL |
[out] | pUrl | Returns the URL of the XML document containing the last error, or NULL if NOT wanted |
[in] | maxUrlLength | Max length of pUrl to return, if pUrl is not NULL |
[in] | domRef | Reference to DOM class |
int mdlXMLDom_getProperty | ( | XmlDomRef | domRef, |
WChar const * | propertyName, | ||
WChar * | propertyValue | ||
) |
Get a property from the given DOM with the given name.
[in] | domRef | Reference to DOM class |
[in] | propertyName | Name of property to get |
[out] | propertyValue | Returned value for the given property value |
int mdlXMLDom_getRootElement | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef | ||
) |
Gets the root element (document element) from the given DOM.
[out] | pNodeRef | returned XML Root Element Node |
[in] | domRef | Reference to DOM class |
int mdlXMLDom_getRootNode | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef | ||
) |
Returns the given root node for the given DOM.
[out] | pNodeRef | returned root XML Node |
[in] | domRef | Reference to DOM class |
int mdlXMLDom_getValidateError | ( | long * | pErrorCode, |
long * | pFilepos, | ||
long * | pLine, | ||
long * | pLinepos, | ||
WCharP | pReason, | ||
int | maxReasonLength, | ||
WCharP | pSrcText, | ||
int | maxSrcTextLength, | ||
WCharP | pUrl, | ||
int | maxUrlLength, | ||
XmlDomRef | domRef | ||
) |
Returns the last validate error if one of the dom creation function fails.
[out] | pErrorCode | Contains the error code of the last parse error, or NULL if NOT wanted |
[out] | pFilepos | Contains the absolute file position where the error occurred, or NULL if NOT wanted |
[out] | pLine | Specifies the line number that contains the error, or NULL if NOT wanted |
[out] | pLinepos | Contains the character position within the line where the error occurred, or NULL if NOT wanted |
[out] | pReason | Describes the reason for the error, or NULL if NOT wanted |
[in] | maxReasonLength | Max length of pReason to return, if pReason is not NULL |
[out] | pSrcText | Returns the text of the line containing the error, or NULL if NOT wanted |
[in] | maxSrcTextLength | Max length of pSrcText to return, if pSrcText is not NULL |
[out] | pUrl | Returns the URL of the XML document containing the last error, or NULL if NOT wanted |
[in] | maxUrlLength | Max length of pUrl to return, if pUrl is not NULL |
[in] | domRef | Reference to DOM class |
int mdlXMLDom_insertElement | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
XmlNodeRef | beforeNodeRef, | ||
int | tagValueType, | ||
WChar const * | pTagName, | ||
const void * | pTagValue | ||
) |
Adds a new XML element to an existing XML DOM.
[out] | pNodeRef | Returned newly created XML Element Node, can be NULL |
[in] | domRef | Reference to DOM class |
[in] | beforeNodeRef | Node to become the next child of the new element |
[in] | tagValueType | XMLDATATYPE_EMPTY, _T32, _UT32, _STRG, _WIDESTRG, _BOOLEAN, _DATETIME |
[in] | pTagName | Tag name for element node |
[in] | pTagValue | Tag value for element node or NULL for an empty element |
int mdlXMLDom_load | ( | XmlDomRef | domRef, |
int | fileSpecType, | ||
WChar const * | pFileSpec, | ||
WChar const * | pStorageSpec, | ||
WChar const * | pStreamSpec | ||
) |
Loads a XML Dom Class using the given file spec.
[in] | domRef | Loads a previously created DOM |
[in] | fileSpecType | FILESPEC_LOCAL, FILESPEC_URL, FILESPEC_LOCAL2 |
[in] | pFileSpec | Full file spec to generate |
[in] | pStorageSpec | Storage (like directory) |
[in] | pStreamSpec | Stream (like file) |
int mdlXMLDom_removeChild | ( | XmlDomRef | domRef, |
XmlNodeRef | nodeRef | ||
) |
Removes a node from an XML DOM.
[in] | nodeRef | Reference to XML Element Node class |
[in] | domRef | Reference to DOM class |
int mdlXMLDom_replaceChild | ( | XmlDomRef | domRef, |
XmlNodeRef | nodeToReplaceRef, | ||
XmlNodeRef | replacementNodeRef | ||
) |
Replaces a node in an XML DOM.
[in] | domRef | Reference to DOM class |
[in] | nodeToReplaceRef | XML Node to be replaced |
[in] | replacementNodeRef | Replacement XML Node |
int mdlXMLDom_replaceOrAppendNodesByXPath | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | domRef, | ||
XmlNodeRef | startNodeRef, | ||
WChar const * | pXpath, | ||
int | tagValueType, | ||
const void * | pTagValue, | ||
int | appendFlags | ||
) |
Adds a series of XML elements and/or an attribute to an existing XML DOM starting at startNode.
[out] | pNodeRef | Returned newly created XML Element Node, can be NULL |
[in] | domRef | Reference to DOM class |
[in] | startNodeRef | XML Node to be begin append nodes to |
[in] | tagValueType | XMLDATATYPE_EMPTY, _T32, _UT32, _STRG, _WIDESTRG, _BOOLEAN, _DATETIME |
[in] | pXpath | xpath criteria to generate nodes for |
[in] | pTagValue | Tag value for element node or NULL for an empty element |
[in] | appendFlags | Flags for node creation/appending |
int mdlXMLDom_save | ( | XmlDomRef | domRef, |
int | fileSpecType, | ||
WChar const * | pFileSpec, | ||
WChar const * | pStorageSpec, | ||
WChar const * | pStreamSpec, | ||
WChar const * | pEncoding, | ||
bool | bCompress, | ||
bool | bOverwrite, | ||
bool | bFormat | ||
) |
Saves the give DOM out to the given file spec.
[in] | domRef | Reference to DOM class |
[in] | fileSpecType | must be FILESPEC_LOCAL |
[in] | pFileSpec | Full file spec to generate |
[in] | pStorageSpec | Storage (like directory) |
[in] | pStreamSpec | Stream (like file) |
[in] | pEncoding | Encoding |
[in] | bCompress | Reserved for future use, zip after saving? |
[in] | bOverwrite | true to overwrite existing file, false to fail if file already exists |
[in] | bFormat | Pretty Print (add indentation newlines) as saving |
int mdlXMLDom_select | ( | XmlNodeListRef * | pNodeListRef, |
XmlDomRef | sourceDomRef, | ||
WChar const * | pXpath | ||
) |
Returns a list of XML Nodes that match the given XPath Criteria.
[out] | pNodeListRef | Returned XML nodelist |
[in] | sourceDomRef | Reference to DOM class |
[in] | pXpath | XPath criteria |
int mdlXMLDom_selectSingleNode | ( | XmlNodeRef * | pNodeRef, |
XmlDomRef | sourceDomRef, | ||
WChar const * | pXpath | ||
) |
Selects the first Node that matches the XPath Criteria.
[out] | pNodeRef | Returned first XML node that matches XPath criteria |
[in] | sourceDomRef | Reference to DOM class |
[in] | pXpath | XPath criteria |
int mdlXMLDom_setParameter | ( | XmlDomRef | domRef, |
int | parameterType, | ||
bool | parameterValue | ||
) |
Sets parameters from the given DOM.
[in] | domRef | Reference to DOM class |
[in] | parameterType | DOM_PARAMETER_* in mdlxmltools.h |
[in] | parameterValue | Sets parameterType for this DOM true/false |
int mdlXMLDom_setProperty | ( | XmlDomRef | domRef, |
WChar const * | propertyName, | ||
WChar const * | propertyValue | ||
) |
Sets a property from the given DOM to the given value.
[in] | domRef | Reference to DOM class |
[in] | propertyName | Name of property to set |
[in] | propertyValue | Property value, as a string, for to set for propertyName |
int mdlXMLDom_setRootElement | ( | XmlDomRef | domRef, |
XmlNodeRef | nodeRef | ||
) |
Sets the current node as the root (document) element for the given DOM.
[in] | domRef | Reference to DOM class |
[in] | nodeRef | node to set as root (document) element |
int mdlXMLDom_setSchemaCache | ( | XmlDomRef | domRef, |
XmlSchemaCacheRef | schemaCacheRef | ||
) |
Associates the schema cache to the given XML DOM.
[in] | domRef | XML Dom to set schema cache for |
[in] | schemaCacheRef | Schema cache to associate with XML Dom |
int mdlXMLDom_validate | ( | XmlDomRef | domRef | ) |
Validates the XML Dom against the previous set schema cache.
[in] | domRef | XML Dom to validate |
int mdlXMLDom_validateAgainstSchema | ( | XmlDomRef | domRef, |
WChar const * | pXMLNSTarget, | ||
WChar const * | pSchemaFilename | ||
) |
Validates the XML DOM against the given schema file name.
[in] | domRef | XML Dom to validate |
[in] | pXMLNSTarget | Namespace of associated schema to add |
[in] | pSchemaFilename | Schema filename to to use to validate XML Dom against |
int mdlXMLDom_validateAgainstSchemaCache | ( | XmlDomRef | domRef, |
XmlSchemaCacheRef | schemaCacheRef | ||
) |
Validates the XML Dom against the given schema cache.
[in] | domRef | XML Dom to validate |
[in] | schemaCacheRef | Schema cache to use to validate XML Dom against |
int mdlXMLDomAttr_getName | ( | WChar * | pAttrNodeName, |
int * | pMaxChars, | ||
XmlNodeRef | attrNodeRef | ||
) |
Returns the name of the given XML Attribute Node.
[in,out] | pAttrNodeName | Returned name of the given XML Attribute |
[in,out] | pMaxChars | Max. number of chars of pAttrNodeName to return, actual number of chars in pAttrValueString returned |
[in] | attrNodeRef | Reference to Xml Attribute Node |
int mdlXMLDomAttr_getValue | ( | WChar * | pAttrValueString, |
int * | pMaxChars, | ||
XmlNodeRef | attrNodeRef | ||
) |
Returns the value of the given XML Attribute Node.
[in,out] | pAttrValueString | Returned value as a string of the given XML Attribute |
[in,out] | pMaxChars | Max. number of chars of pAttrValueString to return, actual number of chars in pAttrValueString returned |
[in] | attrNodeRef | Reference to Xml Attribute Node |
int mdlXMLDomAttr_setValue | ( | XmlNodeRef | attrNodeRef, |
WChar const * | pAttrValueString | ||
) |
Sets the values of the XML Attribute Node.
[in] | attrNodeRef | Reference to Xml Attribute Node |
[in] | pAttrValueString | Value of attribute to set |
int mdlXMLDomAttrList_free | ( | XmlNamedNodeMapRef | nodeMapRef | ) |
Frees the attribute list.
[in] | nodeMapRef | Reference to Attribute list Node Map class |
int mdlXMLDomAttrList_getChild | ( | XmlNodeRef * | pNodeRef, |
XmlNamedNodeMapRef | nodeMapRef, | ||
int | index | ||
) |
Returns an XML Attribute node by index.
[out] | pNodeRef | returned XML Node |
[in] | nodeMapRef | Reference to Attribute list Node Map class |
[in] | index | the index of the attribute to be retrieved |
int mdlXMLDomAttrList_getChildByName | ( | XmlNodeRef * | pNodeRef, |
XmlNamedNodeMapRef | nodeMapRef, | ||
WChar const * | pAttrName | ||
) |
Returns an XML Attribute node by name.
[out] | pNodeRef | returned the XML Attribute node that matches name |
[in] | nodeMapRef | Reference to Attribute list Node Map class |
[in] | pAttrName | Name of attribute to get |
int mdlXMLDomAttrList_getFirstChild | ( | XmlNodeRef * | pNodeRef, |
XmlNamedNodeMapRef | nodeMapRef | ||
) |
Returns the first attribute in the attribute list.
[out] | pNodeRef | Returned first XML Atrribute node |
[in] | nodeMapRef | Reference to Attribute list Node Map class |
int mdlXMLDomAttrList_getNextChild | ( | XmlNodeRef * | pNodeRef, |
XmlNamedNodeMapRef | nodeMapRef | ||
) |
Returns the next attribute in the attribute list.
[out] | pNodeRef | returned next XML Atrribute node |
[in] | nodeMapRef | Reference to Attribute list Node Map class |
long mdlXMLDomAttrList_getNumChildren | ( | XmlNamedNodeMapRef | nodeMapRef | ) |
Returns the number of attributes in the attribute list.
[in] | nodeMapRef | Reference to Attribute list Node Map class |
int mdlXMLDomElement_addAttribute | ( | XmlNodeRef | nodeRef, |
int | attributeType, | ||
WChar const * | pAttributeName, | ||
const void * | pAttributeValue | ||
) |
Adds an XML attribute to the given XML Element Node.
[in] | nodeRef | Reference to Xml Element Node class |
[in] | attributeType | Attribute DataType of pAttributeValue to add, XMLDATATYPE_EMPTY, _T32, _UT32, _STRG, _WIDESTRG, _BOOLEAN, _DATETIME |
[in] | pAttributeName | Attribute name to add |
[in] | pAttributeValue | Attribute value to add |
int mdlXMLDomElement_addAttributeUsingNamespace | ( | XmlDomRef | domRef, |
XmlNodeRef | nodeRef, | ||
int | attributeType, | ||
WChar const * | pNamespaceURI, | ||
WChar const * | pAttributeName, | ||
const void * | pAttributeValue | ||
) |
Adds an XML attribute to the given XML Element Node using namespaces.
[in] | domRef | Reference to XML DOM class |
[in] | nodeRef | Reference to Xml Element Node class |
[in] | attributeType | Attribute DataType of pAttributeValue to add, XMLDATATYPE_EMPTY, _T32, _UT32, _STRG, _WIDESTRG, _BOOLEAN, _DATETIME |
[in] | pNamespaceURI | Attribute Namespace |
[in] | pAttributeName | Attribute name to add |
[in] | pAttributeValue | Attribute value to add |
int mdlXMLDomElement_appendAttributeNode | ( | XmlNodeRef | nodeRef, |
XmlNodeRef | attributeNodeRef | ||
) |
Adds an XML attribute to the given XML Element Node.
[in] | nodeRef | Reference to Xml Element Node class |
[in] | attributeNodeRef | Reference to Xml Attribute Node class |
int mdlXMLDomElement_appendChild | ( | XmlNodeRef | nodeToAppendAfterRef, |
XmlNodeRef | nodeToAppendRef | ||
) |
Appends a XML Node as a Child to the give XML Element Node.
[in] | nodeToAppendAfterRef | XML Node to append to |
[in] | nodeToAppendRef | XML Node to append |
int mdlXMLDomElement_getAllAttributes | ( | XmlNamedNodeMapRef * | pNodeMapRef, |
XmlNodeRef | nodeRef | ||
) |
Returns an XML Named Nop Map with all attributes for the given XML Element.
[in] | pNodeMapRef | Returned XML Node Map with all attributes |
[in] | nodeRef | Reference to XML Element Node class |
int mdlXMLDomElement_getAttribute | ( | void * | pValue, |
int * | pMaxChars, | ||
XmlNodeRef | nodeRef, | ||
WChar const * | pAttributeName, | ||
int | attributeType | ||
) |
Returns the attribute value of the given name on the given XML element.
[in,out] | pValue | Returned value of named attribute returned as the attribute type |
[in,out] | pMaxChars | Max. number of chars of pValue to return, actual number of chars in pValue returned |
[in] | nodeRef | Reference to Xml Element Node class |
[in] | pAttributeName | Attribute name to get value for |
[in] | attributeType | XMLDATATYPE_T32, _UT32, _STRG, _WIDESTRG, _BOOLEAN, _DATETIME |
int mdlXMLDomElement_getAttributeExt | ( | void * | pValue, |
int * | pMaxChars, | ||
XmlNodeRef | nodeRef, | ||
WChar const * | pAttributeName, | ||
int | attributeType, | ||
bool | bFailIfAttributeMissing | ||
) |
Returns the attribute value of the given name on the given XML element.
[in,out] | pValue | Returned value of named attribute returned as the attribute type |
[in,out] | pMaxChars | Max. number of chars of pValue to return, actual number of chars in pValue returned |
[in] | nodeRef | Reference to Xml Element Node class |
[in] | pAttributeName | Attribute name to get value for |
[in] | attributeType | XMLDATATYPE_T32, _UT32, _STRG, _WIDESTRG, _BOOLEAN, _DATETIME |
[in] | bFailIfAttributeMissing | If true, returns ERROR, if the specified attribute does not exist |
int mdlXMLDomElement_getValue | ( | void * | pValue, |
int * | pMaxChars, | ||
XmlNodeRef | nodeRef, | ||
int | attributeType | ||
) |
Returns the text value for the given XML Element.
[in,out] | pValue | Returned value of named attribute returned as the attribute type |
[in,out] | pMaxChars | Max. number of chars of pValue to return, actual number of chars in pValue returned |
[in] | nodeRef | Reference to Xml Element Node class |
[in] | attributeType | XMLDATATYPE_T32, _UT32, _STRG, _WIDESTRG, _BOOLEAN, _DATETIME |
int mdlXMLDomElement_removeAttribute | ( | XmlNodeRef | nodeRef, |
WChar const * | pAttributeName | ||
) |
Remove the specified XML attribute from the given XML Element Node.
[in] | nodeRef | Reference to Xml Element Node class |
[in] | pAttributeName | Attribute name to add |
int mdlXMLDomElement_setValue | ( | XmlNodeRef | nodeRef, |
WChar const * | pValueString | ||
) |
Set the given XML Element value to be pValue.
[in] | pValueString | Value to set |
[in] | nodeRef | Reference to Xml Element Node class |
int mdlXMLDomNode_cloneNode | ( | XmlNodeRef * | pClonedNodeRef, |
XmlNodeRef | nodeRef, | ||
bool | deepClone | ||
) |
Clones the given XML Node.
[out] | pClonedNodeRef | returned cloned XML node |
[in] | nodeRef | Reference to Xml Node class |
[in] | deepClone | true for deep clone, false for shallow clone |
int mdlXMLDomNode_free | ( | XmlNodeRef | nodeRef | ) |
Frees the XML Dom Node.
[in] | nodeRef | Reference to Xml Node class |
int mdlXMLDomNode_getChildNodes | ( | XmlNodeListRef * | pNodeListRef, |
XmlNodeRef | nodeRef | ||
) |
Returns a XML node list of child nodes of the given XML Node.
[out] | pNodeListRef | returned the next XML node at index |
[in] | nodeRef | Reference to Xml Node class |
int mdlXMLDomNode_getName | ( | WChar * | pNodeName, |
int * | pMaxChars, | ||
XmlNodeRef | nodeRef | ||
) |
Gets the node name of the current Xml Node.
[in,out] | pNodeName | Returned node name |
[in,out] | pMaxChars | Max. number of chars pNodeName to return, actual number of chars in pNodeName returned |
[in] | nodeRef | Reference to Xml Node class |
int mdlXMLDomNode_getNodeType | ( | long * | pNodeType, |
XmlNodeRef | nodeRef | ||
) |
Returns the node type for the given XML Node.
[in] | pNodeType | Returned Node Type |
[in] | nodeRef | Reference to XML Node class |
int mdlXMLDomNode_getParentNode | ( | XmlNodeRef * | parentNodeRef, |
XmlNodeRef | nodeToGetParentRef | ||
) |
Gets the parent node of the given element.
[in] | parentNodeRef | Returned Parent Node |
[in] | nodeToGetParentRef | XML Node to be replaced |
int mdlXMLDomNode_getValue | ( | WChar * | pValueString, |
int * | pMaxChars, | ||
XmlNodeRef | nodeRef | ||
) |
Returns the value of given XML Node.
[in,out] | pValueString | Returned value of named attribute returned as the attribute type |
[in,out] | pMaxChars | Max. number of chars of pValueString to return, actual number of chars in pValueString returned |
[in] | nodeRef | Reference to XML Node class |
int mdlXMLDomNode_getXmlText | ( | WChar * | pValueString, |
int * | pMaxChars, | ||
XmlNodeRef | nodeRef | ||
) |
Returns the XML Text of the given XML Node.
[in,out] | pValueString | Returned XML Text |
[in,out] | pMaxChars | Max. number of chars in pValueString to return, actual number of chars (not including NULL) in pValueString returned. |
[in] | nodeRef | Reference to Xml Node class |
bool mdlXMLDomNode_hasChildNodes | ( | XmlNodeRef | nodeRef | ) |
Returns true if the given XML Node has child nodes.
[in] | nodeRef | Reference to Xml Node class |
int mdlXMLDomNode_insertBefore | ( | XmlNodeRef | nodeBeforeRef, |
XmlNodeRef | nodeToInsertRef | ||
) |
Inserts XML node before another XML Node.
[in] | nodeBeforeRef | node before which we insert |
[in] | nodeToInsertRef | node to insert |
int mdlXMLDomNode_replaceChild | ( | XmlNodeRef | parentNodeRef, |
XmlNodeRef | nodeToReplaceRef, | ||
XmlNodeRef | replacementNodeRef | ||
) |
Replaces a node in an XML DOM.
[in] | parentNodeRef | Reference to Parent Node of child to be replaced |
[in] | nodeToReplaceRef | XML Node to be replaced |
[in] | replacementNodeRef | Replacement XML Node |
int mdlXMLDomNode_select | ( | XmlNodeListRef * | pNodeListRef, |
XmlNodeRef | sourceNodeRef, | ||
WChar const * | pXpath | ||
) |
Returns a list of XML Nodes that matches the given XPath Criteria.
[out] | pNodeListRef | Returned XML Node List |
[in] | sourceNodeRef | Reference to XML node |
[in] | pXpath | XPath criteria |
int mdlXMLDomNode_selectSingleNode | ( | XmlNodeRef * | pNodeRef, |
XmlNodeRef | sourceNodeRef, | ||
WChar const * | pXpath | ||
) |
Returns first XML NOde that matches the given XPath Criteria.
[out] | pNodeRef | returned first XML node that matches XPath criteria |
[in] | sourceNodeRef | Reference to XML node |
[in] | pXpath | XPath criteria |
int mdlXMLDomNode_setValue | ( | XmlNodeRef | nodeRef, |
WChar const * | pValueString | ||
) |
Sets the value for the given XML Node.
[in] | nodeRef | Reference to XML Node class |
[in] | pValueString | Value to set the current node to |
void mdlXMLDomNode_verboseElement | ( | XmlNodeRef | nodeRef | ) |
Prints out the XML Element Node Name for debugging purposes only.
[in] | nodeRef | Reference to Xml Node class |
int mdlXMLDomNodeList_free | ( | XmlNodeListRef | nodeListRef | ) |
Frees the given XML Node List.
[in] | nodeListRef | Reference to Node List class |
int mdlXMLDomNodeList_getChild | ( | XmlNodeRef * | pNodeRef, |
XmlNodeListRef | nodeListRef, | ||
long | index | ||
) |
Returns the XML Child Node at the given index in the XML Node List.
[out] | pNodeRef | returned the next XML node at index |
[in] | nodeListRef | Reference to Node List class |
[in] | index | the index of the node list to be retrieved |
int mdlXMLDomNodeList_getFirstChild | ( | XmlNodeRef * | pNodeRef, |
XmlNodeListRef | nodeListRef | ||
) |
Returns the first XML Child Node in given XML Node List.
[out] | pNodeRef | returned first XML node in list |
[in] | nodeListRef | Reference to Node List class |
int mdlXMLDomNodeList_getNextChild | ( | XmlNodeRef * | pNodeRef, |
XmlNodeListRef | nodeListRef | ||
) |
Returns the next XML Child Node in given XML Node List.
[out] | pNodeRef | returned the next XML node in list |
[in] | nodeListRef | Reference to Node List class |
int mdlXMLDomNodeList_getNextChildElement | ( | XmlNodeRef * | childNodeP, |
WChar * | childNodeNameP, | ||
XmlNodeListRef * | childNodeListP, | ||
XmlNodeRef | parentNode | ||
) |
Returns the next child element from the current XML Node List.
[in,out] | childNodeP | XML Node to initialize |
[in,out] | childNodeNameP | Returned Element Tag Name of childNodeP, or NULL |
[in,out] | childNodeListP | XML Node List to initialize |
[in,out] | parentNode | Parent XML Node to iterate Child Nodes |
long mdlXMLDomNodeList_getNumChildren | ( | XmlNodeListRef | nodeListRef | ) |
Returns the number in given XML Node List.
[in] | nodeListRef | Reference to Node List class |
void mdlXMLDomNodeList_initProcessChildren | ( | XmlNodeRef * | childNodeP, |
XmlNodeListRef * | childNodeListP | ||
) |
Initializes a XML Node and XML Node List for use with mdlXMLDomNodeList_getNextChildElement.
[in,out] | childNodeP | XML Node to initialize |
[in,out] | childNodeListP | XML Node List to initialize |
int mdlXMLDomNodeList_select | ( | XmlNodeListRef * | pNodeListRef, |
XmlDomRef | domRef, | ||
WChar const * | pXpath | ||
) |
Returns a list of XML Nodes that match the given XPath Criteria.
[out] | pNodeListRef | Returned XML Node List |
[in] | domRef | Reference to XML DOM class |
[in] | pXpath | XPath criteria |
int mdlXMLDomNodeList_traverse | ( | XmlNodeListRef | nodeListRef, |
int | options, | ||
int(*)(XmlNodeRef node, void *userArgs) | userFuncNodeListTraverse, | ||
void * | userArg | ||
) |
Transverses the given XML Dom Node List and calls the user function for each XML Node in the list.
[in] | nodeListRef | Reference to Node List class |
[in] | options | Transverse Options, reserved for future use |
[in] | userFuncNodeListTraverse | Used call-back function to be called for each XML Node in XML Node List |
[in] | userArg | User definable argument to pass onto UserFuncNodeListTraverse function |