This documentation is archived and is not being maintained.

OracleDataReader.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 fieldOffset As Long, _
   ByVal buffer2() As Char, _
   ByVal bufferoffset As Integer, _
   ByVal length As Integer _
) As Long Implements IDataRecord.GetChars
public virtual long GetChars(
 int i,
 long fieldOffset,
 char[] buffer2,
 int bufferoffset,
 int length
public: virtual __int64 GetChars(
 int i,
 __int64 fieldOffset,
 __wchar_t buffer2 __gc[],
 int bufferoffset,
 int length
public function GetChars(
   i : int,
 fieldOffset : long,
 buffer2 : Char[],
 bufferoffset : int,
 length : int
) : long;


The zero-based column ordinal.
The index within the row where the read operation is to begin.
The buffer into which to copy data.
The index where buffer is to begin the write operation.
The number of characters to read.

Return Value

The actual number of characters read.




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

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


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

.NET Framework Security: 

See Also

OracleDataReader Class | OracleDataReader Members | System.Data.OracleClient Namespace