libupnp-1.8.0~svn20100507/ 0000777 0001750 0001750 00000000000 11373047473 011753 5 0000000 0000000 libupnp-1.8.0~svn20100507/m4/ 0000777 0001750 0001750 00000000000 11373047467 012276 5 0000000 0000000 libupnp-1.8.0~svn20100507/m4/rt_bool_arg_enable.m4 0000644 0001750 0001750 00000003506 11021325542 016236 0000000 0000000 dnl @synopsis RT_BOOL_ARG_ENABLE([FLAG],[DEFAULT],[HELP STRING])
dnl
dnl This macro declares a configure option with 'AC_ARG_ENABLE'.
dnl It is a boolean argument (yes or no values only), and
dnl the corresponding shell variable 'enable_arg' is guaranteed to
dnl be one or the other.
dnl A message is also printed.
dnl
dnl Arguments
dnl $1 = flag name e.g. [debug]
dnl $2 = default value, shall be m4 constant, either [yes] or [no]
dnl $3 = help string (default value is appended) e.g. [compile debugging code]
dnl
dnl @version $Id: rt_bool_arg_enable.m4,v 1.2 2006/02/18 14:35:09 r3mi Exp $
dnl @author Rémi Turboult The ixmlLoadDocumentEx API differs from the ixmlLoadDocument
API in that it returns a an error code representing the actual failure
rather than just NULL.
The ixmlDocument_createAttributeNSEx API differs from the
ixmlDocument_createAttributeNS API in that it returns an error code
describing the reason for failure rather than just NULL.
If errorChar is 0 (default), the parser is strict about XML
encoding : invalid UTF-8 sequences or "&" entities are rejected, and
the parsing aborts.
If errorChar is not 0, the parser is relaxed : invalid UTF-8
characters are replaced by the errorChar, and invalid "&" entities
are left untranslated. The parsing is then allowed to continue. Note that this function can be used for any Node-derived
interface. The difference between ixmlPrintDocument and
ixmlPrintNode is ixmlPrintDocument includes the XML prolog
while ixmlPrintNode only produces XML elements. An XML
document is not well formed unless it includes the prolog
and at least one element.
This function introduces lots of white space to print the
DOMString in readable format.
The ixmlParseBufferEx API differs from the ixmlParseBuffer
API in that it returns an error code representing the actual failure
rather than just NULL.
Copyright (C) 2000-2003 Intel Corporation ALL RIGHTS RESERVED
Revision 1.2.1 (Tue 04 Jul 2006 04:58:36 PM EEST)
The ixmlDocument_createElementEx API differs from the
ixmlDocument_createElement API in that it returns an error code
describing the reason for failure rather than just NULL.
The ixmlDocument_createAttributeEx API differs from the
ixmlDocument_createAttribute API in that it returns an error code
describing the reason for failure rather than just NULL.
Note that this function can be used for any Node-derived
interface. The difference between ixmlNodetoString and
ixmlDocumenttoString is ixmlNodetoString does not include
the XML prolog, it only produces XML elements.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
The ixmlDocument_createCDATASectionEx API differs from the
ixmlDocument_createCDATASection API in that it returns an error code
describing the reason for failure rather than just NULL.
For a complete discussion on the object model, the object hierarchy,
etc., refer to section 1.1 of the DOM2-Core recommendation. Note that this document assumes that the reader has a copy of the DOM2-Core
recommendation. Refer to the link below to obtain a copy. Only a brief
description is included here and the reader is pointed to the DOM2-Core
recommendation for more details. This document does, however, clarify
IXML-specific behavior when the recommendation is unclear.
About DOM
The Document Object Model (DOM) is a set of interfaces that give a
programmatic interface to documents. It provides a platform-neutral and
language-neutral interface for random access and updating elements inside
XML documents. DOM Level 1 provided the basic interfaces to access
document elements. DOM Level 2 extended the interfaces to provide proper
support for XML namespaces.
The latest DOM 2 recommendation is maintained by W3C and is available from
http://www.w3.org/TR/DOM-Level-2-Core. Note that this function can be used for any Node-derived
interface. A similar ixmlPrintDocument function is defined
to avoid casting when printing whole documents. This function
introduces lots of white space to print the DOMString in readable
format.
Note that this function can be used for any Node-derived
interface. The difference between ixmlDocumenttoString and
ixmlNodetoString is ixmlDocumenttoString includes the XML
prolog while ixmlNodetoString only produces XML elements. An XML
document is not well formed unless it includes the prolog
and at least one element.
The ixmlDocument_createElementNSEx API differs from the
ixmlDocument_createElementNS API in that it returns an error code
describing the reason for failure rather than just NULL.
UpnpSendAdvertisement is a synchronous call.
EXPORT_SPEC BOOL ixmlElement_hasAttributeNS
(IXML_Element* element,
DOMString namespaceURI,
DOMString localName )Queries whether the Element has an attribute with the given local name and namespace URI or has a default value for that attribute.
Documentation
Queries whether the Element has an attribute with the given
local name and namespace URI or has a default value for that attribute.
namespaceURI - The namespace URI of the attribute.
localName - The local name of the attribute.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getNodeType.html 0000644 0001750 0001750 00000002514 11021325544 022441 0000000 0000000
EXPORT_SPEC unsigned short ixmlNode_getNodeType
(IXML_Node* nodeptr )
Retrieves the type of a Node.
Documentation
Retrieves the type of a Node. The defined Node constants
are:
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_appendChild.html 0000644 0001750 0001750 00000003143 11021325544 022424 0000000 0000000
EXPORT_SPEC int ixmlNode_appendChild
(IXML_Node* nodeptr,
IXML_Node* newChild )Appends a child Node to the list of children of a Node.
Documentation
Appends a child Node to the list of children of a Node. If
newChild is already in the tree, it is removed first.
newChild - The new child to append.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getPrefix.html 0000644 0001750 0001750 00000002336 11021325544 022151 0000000 0000000
EXPORT_SPEC DOMString ixmlNode_getPrefix
(IXML_Node* nodeptr )
Retrieves the namespace prefix, if present.
Documentation
Retrieves the namespace prefix, if present. The prefix is the name
used as an alias for the namespace URI for this element. Only
Nodes of type eELEMENT_NODE or eATTRIBUTE_NODE can have
a prefix. Nodes created through the Document interface will
only contain a prefix if created using ixmlDocument_createElementNS.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_getElementsByTagNameNS.html 0000644 0001750 0001750 00000002715 11021325544 025166 0000000 0000000
EXPORT_SPEC IXML_NodeList* ixmlElement_getElementsByTagNameNS
(IXML_Element* element,
DOMString namespaceURI,
DOMString localName )Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in the pre-order traversal of the Element tree.
Documentation
Returns a NodeList of all descendant Elements with a
given tag name, in the order in which they are encountered in the
pre-order traversal of the Element tree.
namespaceURI - The namespace URI of the
Elements to find.
localName - The local name of the Elements
to find.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/InterfaceitNamedNodeMap.html 0000644 0001750 0001750 00000006026 11021325544 023023 0000000 0000000
Interface NamedNodeMap
A NamedNodeMap object represents a list of objects that can be
accessed by name. A NamedNodeMap maintains the objects in
no particular order. The Node interface uses a NamedNodeMap
to maintain the attributes of a node.
ixmlNamedNodeMap_getLength
ixmlNamedNodeMap_getNamedItem
ixmlNamedNodeMap_setNamedItem
ixmlNamedNodeMap_removeNamedItem
ixmlNamedNodeMap_item
ixmlNamedNodeMap_getNamedItemNS
ixmlNamedNodeMap_setNamedItemNS
ixmlNamedNodeMap_removeNamedItemNS
ixmlNamedNodeMap_free
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getChildNodes.html 0000644 0001750 0001750 00000002157 11021325544 022731 0000000 0000000
EXPORT_SPEC IXML_NodeList* ixmlNode_getChildNodes
(IXML_Node* nodeptr )
Retrieves the list of children of a Node in a NodeList structure.
Documentation
Retrieves the list of children of a Node in a NodeList
structure. If a Node has no children, ixmlNode_getChildNodes
returns a NodeList structure that contains no Nodes.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createDocument.html 0000644 0001750 0001750 00000001470 11021325544 024045 0000000 0000000
EXPORT_SPEC IXML_Document* ixmlDocument_createDocument
()
Creates a new empty Document node.
Documentation
Creates a new empty Document node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_free.html 0000644 0001750 0001750 00000001547 11021325544 021140 0000000 0000000
EXPORT_SPEC void ixmlNode_free
(IXML_Node* IXML_Node )
Frees a Node and all Nodes in its subtree.
Documentation
Frees a Node and all Nodes in its subtree.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/InterfaceitAttr.html 0000644 0001750 0001750 00000001701 11021325544 021440 0000000 0000000
Interface Attr
The Attr interface represents an attribute of an Element.
The document type definition (DTD) or schema usually dictate the
allowable attributes and values for a particular element. For more
information, refer to the Interface Attr section in the DOM2-Core.
ixmlAttr_free
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_removeAttributeNode.html 0000644 0001750 0001750 00000002656 11021325544 024714 0000000 0000000
EXPORT_SPEC int ixmlElement_removeAttributeNode
(IXML_Element* element,
IXML_Attr* oldAttr,
IXML_Attr** rtAttr )Removes the specified attribute node from an Element.
Documentation
Removes the specified attribute node from an Element.
oldAttr - The attribute to remove from the
Element.
rtAttr - A pointer to an attribute in which to
place the removed attribute.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNamedNodeMap_getNamedItemNS.html 0000644 0001750 0001750 00000002402 11021325544 024415 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_getNamedItemNS
(IXML_NamedNodeMap* nnMap,
DOMString* namespaceURI,
DOMString localName )Retrieves a Node from a NamedNodeMap specified by namespace URI and local name.
Documentation
Retrieves a Node from a NamedNodeMap specified by
namespace URI and local name.
namespaceURI - The namespace URI of the Node to
remove.
localName - The local name of the Node to
remove.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_getTagName.html 0000644 0001750 0001750 00000001701 11021325544 022727 0000000 0000000
EXPORT_SPEC const DOMString ixmlElement_getTagName
(IXML_Element* element )
Returns the name of the tag as a constant string.
Documentation
Returns the name of the tag as a constant string.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlLoadDocumentEx.html 0000644 0001750 0001750 00000002761 11021325544 022124 0000000 0000000
EXPORT_SPEC int ixmlLoadDocumentEx
(char* xmlFile,
IXML_Document** doc )Parses an XML text file converting it into an IXML DOM representation.
Documentation
Parses an XML text file converting it into an IXML DOM representation.
doc - A pointer to the Document if file correctly
parses or NULL on an error.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getAttributes.html 0000644 0001750 0001750 00000002073 11021325544 023040 0000000 0000000
EXPORT_SPEC IXML_NamedNodeMap* ixmlNode_getAttributes
(IXML_Node* nodeptr )
Retrieves the attributes of a Node, if it is an Element node, in a NamedNodeMap structure.
Documentation
Retrieves the attributes of a Node, if it is an Element node,
in a NamedNodeMap structure.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/IXMLAPI.html 0000644 0001750 0001750 00000005727 11021325544 017467 0000000 0000000
IXML API
The IXML API contains utility functions that are not part of the standard
DOM interfaces. They include functions to create a DOM structure from a
file or buffer, create an XML file from a DOM structure, and manipulate
DOMString objects.
ixmlPrintDocument
ixmlPrintNode
ixmlDocumenttoString
ixmlNodetoString
ixmlRelaxParser
ixmlParseBuffer
ixmlParseBufferEx
ixmlLoadDocument
ixmlLoadDocumentEx
ixmlCloneDOMString
ixmlFreeDOMString
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNodeList_length.html 0000644 0001750 0001750 00000001704 11021325544 022327 0000000 0000000
EXPORT_SPEC unsigned long ixmlNodeList_length
(IXML_NodeList* nList )
Returns the number of Nodes in a NodeList.
Documentation
Returns the number of Nodes in a NodeList.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createElementNS.html 0000644 0001750 0001750 00000002320 11021325544 024114 0000000 0000000
EXPORT_SPEC IXML_Element* ixmlDocument_createElementNS
(IXML_Document* doc,
DOMString namespaceURI,
DOMString qualifiedName )Creates a new Element node in the given qualified name and namespace URI.
Documentation
Creates a new Element node in the given qualified name and
namespace URI.
namespaceURI - The namespace URI for the new
Element.
qualifiedName - The qualified name of the new
Element.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNamedNodeMap_setNamedItem.html 0000644 0001750 0001750 00000002301 11021325544 024166 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_setNamedItem
(IXML_NamedNodeMap* nnMap,
IXML_Node* arg )Adds a new Node to the NamedNodeMap using the Node name attribute.
Documentation
Adds a new Node to the NamedNodeMap using the Node
name attribute.
arg - The new Node to add to the
NamedNodeMap.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_setNodeValue.html 0000644 0001750 0001750 00000002520 11021325544 022605 0000000 0000000
EXPORT_SPEC int ixmlNode_setNodeValue
(IXML_Node* nodeptr,
char* newNodeValue )Assigns a new value to a Node.
Documentation
Assigns a new value to a Node. The newNodeValue string is
duplicated and stored in the Node so that the original does not
have to persist past this call.
newNodeValue - The new value of the Node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlParseBuffer.html 0000644 0001750 0001750 00000001762 11021325544 021455 0000000 0000000
EXPORT_SPEC IXML_Document* ixmlParseBuffer
(char* buffer )
Parses an XML text buffer converting it into an IXML DOM representation.
Documentation
Parses an XML text buffer converting it into an IXML DOM representation.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createAttributeNSEx.html 0000644 0001750 0001750 00000003430 11021325544 024766 0000000 0000000
EXPORT_SPEC int ixmlDocument_createAttributeNSEx
(IXML_Document* doc,
DOMString namespaceURI,
DOMString qualifiedName,
IXML_Attr** attrNode )Creates a new Attr node with the given qualified name and namespace URI.
Documentation
Creates a new Attr node with the given qualified name and
namespace URI.
namespaceURI - The namespace URI for the attribute.
qualifiedName - The qualified name of the attribute.
attrNode - A pointer to an Attr where the
new object will be stored.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createAttributeNS.html 0000644 0001750 0001750 00000002271 11021325544 024473 0000000 0000000
EXPORT_SPEC IXML_Attr* ixmlDocument_createAttributeNS
(IXML_Document* doc,
DOMString namespaceURI,
DOMString qualifiedName )Creates a new Attr node with the given qualified name and namespace URI.
Documentation
Creates a new Attr node with the given qualified name and
namespace URI.
namespaceURI - The namespace URI for the attribute.
qualifiedName - The qualified name of the attribute.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_removeChild.html 0000644 0001750 0001750 00000003153 11021325544 022453 0000000 0000000
EXPORT_SPEC int ixmlNode_removeChild
(IXML_Node* nodeptr,
IXML_Node* oldChild,
IXML_Node** returnNode )Removes a child from the list of children of a Node.
Documentation
Removes a child from the list of children of a Node.
returnNode will contain the oldChild Node,
appropriately removed from the tree (i.e. it will no longer have an
owner document).
oldChild - The child Node to remove.
returnNode - Pointer to a Node to place the removed
oldChild Node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_removeAttribute.html 0000644 0001750 0001750 00000002162 11021325544 024076 0000000 0000000
EXPORT_SPEC int ixmlElement_removeAttribute
(IXML_Element* element,
DOMString name )Removes an attribute by name.
Documentation
Removes an attribute by name.
name - The name of the attribute to remove.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlRelaxParser.html 0000644 0001750 0001750 00000002044 11021325544 021473 0000000 0000000
void ixmlRelaxParser
(char errorChar)
Makes the XML parser more tolerant to malformed text.
Documentation
Makes the XML parser more tolerant to malformed text.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_removeAttributeNS.html 0000644 0001750 0001750 00000002471 11021325544 024342 0000000 0000000
EXPORT_SPEC int ixmlElement_removeAttributeNS
(IXML_Element* element,
DOMString namespaceURI,
DOMString localName )Removes an attribute using the namespace URI and local name.
Documentation
Removes an attribute using the namespace URI and local name.
namespaceURI - The namespace URI of the attribute.
localName - The local name of the attribute.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/InterfaceitNodeList.html 0000644 0001750 0001750 00000002520 11021325544 022247 0000000 0000000
Interface NodeList
The NodeList interface abstracts an ordered collection of
nodes. Note that changes to the underlying nodes will change
the nodes contained in a NodeList. The DOM2-Core refers to
this as being live.
ixmlNodeList_item
ixmlNodeList_length
ixmlNodeList_free
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlPrintDocument.html 0000644 0001750 0001750 00000002727 11021325544 022046 0000000 0000000
DOMString ixmlPrintDocument
(IXML_Document* doc)
Renders a Node and all sub-elements into an XML document representation.
Documentation
Renders a Node and all sub-elements into an XML document
representation. The caller is required to free the DOMString
returned from this function using ixmlFreeDOMString when it
is no longer required.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlParseBufferEx.html 0000644 0001750 0001750 00000002771 11021325544 021753 0000000 0000000
EXPORT_SPEC int ixmlParseBufferEx
(char* buffer,
IXML_Document** doc )Parses an XML text buffer converting it into an IXML DOM representation.
Documentation
Parses an XML text buffer converting it into an IXML DOM representation.
doc - A point to store the Document if file correctly
parses or NULL on an error.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNamedNodeMap_getLength.html 0000644 0001750 0001750 00000001713 11021325544 023536 0000000 0000000
EXPORT_SPEC unsigned long ixmlNamedNodeMap_getLength
(IXML_NamedNodeMap* nnMap )
Returns the number of items contained in this NamedNodeMap.
Documentation
Returns the number of items contained in this NamedNodeMap.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlAttr_free.html 0000644 0001750 0001750 00000001457 11021325544 021165 0000000 0000000
EXPORT_SPEC void ixmlAttr_free
(IXML_Attr* attrNode )
Frees an Attr node.
Documentation
Frees an Attr node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/index.html 0000644 0001750 0001750 00000002317 11021325544 017463 0000000 0000000
IXML v1.2
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getPreviousSibling.html 0000644 0001750 0001750 00000002013 11021325544 024030 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNode_getPreviousSibling
(IXML_Node* nodeptr )
Retrieves the sibling Node immediately preceding this Node.
Documentation
Retrieves the sibling Node immediately preceding this Node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_setAttribute.html 0000644 0001750 0001750 00000003114 11021325544 023372 0000000 0000000
EXPORT_SPEC int ixmlElement_setAttribute
(IXML_Element* element,
DOMString name,
DOMString value )Adds a new attribute to an Element.
Documentation
Adds a new attribute to an Element. If an attribute with the same
name already exists, the attribute value will be updated with the
new value in value.
name - The name of the attribute.
value - The value of the attribute. Note that this is
a non-parsed string and any markup must be
escaped.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNamedNodeMap_removeNamedItem.html 0000644 0001750 0001750 00000002100 11021325544 024665 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_removeNamedItem
(IXML_NamedNodeMap* nnMap,
DOMString name )Removes a Node from a NamedNodeMap specified by name.
Documentation
Removes a Node from a NamedNodeMap specified by name.
name - The name of the item to remove.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_getElementById.html 0000644 0001750 0001750 00000002066 11021325544 023746 0000000 0000000
EXPORT_SPEC IXML_Element* ixmlDocument_getElementById
(IXML_Document* doc,
DOMString tagName )Returns the Element whose ID matches that given id.
Documentation
Returns the Element whose ID matches that given id.
tagName - The name of the Element.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createAttribute.html 0000644 0001750 0001750 00000001766 11021325544 024242 0000000 0000000
EXPORT_SPEC IXML_Attr* ixmlDocument_createAttribute
(IXML_Document* doc,
char* name )Creates a new Attr node with the given name.
Documentation
Creates a new Attr node with the given name.
name - The name of the new attribute.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlCDATASection_init.html 0000644 0001750 0001750 00000001555 11021325544 022435 0000000 0000000
EXPORT_SPEC void ixmlCDATASection_init
(IXML_CDATASection* nodeptr )
Initializes a CDATASection node.
Documentation
Initializes a CDATASection node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlCDATASection_free.html 0000644 0001750 0001750 00000001532 11021325544 022406 0000000 0000000
EXPORT_SPEC void ixmlCDATASection_free
(IXML_CDATASection* nodeptr )
Frees a CDATASection node.
Documentation
Frees a CDATASection node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createElementEx.html 0000644 0001750 0001750 00000003531 11021325544 024155 0000000 0000000
EXPORT_SPEC int ixmlDocument_createElementEx
(IXML_Document* doc,
const DOMString tagName,
IXML_Element** rtElement )Creates a new Element node with the given tag name.
Documentation
Creates a new Element node with the given tag name. The new
Element node has a nodeName of tagName and
the localName, prefix, and namespaceURI set
to NULL. To create an Element with a namespace,
see ixmlDocument_createElementNS.
tagName - The tag name of the new Element
node.
rtElement - Pointer to an Element where the new
object will be stored.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_init.html 0000644 0001750 0001750 00000001525 11021325544 022047 0000000 0000000
EXPORT_SPEC void ixmlDocument_init
(IXML_Document* nodeptr )
Initializes a Document node.
Documentation
Initializes a Document node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_free.html 0000644 0001750 0001750 00000002054 11021325544 022023 0000000 0000000
EXPORT_SPEC void ixmlDocument_free
(IXML_Document* doc )
Frees a Document object and all Nodes associated with it.
Documentation
Frees a Document object and all Nodes associated with it.
Any Nodes extracted via any other interface function, e.g.
ixmlDocument_GetElementById, become invalid after this call unless
explicitly cloned.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getParentNode.html 0000644 0001750 0001750 00000001704 11021325544 022751 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNode_getParentNode
(IXML_Node* nodeptr )
Retrieves the parent Node for a Node.
Documentation
Retrieves the parent Node for a Node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getFirstChild.html 0000644 0001750 0001750 00000001744 11021325544 022751 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNode_getFirstChild
(IXML_Node* nodeptr )
Retrieves the first child Node of a Node.
Documentation
Retrieves the first child Node of a Node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getNamespaceURI.html 0000644 0001750 0001750 00000002357 11021325544 023173 0000000 0000000
EXPORT_SPEC const DOMString ixmlNode_getNamespaceURI
(IXML_Node* nodeptr )
Retrieves the namespace URI for a Node as a DOMString.
Documentation
Retrieves the namespace URI for a Node as a DOMString. Only
Nodes of type eELEMENT_NODE or eATTRIBUTE_NODE can
have a namespace URI. Nodes created through the Document
interface will only contain a namespace if created using
ixmlDocument_createElementNS.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createAttributeEx.html 0000644 0001750 0001750 00000003057 11021325544 024532 0000000 0000000
EXPORT_SPEC int ixmlDocument_createAttributeEx
(IXML_Document* doc,
char* name,
IXML_Attr** attrNode )Creates a new Attr node with the given name.
Documentation
Creates a new Attr node with the given name.
name - The name of the new attribute.
attrNode - A pointer to a Attr where the new
object will be stored.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createTextNode.html 0000644 0001750 0001750 00000002023 11021325544 024014 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlDocument_createTextNode
(IXML_Document* doc,
const DOMString data )Creates a new Text node with the given data.
Documentation
Creates a new Text node with the given data.
data - The data to associate with the new Text
node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/InterfaceitElement.html 0000644 0001750 0001750 00000012247 11021325544 022126 0000000 0000000
Interface Element
The Element interface represents an element in an XML document.
Only Elements are allowed to have attributes, which are stored in the
attributes member of a Node. The Element interface
extends the Node interface and adds more operations to manipulate
attributes.
ixmlElement_init
ixmlElement_getTagName
ixmlElement_getAttribute
ixmlElement_setAttribute
ixmlElement_removeAttribute
ixmlElement_getAttributeNode
ixmlElement_setAttributeNode
ixmlElement_removeAttributeNode
ixmlElement_getElementsByTagName
ixmlElement_getAttributeNS
ixmlElement_setAttributeNS
ixmlElement_removeAttributeNS
ixmlElement_getAttributeNodeNS
ixmlElement_setAttributeNodeNS
ixmlElement_getElementsByTagNameNS
ixmlElement_hasAttribute
ixmlElement_hasAttributeNS
ixmlElement_free
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_getAttributeNS.html 0000644 0001750 0001750 00000002247 11021325544 023625 0000000 0000000
EXPORT_SPEC DOMString ixmlElement_getAttributeNS
(IXML_Element* element,
DOMString namespaceURI,
DOMString localname )Retrieves an attribute value using the local name and namespace URI.
Documentation
Retrieves an attribute value using the local name and namespace URI.
namespaceURI - The namespace URI of the attribute.
localname - The local name of the attribute.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_hasChildNodes.html 0000644 0001750 0001750 00000001712 11021325544 022721 0000000 0000000
EXPORT_SPEC BOOL ixmlNode_hasChildNodes
(IXML_Node* nodeptr )
Queries whether or not a Node has children.
Documentation
Queries whether or not a Node has children.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createDocumentEx.html 0000644 0001750 0001750 00000002417 11021325544 024344 0000000 0000000
EXPORT_SPEC int ixmlDocument_createDocumentEx
(IXML_Document** doc )
Creates a new empty Document node.
Documentation
Creates a new empty Document node. The
ixmlDocument_createDocumentEx API differs from the
ixmlDocument_createDocument API in that it returns an error code
describing the reason for the failure rather than just NULL.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlFreeDOMString.html 0000644 0001750 0001750 00000001451 11021325544 021654 0000000 0000000
EXPORT_SPEC void ixmlFreeDOMString
(DOMString buf )
Frees a DOMString.
Documentation
Frees a DOMString.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNodetoString.html 0000644 0001750 0001750 00000002572 11021325544 021670 0000000 0000000
EXPORT_SPEC DOMString ixmlNodetoString
(IXML_Node* doc )
Renders a Node and all sub-elements into an XML text representation.
Documentation
Renders a Node and all sub-elements into an XML text
representation. The caller is required to free the DOMString
returned from this function using ixmlFreeDOMString when it
is no longer required.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/toc.html 0000644 0001750 0001750 00000000640 11021325544 017136 0000000 0000000
Table of Contents
General stuff
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/InterfaceitCDATASection.html 0000644 0001750 0001750 00000002410 11021325544 022665 0000000 0000000
Interface CDATASection
The CDATASection is used to escape blocks of text containing
characters that would otherwise be regarded as markup. CDATA sections
cannot be nested. Their primary purpose is for including material such
XML fragments, without needing to escape all the delimiters. For more
information, refer to the Interface CDATASection section in the
DOM2-Core.
ixmlCDATASection_init
ixmlCDATASection_free
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNamedNodeMap_setNamedItemNS.html 0000644 0001750 0001750 00000002336 11021325544 024437 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_setNamedItemNS
(IXML_NamedNodeMap* nnMap,
IXML_Node* arg )Adds a new Node to the NamedNodeMap using the Node local name and namespace URI attributes.
Documentation
Adds a new Node to the NamedNodeMap using the Node
local name and namespace URI attributes.
arg - The Node to add to the map.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlCloneDOMString.html 0000644 0001750 0001750 00000001656 11021325544 022042 0000000 0000000
EXPORT_SPEC DOMString ixmlCloneDOMString
(const DOMString src )
Clones an existing DOMString.
Documentation
Clones an existing DOMString.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/License.html 0000644 0001750 0001750 00000003723 11021325544 017740 0000000 0000000
License
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getNextSibling.html 0000644 0001750 0001750 00000001773 11021325544 023146 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNode_getNextSibling
(IXML_Node* nodeptr )
Retrieves the sibling Node immediately following this Node.
Documentation
Retrieves the sibling Node immediately following this Node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNamedNodeMap_free.html 0000644 0001750 0001750 00000001634 11021325544 022540 0000000 0000000
EXPORT_SPEC void ixmlNamedNodeMap_free
(IXML_NamedNodeMap* nnMap )
Frees a NamedNodeMap.
Documentation
Frees a NamedNodeMap. The Nodes inside the map are not
freed, just the NamedNodeMap object.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNamedNodeMap_getNamedItem.html 0000644 0001750 0001750 00000002013 11021325544 024152 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_getNamedItem
(IXML_NamedNodeMap* nnMap,
DOMString name )Retrieves a Node from the NamedNodeMap by name.
Documentation
Retrieves a Node from the NamedNodeMap by name.
name - The name of the Node to find.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNamedNodeMap_item.html 0000644 0001750 0001750 00000002127 11021325544 022553 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_item
(IXML_NamedNodeMap* nnMap,
unsigned long index )Retrieves a Node from a NamedNodeMap specified by a numerical index.
Documentation
Retrieves a Node from a NamedNodeMap specified by a
numerical index.
index - The index into the map to remove.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createTextNodeEx.html 0000644 0001750 0001750 00000003107 11021325544 024315 0000000 0000000
EXPORT_SPEC int ixmlDocument_createTextNodeEx
(IXML_Document* doc,
const DOMString data,
IXML_Node** textNode )Creates a new Text node with the given data.
Documentation
Creates a new Text node with the given data.
The ixmlDocument_createTextNodeEx API differs from the
ixmlDocument_createTextNode API in that it returns an error code
describing the reason for failure rather than just NULL.
data - The data to associate with the new
Text node.
textNode - A pointer to a Node where the new
object will be stored.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getNodeValue.html 0000644 0001750 0001750 00000001764 11021325544 022602 0000000 0000000
EXPORT_SPEC DOMString ixmlNode_getNodeValue
(IXML_Node* nodeptr )
Returns the value of the Node as a string.
Documentation
Returns the value of the Node as a string. Note that this string
is not a copy and modifying it will modify the value of the Node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_replaceChild.html 0000644 0001750 0001750 00000004330 11021325544 022567 0000000 0000000
EXPORT_SPEC int ixmlNode_replaceChild
(IXML_Node* nodeptr,
IXML_Node* newChild,
IXML_Node* oldChild,
IXML_Node** returnNode )Replaces an existing child Node with a new child Node in the list of children of a Node.
Documentation
Replaces an existing child Node with a new child Node in
the list of children of a Node. If newChild is already in
the tree, it will first be removed. returnNode will contain the
oldChild Node, appropriately removed from the tree (i.e. it
will no longer have an owner document).
newChild - The child with which to replace oldChild.
oldChild - The child to replace with newChild.
returnNode - Pointer to a Node to place the removed
oldChild Node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createCDATASectionEx.html 0000644 0001750 0001750 00000003147 11021325544 024730 0000000 0000000
EXPORT_SPEC int ixmlDocument_createCDATASectionEx
(IXML_Document* doc,
DOMString data,
IXML_CDATASection** cdNode )Creates a new CDATASection node with given data.
Documentation
Creates a new CDATASection node with given data.
data - The data to associate with the new
CDATASection node.
cdNode - A pointer to a Node where the
new object will be stored.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getOwnerDocument.html 0000644 0001750 0001750 00000002261 11021325544 023502 0000000 0000000
EXPORT_SPEC IXML_Document* ixmlNode_getOwnerDocument
(IXML_Node* nodeptr )
Retrieves the document object associated with this Node.
Documentation
Retrieves the document object associated with this Node. This
owner document Node allows other Nodes to be created in the
context of this document. Note that Document nodes do not have
an owner document.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_hasAttributes.html 0000644 0001750 0001750 00000001757 11021325544 023044 0000000 0000000
EXPORT_SPEC BOOL ixmlNode_hasAttributes
(IXML_Node* node )
Queries whether this Node has attributes.
Documentation
Queries whether this Node has attributes. Note that only
Element nodes have attributes.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/DOMInterfaces.html 0000644 0001750 0001750 00000003760 11021325544 021002 0000000 0000000
DOM Interfaces
The Document Object Model consists of a set of objects and interfaces
for accessing and manipulating documents. IXML does not implement all
the interfaces documented in the DOM2-Core recommendation but defines
a subset of the most useful interfaces. A description of the supported
interfaces and methods is presented in this section.
Interface Node
Interface Attr
Interface CDATASection
Interface Document
Interface Element
Interface NamedNodeMap
Interface NodeList
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_cloneNode.html 0000644 0001750 0001750 00000002314 11021325544 022116 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNode_cloneNode
(IXML_Node* nodeptr,
BOOL deep )Clones a Node.
Documentation
Clones a Node. The new Node does not have a parent. The
deep parameter controls whether the subtree of the Node is
also cloned. For details on cloning specific types of Nodes,
refer to the DOM2-Core recommendation.
deep - TRUE to clone the subtree also or FALSE
to clone only nodeptr.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/icon1.gif 0000644 0001750 0001750 00000000506 11021325544 017164 0000000 0000000 GIF89a Ą ˙˙˙€{ĆFAÍÍkbÍ Ö ţ ţ ď Ć{{Ć Íţ04ţţ ç ś‹¨ţ¤Ćţţ ˝ ”„$ ţÖ „ Z Ţ µ c ˝ Z Js s JJJśdbÍ k21Ś !ů , c@€pH,ŹÄ€`0Ž„‚Áp@$EĹÂŔh8 ‚(08"’IR±Gァ@2š÷ć±YpîyCw !"D
#$!%E&''!ť(G
""—H§¨DA ; libupnp-1.8.0~svn20100507/docs/dist/html/ixml/icon2.gif 0000644 0001750 0001750 00000000506 11021325544 017165 0000000 0000000 GIF89a Ő îîî‘›utYYt†…”UUsdded_^€ONj›RQnmlŽ~›ih‹\[|?>TŻłżĽÁÉmlŽJJe;:O==Mvu•ZYv44G##0WWwHGa('5KJeED]##0(55C--=(eeq……”**9RR_ !ů , c@€pH,ŹÄ€`0Ž„‚Áp@$EĹÂŔh8 ‚(08"’IR±Gァ@2š÷ć±YpîyCw !"D
#$!%E&''!ť(G
""—H§¨DA ; libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getNodeName.html 0000644 0001750 0001750 00000002155 11021325544 022401 0000000 0000000
EXPORT_SPEC const DOMString ixmlNode_getNodeName
(IXML_Node* nodeptr )
Returns the name of the Node, depending on what type of Node it is, in a read-only string.
Documentation
Returns the name of the Node, depending on what type of
Node it is, in a read-only string. Refer to the table in the
DOM2-Core for a description of the node names for various interfaces.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_getElementsByTagName.html 0000644 0001750 0001750 00000002427 11021325544 025112 0000000 0000000
EXPORT_SPEC IXML_NodeList* ixmlDocument_getElementsByTagName
(IXML_Document* doc,
DOMString tagName )Returns a NodeList of all Elements that match the given tag name in the order in which they were encountered in a preorder traversal of the Document tree.
Documentation
Returns a NodeList of all Elements that match the given
tag name in the order in which they were encountered in a preorder
traversal of the Document tree.
tagName - The tag name to find.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_importNode.html 0000644 0001750 0001750 00000004011 11021325544 023215 0000000 0000000
EXPORT_SPEC int ixmlDocument_importNode
(IXML_Document* doc,
IXML_Node* importNode,
BOOL deep,
IXML_Node** rtNode )Imports a Node from another Document into this Document.
Documentation
Imports a Node from another Document into this
Document. The new Node does not a have parent node: it is a
clone of the original Node with the ownerDocument set to
doc. The deep parameter controls whether all the children
of the Node are imported. Refer to the DOM2-Core recommendation
for details on importing specific node types.
importNode - The Node to import.
deep - TRUE to import all children of
importNode or FALSE to import only the
root node.
rtNode - A pointer to a new Node owned by
doc.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_getElementsByTagName.html 0000644 0001750 0001750 00000002516 11021325544 024724 0000000 0000000
EXPORT_SPEC IXML_NodeList* ixmlElement_getElementsByTagName
(IXML_Element* element,
DOMString tagName )Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a pre-order traversal of this Element tree.
Documentation
Returns a NodeList of all descendant Elements with
a given tag name, in the order in which they are encountered in a
pre-order traversal of this Element tree.
tagName - The name of the tag for which to
search.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/Introduction.html 0000644 0001750 0001750 00000003455 11021325544 021041 0000000 0000000
Introduction
The Linux DOM2 XML Parser Version 1.2 (IXML) is a lightweight, portable XML
parser supporting the standard Document Object Model (DOM) Level 2
interfaces. The parser uses a C-style interface, making it idea for small,
embedded applications. This document describes the interfaces supported by
IXML 1.2, referencing the W3C DOM2 recommendations when necessary, and the
additional utility application programming interfaces (APIs) that it
supports.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/General.html 0000644 0001750 0001750 00000000570 11021325544 017730 0000000 0000000
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_getAttribute.html 0000644 0001750 0001750 00000002023 11021325544 023354 0000000 0000000
EXPORT_SPEC DOMString ixmlElement_getAttribute
(IXML_Element* element,
DOMString name )Retrieves an attribute of an Element by name.
Documentation
Retrieves an attribute of an Element by name.
name - The name of the attribute to retrieve.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_init.html 0000644 0001750 0001750 00000001522 11021325544 021657 0000000 0000000
EXPORT_SPEC void ixmlElement_init
(IXML_Element* element )
Initializes a IXML_Element node.
Documentation
Initializes a IXML_Element node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_free.html 0000644 0001750 0001750 00000001611 11021325544 021634 0000000 0000000
EXPORT_SPEC void ixmlElement_free
(IXML_Element* element )
Frees the given Element and any subtree of the Element.
Documentation
Frees the given Element and any subtree of the Element.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_getAttributeNode.html 0000644 0001750 0001750 00000002176 11021325544 024173 0000000 0000000
EXPORT_SPEC IXML_Attr* ixmlElement_getAttributeNode
(IXML_Element* element,
DOMString name )Retrieves an attribute node by name.
Documentation
Retrieves an attribute node by name. See
ixmlElement_getAttributeNodeNS to retrieve an attribute node using
a qualified name or namespace URI.
name - The name of the attribute node to find.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getLastChild.html 0000644 0001750 0001750 00000001735 11021325544 022565 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNode_getLastChild
(IXML_Node* nodeptr )
Retrieves the last child Node of a Node.
Documentation
Retrieves the last child Node of a Node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_setAttributeNodeNS.html 0000644 0001750 0001750 00000003175 11021325544 024450 0000000 0000000
EXPORT_SPEC int ixmlElement_setAttributeNodeNS
(IXML_Element* element,
IXML_Attr* newAttr,
IXML_Attr** rcAttr )Adds a new attribute node.
Documentation
Adds a new attribute node. If an attribute with the same local name
and namespace URI already exists in the Element, the existing
attribute node is replaced with newAttr and the old returned in
rcAttr.
newAttr - The new Attr to add.
rcAttr - A pointer to the replaced Attr, if
it exists.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlPrintNode.html 0000644 0001750 0001750 00000002570 11021325544 021151 0000000 0000000
DOMString ixmlPrintNode
(IXML_Node* doc )
Renders a Node and all sub-elements into an XML text representation.
Documentation
Renders a Node and all sub-elements into an XML text
representation. The caller is required to free the DOMString
returned from this function using ixmlFreeDOMString when it
is no longer required.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocumenttoString.html 0000644 0001750 0001750 00000002600 11021325544 022551 0000000 0000000
DOMString ixmlDocumenttoString
(IXML_Document* doc)
Renders a Node and all sub-elements into an XML document representation.
Documentation
Renders a Node and all sub-elements into an XML document
representation. The caller is required to free the DOMString
returned from this function using ixmlFreeDOMString when it
is no longer required.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlLoadDocument.html 0000644 0001750 0001750 00000001746 11021325544 021631 0000000 0000000
EXPORT_SPEC IXML_Document* ixmlLoadDocument
(char* xmlFile )
Parses an XML text file converting it into an IXML DOM representation.
Documentation
Parses an XML text file converting it into an IXML DOM representation.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createElementNSEx.html 0000644 0001750 0001750 00000003444 11021325544 024421 0000000 0000000
EXPORT_SPEC int ixmlDocument_createElementNSEx
(IXML_Document* doc,
DOMString namespaceURI,
DOMString qualifiedName,
IXML_Element** rtElement )Creates a new Element node in the given qualified name and namespace URI.
Documentation
Creates a new Element node in the given qualified name and
namespace URI.
namespaceURI - The namespace URI for the new
Element.
qualifiedName - The qualified name of the new
Element.
rtElement - A pointer to an Element where the
new object will be stored.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_getAttributeNodeNS.html 0000644 0001750 0001750 00000002217 11021325544 024430 0000000 0000000
EXPORT_SPEC IXML_Attr* ixmlElement_getAttributeNodeNS
(IXML_Element* element,
DOMString namespaceURI,
DOMString localName )Retrieves an Attr node by local name and namespace URI.
Documentation
Retrieves an Attr node by local name and namespace URI.
namespaceURI - The namespace URI of the attribute.
localName - The local name of the attribute.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_hasAttribute.html 0000644 0001750 0001750 00000002310 11021325544 023347 0000000 0000000
EXPORT_SPEC BOOL ixmlElement_hasAttribute
(IXML_Element* element,
DOMString name )Queries whether the Element has an attribute with the given name or a default value.
Documentation
Queries whether the Element has an attribute with the given name
or a default value.
name - The name of the attribute for which to check.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_getElementsByTagNameNS.html 0000644 0001750 0001750 00000003216 11021325544 025350 0000000 0000000
EXPORT_SPEC IXML_NodeList* ixmlDocument_getElementsByTagNameNS
(IXML_Document* doc,
DOMString namespaceURI,
DOMString localName )Returns a NodeList of Elements that match the given local name and namespace URI in the order they are encountered in a preorder traversal of the Document tree.
Documentation
Returns a NodeList of Elements that match the given
local name and namespace URI in the order they are encountered
in a preorder traversal of the Document tree. Either
namespaceURI or localName can be the special "*"
character, which matches any namespace or any local name respectively.
namespaceURI - The namespace of the elements to
find or "*" to match any
namespace.
localName - The local name of the elements to
find or "*" to match any local
name.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNamedNodeMap_removeNamedItemNS.html 0000644 0001750 0001750 00000002406 11021325544 025137 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNamedNodeMap_removeNamedItemNS
(IXML_NamedNodeMap* nnMap,
DOMString namespaceURI,
DOMString localName )Removes a Node from a NamedNodeMap specified by namespace URI and local name.
Documentation
Removes a Node from a NamedNodeMap specified by
namespace URI and local name.
namespaceURI - The namespace URI of the Node
to remove.
localName - The local name of the Node to
remove.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_getLocalName.html 0000644 0001750 0001750 00000002423 11021325544 022544 0000000 0000000
EXPORT_SPEC const DOMString ixmlNode_getLocalName
(IXML_Node* nodeptr )
Retrieves the local name of a Node, if present.
Documentation
Retrieves the local name of a Node, if present. The local name is
the tag name without the namespace prefix. Only Nodes of type
eELEMENT_NODE or eATTRIBUTE_NODE can have a local name.
{\Bf Node}s created through the Document interface will only
contain a local name if created using ixmlDocument_createElementNS.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_setAttributeNode.html 0000644 0001750 0001750 00000003273 11021325544 024206 0000000 0000000
EXPORT_SPEC int ixmlElement_setAttributeNode
(IXML_Element* element,
IXML_Attr* newAttr,
IXML_Attr** rtAttr )Adds a new attribute node to an Element.
Documentation
Adds a new attribute node to an Element. If an attribute already
exists with newAttr as a name, it will be replaced with the
new one and the old one will be returned in rtAttr.
newAttr - The new Attr to add.
rtAttr - A pointer to an Attr where the old
Attr will be stored. This will have
a NULL if no prior node
existed.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNodeList_free.html 0000644 0001750 0001750 00000001707 11021325544 021772 0000000 0000000
EXPORT_SPEC void ixmlNodeList_free
(IXML_NodeList* nList )
Frees a NodeList object.
Documentation
Frees a NodeList object. Since the underlying Nodes are
references, they are not freed using this operating. This only
frees the NodeList object.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNode_insertBefore.html 0000644 0001750 0001750 00000004471 11021325544 022645 0000000 0000000
EXPORT_SPEC int ixmlNode_insertBefore
(IXML_Node* nodeptr,
IXML_Node* newChild,
IXML_Node* refChild )Inserts a new child Node before the existing child Node.
Documentation
Inserts a new child Node before the existing child Node.
refChild can be NULL, which inserts newChild at the
end of the list of children. Note that the Node (or Nodes)
in newChild must already be owned by the owner document (or have no
owner at all) of nodeptr for insertion. If not, the Node
(or Nodes) must be imported into the document using
ixmlDocument_importNode. If newChild is already in the tree,
it is removed first.
newChild - The Node to insert into the tree.
refChild - The reference child where the new Node
should be inserted. The new Node will
appear directly before the reference child.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlNodeList_item.html 0000644 0001750 0001750 00000002115 11021325544 022001 0000000 0000000
EXPORT_SPEC IXML_Node* ixmlNodeList_item
(IXML_NodeList* nList,
unsigned long index )Retrieves a Node from a NodeList specified by a numerical index.
Documentation
Retrieves a Node from a NodeList specified by a
numerical index.
index - The index into the NodeList to retrieve.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlElement_setAttributeNS.html 0000644 0001750 0001750 00000004034 11021325544 023635 0000000 0000000
EXPORT_SPEC int ixmlElement_setAttributeNS
(IXML_Element* element,
DOMString namespaceURI,
DOMString qualifiedName,
DOMString value )Adds a new attribute to an Element using the local name and namespace URI.
Documentation
Adds a new attribute to an Element using the local name and
namespace URI. If another attribute matches the same local name and
namespace, the prefix is changed to be the prefix part of the
qualifiedName and the value is changed to value.
namespaceURI - The namespace URI of the new attribute.
qualifiedName - The qualified name of the attribute.
value - The new value for the attribute.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createCDATASection.html 0000644 0001750 0001750 00000002107 11021325544 024426 0000000 0000000
EXPORT_SPEC IXML_CDATASection* ixmlDocument_createCDATASection
(IXML_Document* doc,
DOMString data )Creates a new CDATASection node with given data.
Documentation
Creates a new CDATASection node with given data.
data - The data to associate with the new
CDATASection node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/InterfaceitNode.html 0000644 0001750 0001750 00000013271 11021325544 021420 0000000 0000000
Interface Node
The Node interface forms the primary datatype for all other DOM
objects. Every other interface is derived from this interface, inheriting
its functionality. For more information, refer to DOM2-Core page 34.
ixmlNode_getNodeName
ixmlNode_getNodeValue
ixmlNode_setNodeValue
ixmlNode_getNodeType
ixmlNode_getParentNode
ixmlNode_getChildNodes
ixmlNode_getFirstChild
ixmlNode_getLastChild
ixmlNode_getPreviousSibling
ixmlNode_getNextSibling
ixmlNode_getAttributes
ixmlNode_getOwnerDocument
ixmlNode_getNamespaceURI
ixmlNode_getPrefix
ixmlNode_getLocalName
ixmlNode_insertBefore
ixmlNode_replaceChild
ixmlNode_removeChild
ixmlNode_appendChild
ixmlNode_hasChildNodes
ixmlNode_cloneNode
ixmlNode_hasAttributes
ixmlNode_free
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/ixmlDocument_createElement.html 0000644 0001750 0001750 00000002450 11021325544 023657 0000000 0000000
EXPORT_SPEC IXML_Element* ixmlDocument_createElement
(IXML_Document* doc,
const DOMString tagName )Creates a new Element node with the given tag name.
Documentation
Creates a new Element node with the given tag name. The new
Element node has a nodeName of tagName and
the localName, prefix, and namespaceURI set
to NULL. To create an Element with a namespace,
see ixmlDocument_createElementNS.
tagName - The tag name of the new Element node.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/ixml/InterfaceitDocument.html 0000644 0001750 0001750 00000013267 11021325544 022316 0000000 0000000
Interface Document
The Document interface represents the entire XML document.
In essence, it is the root of the document tree and provides the
primary interface to the elements of the document. For more information,
refer to the Interface Document section in the DOM2Core.
ixmlDocument_init
ixmlDocument_createDocumentEx
ixmlDocument_createDocument
ixmlDocument_createElementEx
ixmlDocument_createElement
ixmlDocument_createTextNodeEx
ixmlDocument_createTextNode
ixmlDocument_createCDATASectionEx
ixmlDocument_createCDATASection
ixmlDocument_createAttribute
ixmlDocument_createAttributeEx
ixmlDocument_getElementsByTagName
ixmlDocument_createElementNSEx
ixmlDocument_createElementNS
ixmlDocument_createAttributeNSEx
ixmlDocument_createAttributeNS
ixmlDocument_getElementsByTagNameNS
ixmlDocument_getElementById
ixmlDocument_free
ixmlDocument_importNode
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/upnp/ 0000777 0001750 0001750 00000000000 11373047474 015575 5 0000000 0000000 libupnp-1.8.0~svn20100507/docs/dist/html/upnp/UpnpSendActionAsync.html 0000644 0001750 0001750 00000005416 11021325544 022260 0000000 0000000
EXPORT_SPEC int UpnpSendActionAsync
( IN UpnpClient_Handle Hnd,
IN const char* ActionURL,
IN const char* ServiceType,
IN const char* DevUDN,
IN IXML_Document* Action,
IN Upnp_FunPtr Fun,
IN const void* Cookie )UpnpSendActionAsync sends a message to change a state variable in a service, generating a callback when the operation is complete.
Documentation
UpnpSendActionAsync sends a message to change a state variable
in a service, generating a callback when the operation is complete.
See UpnpSendAction for comments on positive return values. These
positive return values are sent in the event struct associated with the
UPNP_CONTROL_ACTION_COMPLETE event.
ActionURL - The action URL of the service.
- ServiceType The type of the service.
- DevUDN This parameter is ignored and must be
NULL.
Action - The DOM document for the action to
perform on this device.
Fun - Pointer to a callback function to
be invoked when the operation
completes.
Cookie - Pointer to user data that to be
passed to the callback when invoked.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/upnp/UpnpGetErrorMessage.html 0000644 0001750 0001750 00000002123 11021325544 022261 0000000 0000000
EXPORT_SPEC const char* UpnpGetErrorMessage
( int errorcode )
UpnpGetErrorMessage converts an SDK error code into a string error message suitable for display.
Documentation
UpnpGetErrorMessage converts an SDK error code into a
string error message suitable for display. The memory returned
from this function should NOT be freed.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/upnp/UPNP_E_SUBSCRIBE_UNACCEPTED-301.html 0000644 0001750 0001750 00000001202 11021325544 023000 0000000 0000000
UPNP_E_SUBSCRIBE_UNACCEPTED [-301]
UPNP_E_SUBSCRIBE_UNACCEPTED signifies that a subscription
request was rejected from the remote side.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/upnp/UpnpAddToAction.html 0000644 0001750 0001750 00000003731 11021325544 021362 0000000 0000000
EXPORT_SPEC int UpnpAddToAction
( IN OUT IXML_Document** ActionDoc,
IN const char* ActionName,
IN const char* ServType,
IN const char* ArgName,
IN const char* ArgVal )UpnpAddToAction creates an action request packet based on its input parameters (status variable name and value pair).
Documentation
UpnpAddToAction creates an action request packet based on its input
parameters (status variable name and value pair). This API is specially
suitable inside a loop to add any number input parameters into an existing
action. If no action document exists in the beginning then a
Upnp_Document variable initialized with NULL should be passed
as a parameter.
- ActionName The action name.
ServType - The service type.
ArgName - The status variable name.
ArgVal - The status variable value.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/upnp/UPNP_E_OUTOF_MEMORY-104.html 0000644 0001750 0001750 00000001303 11021325544 021753 0000000 0000000
UPNP_E_OUTOF_MEMORY [-104]
UPNP_E_OUTOF_MEMORY signifies that not enough resources are
currently available to complete the operation. Most operations require
some free memory in order to complete their work.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/upnp/UPNP_E_INVALID_SERVICE-111.html 0000644 0001750 0001750 00000001374 11021325544 022243 0000000 0000000
UPNP_E_INVALID_SERVICE [-111]
UPNP_E_INVALID_SERVICE is returned only by UpnpNotify,
UpnpNotifyExt, UpnpAcceptSubscription, and
UpnpAcceptSubscriptionExt to signify that the device ID/service
ID pair does not refer to a valid service.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/upnp/UPNP_E_INIT-105.html 0000644 0001750 0001750 00000001317 11021325543 020537 0000000 0000000
UPNP_E_INIT [-105]
UPNP_E_INIT signifies that the SDK has already been
initialized. The SDK needs to be initialied only once per process.
Any additional initialization attempts simply return this error with
no other ill effects.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/upnp/UpnpSendAdvertisement.html 0000644 0001750 0001750 00000003006 11021325543 022647 0000000 0000000
EXPORT_SPEC int UpnpSendAdvertisement
( IN UpnpDevice_Handle Hnd,
IN int Exp )UpnpSendAdvertisement sends out the discovery announcements for all devices and services for a device.
Documentation
UpnpSendAdvertisement sends out the discovery announcements for
all devices and services for a device. Each announcement is made with
the same expiration time.
Exp - The expiration age, in seconds, of
the announcements.
This page was generated with the help of DOC++.
libupnp-1.8.0~svn20100507/docs/dist/html/upnp/Upnp_State_Var_Request.html 0000644 0001750 0001750 00000007027 11021325544 022772 0000000 0000000
struct Upnp_State_Var_Request
Represents the request for current value of a state variable in a service state table.
struct in_addr CtrlPtIPAddr
DOMString CurrentVal
char DevUDN[NAME_SIZE]
int ErrCode
char ErrStr[LINE_SIZE]
char ServiceID[NAME_SIZE]
int Socket
char StateVarName[NAME_SIZE]
Represents the request for current value of a state variable in a service state table.
UpnpNotify sends out an event change notification to all control points subscribed to a particular service.
UpnpNotify sends out an event change notification to all control points subscribed to a particular service. This function is synchronous and generates no callbacks.UpnpNotify may be called during a callback function to send out a notification.
UpnpSubscribe registers a control point to receive event notifications from another device.
UpnpSubscribe registers a control point to receive event notifications from another device. This operation is synchronous.
UpnpOpenHttpGetEx gets specified number of bytes from a file specified in the URL.
UpnpOpenHttpGetEx gets specified number of bytes from a file specified in the URL. The number of bytes is specified through a low count and a high count which are passed as a range of bytes for the request. The SDK allocates the memory for handle and contentType, the application is responsible for freeing this memory.
UpnpReadHttpGet gets specified number of bytes from a file specified in a URL.
UpnpReadHttpGet gets specified number of bytes from a file specified in a URL.
UPNP_E_FINISH signifies that UpnpInit has not been called, or that UpnpFinish has already been called. None of the API functions operate until UpnpInit successfully completes.
Returned in a UPNP_DISCOVERY_RESULT callback.
Returned in a UPNP_DISCOVERY_RESULT callback.
Received by a control point when a new device or service is available.
Received by a control point when a new device or service is available. The Event parameter contains a pointer to a Upnp_Discovery structure with the information about the device or service.
UpnpUnSubscribeAsync removes a subscription of a control point from a service previously subscribed to using UpnpSubscribe or UpnpSubscribeAsync, generating a callback when the operation is complete.
UpnpUnSubscribeAsync removes a subscription of a control point from a service previously subscribed to using UpnpSubscribe or UpnpSubscribeAsync, generating a callback when the operation is complete.Note that many of the error codes for this function are returned in the Upnp_Event_Subscribe structure. In those cases, the function returns UPNP_E_SUCCESS and the appropriate error code will be in the Upnp_Event_Subscribe.ErrCode field in the Event structure passed to the callback.
UPNP_E_SOCKET_WRITE signifies an error writing to a socket. This occurs in any function that makes network connections, such as discovery (e.g. UpnpSearchAsync or UpnpSendAdvertisement), control (e.g. UpnpSendAction), eventing (e.g. UpnpNotify), and HTTP functions (e.g. UpnpDownloadXmlDoc).
UPNP_E_OUTOF_SOCKET signifies that the SDK cannot create any more sockets. This occurs in any function that makes network connections, such as discovery (e.g. UpnpSearchAsync or UpnpSendAdvertisement), control (e.g. UpnpSendAction), eventing (e.g. UpnpNotify), and HTTP functions (e.g. UpnpDownloadXmlDoc).
The description is the URL to the description document.
The description is the URL to the description document.
UPNP_E_SOCKET_CONNECT signifies that the SDK had a problem connecting to a remote host. This occurs in any function that makes network connections, such as discovery (e.g. UpnpSearchAsync or UpnpSendAdvertisement), control (e.g. UpnpSendAction), eventing (e.g. UpnpNotify), and HTTP functions (e.g. UpnpDownloadXmlDoc).
UpnpRemoveVirtualDir removes a virtual directory mapping made with UpnpAddVirtualDir.
UpnpRemoveVirtualDir removes a virtual directory mapping made with UpnpAddVirtualDir.
The description is a file name on the local file system containing the description of the device.
The description is a file name on the local file system containing the description of the device.
UpnpSubscribeAsync performs the same operation as UpnpSubscribe, but returns immediately and calls the registered callback function when the operation is complete.
UpnpSubscribeAsync performs the same operation as UpnpSubscribe, but returns immediately and calls the registered callback function when the operation is complete.Note that many of the error codes for this function are returned in the Upnp_Event_Subscribe structure. In those cases, the function returns UPNP_E_SUCCESS and the appropriate error code will be in the Upnp_Event_Subscribe.ErrCode field in the Event structure passed to the callback.
A UpnpSubscribeAsync call completed.
A UpnpSubscribeAsync call completed. The status of the subscription is in the Event parameter as a Upnp_Event_Subscription structure.
UpnpDownloadXmlDoc downloads an XML document specified in a URL.
UpnpDownloadXmlDoc downloads an XML document specified in a URL. The SDK parses the document and returns it in the form of a DOM document. The application is responsible for freeing the DOM document.
UPNP_E_INVALID_DESC signifies that the description document passed to UpnpRegisterRootDevice or UpnpRegisterRootDevice2 is an invalid description document.
UPNP_E_INIT_FAILED signifies that UpnpInit cannot complete. The typical reason is failure to allocate sufficient resources.
Received by a device when a query for a single service variable arrives.
Received by a device when a query for a single service variable arrives. The Event parameter contains a pointer to a Upnp_State_Var_Request structure containing the name of the variable and value.
UPNP_E_NOTIFY_UNACCEPTED signifies that the remote host did not accept the notify sent from the local device.
The Upnp_SID holds the subscription identifier for a subscription between a client and a device.
The Upnp_SID holds the subscription identifier for a subscription between a client and a device. The SID is a string representation of a globally unique id (GUID) and should not be modified.
Initializes the Linux SDK for UPnP Devices.
Initializes the Linux SDK for UPnP Devices. This function must be called before any other API function can be called. It should be called only once. Subsequent calls to this API return a UPNP_E_INIT error code.Optionally, the application can specify a host IP address (in the case of a multi-homed configuration) and a port number to use for all UPnP operations. Since a port number can be used only by one process, multiple processes using the SDK must specify different port numbers.
If unspecified, the SDK will use the first adapter's IP address and an arbitrary port.
This call is synchronous.
Search for all devices and services on the network.
Search for all devices and services on the network.
UPNP_E_SOCKET_READ signifies an error reading from a socket. This occurs in any function that makes network connections, such as discovery (e.g. UpnpSearchAsync or UpnpSendAdvertisement), control (e.g. UpnpSendAction), eventing (e.g. UpnpNotify), and HTTP functions (e.g. UpnpDownloadXmlDoc).
UpnpSendAction sends a message to change a state variable in a service.
UpnpSendAction sends a message to change a state variable in a service. This is a synchronous call that does not return until the action is complete.Note that a positive return value indicates a SOAP-protocol error code. In this case, the error description can be retrieved from RespNode. A negative return value indicates an SDK error.
Sets the maximum content-length that the SDK will process on an incoming SOAP requests or responses.
Sets the maximum content-length that the SDK will process on an incoming SOAP requests or responses. This API allows devices that have memory constraints to exhibit consistent behaviour if the size of the incoming SOAP message exceeds the memory that device can allocate. The default maximum content-length is DEFAULT_SOAP_CONTENT_LENGTH = 16K bytes.
If '0' is used as the port number in UpnpInit, then this function can be used to retrieve the actual port allocated to the SDK.
If '0' is used as the port number in UpnpInit, then this function can be used to retrieve the actual port allocated to the SDK. If UpnpInit has not succeeded then 0 is returned.
Received by a control point when a matching device or service responds.
Received by a control point when a matching device or service responds. The Event parameter contains a pointer to a Upnp_Discovery structure containing the information about the reply to the search request.
UpnpDownloadUrlItem downloads a file specified in a URL.
UpnpDownloadUrlItem downloads a file specified in a URL. The SDK allocates the memory for outBuf and the application is responsible for freeing this memory. Note that the item is passed as a single buffer. Large items should not be transferred using this function.
UpnpOpenHttpGetProxy gets a file specified in a URL through the specified proxy.
UpnpOpenHttpGetProxy gets a file specified in a URL through the specified proxy. The SDK allocates the memory for handle and contentType, the application is responsible for freeing this memory.
All callback functions share the same prototype, documented below.
All callback functions share the same prototype, documented below. Note that any memory passed to the callback function is valid only during the callback and should be copied if it needs to persist. This callback function needs to be thread safe. The context of the callback is always on a valid thread context and standard synchronization methods can be used. Note, however, because of this the callback cannot call SDK functions unless explicitly noted.int CallbackFxn( Upnp_EventType EventType, void* Event, void* Cookie );where EventType is the event that triggered the callback, Event is a structure that denotes event-specific information for that event, and Cookie is the user data passed when the callback was registered.
See Upnp_EventType for more information on the callback values and the associated Event parameter.
The return value of the callback is currently ignored. It may be used in the future to communicate results back to the SDK.
UPNP_E_SUCCESS signifies that the operation completed successfully. For asynchronous functions, this only means that the packet generated by the operation was successfully transmitted on the network. The result of the entire operation comes as part of the callback for that operation.
UPNP_E_INTERNAL_ERROR is the generic error code for internal conditions not covered by other error codes.
Received by a control point when a device or service shuts down.
Received by a control point when a device or service shuts down. The Event parameter contains a pointer to a Upnp_Discovery structure containing the information about the device or service.
UPNP_E_SOCKET_ERROR is the generic socket error code for conditions not covered by other error codes. This error can be returned by any function that performs network operations.
UPNP_E_INVALID_URL signifies that a URL passed into the function is invalid. The actual cause is function specific, but in general, the URL itself might be malformed (e.g. have invalid characters in it) or the host might be unreachable.
Received by a device when a subscription arrives.
Received by a device when a subscription arrives. The Event parameter contains a pointer to a Upnp_Subscription_Request structure. At this point, the subscription has already been accepted. UpnpAcceptSubscription needs to be called to confirm the subscription and transmit the initial state table. This can be done during this callback. The SDK generates no events for a subscription unless the device application calls UpnpAcceptSubscription.
UPNP_E_NOT_FOUND signifies that the response to a SOAP request did not contain the required XML constructs.
Linux SDK for UPnP Devices Version 1.4 Copyright (C) 2000-2003 Intel Corporation ALL RIGHTS RESERVED
Revision 1.4.1 (Tue 04 Jul 2006 04:58:36 PM EEST)
UpnpSendActionExAsync sends a message to change a state variable in a service, generating a callback when the operation is complete.
UpnpSendActionExAsync sends a message to change a state variable in a service, generating a callback when the operation is complete. See UpnpSendAction for comments on positive return values. These positive return values are sent in the event struct associated with the UPNP_CONTROL_ACTION_COMPLETE event.
Search for a particular device type or a particular device instance.
Search for a particular device type or a particular device instance.
UpnpMakeActionResponse creates an action response packet based on its output parameters (status variable name and value pair).
UpnpMakeActionResponse creates an action response packet based on its output parameters (status variable name and value pair). Any number of input parameters can be passed to this function but every output variable name should have a matching value argument.
UpnpResolveURL combines a base URL and a relative URL into a single absolute URL.
UpnpResolveURL combines a base URL and a relative URL into a single absolute URL. The memory for AbsURL needs to be allocated by the caller and must be large enough to hold the BaseURL and RelURL combined.
UpnpAddToActionResponse creates an action response packet based on its output parameters (status variable name and value pair).
UpnpAddToActionResponse creates an action response packet based on its output parameters (status variable name and value pair). This API is especially suitable inside a loop to add any number of input parameters into an existing action response. If no action document exists in the beginning, a Upnp_Document variable initialized with NULL should be passed as a parameter.
UpnpRenewSubscription renews a subscription that is about to expire.
UpnpRenewSubscription renews a subscription that is about to expire. This function is synchronous.
The Linux SDK for UPnP Devices contains some additional, optional utility APIs that can be helpful in writing applications using the SDK. These additional APIs can be compiled out in order to save code size in the SDK. Refer to the README for details.
Search for a particular service type, possibly on a particular device type or device instance.
Search for a particular service type, possibly on a particular device type or device instance.
UpnpCreatePropertySet creates a property set message packet.
UpnpCreatePropertySet creates a property set message packet. Any number of input parameters can be passed to this function but every input variable name should have a matching value input argument.
UpnpSetVirtualDirCallbacks sets the callback function to be used to access a virtual directory.
UpnpSetVirtualDirCallbacks sets the callback function to be used to access a virtual directory. Refer to the description of UpnpVirtualDirCallbacks for a description of the functions.
UPNP_E_SOCKET_BIND signifies that the SDK had a problem binding a socket to a network interface. This occurs in any function that makes network connections, such as discovery (e.g. UpnpSearchAsync or UpnpSendAdvertisement), control (e.g. UpnpSendAction), eventing (e.g. UpnpNotify), and HTTP functions (e.g. UpnpDownloadXmlDoc).
The reason code for an event callback.
The Event parameter will be different depending on the reason for the callback. The descriptions for each event type describe the contents of the Event parameter.
UPNP_E_BAD_HTTPMSG signifies that the HTTP message contains invalid message headers. The error always refers to the HTTP message header received from the remote host. The main areas where this occurs are in SOAP control messages (e.g. UpnpSendAction), GENA subscription message (e.g. UpnpSubscribe), GENA event notifications (e.g. UpnpNotify), and HTTP transfers (e.g. UpnpDownloadXmlDoc).
UpnpOpenHttpGet gets a file specified in a URL.
UpnpOpenHttpGet gets a file specified in a URL. The SDK allocates the memory for handle and contentType, the application is responsible for freeing this memory.
Returned along with a UPNP_EVENT_SUBSCRIBE_COMPLETE or UPNP_EVENT_UNSUBSCRIBE_COMPLETE callback.
Returned along with a UPNP_EVENT_SUBSCRIBE_COMPLETE or UPNP_EVENT_UNSUBSCRIBE_COMPLETE callback.
A UpnpUnSubscribeAsync call completed.
A UpnpUnSubscribeAsync call completed. The status of the subscription is in the Event parameter as a Upnp_Event_Subscribe structure.
UPNP_E_FILE_NOT_FOUND signifies that the filename passed to one of the device registration functions was not found or was not accessible.
The description is a pointer to a character array containing the XML description document.
The description is a pointer to a character array containing the XML description document.
UpnpAddVirtualDir adds a virtual directory mapping.
UpnpAddVirtualDir adds a virtual directory mapping.All webserver requests containing the given directory are read using functions contained in a UpnpVirtualDirCallbacks structure registered via UpnpSetVirtualDirCallbacks.
UpnpSearchAsync searches for devices matching the given search target.
UpnpSearchAsync searches for devices matching the given search target. The function returns immediately and the SDK calls the default callback function, registered during the UpnpRegisterClient call, for each matching root device, device, or service. The application specifies the search type by the Target parameter.Note that there is no way for the SDK to distinguish which client instance issued a particular search. Therefore, the client can get search callbacks that do not match the original criteria of the search. Also, the application will receive multiple callbacks for each search.
UPNP_E_INVALID_ARGUMENT signifies that one or more of the parameters passed to a function is invalid. Refer to the individual function descriptions for the acceptable ranges for parameters.
Represents the reply for the current value of a state variable in an asynchronous call.
Represents the reply for the current value of a state variable in an asynchronous call.
Unregisters a root device registered with UpnpRegisterRootDevice or UpnpRegisterRootDevice2.
Unregisters a root device registered with UpnpRegisterRootDevice or UpnpRegisterRootDevice2. After this call, the UpnpDevice_Handle is no longer valid. For all advertisements that have not yet expired, the SDK sends a device unavailable message automatically.UpnpUnRegisterRootDevice is a synchronous call and generates no callbacks. Once this call returns, the SDK will no longer generate callbacks to the application.
A UpnpSendActionAsync call completed.
A UpnpSendActionAsync call completed. The Event parameter contains a pointer to a Upnp_Action_Complete structure with the results of the action.
UpnpCloseHttpPost sends and receives any pending data, closes the connection with the server, and frees memory allocated during the UpnpOpenHttpPost call.
UpnpCloseHttpPost sends and receives any pending data, closes the connection with the server, and frees memory allocated during the UpnpOpenHttpPost call.
UPNP_E_UNSUBSCRIBE_UNACCEPTED signifies that an unsubscribe request was rejected from the remote side.
Copyright (c) 2000-2003 Intel Corporation All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither name of Intel Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
UpnpUnSubscribe removes the subscription of a control point from a service previously subscribed to using UpnpSubscribe or UpnpSubscribeAsync.
UpnpUnSubscribe removes the subscription of a control point from a service previously subscribed to using UpnpSubscribe or UpnpSubscribeAsync. This is a synchronous call.
UPNP_E_CANCELED signifies that the operation was canceled. This error can be returned by any function that allows for external cancelation.
Returned when a control point application registers with UpnpRegisterClient.
Returned when a control point application registers with UpnpRegisterClient. Client handles can only be used with functions that operate with a client handle.
UPNP_E_NETWORK_ERROR signifies that a network error occurred. It is the generic error code for network problems that are not covered under one of the more specific error codes. The typical meaning is the SDK failed to read the local IP address or had problems configuring one of the sockets.
A UpnpGetServiceVarStatus call completed.
A UpnpGetServiceVarStatus call completed. The Event parameter contains a pointer to a Upnp_State_Var_Complete structure containing the value for the variable.
UpnpHttpGetProgress rettrieve progress information of a http-get transfer.
UpnpHttpGetProgress rettrieve progress information of a http-get transfer.
The functions in the SDK API can return a variety of error codes to describe problems encountered during execution. This section lists the error codes and provides a brief description of what each error code means. Refer to the documentation for each function for a description of what an error code means in that context.
UpnpSetMaxSubscriptionTimeOut sets the maximum time-out accepted for a subscription request or renewal.
UpnpSetMaxSubscriptionTimeOut sets the maximum time-out accepted for a subscription request or renewal. The default value accepts the time-out set by the control point. If a control point requests a subscription time-out less than or equal to the maximum, the SDK grants the value requested by the control point. If the time-out is greater, the SDK returns the maximum value.
UpnpCloseHttpGet closes the connection and frees memory that was allocated for the handle parameter.
UpnpCloseHttpGet closes the connection and frees memory that was allocated for the handle parameter.
UpnpWriteHttpPost sends a request to a server to copy the contents of a buffer to the URI specified in the UpnpOpenHttpPost call.
UpnpWriteHttpPost sends a request to a server to copy the contents of a buffer to the URI specified in the UpnpOpenHttpPost call.
UpnpGetServiceVarStatusAsync queries the state of a variable of a service, generating a callback when the operation is complete.
UpnpGetServiceVarStatusAsync queries the state of a variable of a service, generating a callback when the operation is complete. Note that the use of this function is deprecated by the UPnP Forum.
UPNP_E_LISTEN signifies that the SDK had a problem setting the socket to listen for incoming connections. This error only happens during initialization (i.e. UpnpInit).
UpnpSetWebServerRootDir sets the document root directory for the internal web server.
UpnpSetWebServerRootDir sets the document root directory for the internal web server. This directory is considered the root directory (i.e. "/") of the web server.This function also activates or deactivates the web server. To disable the web server, pass NULL for rootDir; to activate, pass a valid directory string.
Note that this function is not available when the web server is not compiled into the SDK.
UPNP_E_INVALID_PARAM signifies that one or more of the parameters passed to the function is not valid. Refer to the documentation for each function for more information on the valid ranges of the parameters.
Received by a device when a control point issues a control request.
Received by a device when a control point issues a control request. The Event parameter contains a pointer to a Upnp_Action_Request structure containing the action. The application stores the results of the action in this structure.
UpnpOpenHttpPost makes an HTTP POST request message, opens a connection to the server and sends the POST request to the server if the connection to the server succeeds.
UpnpOpenHttpPost makes an HTTP POST request message, opens a connection to the server and sends the POST request to the server if the connection to the server succeeds. The SDK allocates the memory for handle and contentType, the application is responsible for freeing this memory.
This document gives a brief description of the Linux SDK for UPnP Devices API. Section 1 covers the license under which the SDK is distributed. Section 2 talks about the callback functions used in many parts of the API. Finally, section 3 details the structures and functions that comprise the API.The Linux SDK for UPnP Devices version 1.2 supports the following platforms:
- Linux* running on an Intel Architecture processor
- Linux running on an Intel StrongARM or XScale processor
* Other brands and names are the property of their respective owners.
Received by a control point when an event arrives.
Received by a control point when an event arrives. The Event parameter contains a Upnp_Event structure with the information about the event.
UPNP_E_ALREADY_REGISTERED signifies that a client or a device is already registered. The SDK currently has a limit of one registered client and one registered device per process.
Returned along with a UPNP_EVENT_RECEIVED callback.
Returned along with a UPNP_EVENT_RECEIVED callback.
UpnpCancelHttpGet set the cancel flag of the handle parameter.
UpnpCancelHttpGet set the cancel flag of the handle parameter.
If NULL is used as the IP address in UpnpInit, then this function can be used to retrieve the actual interface address on which device is running.
If NULL is used as the IP address in UpnpInit, then this function can be used to retrieve the actual interface address on which device is running. If UpnpInit has not succeeded then NULL is returned.
UPNP_E_BAD_RESPONSE signifies that the response received from the remote side of a connection is not correct for the protocol. This applies to the GENA, SOAP, and HTTP protocols.
A client subscription has expired.
A client subscription has expired. This will only occur if auto-renewal of subscriptions is disabled. The Event parameter is a Upnp_Event_Subscribe structure. The subscription is no longer valid.
UpnpSetMaxSubscriptions sets the maximum number of subscriptions accepted per service.
UpnpSetMaxSubscriptions sets the maximum number of subscriptions accepted per service. The default value accepts as many as system resources allow. If the number of current subscriptions for a service is greater than the requested value, the SDK accepts no new subscriptions or renewals, however, the SDK does not remove any current subscriptions.
UpnpSendActionEx sends a message to change a state variable in a service.
UpnpSendActionEx sends a message to change a state variable in a service. This is a synchronous call that does not return until the action is complete.Note that a positive return value indicates a SOAP-protocol error code. In this case, the error description can be retrieved from RespNode. A negative return value indicates an SDK error.
UpnpIsWebServerEnabled returns TRUE if the webserver is enabled, or FALSE if it is not.
UpnpIsWebServerEnabled returns TRUE if the webserver is enabled, or FALSE if it is not.
UpnpAddToPropertySet can be used when an application needs to transfer the status of many variables at once.
UpnpAddToPropertySet can be used when an application needs to transfer the status of many variables at once. It can be used (inside a loop) to add some extra status variables into an existing property set. If the application does not already have a property set document, the application should create a variable initialized with NULL and pass that as the first parameter.
Returned as part of a UPNP_CONTROL_ACTION_COMPLETE callback.
Returned as part of a UPNP_CONTROL_ACTION_COMPLETE callback.
OBSOLETE METHOD : use UpnpSetMaxContentLength instead.
OBSOLETE METHOD : use UpnpSetMaxContentLength instead. Warning: the Handle argument provided here is not used, so the effect of this function is global to the SDK (= same as UpnpSetMaxContentLength ).
UpnpRegisterRootDevice registers a device application with the SDK.
UpnpRegisterRootDevice registers a device application with the SDK. A device application cannot make any other API calls until it registers using this function. Device applications can also register as control points (see UpnpRegisterClient to get a control point handle to perform control point functionality).UpnpRegisterRootDevice is synchronous and does not generate any callbacks. Callbacks can occur as soon as this function returns.
UpnpUnRegisterClient unregisters a control point application, unsubscribing all active subscriptions.
UpnpUnRegisterClient unregisters a control point application, unsubscribing all active subscriptions. After this call, the UpnpClient_Handle is no longer valid.UpnpUnRegisterClient is a synchronous call and generates no callbacks. The SDK generates no more callbacks after this function returns.
Returned when a device application registers with UpnpRegisterRootDevice or UpnpRegisterRootDevice2.
Returned when a device application registers with UpnpRegisterRootDevice or UpnpRegisterRootDevice2. Device handles can only be used with functions that operate with a device handle.
UpnpRegisterRootDevice2 is similar to UpnpRegisterRootDevice, except that it also allows the description document to be specified as a file or a memory buffer.
UpnpRegisterRootDevice2 is similar to UpnpRegisterRootDevice, except that it also allows the description document to be specified as a file or a memory buffer. The description can also be configured to have the correct IP and port address.NOTE: For the configuration to be functional, the internal web server MUST be present. In addition, the web server MUST be activated (using UpnpSetWebServerRootDir) before calling this function. The only condition where the web server can be absent is if the description document is specified as a URL and no configuration is required (i.e. config_baseURL = 0.)
UpnpRegisterRootDevice2 is synchronous and does not generate any callbacks. Callbacks can occur as soon as this function returns.
Examples of using different types of description documents:
1) Description specified as a URL: descriptionType == UPNPREG_URL_DESC description is the URL bufferLen = 0 (ignored) 2) Description specified as a file: descriptionType == UPNPREG_FILENAME_DESC description is a filename bufferLen = 0 (ignored) 3) Description specified as a memory buffer: descriptionType == UPNPREG_BUF_DESC description is pointer to a memory buffer bufferLen == length of memory buffer
UpnpAcceptSubscriptionExt is similar to UpnpAcceptSubscription except that it takes a DOM document for the variables to event rather than an array of strings.
UpnpAcceptSubscriptionExt is similar to UpnpAcceptSubscription except that it takes a DOM document for the variables to event rather than an array of strings. This function is sychronous and generates no callbacks.UpnpAcceptSubscriptionExt can be called during the execution of a callback function.
The Linux SDK for UPnP Devices contains functions that generate asynchronous callbacks. To simplify the application callback functions, these callbacks are executed on a thread owned by the SDK itself. The SDK executes the application's callback function in a thread context so the application can allocate memory and preserve the information it needs. The application can also use standard thread synchronization methods to ensure data integrity. Due to the possibility of deadlock, the application cannot call back into the SDK during these callbacks unless explicitly noted. There is no restriction in calling into the operating system or any other application interfaces.
UpnpRegisterClient registers a control point application with the SDK.
UpnpRegisterClient registers a control point application with the SDK. A control point application cannot make any other API calls until it registers using this function.UpnpRegisterClient is a synchronous call and generates no callbacks. Callbacks can occur as soon as this function returns.
Terminates the Linux SDK for UPnP Devices.
Terminates the Linux SDK for UPnP Devices. This function must be the last API function called. It should be called only once. Subsequent calls to this API return a UPNP_E_FINISH error code.
UpnpRemoveAllVirtualDirs removes all virtual directory mappings.
UpnpRemoveAllVirtualDirs removes all virtual directory mappings.
The UpnpVirtualDirCallbacks structure contains the pointers to file-related callback functions a device application can register to virtualize URLs.
The UpnpVirtualDirCallbacks structure contains the pointers to file-related callback functions a device application can register to virtualize URLs.
The auto-renewal of a client subscription failed.
The auto-renewal of a client subscription failed. The Event parameter is a Upnp_Event_Subscribe structure with the error code set appropriately. The subscription is no longer valid.
UpnpNotifyExt is similar to UpnpNotify except that it takes a DOM document for the event rather than an array of strings.
UpnpNotifyExt is similar to UpnpNotify except that it takes a DOM document for the event rather than an array of strings. This function is synchronous and generates no callbacks.UpnpNotifyExt may be called during a callback function to send out a notification.
UPNP_E_TIMEDOUT signifies that too much time elapsed before the required number of bytes were sent or received over a socket. This error can be returned by any function that performs network operations.
Specifies the type of description in UpnpRegisterRootDevice2.
These values control how UpnpRegisterRootDevice2 interprets the description parameter.
UPNP_E_OUTOF_HANDLE signifies that the SDK does not have any more space for additional handles. The SDK allocates space for only a few handles in order to conserve memory.
Search for all root devices on the network.
Search for all root devices on the network.
Represents the different types of searches that can be performed using the SDK for UPnP Devices API.
By specifying these different values to UpnpSearchAsync, the control point application can control the scope of the search from all devices to specific devices or services.
UPNP_E_EXT_NOT_XML signifies that the file name of the description document passed to UpnpRegisterRootDevice2 does not end in ".xml".
UpnpRenewSubscriptionAsync renews a subscription that is about to expire, generating a callback when the operation is complete.
UpnpRenewSubscriptionAsync renews a subscription that is about to expire, generating a callback when the operation is complete.Note that many of the error codes for this function are returned in the Upnp_Event_Subscribe structure. In those cases, the function returns UPNP_E_SUCCESS and the appropriate error code will be in the Upnp_Event_Subscribe.ErrCode field in the Event structure passed to the callback.
UpnpMakeAction creates an action request packet based on its input parameters (status variable name and value pair).
UpnpMakeAction creates an action request packet based on its input parameters (status variable name and value pair). Any number of input parameters can be passed to this function but every input variable name should have a matching value argument.
UpnpAcceptSubscription accepts a subscription request and sends out the current state of the eventable variables for a service.
UpnpAcceptSubscription accepts a subscription request and sends out the current state of the eventable variables for a service. The device application should call this function when it receives a UPNP_EVENT_SUBSCRIPTION_REQUEST callback. This function is synchronous and generates no callbacks.UpnpAcceptSubscription can be called during the execution of a callback function.
Received by a control point when the search timeout expires.
Received by a control point when the search timeout expires. The SDK generates no more callbacks for this search after this event. The Event parameter is NULL.
A UpnpRenewSubscriptionAsync call completed.
A UpnpRenewSubscriptionAsync call completed. The status of the renewal is in the Event parameter as a Upnp_Event_Subscription structure.
Returned along with a UPNP_EVENT_SUBSCRIPTION_REQUEST callback.
Returned along with a UPNP_EVENT_SUBSCRIPTION_REQUEST callback.
UpnpGetServiceVarStatus queries the state of a state variable of a service on another device.
UpnpGetServiceVarStatus queries the state of a state variable of a service on another device. This is a synchronous call. A positive return value indicates a SOAP error code, whereas a negative return code indicates an SDK error code. Note that the use of this function is deprecated by the UPnP Forum.
UPNP_E_INVALID_ACTION signifies that the SOAP action message is invalid. This can be because the DOM document passed to the function was malformed or the action message is not correct for the given action.
UPNP_E_FILE_READ_ERROR signifies an error when reading a file.
UpnpEnableWebServer enables or disables the webserver.
UpnpEnableWebServer enables or disables the webserver. A value of TRUE enables the webserver, FALSE disables it.
UPNP_E_INVALID_HANDLE signifies that the handle passed to a function is not a recognized as a valid handle.