This documentation is archived and is not being maintained.

DataServiceContext.BeginGetReadStream Method

Asynchronously gets binary property data for the specified entity as a data stream along with the specified message headers.

Namespace:  System.Data.Services.Client
Assembly:  System.Data.Services.Client (in System.Data.Services.Client.dll)

public IAsyncResult BeginGetReadStream(
	Object entity,
	DataServiceRequestArgs args,
	AsyncCallback callback,
	Object state
)

Parameters

entity
Type: System.Object
The entity that has the binary property to retrieve.
args
Type: System.Data.Services.Client.DataServiceRequestArgs
Instance of the DataServiceRequestArgs class that contains settings for the HTTP request message.
callback
Type: System.AsyncCallback
Delegate to invoke when results are available for client consumption.
state
Type: System.Object
User-defined state object passed to the callback.

Return Value

Type: System.IAsyncResult
An IAsyncResult object that is used to track the status of the asynchronous operation.

ExceptionCondition
ArgumentNullException

Any of the parameters supplied to the method is null.

ArgumentException

The entity is not tracked by this DataServiceContext.

-or-

The entity is in the Added state.

-or-

The entity is not a Media Link Entry and does not have a binary property.

The GetReadStream method asynchronously requests a data stream that contains the binary property of the requested entity.

In the AtomPub protocol, the entity is a Media Link Entry and the binary property is the associated Media Resource.

No validation is performed on the headers that are set in args. Therefore, do not change an HTTP header in a way that changes the meaning of the request.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: