Export (0) Print
Expand All

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
)

Parameters

i
Type: System.Int32
The zero-based column ordinal.
fieldoffset
Type: System.Int64
The index within the row from which to start the read operation.
buffer
Type: System.Char[]
The buffer into which to read the stream of bytes.
bufferoffset
Type: System.Int32
The index for buffer to start the read operation.
length
Type: System.Int32
The number of bytes to read.

Return Value

Type: System.Int64
The actual number of characters read.

ExceptionCondition
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 null, GetChars returns the length of the field in characters.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft