This documentation is archived and is not being maintained.

IDataRecord.GetBytes Method

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

[Visual Basic]
Function GetBytes( _
   ByVal i As Integer, _
   ByVal fieldOffset As Long, _
   ByVal buffer() As Byte, _
   ByVal bufferoffset As Integer, _
   ByVal length As Integer _
) As Long
[C#]
long GetBytes(
   int i,
 long fieldOffset,
 byte[] buffer,
 int bufferoffset,
 int length
);
[C++]
__int64 GetBytes(
   int i,
 __int64 fieldOffset,
 unsigned char buffer __gc[],
 int bufferoffset,
 int length
);
[JScript]
function GetBytes(
   i : int,
 fieldOffset : long,
 buffer : Byte[],
 bufferoffset : int,
 length : int
) : long;

Parameters

i
The zero-based column ordinal.
fieldOffset
The index within the field from which to begin the read operation.
buffer
The buffer into which to read the stream of bytes.
bufferoffset
The index for buffer to begin the read operation.
length
The number of bytes to read.

Return Value

The actual number of bytes read.

Exceptions

Exception Type Condition
IndexOutOfRangeException The index passed was outside the range of 0 through FieldCount.

Remarks

GetBytes returns the number of available bytes in the field. In most cases 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 a null reference (Nothing in Visual Basic), GetBytes returns the length of the row in bytes.

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

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

IDataRecord Interface | IDataRecord Members | System.Data Namespace

Show: