System.Data Namespace IDataRecord Class
Returns the value of the specified column as a byte array.
[ VB ]
NotOverridable Public Function GetBytes ( _
ByVal index As Integer, _
ByVal dataIndex As Long, _
ByVal buffer ( ) As Byte, _
ByVal bufferIndex As Integer, _
ByVal length As Integer _
) As Long
[ C# ]
public long GetBytes (
int index,
long dataIndex,
byte [ ] buffer,
int bufferIndex,
int length
);
[ C++ ]
public: __sealed int64 GetBytes (
int index,
int64 dataIndex,
unsigned char* buffer [ ],
int bufferIndex,
int length
);
[ JScript ]
public function GetBytes (
index : int,
dataIndex : long,
buffer : Byte [ ],
bufferIndex : int,
length : int
) : long
- index
- 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.
The actual number of bytes read.
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 IDataRecord is reading a large data structure into a buffer.
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.
IDataRecord Members
