WebSocketCompleteAction-Funktion (websocket.h)
Die WebSocketCompleteAction-Funktion schließt eine Aktion ab, die von WebSocketGetAction gestartet wurde.
Syntax
void WebSocketCompleteAction(
[in] WEB_SOCKET_HANDLE hWebSocket,
[in] PVOID pvActionContext,
[in] ULONG ulBytesTransferred
);
Parameter
[in] hWebSocket
Typ: WEB_SOCKET_HANDLE
WebSocket-Sitzungshandle, das von einem vorherigen Aufruf von WebSocketCreateClientHandle oder WebSocketCreateServerHandle zurückgegeben wurde.
[in] pvActionContext
Typ: PVOID
Zeiger auf ein Aktionskontexthandle, das von einem vorherigen Aufruf von WebSocketGetAction zurückgegeben wurde.
[in] ulBytesTransferred
Typ: ULONG
Anzahl der Bytes, die für die WEB_SOCKET_SEND_TO_NETWORK_ACTION - oder WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION-Aktionen übertragen wurden. Dieser Wert muss für alle anderen Aktionen 0 sein.
Rückgabewert
Wenn die Funktion erfolgreich ist, gibt sie S_OK zurück.
Wenn die Funktion fehlschlägt, gibt sie einen in WinError.h definierten Systemfehlercode zurück.
Hinweise
Jeder Aufruf von WebSocketGetAction muss mit einem Aufruf von WebSocketCompleteAction gekoppelt werden. Bei den folgenden Netzwerkaktionen können E/A-Fehler auftreten:
- WEB_SOCKET_SEND_TO_NETWORK_ACTION: Wenn ulBytesTransferred sich von der Summe aller Pufferlängen unterscheidet, die von WebSocketGetAction zurückgegeben werden, wird die aktuelle Sendeaktion abgebrochen, und der nächste Aufruf von WebSocketGetAction gibt WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION zurück, auch wenn nicht alle an WebSocketSend übergebenen Puffer verarbeitet wurden.
- WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION: Wenn ulBytesTransferred 0 ist, wird die aktuelle Empfangsaktion abgebrochen, und der nächste Aufruf von WebSocketGetAction gibt WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION zurück, auch wenn nicht alle an WebSocketReceive übergebenen Puffer verarbeitet wurden.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows 8 [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2012 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | websocket.h |
| Bibliothek | Websocket.lib |
| DLL | Websocket.dll |