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