SqlCeDataReader.GetChars Method

Reads a stream of characters 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)


Public Overrides Function GetChars ( _
    ordinal As Integer, _
    dataIndex As Long, _
    buffer As Char(), _
    bufferIndex As Integer, _
    length As Integer _
) As Long
public override long GetChars (
    int ordinal,
    long dataIndex,
    char[] buffer,
    int bufferIndex,
    int length
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


  • ordinal
    The zero-based column ordinal.
  • dataIndex
    The index within the row from which to begin the read operation.
  • buffer
    The buffer into which to copy data.
  • bufferIndex
    The index for buffer to begin the read operation.
  • length
    The number of characters to read.

Return Value

The actual number of characters read.


Exception type Condition

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


GetChars returns the number of available characters 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 GetChars has already been used to obtain characters 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, GetChars returns the length of the field in characters.

No conversions are performed; therefore, the data retrieved must already be a character array.

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.


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

See Also


SqlCeDataReader Class
SqlCeDataReader Members
System.Data.SqlServerCe Namespace