WinHttpWebSocketReceive 関数 (winhttp.h)

  • [アーティクル]

WinHttpWebSocketReceive 関数は、WebSocket 接続からデータを受信します。

構文

WINHTTPAPI DWORD WinHttpWebSocketReceive(
  [in]  HINTERNET                      hWebSocket,
  [out] PVOID                          pvBuffer,
  [in]  DWORD                          dwBufferLength,
  [out] DWORD                          *pdwBytesRead,
  [out] WINHTTP_WEB_SOCKET_BUFFER_TYPE *peBufferType
);

パラメーター

[in] hWebSocket

種類: HINTERNET

WebSocket へのハンドル。

[out] pvBuffer

種類: PVOID

データを受信するバッファーへのポインター。

[in] dwBufferLength

型: DWORD

pvBuffer の長さ (バイト単位)。

[out] pdwBytesRead

種類: DWORD*

操作の最後に接続から読み取られたバイト数を受け取る DWORD へのポインター。 これは、 WinHttpWebSocketReceive が NO_ERROR を返し、ハンドルが同期モードで開かれた場合にのみ設定されます。

[out] peBufferType

種類: WINHTTP_WEB_SOCKET_BUFFER_TYPE*

返されるバッファーの型。 これは、 WinHttpWebSocketReceive が NO_ERROR を返し、ハンドルが同期モードで開かれた場合にのみ設定されます。

戻り値

型: DWORD

成功にNO_ERROR。 それ以外の場合はエラー コード。

説明
ERROR_INVALID_OPERATION
 クローズまたは受信が保留中であるか、受信チャネルが既に閉じられています。
ERROR_INVALID_PARAMETER
 パラメーターが無効です。
ERROR_WINHTTP_INVALID_SERVER_RESPONSE
 サーバーから無効なデータが受信されました。
ERROR_WINHTTP_OPERATION_CANCELLED
 接続を閉じる には WinHttpWebSocketClose が呼び出されたため、操作が取り消されました。

要件

   
サポートされている最小のクライアント Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winhttp.h
Library Winhttp.lib
[DLL] Winhttp.dll