SqlCeResultSet.GetBytes Method
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
'Usage
Dim instance As SqlCeResultSet
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 ordinal position of the column from which retrieve data.
- dataIndex
Type: System.Int64
The offset (in bytes) within the field from which to start copying data.
- buffer
Type: array<System.Byte[]
The buffer into which to copy the data.
- bufferIndex
Type: System.Int32
The offset within the buffer from which to start the copy.
- length
Type: System.Int32
The maximum number of bytes to copy.
Return Value
Type: System.Int64
The actual number of bytes copied to the buffer.
Implements
IDataRecord.GetBytes(Int32, Int64, array<Byte[], Int32, Int32)
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.