This documentation is archived and is not being maintained.

OdbcDataReader.GetBytes Method

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

Namespace:  System.Data.Odbc
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 where the read operation is to start.

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 number of bytes to read.

Return Value

Type: System.Int64
The number of bytes read.

Implements

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 OdbcDataReader was created by using CommandBehavior.SequentialAccess.

Conversions are performed based on the underlying capabilities of the ODBC driver. If the conversion is not supported then the method call will fail.

NoteNote:

No exception will be thrown if the value of bufferIndex is outside the array. No data will be read and the method will return 0.

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

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
Show: