WsSetFaultErrorDetail 函数 (webservices.h)

写入存储在 WS_ERROR 对象中的错误详细信息。

语法

HRESULT WsSetFaultErrorDetail(
  [in] WS_ERROR                          *error,
  [in] const WS_FAULT_DETAIL_DESCRIPTION *faultDetailDescription,
  [in] WS_WRITE_OPTION                   writeOption,
       const void                        *value,
  [in] ULONG                             valueSize
);

参数

[in] error

将包含错误信息的错误对象。

[in] faultDetailDescription

指向错误详细信息说明的指针。

如果错误详细信息说明的操作字段为非 NULL,则将其设置为WS_ERROR的WS_FAULT_ERROR_PROPERTY_ACTION

故障详细信息说明的元素说明描述错误详细信息中元素的格式。

[in] writeOption

有关如何分配值的信息。 有关详细信息 ,请参阅WS_WRITE_OPTION

value

指向要序列化的值的指针。

[in] valueSize

要序列化的值的大小(以字节为单位)。

如果值为 NULL,则大小应为 0。

返回值

此函数可以返回其中一个值。

返回代码 说明
WS_E_INVALID_FORMAT
输入数据未采用预期格式或没有预期值。
E_INVALIDARG
一个或多个参数无效。
E_OUTOFMEMORY
内存不足。

注解

此 API 将序列化存储在 WS_ERROR 对象中的WS_FAULT的详细信息字段的值。

此函数根据提供的WS_FAULT_DETAIL_DESCRIPTION中WS_ELEMENT_DESCRIPTION的内容支持以下方案:

  • 写入单个元素。 在这种情况下, 应将WS_ELEMENT_DESCRIPTION 的 elementLocalName 和 elementNs 字段设置为要写入的元素的本地名称和命名空间,并且类型和类型说明表示要序列化的值的类型。
  • 将多个元素作为单个值写入。 在这种情况下,应将 WS_ELEMENT_DESCRIPTION 的 elementLocalName 和 elementNs 字段设置为 NULL,并指定 WS_STRUCT_TYPEWS_STRUCT_DESCRIPTION 。 要序列化的结构值的每个字段都应对应于要在错误详细信息中写入的元素 () 。 writeOption 参数必须是 WS_WRITE_REQUIRED_VALUEWS_WRITE_REQUIRED_POINTER

要求

要求
最低受支持的客户端 Windows 7 [桌面应用 |UWP 应用]
最低受支持的服务器 Windows Server 2008 R2 [桌面应用 |UWP 应用]
目标平台 Windows
标头 webservices.h
Library WebServices.lib
DLL WebServices.dll