HttpClient.GetBufferAsync(Uri) HttpClient.GetBufferAsync(Uri) HttpClient.GetBufferAsync(Uri) HttpClient.GetBufferAsync(Uri) HttpClient.GetBufferAsync(Uri) Method

Definition

Send a GET request to the specified Uri and return the response body as a buffer in an asynchronous operation.

public : IAsyncOperationWithProgress<IBuffer, HttpProgress> GetBufferAsync(Uri uri)
IAsyncOperationWithProgress<IBuffer, HttpProgress> GetBufferAsync(Uri uri) const;
public IAsyncOperationWithProgress<IBuffer, HttpProgress> GetBufferAsync(Uri uri)
Public Function GetBufferAsync(uri As Uri) As IAsyncOperationWithProgress(Of IBufferHttpProgress)
Windows.Web.Http.HttpClient.getBufferAsync(uri).done( /* Your success and error handlers */ );
Parameters
uri
Uri Uri Uri

The Uri the request is sent to.

Returns

Remarks

This operation will not block. The returned IAsyncOperationWithProgress(IBuffer, HttpProgress) object will complete after the whole response body is read.

The HttpClient class is often used by an app to download and then parse text. It is possible that the character encoding specified in the Content-Type header by an HTTP server does not match the character encoding of the HTTP response body (the XML encoding in an XML document, for example). One way to use HttpClient with text is to call the GetStringAsync method and pass the returned string to the text parser. However, this can result in errors if the Content-Type is not a type expressible as a string. A reliable way to use HttpClient with an XML parser is to call the GetBufferAsync method and parse the buffer for the "<?xml>" element. Then use the character encoding specified ("<xmlversion="1.0" encoding="UTF-8"?>", for example) to parse the HTTP response body. For other text formats, similar methods can be used where the app scans the initial part of the HTTP response body to determine the character encoding used.

Below are the exceptions that this function throws.

E_INVALIDARG

The uri parameter was a null reference (Nothing in Visual Basic).

See Also