Fungsi WebSocketReceive (websocket.h)

Fungsi WebSocketReceive menambahkan operasi terima ke antrean operasi komponen protokol.

Sintaks

HRESULT WebSocketReceive(
  [in]           WEB_SOCKET_HANDLE hWebSocket,
  [in, optional] WEB_SOCKET_BUFFER *pBuffer,
  [in, optional] PVOID             pvContext
);

Parameter

[in] hWebSocket

Jenis: WEB_SOCKET_HANDLE

Handel sesi WebSocket yang dikembalikan oleh panggilan sebelumnya ke WebSocketCreateClientHandle atau WebSocketCreateServerHandle.

[in, optional] pBuffer

Jenis: WEB_SOCKET_BUFFER*

Penunjuk ke array struktur WEB_SOCKET_BUFFER yang akan ditulis data WebSocket ketika dikembalikan oleh WebSocketGetAction. Jika NULL, WebSocketGetAction akan mengembalikan buffer internal yang mengaktifkan skenario nol-salin.

Catatan Setelah WEB_SOCKET_INDICATE_RECEIVE_COMPLETE dikembalikan oleh WebSocketGetAction untuk tindakan ini, penunjuk memori ke oleh pBuffer dapat diklaim kembali.

 

[in, optional] pvContext

Jenis: PVOID

Penunjuk ke handel konteks aplikasi yang akan dikembalikan oleh panggilan berikutnya ke WebSocketGetAction.

Nilai kembali

Jenis: HRESULT

Jika fungsi berhasil, fungsi akan mengembalikan S_OK.

Jika fungsi gagal, fungsi mengembalikan salah satu kode kesalahan berikut atau sistem yang ditentukan dalam WinError.h.

Menampilkan kode	Deskripsi
E_INVALID_PROTOCOL_OPERATION	Protokol melakukan operasi yang tidak valid.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 8 [khusus aplikasi desktop]
Server minimum yang didukung	Windows Server 2012 [hanya aplikasi desktop]
Target Platform	Windows
Header	websocket.h
Pustaka	Websocket.lib
DLL	Websocket.dll

Lihat juga

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketSend