DataServiceContext.GetReadStream Method (Object, DataServiceRequestArgs)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 DataServiceStreamResponse GetReadStream(
	object entity,
	DataServiceRequestArgs args
)

Parameters

entity
Type: System.Object

The entity that has the binary property to retrieve.

args
Type: System.Data.Services.Client.DataServiceRequestArgs

Instance of DataServiceRequestArgs class that contains settings for the HTTP request message.

Return Value

Type: System.Data.Services.Client.DataServiceStreamResponse

An instance of DataServiceStreamResponse that represents the response.

Exception Condition
ArgumentNullException

entity is null.

-or-

args 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 synchronously 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
Available since 3.5
Return to top
Show: