This documentation is archived and is not being maintained.

OleDbDataReader.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.OleDb
Assembly: System.Data (in

public override long GetChars (
	int ordinal,
	long dataIndex,
	char[] buffer,
	int bufferIndex,
	int length
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



The zero-based column ordinal.


The index within the row from which to start the read operation.


The buffer into which to copy data.


The index for buffer to start the write operation.


The number of characters to read.

Return Value

The actual number of characters read.

GetChars returns the number of available characters in the field. Most of the time 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 OleDbDataReader 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 a null reference (Nothing in Visual Basic), GetChars returns the length of the field in characters.

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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0