This documentation is archived and is not being maintained.

IDataRecord.GetChars Method

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

Namespace: System.Data
Assembly: System.Data (in system.data.dll)

long GetChars (
	int i,
	long fieldoffset,
	char[] buffer,
	int bufferoffset,
	int length
)
long GetChars (
	int i, 
	long fieldoffset, 
	char[] buffer, 
	int bufferoffset, 
	int length
)
function GetChars (
	i : int, 
	fieldoffset : long, 
	buffer : char[], 
	bufferoffset : int, 
	length : int
) : long

Parameters

i

The zero-based column ordinal.

fieldoffset

The index within the row from which to start the read operation.

buffer

The buffer into which to read the stream of bytes.

bufferoffset

The index for buffer to start the read operation.

length

The number of bytes to read.

Return Value

The actual number of characters read.

Exception typeCondition

IndexOutOfRangeException

The index passed was outside the range of 0 through FieldCount.

GetChars returns the number of available characters in the field. Frequently this is the exact length of the field. However, the number returned may be less than the exact length of the field if GetChars has already been used to obtain characters from the field.

If you pass a buffer that is a null reference (Nothing in Visual Basic), GetChars returns the length of the field in characters.

No conversions are performed; therefore the data retrieved must already be a character array.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Show: