IRenderingControl::InvokeVendorAction (Windows Embedded CE 6.0)

1/6/2010

This method enables RenderingControl implementations and users to provide and invoke custom vendor-specific actions that are not defined in the RenderingControl DCP.

Syntax

virtual DWORD InvokeVendorAction(
  LPCWSTR pszActionName,
  DISPPARAMS* pdispparams, 
  VARIANT* pvarResult
) = 0;

Parameters

• pszActionName
  [in] Name of the vendor-specific action.

• pdispparams
  [in] Pointer to a DISPPARAMS structure that contains input and/or output parameters used by the vendor-specific action.

• pvarResult
  [in, out] Pointer to a VARIANT that the implementation of this method can use to return the results of the specified action. Implementations can also use output parameters in the pdispparams parameter.

Return Value

Custom implementations can return appropriate error codes. Should return SUCCESS_AV if the method succeeds. Otherwise, should return an error code defined in WinError.h or UPnP.h, one of the UPnP AV-specific return values specified in UPnPAVError, or a custom error code defined by the action.

Remarks

Devices implement this method to provide custom vendor-specific actions. In addition to implementing this method, follow all of the other standard processes for extending UPnP DCPs, including updating the service description XML documents, and so on.

Control points call this method to invoke custom vendor-specific actions.

For more information about implementing and calling custom actions, see Implementing and Calling Custom Actions.

The RenderingControl service does not require that this method be implemented. The IRenderingControlImpl class therefore overrides this method to return ERROR_AV_UPNP_INVALID_ACTION.

For more information about implementing custom vendor-specific actions, see UPnP AV DCP Documentation.

Requirements

See Also

Reference

IRenderingControl
IRenderingControlImpl
UPnPAVError

Other Resources

DISPPARAMS
VARIANT and VARIANTARG