IDataRecord.GetBytes(Int32, Int64, Byte[], Int32, Int32) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Reads a stream of bytes from the specified column offset into the buffer as an array, starting at the given buffer offset.
public:
long GetBytes(int i, long fieldOffset, cli::array <System::Byte> ^ buffer, int bufferoffset, int length);public long GetBytes (int i, long fieldOffset, byte[] buffer, int bufferoffset, int length);public long GetBytes (int i, long fieldOffset, byte[]? buffer, int bufferoffset, int length);abstract member GetBytes : int * int64 * byte[] * int * int -> int64Public Function GetBytes (i As Integer, fieldOffset As Long, buffer As Byte(), bufferoffset As Integer, length As Integer) As LongParameters
- i
- Int32
The zero-based column ordinal.
- fieldOffset
- Int64
The index within the field from which to start the read operation.
- buffer
- Byte[]
The buffer into which to read the stream of bytes.
- bufferoffset
- Int32
The index for buffer to start the read operation.
- length
- Int32
The number of bytes to read.
Returns
The actual number of bytes read.
Exceptions
The index passed was outside the range of 0 through FieldCount.
Remarks
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.
