pfn-websocket-completion-funtion.md

title	PFN_WEBSOCKET_COMPLETION Funtion
description	Learn how the PFN_WEBSOCKET_COMPLETION function defines the WebSocket completion function prototype.
ms.date	10/07/2016
ms.assetid	2824d960-9a3e-4d11-8a55-4814ac5ca87a

PFN_WEBSOCKET_COMPLETION Funtion

Defines the WebSocket completion function prototype.

Syntax

typedef VOID(WINAPI* PFN_WEBSOCKET_COMPLETION)(  
   HRESULT hrError,  
   VOID* pvCompletionContext,  
   DWORD cbIO,  
   BOOL fUTF8Encoded,  
   BOOL fFinalFragment,  
   BOOL fClose  
);  

Parameters

hrError
The error code generated by the operation.

pvCompletionContext
Points to the completion context information for the operation.

cbIO
The number of bytes of I/O in the last call.

fUTF8Encoded
true if the data is Unicode (UTF-8) encoded; otherwise, false.

fFinalFragment
true if this is the final fragment to write; otherwise false.

fClose
true to close the WebSocket after this operation; otherwise false.

Return Value

This function does not return a value.

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

Web Server Core Functions