IDataServiceStreamProvider.GetReadStream Method
Returns a stream that contains the media resource data for the specified entity, which is a media link entry.
Namespace: System.Data.Services.Providers
Assembly: Microsoft.Data.Services (in Microsoft.Data.Services.dll)
Syntax
'Declaration
Function GetReadStream ( _
entity As Object, _
etag As String, _
checkETagForEquality As Nullable(Of Boolean), _
operationContext As DataServiceOperationContext _
) As Stream
'Usage
Dim instance As IDataServiceStreamProvider
Dim entity As Object
Dim etag As String
Dim checkETagForEquality As Nullable(Of Boolean)
Dim operationContext As DataServiceOperationContext
Dim returnValue As Stream
returnValue = instance.GetReadStream(entity, _
etag, checkETagForEquality, operationContext)
Stream GetReadStream(
Object entity,
string etag,
Nullable<bool> checkETagForEquality,
DataServiceOperationContext operationContext
)
Stream^ GetReadStream(
Object^ entity,
String^ etag,
Nullable<bool> checkETagForEquality,
DataServiceOperationContext^ operationContext
)
abstract GetReadStream :
entity:Object *
etag:string *
checkETagForEquality:Nullable<bool> *
operationContext:DataServiceOperationContext -> Stream
function GetReadStream(
entity : Object,
etag : String,
checkETagForEquality : Nullable<boolean>,
operationContext : DataServiceOperationContext
) : Stream
Parameters
- entity
Type: System.Object
The entity that is a media link entry with a related media resource.
- etag
Type: System.String
The eTag value sent as part of the HTTP request that is sent to the data service.
- checkETagForEquality
Type: System.Nullable<Boolean>
A nullable Boolean value that determines what kind of conditional request was issued to the data service, which is true when the eTag was sent in an If-Match header, false when the eTag was sent in an If-None-Match header, and nulla null reference (Nothing in Visual Basic) when the request was not conditional and no eTag was included in the request.
- operationContext
Type: System.Data.Services.DataServiceOperationContext
The DataServiceOperationContext instance used by the data service to process the request.
Return Value
Type: System.IO.Stream
The data Stream that contains the binary property data of the entity.
Remarks
eTag is the value of an If-Match or If-None-Match header.
The GetReadStream method is called by the data service runtime to acquire the stream that the data service returns to the client when the client requests the media resource for the specified entity, which is a media link entry. For more information, see Streaming Provider (WCF Data Services).