HttpContent.CreateContentReadStreamAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| CreateContentReadStreamAsync() |
Serialize the HTTP content to a memory stream as an asynchronous operation. |
| CreateContentReadStreamAsync(CancellationToken) |
Serializes the HTTP content to a memory stream as an asynchronous operation. |
CreateContentReadStreamAsync()
- Source:
- HttpContent.cs
- Source:
- HttpContent.cs
- Source:
- HttpContent.cs
Serialize the HTTP content to a memory stream as an asynchronous operation.
protected:
virtual System::Threading::Tasks::Task<System::IO::Stream ^> ^ CreateContentReadStreamAsync();protected virtual System.Threading.Tasks.Task<System.IO.Stream> CreateContentReadStreamAsync ();abstract member CreateContentReadStreamAsync : unit -> System.Threading.Tasks.Task<System.IO.Stream>
override this.CreateContentReadStreamAsync : unit -> System.Threading.Tasks.Task<System.IO.Stream>Protected Overridable Function CreateContentReadStreamAsync () As Task(Of Stream)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 to the memory stream.
Once the operation completes, the Result property on the returned task object contains the memory stream that represents the HTTP content. The returned stream can then be used to read the content using various stream APIs.
The CreateContentReadStreamAsync method buffers the content to a memory stream. Derived classes can override this behavior if there is a better way to retrieve the content as stream. For example, a byte array or a string could use a more efficient method way such as wrapping a read-only MemoryStream around the bytes or string.
Applies to
CreateContentReadStreamAsync(CancellationToken)
- Source:
- HttpContent.cs
- Source:
- HttpContent.cs
- Source:
- HttpContent.cs
Serializes the HTTP content to a memory stream as an asynchronous operation.
protected:
virtual System::Threading::Tasks::Task<System::IO::Stream ^> ^ CreateContentReadStreamAsync(System::Threading::CancellationToken cancellationToken);protected virtual System.Threading.Tasks.Task<System.IO.Stream> CreateContentReadStreamAsync (System.Threading.CancellationToken cancellationToken);abstract member CreateContentReadStreamAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.CreateContentReadStreamAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Protected Overridable Function CreateContentReadStreamAsync (cancellationToken As CancellationToken) As Task(Of Stream)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 to the memory stream.
Once the operation completes, the Result property on the returned task object contains the memory stream that represents the HTTP content. The returned stream can then be used to read the content using various stream APIs.
The CreateContentReadStreamAsync method buffers the content to a memory stream. Derived classes can override this behavior if there is a better way to retrieve the content as stream. For example, a byte array or a string could use a more efficient method way such as wrapping a read-only MemoryStream around the bytes or string.)
