OnResponseReceived Event (Windows 8)

Article
10/27/2016

Fired when a client has received a complete response from the server.

C/C++ Syntax

HRESULT OnResponseReceived(  
        IXMLHTTPRequest2 *pXHR,  
        ISequentialStream *pResponseStream);

Parameters

pXHR[in]
The IXMLHTTPRequest2 object associated with this callback.

pResponseStream[in]
The response stream being received. The client can call ISequentialStream::Read to begin processing the data, or it can store a reference to pResponseStream for later processing. This response stream is wrapped in a stream synchronization object that prevents concurrent read and write operations, so the application does not need to implement custom synchronization.

Return Values

S_OK
The value returned if successful.

Remarks

When this event fires the application can begin processing data from the HTTP response. Processing may begin before this event fires if an earlier OnDataAvailable event has occurred.

Custom streams receive a call to ISequentialStream::Write specifying 0 bytes written before OnResponseReceivedEvent is fired. The client can process data directly from the Write call instead of calling ISequentialStream::Read on the custom stream, and it can rely on the zero-byte Write call to indicate that the response has been received.

Versioning

Implemented in: MSXML 6.0

Applies to

IXMLHTTPRequest2 (Windows 8)