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

Reference

Definition

Namespace:: System.Data.OleDb

Assembly:: System.Data.OleDb.dll

Assembly:: System.Data.dll

Package:: System.Data.OleDb v6.0.0

Package:: System.Data.OleDb v7.0.0

Package:: System.Data.OleDb v8.0.0

Package:: System.Data.OleDb v9.0.0-preview.2.24128.5

Source:: OleDbDataReader.cs

Source:: OleDbDataReader.cs

Source:: OleDbDataReader.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Reads a stream of characters from the specified column offset into the buffer as an array starting at the given buffer offset.

public:
 override long GetChars(int ordinal, long dataIndex, cli::array <char> ^ buffer, int bufferIndex, int length);

public:
 virtual long GetChars(int ordinal, long dataIndex, cli::array <char> ^ buffer, int bufferIndex, int length);

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

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);

override this.GetChars : int * int64 * char[] * int * int -> int64

abstract member GetChars : int * int64 * char[] * int * int -> int64
override this.GetChars : int * int64 * char[] * int * int -> int64

Public Overrides Function GetChars (ordinal As Integer, dataIndex As Long, buffer As Char(), bufferIndex As Integer, length As Integer) As Long

Public Function GetChars (ordinal As Integer, dataIndex As Long, buffer As Char(), bufferIndex As Integer, length As Integer) As Long

Parameters

ordinal: Int32

The zero-based column ordinal.

dataIndex: Int64

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

buffer: Char[]

The buffer into which to copy data.

bufferIndex: Int32

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

length: Int32

The number of characters to read.

Returns

Int64

The actual number of characters read.

Implements

GetChars(Int32, Int64, Char[], Int32, Int32)

Remarks

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.

Applies to