Fungsi WinHttpWebSocketReceive (winhttp.h)

Fungsi WinHttpWebSocketReceive menerima data dari koneksi WebSocket.

Sintaks

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

Parameter

[in] hWebSocket

Jenis: HINTERNET

Menangani ke WebSocket.

[out] pvBuffer

Jenis: PVOID

Arahkan ke buffer untuk menerima data.

[in] dwBufferLength

Jenis: DWORD

Panjang pvBuffer, dalam byte.

[out] pdwBytesRead

Jenis: DWORD*

Penunjuk ke DWORD yang menerima jumlah byte yang dibaca dari koneksi di akhir operasi. Ini diatur hanya jika WinHttpWebSocketReceive mengembalikan NO_ERROR dan handel dibuka dalam mode sinkron.

[out] peBufferType

Jenis: WINHTTP_WEB_SOCKET_BUFFER_TYPE*

Jenis buffer yang dikembalikan. Ini hanya diatur jika WinHttpWebSocketReceive mengembalikan NO_ERROR dan handel dibuka dalam mode sinkron.

Menampilkan nilai

Jenis: DWORD

NO_ERROR pada kesuksesan. Jika tidak, kode kesalahan.

	Deskripsi
ERROR_INVALID_OPERATION	Penutupan atau penerimaan tertunda, atau saluran penerima telah ditutup.
ERROR_INVALID_PARAMETER	Parameter tidak valid.
ERROR_WINHTTP_INVALID_SERVER_RESPONSE	Data tidak valid diterima dari server.
ERROR_WINHTTP_OPERATION_CANCELLED	Operasi dibatalkan karena WinHttpWebSocketClose dipanggil untuk menutup koneksi.

Persyaratan

Klien minimum yang didukung	Windows 8 [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2012 [hanya aplikasi desktop]
Target Platform	Windows
Header	winhttp.h
Pustaka	Winhttp.lib
DLL	Winhttp.dll