Edit

Share via

WSDGenerateFault function (wsdutil.h)

  • Article

Generates a SOAP fault.

Syntax

HRESULT WSDGenerateFault(
  [in]  LPCWSTR        pszCode,
  [in]  LPCWSTR        pszSubCode,
  [in]  LPCWSTR        pszReason,
  [in]  LPCWSTR        pszDetail,
  [in]  IWSDXMLContext *pContext,
  [out] WSD_SOAP_FAULT **ppFault
);

Parameters

[in] pszCode

A SOAP fault code.

The list of possible fault codes follows. For a description of each fault code, see the SOAP Version 1.2 specification.

VersionMismatch

MustUnderstand

DataEncodingUnknown

Sender

Receiver

[in] pszSubCode

A fault subcode.

[in] pszReason

A human readable explanation of the fault.

[in] pszDetail

Contains application-specific error information pertaining to the fault.

[in] pContext

An IWSDXMLContext interface that represents the context in which to generate the fault.

[out] ppFault

A WSD_SOAP_FAULT structure that contains the generated fault. When the calling application is done with this data, ppFault must be freed with a call to WSDFreeLinkedMemory.

Return value

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

Return code Description
S_OK
 Method completed successfully.
E_INVALIDARG
 pszCode, pszReason, or pContext is NULL.
E_POINTER
 ppFault is NULL.

Remarks

SOAP faults provide a way to communicate error information on failed SOAP messages. Different Web Services protocols extend faults to provide contextual error information, and in some cases, like in WS-Eventing, faults are an expected part of specific message patterns as the client determines whether or not the device supports specific features.

The following fault subcodes are not implemented by WSDAPI:

  • InvalidMessageInformationHeader
  • MessageInformationHeaderRequired
  • UnsupportedExpirationType
  • InvalidMessage
  • FilteringNotSupported

Requirements

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