domcif.h

upnpsdk-1.0.4.tar.gz Intel UPnP SDK Source

/** Inherited from Interface Node.  Refer to the {\tt parentNode} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_Node UpnpDocument_getParentNode(
	Upnp_Document OperationDocument
	);

/** Inherited from Interface Node.  Refer to the {\tt childNodes} attribute in 
 * the DOM Level 1 specification page 29. 
 */
Upnp_NodeList UpnpDocument_getChildNodes(
	Upnp_Document OperationDocument
	);

/** Inherited from Interface Node.  Refer to the {\tt firstChild} attribute in 
 * the DOM Level 1 specification page 29. 
 */
Upnp_Node UpnpDocument_getFirstChild(
	Upnp_Document OperationDocument
	);

/** Inherited from Interface Node.  Refer to the {\tt lastChild} attribute in 
 * the DOM Level 1 specification page 29. 
 */
Upnp_Node UpnpDocument_getLastChild(
	Upnp_Document OperationDocument
	);

/** Inherited from Interface Node.  Refer to the {\tt previousSibling} 
 * attribute in the DOM Level 1 specification page 29. 
 */
Upnp_Node UpnpDocument_getPreviousSibling(
	Upnp_Document OperationDocument
	);

/** Inherited from Interface Node.  Refer to the {\tt nextSibling} attribute 
 * in the DOM Level 1 specification page 29. 
 */
Upnp_Node UpnpDocument_getNextSibling(
	Upnp_Document OperationDocument
	);

/** Inherited from Interface Node.  Refer to the {\tt attributes} attribute in 
 * the DOM Level 1 specification page 29. 
 */
Upnp_NamedNodeMap UpnpDocument_getAttributes(
	Upnp_Document OperationDocument
	);

/** Inherited from Interface Node.  Refer to the {\tt ownerDocument} 
 * attribute in the DOM Level 1 specification page 29. 
 */
Upnp_Document UpnpDocument_getOwnerDocument(
	Upnp_Document OperationDocument
	);

/** Frees a document object.
 *
 * @return This method does not return a value.
 */

Upnp_Void UpnpDocument_free(
	Upnp_Document OperationDocument
	);

Upnp_Void UpnpDocumentTree_free(
	Upnp_Document OperationDocument
	);

//@} // Interface Document

/***************************************************************************/
//Interface Element Implementation
/***************************************************************************/

/** @name Interface Element
 *  Refer tot he DOM Level 1 specification page 38.
 */

//@{

/** Refer to the DOM Level 1 specification page 40. */
Upnp_Void UpnpElement_setAttribute(
	Upnp_Element OperationElement, 
	Upnp_DOMString name, 
	Upnp_DOMString value, 
	Upnp_DOMException *err
	);

/** Refer to the DOM Level 1 specification page 41. */
Upnp_Attr UpnpElement_setAttributeNode(
	Upnp_Element OperationElement, 
	Upnp_Attr newAttr, 
	Upnp_DOMException *err
	);

