HttpContent.ReadAsStringAsync Method

Definition

Namespace:

System.Net.Http

Assembly:

System.Net.Http.dll

Overloads

ReadAsStringAsync()	Serialize the HTTP content to a string as an asynchronous operation.
ReadAsStringAsync(CancellationToken)	Serialize the HTTP content to a string as an asynchronous operation.

ReadAsStringAsync()

Source:

HttpContent.cs

Serialize the HTTP content to a string as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::String ^> ^ ReadAsStringAsync();

public System.Threading.Tasks.Task<string> ReadAsStringAsync ();

member this.ReadAsStringAsync : unit -> System.Threading.Tasks.Task<string>

Public Function ReadAsStringAsync () As Task(Of String)

Returns

Task<String>

The task object representing the asynchronous operation.

Remarks

This operation will not block. The returned Task<TResult> object will complete after all of the content has been written as a string.

Once the operation completes, the Result property on the returned task object contains the string with the HTTP content.

Note that this method will internally buffer the content via LoadIntoBufferAsync().

ReadAsStringAsync(CancellationToken)

Source:

HttpContent.cs

Serialize the HTTP content to a string as an asynchronous operation.

public:
 System::Threading::Tasks::Task<System::String ^> ^ ReadAsStringAsync(System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<string> ReadAsStringAsync (System.Threading.CancellationToken cancellationToken);

member this.ReadAsStringAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Function ReadAsStringAsync (cancellationToken As CancellationToken) As Task(Of String)

Parameters

cancellationToken

CancellationToken

The cancellation token to cancel the operation.

Returns

Task<String>

The task object representing the asynchronous operation.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This operation will not block. The returned Task<TResult> object will complete after all of the content has been written as a string.

Once the operation completes, the Result property on the returned task object contains the string with the HTTP content.

Note that this method will internally buffer the content via LoadIntoBufferAsync().