Export (0) Print
Expand All

SqlDataReader.GetBytes Method

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

[Visual Basic]
Public Overridable Function GetBytes( _
   ByVal i As Integer, _
   ByVal dataIndex As Long, _
   ByVal buffer() As Byte, _
   ByVal bufferIndex As Integer, _
   ByVal length As Integer _
) As Long Implements IDataRecord.GetBytes
[C#]
public virtual long GetBytes(
 int i,
 long dataIndex,
 byte[] buffer,
 int bufferIndex,
 int length
);
[C++]
public: virtual __int64 GetBytes(
 int i,
 __int64 dataIndex,
 unsigned char buffer __gc[],
 int bufferIndex,
 int length
);
[JScript]
public function GetBytes(
   i : int,
 dataIndex : long,
 buffer : Byte[],
 bufferIndex : int,
 length : int
) : long;

Parameters

i
The zero-based column ordinal.
dataIndex
The index within the field from which to begin the read operation.
buffer
The buffer into which to read the stream of bytes.
bufferIndex
The index for buffer to begin the read operation.
length
The maximum length to copy into the buffer.

Return Value

The actual number of bytes read.

Implements

IDataRecord.GetBytes

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. This may be the case, for example, if the SqlDataReader 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 a null reference (Nothing in Visual Basic), GetBytes returns the length of the field 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

SqlDataReader Class | SqlDataReader Members | System.Data.SqlClient Namespace

Show:
© 2014 Microsoft