SqlCeResultSet.GetChars Method
Copies a length of chars 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 GetChars ( _
ordinal As Integer, _
dataIndex As Long, _
buffer As Char(), _
bufferIndex As Integer, _
length As Integer _
) As Long
'Usage
Dim instance As SqlCeResultSet
Dim ordinal As Integer
Dim dataIndex As Long
Dim buffer As Char()
Dim bufferIndex As Integer
Dim length As Integer
Dim returnValue As Long
returnValue = instance.GetChars(ordinal, _
dataIndex, buffer, bufferIndex, length)
public override long GetChars(
int ordinal,
long dataIndex,
char[] buffer,
int bufferIndex,
int length
)
public:
virtual long long GetChars(
int ordinal,
long long dataIndex,
array<wchar_t>^ buffer,
int bufferIndex,
int length
) override
abstract GetChars :
ordinal:int *
dataIndex:int64 *
buffer:char[] *
bufferIndex:int *
length:int -> int64
override GetChars :
ordinal:int *
dataIndex:int64 *
buffer:char[] *
bufferIndex:int *
length:int -> int64
public override function GetChars(
ordinal : int,
dataIndex : long,
buffer : char[],
bufferIndex : int,
length : int
) : long
Parameters
- ordinal
Type: System.Int32
The ordinal position of the field from which to retrieve data.
- dataIndex
Type: System.Int64
The offset (in chars) within the field from which to start copying.
- buffer
Type: array<System.Char[]
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 chars copied.
Implements
IDataRecord.GetChars(Int32, Int64, array<Char[], Int32, Int32)
Remarks
This function returns the actual number of chars copied, which can be less than the requested length if the end of the field is reached.
If you pass in a null buffer, GetChars returns the length of the field, in chars.
If the command is executed with a command behavior of SequentialAccess, calls to GetChars must specify sequentially increasing reads; otherwise, an exception is thrown.
An exception is thrown if no field exists at the specified ordinal position.