WSDGenerateFault 函数 (wsdutil.h)

生成 SOAP 错误。

语法

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

参数

[in] pszCode

SOAP 错误代码。

以下列出了可能的故障代码。 有关每个故障代码的说明,请参阅 SOAP 版本 1.2 规范

VersionMismatch

MustUnderstand

DataEncodingUnknown

发送方

接收方

[in] pszSubCode

故障子代码。

[in] pszReason

故障的人类可读解释。

[in] pszDetail

包含与错误相关的特定于应用程序的错误信息。

[in] pContext

一个 IWSDXMLContext 接口,表示要在其中生成错误的上下文。

[out] ppFault

包含生成的错误的 WSD_SOAP_FAULT 结构。 当调用应用程序使用此数据完成时,必须通过调用 WSDFreeLinkedMemory 来释放 ppFault

返回值

可能的返回值包括但不限于以下内容:

返回代码 说明
S_OK
方法已成功完成。
E_INVALIDARG
pszCodepszReasonpContextNULL
E_POINTER
ppFaultNULL

注解

SOAP 错误提供了一种在失败的 SOAP 消息上传达错误信息的方法。 不同的 Web 服务协议扩展错误以提供上下文错误信息,在某些情况下(例如在 WS-Eventing 中),当客户端确定设备是否支持特定功能时,错误是特定消息模式的预期部分。

WSDAPI 不实现以下故障子代码:

  • InvalidMessageInformationHeader
  • MessageInformationHeaderRequired
  • UnsupportedExpirationType
  • InvalidMessage
  • FilteringNotSupported

要求

   
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 wsdutil.h (包括 Wsdapi.h)
Library Wsdapi.lib
DLL Wsdapi.dll