WsRequestReply 関数 (webservices.h)

  • [アーティクル]

要求メッセージを送信し、相関応答メッセージを受信するために使用されます。

構文

HRESULT WsRequestReply(
  [in]           WS_CHANNEL                   *channel,
  [in]           WS_MESSAGE                   *requestMessage,
  [in]           const WS_MESSAGE_DESCRIPTION *requestMessageDescription,
  [in]           WS_WRITE_OPTION              writeOption,
                 const void                   *requestBodyValue,
  [in]           ULONG                        requestBodyValueSize,
  [in]           WS_MESSAGE                   *replyMessage,
  [in]           const WS_MESSAGE_DESCRIPTION *replyMessageDescription,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
  [in, optional] const WS_ASYNC_CONTEXT       *asyncContext,
  [in, optional] WS_ERROR                     *error
);

パラメーター

[in] channel

要求/応答操作を実行するチャネル。

[in] requestMessage

要求の送信に使用するメッセージ オブジェクト。

メッセージ オブジェクトは 、WS_MESSAGE_STATE_EMPTY または WS_MESSAGE_STATE_INITIALIZED内にある必要があります。

[in] requestMessageDescription

WS_MESSAGE_DESCRIPTIONのアクション フィールドは、要求メッセージのアクション ヘッダーとして使用されます。 アクションが必要ない場合、このフィールドは NULL になる可能性があります。

WS_MESSAGE_DESCRIPTIONの bodyElementDescription フィールドは、要求メッセージの本文をシリアル化するために使用されます。 body 要素が必要ない場合、このフィールドは NULL になります。 bodyElementDescription に従って本文をシリアル化する方法については、「 WsWriteBody 」を参照してください。

[in] writeOption

body 要素が必要かどうか、および値の割り当て方法。 詳細については、「 WS_WRITE_OPTION 」を参照してください。

requestBodyValue

要求オブジェクトの本文でシリアル化する値へのポインター。

[in] requestBodyValueSize

シリアル化される要求値のサイズ (バイト単位)。

[in] replyMessage

応答の受信に使用するメッセージ オブジェクト。

メッセージ オブジェクトは 、WS_MESSAGE_STATE_EMPTYに存在する必要があります。

[in] replyMessageDescription

WS_MESSAGE_DESCRIPTIONのアクション フィールドは、受信した応答メッセージのアクション ヘッダーを確認するために使用されます。 アクションが必要ない場合、このフィールドは NULL になる可能性があります。 NULL の場合、受信したメッセージのアクション ヘッダーが存在する場合は無視されます。

WS_MESSAGE_DESCRIPTIONの bodyElementDescription フィールドは、応答メッセージの本文を逆シリアル化するために使用されます。 body 要素が必要ない場合、このフィールドは NULL になります。 bodyElementDescription に従って本文を逆シリアル化する方法については、「 WsReadBody 」を参照してください。

[in] readOption

応答本文要素が必要かどうか、および値を割り当てる方法。 詳細については、「 WS_READ_OPTION と WsReadBody」を参照してください。

[in, optional] heap

逆シリアル化された応答本文の値を割り当てるために使用されるヒープ。 指定した型にヒープが必要ない場合は、このパラメーターを NULL にすることができます。

value

本文の逆シリアル化された値を格納する場所。

このパラメーターの解釈は 、WS_READ_OPTIONによって異なります。

応答 WS_MESSAGE_DESCRIPTION の bodyElementDescription が NULL の場合、このパラメーターはタッチされません。 この場合、 パラメーターを指定する必要はありません。

[in] valueSize

このパラメーターの解釈は 、WS_READ_OPTIONによって異なります。

[in, optional] asyncContext

関数を非同期で呼び出す方法に関する情報。同期的に呼び出す場合は NULL 。

[in, optional] error

関数が失敗した場合に追加のエラー情報を格納する場所を指定します。

戻り値

この関数は、これらの値のいずれかを返すことができます。

リターン コード 説明
WS_E_ENDPOINT_FAULT_RECEIVED
 応答メッセージにエラーが含まれていました。 エラーは、WsGetErrorProperty を使用してWS_ERRORから抽出できます。
WS_S_ASYNC
 非同期操作はまだ保留中です。
WS_E_OPERATION_ABORTED
 操作が中止されました。
