GetChars Method
Collapse the table of content
Expand the table of content

SqlDataRecord.GetChars Method

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 long GetChars(
	int ordinal,
	long fieldOffset,
	char[] buffer,
	int bufferOffset,
	int length


Type: System.Int32

The zero-based ordinal of the column.

Type: System.Int64

The offset into the field value to start retrieving characters.

Type: System.Char[]

The target buffer to copy chars to.

Type: System.Int32

The offset into the buffer to start copying chars to.

Type: System.Int32

The number of chars to copy to the buffer.

Return Value

Type: System.Int64
The number of characters copied.


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


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


The column specified by ordinal is null.


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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

© 2015 Microsoft