Export (0) Print
Expand All

WINHTTP_WEB_SOCKET_STATUS structure

The WINHTTP_WEB_SOCKET_STATUS enumeration includes the status of a WebSocket operation.

Syntax


typedef struct _WINHTTP_WEB_SOCKET_STATUS {
  DWORD                          dwBytesTransferred;
  WINHTTP_WEB_SOCKET_BUFFER_TYPE eBufferType;
} WINHTTP_WEB_SOCKET_STATUS;

Members

dwBytesTransferred

Type: DWORD

The amount of bytes transferred in the operation.

eBufferType

Type: WINHTTP_WEB_SOCKET_BUFFER_TYPE

The type of data in the buffer.

Remarks

A WINHTTP_WEB_SOCKET_STATUS structure is passed to the completion callback of WinHttpWebSocketSend when dwInternetStatus is WINHTTP_CALLBACK_STATUS_READ_COMPLETE.

A WINHTTP_WEB_SOCKET_STATUS structure is passed to the completion callback of WinHttpWebSocketReceive when dwInternetStatus is WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE.

A WINHTTP_WEB_SOCKET_STATUS structure is passed to the completion callback of WinHttpWebSocketClose when dwInternetStatus is WINHTTP_CALLBACK_STATUS_CLOSE_COMPLETE.

A WINHTTP_WEB_SOCKET_STATUS structure is passed to the completion callback of WinHttpWebSocketShutdown when dwInternetStatus is WINHTTP_CALLBACK_STATUS_SHUTDOWN_COMPLETE.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Winhttp.h

See also

WinHttpWebSocketSend
WinHttpWebSocketReceive
WinHttpWebSocketClose
WinHttpWebSocketShutdown
WINHTTP_WEB_SOCKET_BUFFER_TYPE
WINHTTP_STATUS_CALLBACK

 

 

Community Additions

ADD
Show:
© 2014 Microsoft