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

 

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

Namespace:   Microsoft.SqlServer.Server
Assembly:  System.Data (in System.Data.dll)

Public Overridable Function GetChars (
	ordinal As Integer,
	fieldOffset As Long,
	buffer As Char(),
	bufferOffset As Integer,
	length As Integer
) As Long

Parameters

ordinal
Type: System.Int32

The zero-based ordinal of the column.

fieldOffset
Type: System.Int64

The offset into the field value to start retrieving characters.

buffer
Type: System.Char()

The target buffer to copy chars to.

bufferOffset
Type: System.Int32

The offset into the buffer to start copying chars to.

length
Type: System.Int32

The number of chars to copy to the buffer.

Return Value

Type: System.Int64

The number of characters copied.

Exception Condition
IndexOutOfRangeException

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

SqlNullValueException

The column specified by ordinal is null.

InvalidCastException

There is a type mismatch.

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.

.NET Framework
Available since 2.0
Return to top
Show: