This documentation is archived and is not being maintained.

SqlDataReader.GetBytes Method

Reads a stream of bytes from the specified column offset into the buffer an array starting at the given buffer offset.

Namespace:  System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)

public override long GetBytes(
	int i,
	long dataIndex,
	byte[] buffer,
	int bufferIndex,
	int length
)

Parameters

i
Type: System.Int32

The zero-based column ordinal.

dataIndex
Type: System.Int64

The index within the field from which to begin the read operation.

buffer
Type: System.Byte[]

The buffer into which to read the stream of bytes.

bufferIndex
Type: System.Int32

The index within the buffer where the write operation is to start.

length
Type: System.Int32

The maximum length to copy into the buffer.

Return Value

Type: System.Int64
The number of bytes read.

Implements

IDataRecord.GetBytes(Int32, Int64, Byte[], Int32, Int32)
IDataRecord.GetBytes(Int32, Int64, Byte[], Int32, Int32)

If you call GetBytes with a non-null buffer, the data is read into the buffer, and GetBytes will return the number of bytes that were read into the buffer.

If you call GetBytes with a null buffer, then no data is read, and GetBytes will return the number of bytes that are available to read. In most cases, this number is the full length of the field. However, if GetBytes has already been used to read bytes from the field, then the return value may instead be only the number of bytes remaining in the field. This may be the case, for example, if the SqlDataReader was created by using CommandBehavior.SequentialAccess.

No conversions are performed; therefore, the data retrieved must already be a byte array.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Show: