This documentation is archived and is not being maintained.

SqlDataRecord::GetBytes Method

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

Namespace:  Microsoft.SqlServer.Server
Assembly:  System.Data (in System.Data.dll)

public:
virtual long long GetBytes(
	int ordinal, 
	long long fieldOffset, 
	array<unsigned char>^ buffer, 
	int bufferOffset, 
	int length
)

Parameters

ordinal
Type: System::Int32
The zero-based ordinal of the column.
fieldOffset
Type: System::Int64
The offset into the field value to start retrieving bytes.
buffer
Type: array<System::Byte>
The target buffer to which to copy bytes.
bufferOffset
Type: System::Int32
The offset into the buffer to which to start copying bytes.
length
Type: System::Int32
The number of bytes to copy to the buffer.

Return Value

Type: System::Int64
The number of bytes copied.

Implements

IDataRecord::GetBytes(Int32, Int64, array<Byte>, Int32, Int32)

ExceptionCondition
IndexOutOfRangeException

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

SqlNullValueException

The column specified by ordinal is null.

InvalidCastException

There is a type mismatch.

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: