IXMLHttpRequest::responseStream Method

IXMLHttpRequest::get_responseStream Method

Represents the response entity body as an IStream. This stream returns the raw un-decoded bytes as received directly from the server. So depending on what the server sent, this may appear as binary-encoded data (UTF-8, UCS-2, UCS-4, shiftJis, and so on).

Visual Basic Syntax

strValue = oXMLHttpRequest.responseStream

C/C++ Syntax

HRESULT get_responseStream(VARIANT* pvarVal);

Parameters

pvarVal [out]: Response entity body as an IStream.

C/C++ Return Values

S_OK: Value returned if successful.
E_PENDING: Value returned if the data is unavailable.

Remarks

This property represents only one of several forms in which the HTTP response can be returned.

Example

HRESULT hr;
IXMLHttpRequest *pIXMLHttpRequest = NULL;
IStream *pIStream = NULL;
VARIANT varValue;

try
{
   // Create XMLHttpRequest object and initialize pIXMLHttpRequest.
   hr = pIXMLHttpRequest->get_responseStream(&varValue);
   if(SUCCEEDED(hr))
   {
      pIStream = (IStream*)varValue.punkVal;
      if(pIStream)
      {
         pIStream->Release();
         pIStream = NULL;
      }
   }   
}
catch(...)
{
   if(pIStream)
      pIStream->Release();
   DisplayErrorToUser();
}   
// Release pIXMLHttpRequest when finished with it.