WsReadMessageStart 関数 (webservices.h)

  • [アーティクル]

チャネルから次のメッセージのヘッダーを読み取り、body 要素を読み取る準備をします。

構文

HRESULT WsReadMessageStart(
  [in]           WS_CHANNEL             *channel,
  [in]           WS_MESSAGE             *message,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

パラメーター

[in] channel

受信元のチャネル。

[in] message

受信するメッセージ。

[in, optional] asyncContext

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

[in, optional] error

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

戻り値

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

リターン コード 説明
S_OK
 メッセージの開始が正常に受信されました。
WS_S_END
 チャネルで使用できるメッセージはこれ以上ありません。
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 つ以上の引数が無効です。
その他のエラー
この関数は、上記以外のエラーを返す場合があります。

注釈

これにより、チャネルから次のメッセージの先頭 (メッセージのヘッダーを含む) が読み取ります。

この関数は WsReadEnvelopeStart に似ていますが、チャネルで使用されます。

成功すると、ヘッダーはメッセージに格納され、ランダム アクセス形式でアクセスできます (たとえば、 WsGetHeader を使用)。

メッセージは WS_MESSAGE_STATE_EMPTY 状態である必要があります。 成功すると、メッセージは WS_MESSAGE_STATE_READING 状態に遷移します。

メッセージ本文の要素を逆シリアル化するには、 WsReadBody を使用します。 メッセージの XML リーダーから直接読み取るには、まず WS_MESSAGE_PROPERTY_BODY_READER プロパティを使用してリーダーを取得します。

チャネル入力がストリーミングされる場合 (WS_STREAMED_INPUT_TRANSFER_MODE)、実際に読み取られる前に、本文の次の部分を受信するために WsFillBody を呼び出す必要があります。

要件

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