This documentation is archived and is not being maintained.

OdbcDataReader.GetChars Method

Note: This namespace, class, or member is supported only in version 1.1 of the .NET Framework.

Reads a stream of characters from the specified column offset into the buffer as an array, starting at the given buffer offset.

[Visual Basic]
Public Overridable Function GetChars( _
   ByVal i As Integer, _
   ByVal dataIndex As Long, _
   ByVal buffer() As Char, _
   ByVal bufferIndex As Integer, _
   ByVal length As Integer _
) As Long Implements IDataRecord.GetChars
[C#]
public virtual long GetChars(
 int i,
 long dataIndex,
 char[] buffer,
 int bufferIndex,
 int length
);
[C++]
public: virtual __int64 GetChars(
 int i,
 __int64 dataIndex,
 __wchar_t buffer __gc[],
 int bufferIndex,
 int length
);
[JScript]
public 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 row where the read operation is to begin.
buffer
The buffer into which to copy data.
bufferIndex
The index where buffer is to begin the write operation.
length
The number of characters to read.

Return Value

The actual number of characters read.

Implements

IDataRecord.GetChars

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 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 OdbcDataReader is reading a large data structure into a buffer. For more information, see the SequentialAccess setting for CommandBehavior.

If you pass a buffer that is a null value, GetChars returns the length of the field in characters.

Conversions are performed based on the underlying capabilities of the ODBC driver. If the conversion is not supported then the method call will fail.

Requirements

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

See Also

OdbcDataReader Class | OdbcDataReader Members | System.Data.Odbc Namespace

Show: