GetChars Method

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


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


Type: System.Int32

The zero-based column ordinal.

Type: System.Int64

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

Type: System.Char[]

The buffer into which to read the stream of bytes.

Type: System.Int32

The index for buffer to start the read operation.

Type: System.Int32

The number of bytes to read.

Return Value

Type: System.Int64

The actual number of characters read.

Exception Condition

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
Available since 1.1
Return to top
© 2015 Microsoft