Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 2.97 KB

ns-websocket-web_socket_buffer.md

File metadata and controls

114 lines (83 loc) · 2.97 KB
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
NS:websocket._WEB_SOCKET_BUFFER
WEB_SOCKET_BUFFER (websocket.h)
Contains data for a specific WebSocket action.
*PWEB_SOCKET_BUFFER
WEB_SOCKET_BUFFER
WEB_SOCKET_BUFFER union [Websocket Protocol Component API]
websock.web_socket_buffer
websocket/WEB_SOCKET_BUFFER
websock\web_socket_buffer.htm
WebSock
05EC3940-4A17-4FBB-9446-15B511E18FF2
12/05/2018
*PWEB_SOCKET_BUFFER, WEB_SOCKET_BUFFER, WEB_SOCKET_BUFFER union [Websocket Protocol Component API], websock.web_socket_buffer, websocket/WEB_SOCKET_BUFFER
websocket.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
Windows
WEB_SOCKET_BUFFER, *PWEB_SOCKET_BUFFER
19H1
_WEB_SOCKET_BUFFER
websocket/_WEB_SOCKET_BUFFER
PWEB_SOCKET_BUFFER
websocket/PWEB_SOCKET_BUFFER
WEB_SOCKET_BUFFER
websocket/WEB_SOCKET_BUFFER
c++
APIRef
kbSyntax
HeaderDef
Websocket.h
WEB_SOCKET_BUFFER

WEB_SOCKET_BUFFER structure

-description

The WEB_SOCKET_BUFFER structure contains data for a specific WebSocket action.

-struct-fields

-field Data

-field Data.pbBuffer

Type: PBYTE Pointer to the WebSocket buffer data.

-field Data.ulBufferLength

Type: ULONG Length, in bytes, of the buffer pointed to by pbBuffer.

-field CloseStatus

-field CloseStatus.pbReason

Type: PBYTE A point to a UTF-8 string that represents the reason the connection is closed. If ulReasonLength is 0, this must be NULL.

-field CloseStatus.ulReasonLength

Type: ULONG Length, in bytes, of the buffer pointed to by pbReason. It cannot exceed WEB_SOCKET_MAX_CLOSE_REASON_LENGTH (123 bytes).

-field CloseStatus.usStatus

Type: USHORT

WEB_SOCKET_CLOSE_STATUS enumeration that specifies the WebSocket status.

-remarks

Application must use the Data struct for all buffer types except WEB_SOCKET_CLOSE_BUFFER_TYPE. The CloseStatus struct is used for WEB_SOCKET_CLOSE_BUFFER_TYPE.

-see-also

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend