IWebSocketContext::ReadFragment Method

 

Reads a data fragment from an asynchronous connection.

Syntax

virtual HRESULT ReadFragment(  
   _Out_ VOID* pData,  
   _Inout_ DWORD* pcbData,  
   _In_ BOOL fAsync,  
   _Out_ BOOL* pfUTF8Encoded,  
   _Out_ BOOL* pfFinalFragment,  
   _Out_ BOOL* pfConnectionClose,  
   _In_ PFN_WEBSOCKET_COMPLETION pfnCompletion = NULL,   _In_ VOID* pvCompletionContext = NULL,  
   _Out_ BOOL* pfCompletionExpected = NULL  
) = 0;  

Parameters

pData
[OUT] Data fragment that was read.

pcbData
[IN][OUT] Number of bytes in the data fragment.

fAsync
[IN] true if the method should complete asynchronously; otherwise, false.

pfUTF8Encoded
[OUT] true if the data is Unicode (UTF-8) encoded; otherwise, false.

pfFinalFragment
[OUT] true if this is the final data fragment; otherwise false.

pfConnectionClose
[OUT] true if the connection will close; otherwise false.

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

See Also

IWebSocketContext Interface