Edit

OleDbDataReader.GetBytes(Int32, Int64, Byte[], Int32, Int32) Method

  • Reference

Definition

Namespace:
System.Data.OleDb
Assembly:
System.Data.OleDb.dll
Assembly:
System.Data.dll
Package:
System.Data.OleDb v6.0.0
Package:
System.Data.OleDb v7.0.0
Package:
System.Data.OleDb v8.0.0
Package:
System.Data.OleDb v9.0.0-preview.2.24128.5
Source:
OleDbDataReader.cs
Source:
OleDbDataReader.cs
Source:
OleDbDataReader.cs

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

public:
 override long GetBytes(int ordinal, long dataIndex, cli::array <System::Byte> ^ buffer, int bufferIndex, int length);
public:
 virtual long GetBytes(int ordinal, long dataIndex, cli::array <System::Byte> ^ buffer, int bufferIndex, int length);
public override long GetBytes (int ordinal, long dataIndex, byte[] buffer, int bufferIndex, int length);
public override long GetBytes (int ordinal, long dataIndex, byte[]? buffer, int bufferIndex, int length);
public long GetBytes (int ordinal, long dataIndex, byte[] buffer, int bufferIndex, int length);
override this.GetBytes : int * int64 * byte[] * int * int -> int64
abstract member GetBytes : int * int64 * byte[] * int * int -> int64
override this.GetBytes : int * int64 * byte[] * int * int -> int64
Public Overrides Function GetBytes (ordinal As Integer, dataIndex As Long, buffer As Byte(), bufferIndex As Integer, length As Integer) As Long
Public Function GetBytes (ordinal As Integer, dataIndex As Long, buffer As Byte(), bufferIndex As Integer, length As Integer) As Long

Parameters

ordinal
Int32

The zero-based column ordinal.

dataIndex
Int64

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

buffer
Byte[]

The buffer into which to read the stream of bytes.

bufferIndex
Int32

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

length
Int32

The maximum length to copy into the buffer.

Returns

Int64

The actual number of bytes read.

Implements

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

Remarks

GetBytes returns the number of available bytes in the field. Most of the time this is the exact length of the field. However, the number returned may be less than the true length of the field if GetBytes has already been used to obtain bytes from the field. This may be the case, for example, when the OleDbDataReader is reading a large data structure into a buffer. For more information, see the SequentialAccess setting for CommandBehavior.

If you pass a buffer that is null, GetBytes returns the length of the field in bytes.

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

Applies to

See also