WebSocketReceive-Funktion (websocket.h)
Die WebSocketReceive-Funktion fügt der Vorgangswarteschlange der Protokollkomponente einen Empfangsvorgang hinzu.
Syntax
HRESULT WebSocketReceive(
[in] WEB_SOCKET_HANDLE hWebSocket,
[in, optional] WEB_SOCKET_BUFFER *pBuffer,
[in, optional] PVOID pvContext
);
Parameter
[in] hWebSocket
Typ: WEB_SOCKET_HANDLE
WebSocket-Sitzungshandle, das von einem vorherigen Aufruf von WebSocketCreateClientHandle oder WebSocketCreateServerHandle zurückgegeben wurde.
[in, optional] pBuffer
Typ: WEB_SOCKET_BUFFER*
Ein Zeiger auf ein Array von WEB_SOCKET_BUFFER Strukturen, in das WebSocket-Daten geschrieben werden, wenn sie von WebSocketGetAction zurückgegeben werden. Bei NULL gibt WebSocketGetAction einen internen Puffer zurück, der Zero-Copy-Szenarien ermöglicht.
[in, optional] pvContext
Typ: PVOID
Ein Zeiger auf ein Anwendungskontexthandle, das von einem nachfolgenden Aufruf von WebSocketGetAction zurückgegeben wird.
Rückgabewert
Typ: HRESULT
Wenn die Funktion erfolgreich ist, wird S_OK zurückgegeben.
Wenn die Funktion fehlschlägt, gibt sie einen der folgenden oder einen in WinError.h definierten Systemfehlercode zurück.
| Rückgabecode | Beschreibung |
|---|---|
|
Das Protokoll hat einen ungültigen Vorgang ausgeführt. |
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 |