Share via

WSDGenerateFaultEx (Compact 2013)

  • Article

3/26/2014

This function generates a SOAP fault.

Syntax

HRESULT WSDGenerateFaultEx(
  WSDXML_NAME* pCode,
  WSDXML_NAME* pSubCode,
  WSD_LOCALIZED_STRING_LIST* pReasons,
  const LPCWSTR* pszDetail,
  WSD_SOAP_FAULT** ppFault
);

Parameters

  • pCode
    [in] 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 at this World Wide Web Consortium Web site.

    • VersionMismatch
    • MustUnderstand
    • DataEncodingUnknown
    • Sender
    • Receiver
  • pSubCode
    [in] A fault subcode.
  • pszDetail
    [in] Contains application-specific error information pertaining to the fault.
  • ppFault
    [out] A WSD_SOAP_FAULT structure that contains the generated fault.

Return Value

The following table shows the possible error code return values.

Error Code

Description

S_OK

The function succeeded.

E_INVALIDARG

pCode or pReasons 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

Header

wsdapi.h

Library

wsdapi.lib

See Also

Reference

Web Services on Devices Functions
Web Services on Devices Reference