SqlCeResultSet.GetChars Method

Article
10/22/2007

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

public long GetChars (
    int ordinal, 
    long dataIndex, 
    char[] buffer, 
    int bufferIndex, 
    int length
)

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

Parameters

ordinal
The ordinal position of the field from which to retrieve data.

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

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 chars copied.

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 a null reference (Nothing in Visual Basic) 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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

Platforms

Windows CE, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows XP Professional x64 Edition, Windows XP SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Compact Framework

Supported in: 2.0