WsGetMessageProperty 函数 (webservices.h)

  • 项目

检索指定的 Message 对象属性。 要检索的属性由 WS_MESSAGE_PROPERTY_ID 输入参数标识。

语法

HRESULT WsGetMessageProperty(
  [in]           WS_MESSAGE             *message,
  [in]           WS_MESSAGE_PROPERTY_ID id,
                 void                   *value,
  [in]           ULONG                  valueSize,
  [in, optional] WS_ERROR               *error
);

参数

[in] message

指向包含所需属性 的 Message 对象的指针。 此参数必须是有效的 WS_LISTENER 对象。

[in] id

这是标识所需属性 的WS_MESSAGE_PROPERTY_ID 枚举器值。

value

对存储检索到的属性值的位置的引用。 指针必须具有与 属性类型兼容的对齐方式。

[in] valueSize

调用方为存储检索的属性值分配的字节长度缓冲区大小。

[in, optional] error

指向 WS_ERROR 对象的指针，如果函数失败，应存储有关错误的其他信息。

返回值

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

返回代码 说明
E_INVALIDARG
 此对象不支持属性 ID，或者指定的缓冲区不足以容纳值。
E_OUTOFMEMORY
 应用程序内存不足。
其他错误
此函数可能会返回上面未列出的其他错误。

要求

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