This documentation is archived and is not being maintained.

SqlDataRecord.GetChars Method

Note: This method is new in the .NET Framework version 2.0.

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

Parameters

ordinal

The zero-based ordinal of the column.

fieldOffset

The offset into the field value to start retrieving characters.

buffer

The target buffer to copy chars to.

bufferOffset

The offset into the buffer to start copying chars to.

length

The number of chars to copy to the buffer.

Return Value

The number of characters copied.

Exception typeCondition

IndexOutOfRangeException

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

SqlNullValueException

The column specified by ordinal is a null reference (Nothing in Visual Basic).

InvalidCastException

There is a type mismatch.

This method allows 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 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show: