Edit

Share via

IWSDServiceMessaging::FaultRequest method (wsdhost.h)

  • Article

Sends a fault matching a given request context. This method should be called only from generated code.

Syntax

HRESULT FaultRequest(
  [in]           WSD_SOAP_HEADER       *pRequestHeader,
  [in]           IWSDMessageParameters *pMessageParameters,
  [in, optional] WSD_SOAP_FAULT        *pFault
);

Parameters

[in] pRequestHeader

Pointer to a WSD_SOAP_HEADER structure that contains the SOAP header of the original request that caused the fault.

[in] pMessageParameters

Pointer to an IWSDMessageParameters object that contains the message parameters for the original request that caused the fault.

[in, optional] pFault

Pointer to a WSD_SOAP_FAULT structure that describes the fault to serialize and send. If this parameter is omitted, a fault of type wsa:EndpointUnavailable will be sent.

Return value

Possible return values include, but are not limited to, the following.

Return code Description
S_OK
 Method succeeded.
E_INVALIDARG
 pRequestHeader or pMessageParameters is NULL.
E_ABORT
 The method could not be completed.
E_OUTOFMEMORY
 Insufficient memory to complete the operation.
E_FAIL
 The method failed.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wsdhost.h (include Wsdapi.h)
DLL Wsdapi.dll

See also

IWSDServiceMessaging