SqlDataReader.GetStream(Int32) Method

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

Retrieves binary, image, varbinary, UDT, and variant data types as a Stream.

public:
 override System::IO::Stream ^ GetStream(int i);

public override System.IO.Stream GetStream (int i);

override this.GetStream : int -> System.IO.Stream

Public Overrides Function GetStream (i As Integer) As Stream

Parameters

i

Int32

The zero-based column ordinal.

Returns

Stream

A stream object.

Exceptions

InvalidOperationException

The connection drops or is closed during the data retrieval.

The SqlDataReader is closed during the data retrieval.

There is no data ready to be read (for example, the first Read() hasn't been called, or returned false).

Tried to read a previously-read column in sequential mode.

There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream.

IndexOutOfRangeException

Trying to read a column that does not exist.

InvalidCastException

The returned type was not one of the types below:

• binary

• image

• varbinary

• udt

Remarks

ReadTimeout defaults to the value of CommandTimeout; but you can modify ReadTimeout via GetStream.

Null values will be returned as an empty (zero bytes) Stream.

GetBytes will raise an InvalidOperationException exception when used on an object returned by GetStream when SequentialAccess is in effect.

SqlException exceptions raised from Stream are thrown as IOException exceptions; check the inner exception for the SqlException.

The following Stream members are not available for objects returned by GetStream:

• BeginWrite

• EndWrite

• Length

• Position

• Seek

• SetLength

• Write

• WriteByte

• WriteTimeout

For more information, see SqlClient Streaming Support.