/** Refer to the DOM Level 1 specification page 41. */
Upnp_NodeList UpnpElement_getElementsByTagName(
	Upnp_Element OperationElement, 
	Upnp_DOMString name
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 29. 
 */
Upnp_Node UpnpElement_insertBefore(
	Upnp_Element OperationElement, 
	Upnp_Node newChild, 
	Upnp_Node refChild, 
	Upnp_DOMException *err
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 30. 
 */
Upnp_Node UpnpElement_replaceChild(
	Upnp_Element OperationElement, 
	Upnp_Node newChild, 
	Upnp_Node oldChild, 
	Upnp_DOMException *err
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 30. 
 */
Upnp_Node UpnpElement_removeChild(
	Upnp_Element OperationElement, 
	Upnp_Node oldChild, 
	Upnp_DOMException *err
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 30. 
 */
Upnp_Node UpnpElement_appendChild(
	Upnp_Element OperationElement, 
	Upnp_Node newChild, 
	Upnp_DOMException *err
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 31. 
 */
Upnp_Bool UpnpElement_hasChildNodes(
	Upnp_Element OperationElement
	);

/** Inheritied from Interface Node.  Refer to the DOM Level 1 specification 
 *  page 31. 
 */
Upnp_Node UpnpElement_cloneNode(
	Upnp_Element OperationElement, 
	Upnp_Bool deep);

/** Inherited from Interface Node.  Refer to the {\tt nodeName} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_DOMString UpnpElement_getNodeName(
	Upnp_Element OperationElement
	);

/** Inherited from Interface Node.  Refer to the {\tt nodeName} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_DOMString UpnpElement_getNodeValue(
	Upnp_Element OperationElement, 
	Upnp_DOMException *err
	);

/** Inherited from Interface Node.  Refer to the {\tt nodeName} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_Void UpnpElement_setNodeValue(
	Upnp_Element OperationElement, 
	Upnp_DOMString nodeValue, 
	Upnp_DOMException *err
	);

/** Inherited from Interface Node.  Refer to the {\tt nodeType} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_UShort UpnpElement_getNodeType(
	Upnp_Element OperationElement
	);

/** Inherited from Interface Node.  Refer to the {\tt parentNode} attribute in 
 * the DOM Level 1 specification page 28. 
 */
Upnp_Node UpnpElement_getParentNode(
	Upnp_Element OperationElement
	);

/** Inherited from Interface Node.  Refer to the {\tt childNodes} attribute in 
 * the DOM Level 1 specification page 29. 
 */
Upnp_NodeList UpnpElement_getChildNodes(
	Upnp_Element OperationElement
	);

/** Inherited from Interface Node.  Refer to the {\tt firstChild} attribute in 
 * the DOM Level 1 specification page 29. 
 */
Upnp_Node UpnpElement_getFirstChild(
	Upnp_Element OperationElement
	);

/** Inherited from Interface Node.  Refer to the {\tt lastChild} attribute in 
 * the DOM Level 1 specification page 29. 
 */
Upnp_Node UpnpElement_getLastChild(
	Upnp_Element OperationElement
	);

/** Inherited from Interface Node.  Refer to the {\tt previousSibling} 
 * attribute in the DOM Level 1 specification page 29. 
 */
Upnp_Node UpnpElement_getPreviousSibling(
	Upnp_Element OperationElement
	);

/** Inherited from Interface Node.  Refer to the {\tt nextSibling} attribute 
 * in the DOM Level 1 specification page 29. 
 */
Upnp_Node UpnpElement_getNextSibling(
	Upnp_Element OperationElement
	);

/** Inherited from Interface Node.  Refer to the {\tt attributes} attribute in 
 * the DOM Level 1 specification page 29. 
 */
Upnp_NamedNodeMap UpnpElement_getAttributes(
	Upnp_Element OperationElement
	);

/** Inherited from Interface Node.  Refer to the {\tt ownerDocument} 
 * attribute in the DOM Level 1 specification page 29. 
 */
Upnp_Document UpnpElement_getOwnerDocument(
	Upnp_Element OperationElement
	);

/** Frees an element object.
 *
 * @return This method does not return a value.
 */
Upnp_Void	UpnpElement_free(Upnp_Element OperationElement);

//@} // Interface Element

/****************************************************************************/
//Interface NodeList Implementation
/****************************************************************************/

/** @name Interface NodeList
 * Refer to the DOM Level 1 specification page 32.
 */

//@{

/** Refer to the DOM Level 1 specification page 32. */
Upnp_Node UpnpNodeList_item(
	Upnp_NodeList OperationNodeList, 
	unsigned long index
	);

/** Refer to the {\tt length} attribute in the DOM Level 1 specification 
 * page 32. 
 */
int UpnpNodeList_getLength(
	Upnp_NodeList OperationNodeList
	);

/** Frees a NodeList object.
 *
 * @return This method does not return a value.
 */
Upnp_Void UpnpNodeList_free(
	Upnp_NodeList OperationNodeList
	);

//@} // Interface NodeList

/****************************************************************************/
//Interface NamedNodeMap Implementation
/****************************************************************************/

/** @name Interface NamedNodeMap
 * Refer to the DOM Level 1 specification page 32.
 */

//@{

/** Refer to the DOM Level 1 specification page 33. */
Upnp_Node UpnpNamedNodeMap_getNamedItem(
	Upnp_NamedNodeMap OperationNamedNodeMap, 
	Upnp_DOMString name
	);

/** Refer to the DOM Level 1 specification page 34. */
Upnp_Node UpnpNamedNodeMap_item(
	Upnp_NamedNodeMap OperationNamedNodeMap, 
	unsigned long index
	);

/** Refer to the {\tt length} attribute in the DOM Level 1 specification 
 * page 39. 
 */
Upnp_ULong UpnpNamedNodeMap_getLength(
	Upnp_NamedNodeMap OperationNamedNodeMap
	);

/** Frees a NamedNodeMap object.
 *
 * @return This method does not return a value.
 */
Upnp_Void UpnpNamedNodeMap_free(
	Upnp_NamedNodeMap OperationNamedNodeMap
	);

//@} // Interface NamedNodeMap

/****************************************************************************/
//Utils
/****************************************************************************/

/** @name Utility functions
 *  The functions in this section are not defined by the DOM Level 1
 *  specification but are useful in dealing with DOM documents.
 */

//@{

/**{\bf UpnpNewPrintDocument} "prints" or renders a DOM object back into an
 * XML text buffer.  The caller is responsible for freeing the returned
 * DOMString using {\bf UpnpDOMString_free} when finished.
 *
 * @return A string buffer containing the rendered XML document.
 */
Upnp_DOMString UpnpNewPrintDocument(
	Upnp_Node OperationNode /** The DOM object to render to XML. */
	);
	
/**{\bf UpnpPrintDocumentDeEscaped} "prints" or renders a DOM object back into an
 * XML text buffer.  The printed file will not have escape the characters.
 * The caller is responsible for freeing the returned
 * DOMString using {\bf UpnpDOMString_free} when finished.
 *
 * @return A string buffer containing the rendered XML document.
 */
Upnp_DOMString UpnpPrintDocumentDeEscaped(
	Upnp_Node OperationNode /** The DOM object to render to XML. */
	);

/** {\bf UpnpPrintDocument} is obsolete and may be removed in future versions.
 * Use {\bf UpnpNewPrintDocument} instead.
 */	
Upnp_Void UpnpPrintDocument(
	Upnp_Node OperationNode, /** The DOM object to render to XML. */
	char * Upnp_Buff         /** Pointer to a buffer to store the XML. */
	);

/** {\bf UpnpParse_buffer} parses an XML buffer, returning a DOM Document.
 *
 * @return A DOM document representation of the XML buffer.
 */		
Upnp_Document UpnpParse_Buffer(
	char *Buff  	/** The buffer containing the XML to parse. */
	);

/** {\bf UpnpDOMString_free} frees Upnp_DOMString buffers. Should only
 *  be used to deallocate UpnpDOMStrings passed out of the library, or
 *  created through {\bf UpnpCloneDOMString}.
 *
 * @return This function does not return a value.
 */

Upnp_Void UpnpDOMString_free(
				    Upnp_DOMString in
				    );

/** {\bf Upnpfree} frees Upnp_DOMString buffers.  It should not be used to
 *  free any other type of memory. Deprecated use UpnpDOMString_free.
 *
 * @return This function does not return a value.
 */

Upnp_Void Upnpfree(
	void * in
	);

/** {\bf UpnpParseFileAndGetDocument} parses an XML file, returning a DOM Document.
 *
 * @return A DOM document representation of the XML file.
 */		
Upnp_Document  UpnpParseFileAndGetDocument(
	char* xmlFile	/** The name of the XML file to parse. */
	);

/** {\bf UpnpCloneDOMString} clones a DOM String.
 *
 * @return the cloned DOM string.
 */		
char *UpnpCloneDOMString(const char *src);

//@} Utility functions

//@} DOM APIs

#ifdef OBSOLETE
//typedef enum { ELEMENT_NODE=1, ATTRIBUTE_NODE=2, TEXT_NODE=3, CDATA_SECTION_NODE=4, ENTITY_REFERENCE_NODE=5, ENTITY_NODE=6, PROCESSING_INSTRUCTION_NODE=7, COMMENT_NODE=8, DOCUMENT_NODE=9, DOCUMENT_TYPE_NODE=10, DOCUMENT_FRAGMENT_NODE=11, NOTATION_NODE=12 } Upnp_NodeType;

/*******************************************************************************************************************************/
//Interface DOM Implementation
/*******************************************************************************************************************************/
//Upnp_Bool Upnp_DOMImplementation_hasFeature( const Upnp_DOMString & feature,const Upnp_DOMString & version);

//#define Upnp_DOMException1 Upnp_DOMException

#endif

#ifdef __cplusplus
}
#endif
#endif