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

Definition

Gets the value for the column specified by the ordinal as an array of Char objects.

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

Parameters

ordinal
Int32 Int32 Int32 Int32

The zero-based ordinal of the column.

fieldOffset
Int64 Int64 Int64 Int64

The offset into the field value to start retrieving characters.

buffer
Char[]

The target buffer to copy chars to.

bufferOffset
Int32 Int32 Int32 Int32

The offset into the buffer to start copying chars to.

length
Int32 Int32 Int32 Int32

The number of chars to copy to the buffer.

Returns

The number of characters copied.

Implements

Exceptions

The ordinal is less than 0 or greater than the number of columns (that is, FieldCount).

Remarks

This method enables you to obtain a character value either in a single call or in chunks. Getting the value in chunks is useful for large values or values of unknown size.

To obtain the value in several chunks, allocate a char array of the chunk-size and call GetChars repeatedly adjusting the fieldOffset parameter accordingly in each call.

Applies to