This documentation is archived and is not being maintained.

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.

[Visual Basic]
Function GetChars( _
   ByVal i As Integer, _
   ByVal fieldoffset As Long, _
   ByVal buffer() As Char, _
   ByVal bufferoffset As Integer, _
   ByVal length As Integer _
) As Long
[C#]
long GetChars(
   int i,
 long fieldoffset,
 char[] buffer,
 int bufferoffset,
 int length
);
[C++]
__int64 GetChars(
   int i,
 __int64 fieldoffset,
 __wchar_t buffer __gc[],
 int bufferoffset,
 int length
);
[JScript]
function GetChars(
   i : int,
 fieldoffset : long,
 buffer : Char[],
 bufferoffset : int,
 length : int
) : long;

Parameters

i
The zero-based column ordinal.
fieldoffset
The index within the row from which to begin the read operation.
buffer
The buffer into which to read the stream of bytes.
bufferoffset
The index for buffer to begin the read operation.
length
The number of bytes to read.

Return Value

The actual number of characters read.

Exceptions

Exception Type Condition
IndexOutOfRangeException The index passed was outside the range of 0 through FieldCount.

Remarks

GetChars returns the number of available characters in the field. In most cases 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 a null reference (Nothing in Visual Basic), GetChars returns the length of the field in characters.

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

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

IDataRecord Interface | IDataRecord Members | System.Data Namespace

Show: