Fungsi WebSocketCompleteAction (websocket.h)

Fungsi WebSocketCompleteAction menyelesaikan tindakan yang dimulai oleh WebSocketGetAction.

Sintaks

VOID WebSocketCompleteAction(
  [in] WEB_SOCKET_HANDLE hWebSocket,
  [in] PVOID             pvActionContext,
  [in] ULONG             ulBytesTransferred
);

Parameter

[in] hWebSocket

Jenis: WEB_SOCKET_HANDLE

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

[in] pvActionContext

Jenis: PVOID

Penunjuk ke handel konteks tindakan yang dikembalikan oleh panggilan sebelumnya ke WebSocketGetAction.

[in] ulBytesTransferred

Jenis: ULONG

Jumlah byte yang ditransfer untuk tindakan WEB_SOCKET_SEND_TO_NETWORK_ACTION atau WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION . Nilai ini harus 0 untuk semua tindakan lainnya.

Mengembalikan nilai

Jika fungsi berhasil, fungsi akan mengembalikan S_OK.

Jika fungsi gagal, fungsi mengembalikan kode kesalahan sistem yang ditentukan dalam WinError.h.

Keterangan

Setiap panggilan ke WebSocketGetAction harus dipasangkan dengan panggilan ke WebSocketCompleteAction. Untuk tindakan jaringan berikut, kesalahan I/O dapat terjadi:

• WEB_SOCKET_SEND_TO_NETWORK_ACTION: jika ulBytesTransferred berbeda dari jumlah semua panjang buffer yang dikembalikan dari WebSocketGetAction , tindakan pengiriman saat ini dibatalkan dan panggilan berikutnya ke WebSocketGetAction akan mengembalikan WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION meskipun tidak semua buffer yang diteruskan ke WebSocketSend diproses .
• WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION: jika ulBytesTransferred adalah 0, tindakan terima saat ini dibatalkan dan panggilan berikutnya ke WebSocketGetAction akan mengembalikan WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION meskipun tidak semua buffer yang diteruskan ke WebSocketReceive diproses.

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

WebSocketGetAction