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

 

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

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

long long GetBytes(
	int i,
	long long fieldOffset,
	array<unsigned char>^ buffer,
	int bufferoffset,
	int length
)

Parameters

i
Type: System::Int32

The zero-based column ordinal.

fieldOffset
Type: System::Int64

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

buffer
Type: array<System::Byte>^

The buffer into which to read the stream of bytes.

bufferoffset
Type: System::Int32

The index for buffer to start the read operation.

length
Type: System::Int32

The number of bytes to read.

Return Value

Type: System::Int64

The actual number of bytes read.

Exception Condition
IndexOutOfRangeException

The index passed was outside the range of 0 through FieldCount.

GetBytes returns the number of available bytes in the field. Frequently 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.

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

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

.NET Framework
Available since 1.1
Return to top
Show: