Export (0) Print
Expand All

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

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 actual number of characters read.

Implements

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

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 true length of the field if GetChars has already been used to obtain characters from the field. This may be the case, for example, if the SqlDataReader is reading a large data structure into a buffer. For more information, see the SequentialAccess setting for CommandBehavior.

The actual number of characters read can be less than the requested length, if the end of the field is reached. If you pass a buffer that is null, GetChars returns the length of the entire field in characters, not the remaining size based on the buffer offset parameter.

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

NoteNote

The GetChars method returns 0 when dataIndex is negative.

.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