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

Definition

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

public:
 virtual long GetChars(int i, long fieldOffset, cli::array <char> ^ buffer2, int bufferoffset, int length);
public:
 override long GetChars(int i, long fieldOffset, cli::array <char> ^ buffer2, int bufferoffset, int length);
public long GetChars (int i, long fieldOffset, char[] buffer2, int bufferoffset, int length);
public override long GetChars (int i, long fieldOffset, char[] buffer2, int bufferoffset, int length);
abstract member GetChars : int * int64 * char[] * int * int -> int64
override this.GetChars : int * int64 * char[] * int * int -> int64
override this.GetChars : int * int64 * char[] * int * int -> int64
Public Function GetChars (i As Integer, fieldOffset As Long, buffer2 As Char(), bufferoffset As Integer, length As Integer) As Long
Public Overrides Function GetChars (i As Integer, fieldOffset As Long, buffer2 As Char(), bufferoffset As Integer, length As Integer) As Long

Parameters

i
Int32

The zero-based column ordinal.

fieldOffset
Int64

The index within the row where the read operation is to begin.

buffer2
Char[]

The buffer into which to copy data.

bufferoffset
Int32

The index where buffer2 is to begin the write operation.

length
Int32

The number of characters to read.

Returns

The actual number of characters read.

Implements

Remarks

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, if the OracleDataReader is reading a large data structure into a buffer. For more information, see the SequentialAccess setting of CommandBehavior.

If you pass a buffer that is a null value. GetChars returns the length of the field in characters.

Applies to