WsCreateMessage 関数 (webservices.h)

  • [アーティクル]

指定したプロパティを持つ メッセージ オブジェクトを作成します。

構文

HRESULT WsCreateMessage(
  [in]           WS_ENVELOPE_VERSION       envelopeVersion,
  [in]           WS_ADDRESSING_VERSION     addressingVersion,
                 const WS_MESSAGE_PROPERTY *properties,
  [in]           ULONG                     propertyCount,
                 WS_MESSAGE                **message,
  [in, optional] WS_ERROR                  *error
);

パラメーター

[in] envelopeVersion

メッセージのエンベロープのバージョンを指定する WS_ENVELOPE_VERSION 列挙値。

[in] addressingVersion

メッセージのアドレス指定のバージョンを指定する WS_ADDRESSING_VERSION 。

properties

メッセージの省略可能なプロパティの配列。 「WS_MESSAGE_PROPERTY」を参照してください。

このパラメーターの値は NULL である可能性があります。この場合、 propertyCount パラメーターは 0 (ゼロ) である必要があります。

[in] propertyCount

プロパティ配列内の プロパティ の数。

message

成功した場合、新しいメッセージを表す WS_MESSAGE 構造体のアドレスを受け取るポインター。

この構造体が不要になった場合は、 WsFreeMessage を呼び出して解放する必要があります。

[in, optional] error

関数が失敗した場合に追加のエラー情報を受け取る WS_ERROR 構造体へのポインター。

戻り値

関数が成功した場合は、NO_ERRORを返します。それ以外の場合は、HRESULT エラー コードを返します。

リターン コード 説明
E_OUTOFMEMORY
 操作を完了するためのメモリ不足。
E_INVALIDARG
 1 つ以上の引数が無効です。
その他のエラー
この関数は、上記以外のエラーを返す場合があります。

注釈

メッセージ オブジェクトは、Windows Web サービスの配信手段です。 1 つのメッセージ オブジェクトを使用して、シーケンシャル メッセージを送受信できます。 この方法でメッセージ オブジェクトを再利用すると、メモリ割り当てを減らすことができます。 メッセージが不要になった場合は、 WsFreeMessage を呼び出してメモリを解放する必要があります。 (メッセージ オブジェクトの再利用の詳細については、「 WsResetMessage 」を参照してください)。

特定のチャネルで使用するメッセージを作成する場合は、 WsCreateMessageForChannel 関数を使用します。これにより、チャネルの正しいメッセージ バージョンが保証されます。

要件

要件 値
サポートされている最小のクライアント Windows 7 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー webservices.h
Library WebServices.lib
[DLL] WebServices.dll