Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
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
)
public long GetChars (
	int i, 
	long dataIndex, 
	char[] buffer, 
	int bufferIndex, 
	int length
)
public override function GetChars (
	i : int, 
	dataIndex : long, 
	buffer : char[], 
	bufferIndex : int, 
	length : int
) : long

Parameters

i

The zero-based column ordinal.

dataIndex

The index within the field from which to begin the read operation.

buffer

The buffer into which to read the stream of bytes.

bufferIndex

The index for buffer to begin the write operation.

length

The maximum length to copy into the buffer.

Return Value

The actual number of characters read.

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 a null reference (Nothing in Visual Basic), 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

You cannot use GetChars to read a VarChar column in chunks if CommandBehavior is set to SequentialAccess.

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

Community Additions

ADD
Show:
© 2015 Microsoft