DataServiceContext.SetSaveStream Method (Object, Stream, Boolean, DataServiceRequestArgs)
Sets a binary data stream for the specified entity, with the specified headers in the request message.
Namespace: System.Data.Services.Client
Assembly: Microsoft.Data.Services.Client (in Microsoft.Data.Services.Client.dll)
Syntax
'Declaration
Public Sub SetSaveStream ( _
entity As Object, _
stream As Stream, _
closeStream As Boolean, _
args As DataServiceRequestArgs _
)
'Usage
Dim instance As DataServiceContext
Dim entity As Object
Dim stream As Stream
Dim closeStream As Boolean
Dim args As DataServiceRequestArgs
instance.SetSaveStream(entity, stream, _
closeStream, args)
public void SetSaveStream(
Object entity,
Stream stream,
bool closeStream,
DataServiceRequestArgs args
)
public:
void SetSaveStream(
Object^ entity,
Stream^ stream,
bool closeStream,
DataServiceRequestArgs^ args
)
member SetSaveStream :
entity:Object *
stream:Stream *
closeStream:bool *
args:DataServiceRequestArgs -> unit
public function SetSaveStream(
entity : Object,
stream : Stream,
closeStream : boolean,
args : DataServiceRequestArgs
)
Parameters
- entity
Type: System.Object
The entity to which the binary stream belongs.
- stream
Type: System.IO.Stream
The Stream from which to read the binary data.
- closeStream
Type: System.Boolean
A Boolean value that determines whether the data stream is closed when the SaveChanges method is completed.
- args
Type: System.Data.Services.Client.DataServiceRequestArgs
An instance of the DataServiceRequestArgs class that contains settings for the HTTP request message.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | Any of the parameters supplied to the method are nulla null reference (Nothing in Visual Basic). |
| ArgumentException | The entity is not being tracked by this DataServiceContext instance. -or- The entity has the MediaEntryAttribute applied. |
Remarks
The SetSaveStream method sets the binary stream that is the Media Resource that belongs to the entity, which is called a Media Link Entry.
Calling the SetSaveStream method marks the entity as a Media Link Entry. The entity state is also set to Modified so that the stream will be sent to the data service the next time that the SaveChanges method is called.
The SetSaveStream method reads the Stream through to the end. A Seek operation is not tried on the Stream.
When closeStream is true, the SaveChanges method closes the stream before it returns. The stream is closed even when an error occurs and the stream is not read.
When the entity has the MediaEntryAttribute applied, the Media Resource cannot be a data stream. Remove this attribute before you try to set the data stream for the entity.
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.