Share via


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

Definition

Gets the value for the column specified by the ordinal as an array of Byte objects.

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

Parameters

ordinal
Int32

The zero-based ordinal of the column.

fieldOffset
Int64

The offset into the field value to start retrieving bytes.

buffer
Byte[]

The target buffer to which to copy bytes.

bufferOffset
Int32

The offset into the buffer to which to start copying bytes.

length
Int32

The number of bytes to copy to the buffer.

Returns

The number of bytes copied.

Implements

Exceptions

The ordinal is less than 0 or greater than the number of columns (that is, FieldCount).

The column specified by ordinal is null.

There is a type mismatch.

Remarks

This method enables you to obtain a binary value either in a single call or in chunks. Getting the value in chunks is useful for large values or values of unknown size.

To obtain the value in several chunks, allocate a byte array of the chunk-size and call GetBytes repeatedly, adjusting the fieldOffset parameter accordingly in each call.

Applies to