GetBytes Method

Article
09/27/2010

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

Namespace: System.Data.SqlServerCe
Assembly: System.Data.SqlServerCe (in System.Data.SqlServerCe.dll)

Syntax

'Declaration
Public Overrides Function GetBytes ( _
    ordinal As Integer, _
    dataIndex As Long, _
    buffer As Byte(), _
    bufferIndex As Integer, _
    length As Integer _
) As Long
'Usage
Dim instance As SqlCeDataReader
Dim ordinal As Integer
Dim dataIndex As Long
Dim buffer As Byte()
Dim bufferIndex As Integer
Dim length As Integer
Dim returnValue As Long

returnValue = instance.GetBytes(ordinal, _
    dataIndex, buffer, bufferIndex, length)

public override long GetBytes(
    int ordinal,
    long dataIndex,
    byte[] buffer,
    int bufferIndex,
    int length
)

public:
virtual long long GetBytes(
    int ordinal, 
    long long dataIndex, 
    array<unsigned char>^ buffer, 
    int bufferIndex, 
    int length
) override

abstract GetBytes : 
        ordinal:int * 
        dataIndex:int64 * 
        buffer:byte[] * 
        bufferIndex:int * 
        length:int -> int64 
override GetBytes : 
        ordinal:int * 
        dataIndex:int64 * 
        buffer:byte[] * 
        bufferIndex:int * 
        length:int -> int64

public override function GetBytes(
    ordinal : int, 
    dataIndex : long, 
    buffer : byte[], 
    bufferIndex : int, 
    length : int
) : long

Parameters

ordinal
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: array<System. . :: . .Byte> [] () [] []
The buffer into which to read the stream of bytes.

bufferIndex
Type: System. . :: . .Int32
The index for buffer to begin the read operation.

length
Type: System. . :: . .Int32
The maximum length to copy into the buffer.

Return Value

Type: System. . :: . .Int64
The actual number of bytes read.

Implements

IDataRecord. . :: . .GetBytes(Int32, Int64, array<Byte> [] () [] [], Int32, Int32)

Exceptions

Exception	Condition
InvalidOperationException	The operation is not valid. The SqlCeDataReader may be positioned after the last row in the result set.

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, when the SqlCeDataReader 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 null Nothing nullptr unit 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.

Share via