iwebsocketcontext-getclosestatus-method.md

title	IWebSocketContext::GetCloseStatus Method
description	Describes the IWebSocketContext::GetCloseStatus method and details its syntax, parameters, return value, and requirements.
ms.date	10/07/2016
ms.assetid	f5db45c5-a53b-4299-9802-c87e3a58b068

IWebSocketContext::GetCloseStatus Method

Retrieves the close status code for the connection.

Syntax

virtual HRESULT GetCloseStatus(  
   _Out_ USHORT* pStatusCode,  
   _Out_ BYTE** ppbReason = NULL,  
   _Out_ USHORT* pcbReason = NULL  
) = 0;  

Parameters

pStatusCode
[OUT] Points to the close status code provided by the server.

ppbReason
[OUT] Points to the start of the reason text string.

pcbReason
[OUT] Number of bytes in the reason text string.

Return Value

An HRESULT. Possible values include, but are not limited to, those in the following table.

Value	Description
S_OK	Indicates that the operation was successful.

Requirements

Type	Description
Client	- IIS 7.0 on [!INCLUDEwinvista] - IIS 7.5 on Windows 7 - IIS 8.0 on Windows 8 - IIS 10.0 on Windows 10
Server	- IIS 7.0 on [!INCLUDEwinsrv2008] - IIS 7.5 on Windows Server 2008 R2 - IIS 8.0 on Windows Server 2012 - IIS 8.5 on Windows Server 2012 R2 - IIS 10.0 on Windows Server 2016
Product	- IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 - [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header	Iiswebsocket.h

See Also

IWebSocketContext Interface