OleDbDataReader.GetChars Method (Int32, Int64, Char[], Int32, Int32)

 

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 System.Data.dll)

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

Parameters

ordinal
Type: System.Int32

The zero-based column ordinal.

dataIndex
Type: System.Int64

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

buffer
Type: System.Char[]

The buffer into which to copy data.

bufferIndex
Type: System.Int32

The index within the buffer where the write operation is to start.

length
Type: System.Int32

The number of characters to read.

Return Value

Type: System.Int64

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 null, GetChars returns the length of the field in characters.

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

.NET Framework
Available since 1.1
Return to top
Show: