This topic has not yet been rated - Rate this topic

SqlDataReader.GetChars Method

.NET Framework 3.5

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.SqlClient
Assembly: System.Data (in System.Data.dll)

Syntax

C++

JScript

Copy

public override long GetChars(
	int i,
	long dataIndex,
	char[] buffer,
	int bufferIndex,
	int length
)

Parameters

i: Type: System.Int32
The zero-based column ordinal.

dataIndex: Type: System.Int64
The index within the field from which to begin the read operation.

buffer: Type: System.Char[]
The buffer into which to read the stream of bytes.

bufferIndex: Type: System.Int32
The index within the buffer where the write operation is to start.

length: Type: System.Int32
The maximum length to copy into the buffer.

Return Value

Type: System.Int64
The number of characters read.

Implements

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

Remarks

If you call GetChars with a non-null buffer, the data is read into the buffer, and GetChars will return the number of bytes that were read into the buffer.

If you call GetChars with a null buffer, then no data is read, and GetChars will return the number of bytes that are available to read.

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

Note:
The GetChars method returns 0 when dataIndex is negative.

Platforms

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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.

Version Information