WS_E_INVALID_OPERATION
 オブジェクトの現在の状態のため、操作は許可されません。
WS_E_ENDPOINT_NOT_FOUND
 リモート エンドポイントが存在しないか、見つかりませんでした。
WS_E_ENDPOINT_ACCESS_DENIED
 リモート エンドポイントによってアクセスが拒否されました。
WS_E_ENDPOINT_DISCONNECTED
 リモート エンドポイントとの接続が終了しました。
WS_E_ENDPOINT_FAILURE
 リモート エンドポイントで要求を処理できませんでした。
WS_E_ENDPOINT_NOT_AVAILABLE
 リモート エンドポイントは現在、この場所でサービスを提供していません。
WS_E_ENDPOINT_TOO_BUSY
 オーバーロードされているため、リモート エンドポイントで要求を処理できません。
WS_E_ENDPOINT_UNREACHABLE
 リモート エンドポイントに到達できませんでした。
WS_E_INVALID_ENDPOINT_URL
 エンドポイント アドレス URL が無効です。
WS_E_INVALID_FORMAT
 入力データが予期された形式でなかったか、予期された値を持っていませんでした。
WS_E_OPERATION_TIMED_OUT
 割り当てられた時間内に操作が完了しませんでした。
WS_E_PROXY_ACCESS_DENIED
 HTTP プロキシ サーバーによってアクセスが拒否されました。
WS_E_PROXY_FAILURE
 HTTP プロキシ サーバーが要求を処理できませんでした。
WS_E_QUOTA_EXCEEDED
 クォータを超えました。
WS_E_SECURITY_VERIFICATION_FAILURE
 受信したデータのセキュリティ検証が成功しなかった。
WS_E_SECURITY_SYSTEM_FAILURE
 Windows Web Services フレームワークでセキュリティ操作が失敗しました。
WS_E_SECURITY_TOKEN_EXPIRED
 セキュリティ トークンの有効期限が切れたため、サーバーによって拒否されました。
WS_E_PROXY_REQUIRES_BASIC_AUTH
 HTTP プロキシ サーバーには、HTTP 認証スキーム 'basic' が必要です。
WS_E_PROXY_REQUIRES_DIGEST_AUTH
 HTTP プロキシ サーバーには、HTTP 認証スキーム 'digest' が必要です。
WS_E_PROXY_REQUIRES_NEGOTIATE_AUTH
 HTTP プロキシ サーバーには、HTTP 認証スキーム 'negotiate' が必要です。
WS_E_PROXY_REQUIRES_NTLM_AUTH
 HTTP プロキシ サーバーには、HTTP 認証スキーム 'NTLM' が必要です。
WS_E_SERVER_REQUIRES_BASIC_AUTH
 リモート エンドポイントには HTTP 認証スキーム 'basic' が必要です。
WS_E_SERVER_REQUIRES_DIGEST_AUTH
 リモート エンドポイントには HTTP 認証スキーム 'digest' が必要です。
WS_E_SERVER_REQUIRES_NEGOTIATE_AUTH
 リモート エンドポイントには、HTTP 認証スキーム 'negotiate' が必要です。
WS_E_SERVER_REQUIRES_NTLM_AUTH
 リモート エンドポイントには HTTP 認証スキーム 'NTLM' が必要です。
CERT_E_EXPIRED
 署名されたファイル内の現在のシステム クロックまたはタイムスタンプに対して検証するときに、必要な証明書がその有効期間内にありません。
CERT_E_CN_NO_MATCH
 証明書の CN 名が、渡された値と一致しません。
CERT_E_UNTRUSTEDROOT
 証明書チェーンは処理されましたが、信頼プロバイダーによって信頼されていないルート証明書で終了しました。
CERT_E_WRONG_USAGE
 証明書が要求された使用法に対して無効である。
CRYPT_E_REVOCATION_OFFLINE
 失効サーバーがオフラインであったため、失効関数が失効を確認できませんでした。
E_OUTOFMEMORY
 メモリが不足しました。
E_INVALIDARG
 1 つ以上の引数が無効です。
その他のエラー
この関数は、上記以外のエラーを返す場合があります。

注釈

メッセージは、 WS_ADDRESSING_VERSIONに応じて関連付けされます。 要求応答メッセージの関連付けの詳細については、「 チャネル層の概要 」を参照してください。

要件

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