DataServiceContext.GetReadStream Method (Object)

Gets the binary data stream that belongs to the specified entity.

Not supported by the WCF Data Services 5.0 client for Silverlight.

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

Syntax

'Declaration
Public Function GetReadStream ( _
    entity As Object _
) As DataServiceStreamResponse
'Usage
Dim instance As DataServiceContext 
Dim entity As Object 
Dim returnValue As DataServiceStreamResponse 

returnValue = instance.GetReadStream(entity)
public DataServiceStreamResponse GetReadStream(
    Object entity
)
public:
DataServiceStreamResponse^ GetReadStream(
    Object^ entity
)
member GetReadStream : 
        entity:Object -> DataServiceStreamResponse
public function GetReadStream(
    entity : Object
) : DataServiceStreamResponse

Parameters

  • entity
    Type: System.Object
    The entity that has the binary stream to retrieve.

Return Value

Type: System.Data.Services.Client.DataServiceStreamResponse
An instance of DataServiceStreamResponse that represents the response.

Exceptions

Exception Condition
ArgumentNullException

The entity is nulla null reference (Nothing in Visual Basic).

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 related binary stream.

Remarks

The GetReadStream method synchronously requests the binary data stream that belongs to the requested entity.

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

See Also

Reference

DataServiceContext Class

GetReadStream Overload

System.Data.Services.Client Namespace