Edit

Share via

IUPnPServiceAsync::EndInvokeAction method (upnp.h)

  • Article

The EndInvokeAction method retrieves the results of a previous BeginInvokeAction operation and retrieves the resultant output arguments.

Syntax

HRESULT EndInvokeAction(
  [in, out] ULONG64 ullRequestID,
  [in, out] VARIANT *pvOutActionArgs,
  [in]      VARIANT *pvRetVal
);

Parameters

[in, out] ullRequestID

On input, contains a reference to an empty array. On output, receives a reference to the array of service-specific output arguments. In the event the action doesn't have output arguments, this parameter contains an empty array.

Note  Clear this parameter with VariantClear.
 

[in, out] pvOutActionArgs

On input contains a reference to an empty array. On output, receives a reference to a VARIANT that contains the return value of the invoked action.

Note  Clear this parameter with VariantClear.
 

[in] pvRetVal

A 64-bit ULONG value that corresponds to the BeginInvokeAction operation initiated 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
UPNP_E_DEVICE_TIMEOUT
 The device has not responded within the 30 second time-out period.
UPNP_E_DEVICE_ERROR
 An unknown error has occurred.
UPNP_E_INVALID_ARGUMENTS
 One or more of the arguments passed is invalid.
UPNP_E_INVALID_ACTION
 This action is not supported by the device.
UPNP_E_ERROR_PROCESSING_RESPONSE
 The device has sent a response that cannot be processed; for example, the response was corrupted.
UPNP_E_PROTOCOL_ERROR
 An error occurred at the UPnP control-protocol level.
UPNP_E_TRANSPORT_ERROR
 An HTTP error occurred. Use the IUPnPService::LastTransportStatus property to obtain the actual HTTP status code.
Note  This error code is also returned when the SOAP response exceeds 100 kilobytes.
 
 
Note  Some values can indicate that an error was received from a UPnP-certified device. For more information, see Device Error Codes.
 

Requirements

Requirement Value
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

IUPnPService::LastTransportStatus

IUPnPServiceAsync

IUPnPServiceAsync::BeginInvokeAction