Skip to content

Latest commit

 

History

History
209 lines (179 loc) · 5.06 KB

nf-upnp-iupnpdescriptiondocument-load.md

File metadata and controls

209 lines (179 loc) · 5.06 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:upnp.IUPnPDescriptionDocument.Load
IUPnPDescriptionDocument::Load (upnp.h)
The Load method loads a document synchronously. This method does not return control to the caller until the load operation is complete.
IUPnPDescriptionDocument interface [UPnP APIs]
Load method
IUPnPDescriptionDocument.Load
IUPnPDescriptionDocument::Load
Load
Load method [UPnP APIs]
Load method [UPnP APIs]
IUPnPDescriptionDocument interface
_upnp_iupnpdescriptiondocument_load
upnp.iupnpdescriptiondocument_load
upnp/IUPnPDescriptionDocument::Load
upnp\iupnpdescriptiondocument_load.htm
upnp
02ae8af2-44f2-4b7c-a426-f2a26c43da37
12/05/2018
IUPnPDescriptionDocument interface [UPnP APIs],Load method, IUPnPDescriptionDocument.Load, IUPnPDescriptionDocument::Load, Load, Load method [UPnP APIs], Load method [UPnP APIs],IUPnPDescriptionDocument interface, _upnp_iupnpdescriptiondocument_load, upnp.iupnpdescriptiondocument_load, upnp/IUPnPDescriptionDocument::Load
upnp.h
Windows
Windows XP [desktop apps only]
None supported
Upnp.dll
Windows
19H1
IUPnPDescriptionDocument::Load
upnp/IUPnPDescriptionDocument::Load
c++
APIRef
kbSyntax
COM
Upnp.dll
IUPnPDescriptionDocument.Load

IUPnPDescriptionDocument::Load

-description

The Load method loads a document synchronously. This method does not return control to the caller until the load operation is complete.

-parameters

-param bstrUrl [in]

Specifies the URL of the document to load.

-returns

If the method succeeds, the return value is S_OK. Otherwise, the method returns one of the COM error codes defined in WinError.h, or one of the following UPnP return values.

Return code Description
UPNP_E_DEVICE_ELEMENT_EXPECTED
XML document does not have a device element. It is missing either from the root element or the DeviceList element.
UPnP_E_DEVICE_ELEMENT_EXPECTED
There is no Device element in the specified description document.
UPNP_E_DEVICE_NODE_INCOMPLETE
XML document is missing one of the required elements from the Device element.
UPNP_E_ICON_ELEMENT_EXPECTED
XML document does not have an icon element. It is missing from the IconList element, or the DeviceList element does not contain an IconList element.
UPnP_E_ICON_ELEMENT_EXPECTED
There is no Icon element in the specified description document.
UPNP_E_ICON_NODE_INCOMPLETE
XML document is missing one of the required elements from the Icon element.
UPnP_E_ICON_NODE_INCOMPLETE
There is no Icon Node in the specified description document.
UPNP_E_ROOT_ELEMENT_EXPECTED
XML document does not have a root element at the top level of the document.
UPnP_E_ROOT_ELEMENT_EXPECTED
There is no Root element in the specified description document.
UPNP_E_SERVICE_ELEMENT_EXPECTED
XML document does not have a service element. It is missing from the ServiceList element, or the DeviceList element does not contain a ServiceList element.
UPNP_E_SERVICE_NODE_INCOMPLETE
XML document is missing one of the required elements from the Service element.

-remarks

This method should not be called from a user interface thread because it can take a long time for the method to return.

If the Load method is called by a script within a Web page, bstrUrl may be a relative URL. The address of the current web page is used as the base URL.

If this method is called from a Web page, the URL the caller specifies must refer to the same server from which the Web page was loaded.

-see-also

IUPnPDescriptionDocument

IUPnPDescriptionDocument::LoadAsync