SqlDataReader.GetBytes Method
Reads a stream of bytes from the specified column offset into the buffer an array starting at the given buffer offset.
Namespace: System.Data.SqlClient
Assembly: System.Data (in System.Data.dll)
abstract GetBytes : i:int * dataIndex:int64 * buffer:byte[] * bufferIndex:int * length:int -> int64 override GetBytes : i:int * dataIndex:int64 * buffer:byte[] * bufferIndex:int * length:int -> int64
Parameters
- i
- Type: System.Int32
The zero-based column ordinal.
- dataIndex
- Type: System.Int64
The index within the field from which to begin the read operation.
- buffer
- Type: System.Byte[]
The buffer into which to read the stream of bytes.
- bufferIndex
- Type: System.Int32
The index within the buffer where the write operation is to start.
- length
- Type: System.Int32
The maximum length to copy into the buffer.
Implements
IDataRecord.GetBytes(Int32, Int64, Byte[], Int32, Int32)GetBytes returns the number of available bytes in the field. Most of the time 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 entire field in bytes, not the remaining size based on the buffer offset parameter.
No conversions are performed; therefore, the data retrieved must already be a byte array.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
