HttpContent.ReadAsStringAsync Method

Definition

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
Source:
HttpContent.cs
Source:
HttpContent.cs

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

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

Returns

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().

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

ReadAsStringAsync(CancellationToken)

Source:
HttpContent.cs
Source:
HttpContent.cs
Source:
HttpContent.cs

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

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

Parameters

cancellationToken
CancellationToken

The cancellation token to cancel the operation.

Returns

The task object representing the asynchronous operation.

Exceptions

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().

Applies to

.NET 9 and other versions
Product Versions
.NET 5, 6, 7, 8, 9