nf-websocket-websocketreceive.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:websocket.WebSocketReceive	WebSocketReceive function (websocket.h)	Adds a receive operation to the protocol component operation queue.	WebSocketReceive WebSocketReceive function [Websocket Protocol Component API] websock.websocketreceive websocket/WebSocketReceive	websock\websocketreceive.htm	WebSock	6285c6fc-1f7a-45f3-ba28-94992e73693e	12/05/2018	WebSocketReceive, WebSocketReceive function [Websocket Protocol Component API], websock.websocketreceive, websocket/WebSocketReceive	websocket.h		Windows	Windows 8 [desktop apps only]	Windows Server 2012 [desktop apps only]										Websocket.lib	Websocket.dll		Windows			19H1	WebSocketReceive websocket/WebSocketReceive	c++	APIRef kbSyntax	DllExport	websocket.dll	WebSocketReceive

WebSocketReceive function

-description

The WebSocketReceive function adds a receive operation to the protocol component operation queue.

-parameters

-param hWebSocket [in]

Type: WEB_SOCKET_HANDLE

WebSocket session handle returned by a previous call to WebSocketCreateClientHandle or WebSocketCreateServerHandle.

-param pBuffer [in, optional]

Type: WEB_SOCKET_BUFFER*

A pointer to an array of WEB_SOCKET_BUFFER structures that WebSocket data will be written to when it is returned by WebSocketGetAction. If NULL, WebSocketGetAction will return an internal buffer that enables zero-copy scenarios.

Note  Once WEB_SOCKET_INDICATE_RECEIVE_COMPLETE is returned by WebSocketGetAction for this action, the memory pointer to by pBuffer can be reclaimed.

 

-param pvContext [in, optional]

Type: PVOID

A pointer to an application context handle that will be returned by a subsequent call to WebSocketGetAction.

-returns

Type: HRESULT

If the function succeeds, it returns S_OK.

If the function fails, it returns one of the following or a system error code defined in WinError.h.

Return code	Description
E_INVALID_PROTOCOL_OPERATION	Protocol performed an invalid operation.

-see-also

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketSend