IUPnPServiceAsync::BeginSCPDDownload method (upnp.h)

The BeginSCPDDownload method initiates the asynchronous download of an Service Control Protocol Description (SCPD) document.

Syntax

HRESULT BeginSCPDDownload(
  [in, optional] IUPnPAsyncResult *pAsyncResult,
  [out]          PULONG64         pullRequestID
);

Parameters

[in, optional] pAsyncResult

Specifies a pointer to an IUPnPAsyncResult object. When the BeginSCPDDownload call is complete, UPnP will use the IUPnPAsyncResult::AsyncOperationComplete method to notify the control point.

[out] pullRequestID

Pointer to a 64-bit ULONG value used to identify the BeginSCPDDownload operation requested prior to this call.

Return value

Returns S_OK on success. Otherwise, the method returns a COM error code defined in WinError.h or one of the following values:

Return code Description
E_FAIL
Failed to initiate the SCPD download.
E_INVALIDARG
pAsyncResult is invalid.

Requirements

   
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header upnp.h
DLL Upnp.dll

See also

IUPnPAsyncResult::AsyncOperationComplete

IUPnPServiceAsync

IUPnPServiceAsync::BeginInvokeAction