DataServiceContext.GetReadStream Method (Object, DataServiceRequestArgs)
Gets binary property data for the specified entity as a data stream along with the specified message headers.
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.DataServiceStreamResponseAn 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.
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.
