DB2DataReader.GetChars Method

Syntax

[Visual Basic]
Public Function GetChars( _
   ByVal i As Integer, _
   ByVal dataIndex As Long, _
   ByVal buffer() As Char, _
   ByVal bufferIndex As Integer, _
   ByVal length As Integer _
) As Long
[C#]
public long GetChars(
   int i,
   long dataIndex,
   char[] buffer,
   int bufferIndex,
   int length
);
[C++]
public: __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.

Exceptions

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 DB2®DataReader is reading a CLOB into a buffer. For more information, see the SequentialAccess setting of System.Data.CommandBehavior in the Microsoft(R) .NET Framework SDK documentation.

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