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
 這個物件不支援屬性識別碼，或指定的緩衝區不足以表示值。
E_OUTOFMEMORY
 應用程式記憶體不足。
其他錯誤
此函式可能會傳回上面未列出的其他錯誤。

規格需求

   
最低支援的用戶端 Windows 7 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2008 R2 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 webservices.h
程式庫 WebServices.lib
Dll WebServices.dll