PFN_WEBSOCKET_COMPLETION Funtion

IIS 7.0
 

Defines the WebSocket completion function prototype.

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

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.

This function does not return a value.

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

Show: