SqlCeResultSet.GetBytes Method

Article
10/22/2009

Copies a length of bytes into the buffer, starting at a specified position in the specified field.

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

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

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

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

Parameters

ordinal
The ordinal position of the column from which retrieve data.

dataIndex
The offset (in bytes) within the field from which to start copying data.

buffer
The buffer into which to copy the data.

bufferIndex
The offset within the buffer from which to start the copy.

length
The maximum number of bytes to copy.

Return Value

The actual number of bytes copied to the buffer.

Remarks

This function returns the actual number of bytes copied, which can be less than the requested length if the end of the field is reached.

If you pass in a null buffer, GetBytes returns the length of the field, in bytes.

If the command is executed with a command behavior of SequentialAccess, calls to GetBytes must specify sequentially increasing reads; otherwise, an exception is thrown.

GetBytes can only be called for columns with an underlying type of binary or varbinary, or that were constructed with objects that can be cast to a byte array.

An exception is thrown if no field exists at the specified ordinal position.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows Mobile 5.0, Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003, Windows Mobile 2003 for Pocket PC, Windows CE 5.0
Version Information
.NET Framework and NET Compact Framework
Supported in 3.5
.NET Framework
Supported in 3.0
.NET Compact Framework and .Net Framework
Supported in 2.0