IWebSocketContext::SendConnectionClose Method
Signals the close of a WebSocket connection.
Syntax
virtual HRESULT SendConnectionClose(
_In_ BOOL fAsync,
_In_ USHORT* pStatusCode = NULL,
_In_ LPCWSTR pszReason = NULL,
_In_ PFN_WEBSOCKET_COMPLETION pfnCompletion = NULL,
_In_ VOID* pvCompletionContext = NULL,
_Out_ BOOL* pfCompletionExpected = NULL
) = 0;
Parameters
fAsync
[IN] true if the method should complete asynchronously; otherwise, false.
pStatusCode
[IN] Points to the status code for the connection.
pszReason
[IN] Points to the reason text for the status.
pfnCompletion
[IN] Points to the function that will complete the operation.
pvCompletionContext
[IN] Points to the completion context information for the operation.
pfCompletionExpected
[OUT] true if an asynchronous completion is pending for this call; otherwise, false.
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 Windows Vista - IIS 7.5 on Windows 7 - IIS 8.0 on Windows 8 - IIS 10.0 on Windows 10 |
| Server | - IIS 7.0 on Windows Server 2008 - 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 Technical Preview |
| Product | - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 - IIS Express 7.5, IIS Express 8.0, IIS Express 10.0 |
| Header | Iiswebsocket.h |