Mimer SQL Data Provider help
GetChars Method




Mimer.Data.Client Namespace > MimerDataReader Class : GetChars Method
The zero-based column ordinal position.
The offset within the field from which to begin the read operation.
The buffer into which to read the stream of characters.
The offset for buffer to begin the read operation.
The maximum length to copy into the buffer.
Reads a stream of characters from the specified column offset into the buffer starting at the given buffer offset.
Syntax
'Declaration
 
Public Overrides NotOverridable Function GetChars( _
   ByVal i As Integer, _
   ByVal fieldOffset As Long, _
   ByVal buffer() As Char, _
   ByVal bufferOffset As Integer, _
   ByVal bufferLength As Integer _
) As Long
public override long GetChars( 
   int i,
   long fieldOffset,
   char[] buffer,
   int bufferOffset,
   int bufferLength
)
public function GetChars( 
    i: Integer;
    fieldOffset: Int64;
    buffer: Chararray of;
    bufferOffset: Integer;
    bufferLength: Integer
): Int64; override; 
public override function GetChars( 
   i : int,
   fieldOffset : long,
   buffer : char[],
   bufferOffset : int,
   bufferLength : int
) : long;
public: long GetChars( 
   int i,
   long fieldOffset,
   char[]* buffer,
   int bufferOffset,
   int bufferLength
) override 

Parameters

i
The zero-based column ordinal position.
fieldOffset
The offset within the field from which to begin the read operation.
buffer
The buffer into which to read the stream of characters.
bufferOffset
The offset for buffer to begin the read operation.
bufferLength
The maximum length to copy into the buffer.

Return Value

The actual number of characters read.
Exceptions
ExceptionDescription
The underlying SQL data type cannot be converted to a char array.
The MimerDataReader is not positioned on a row.
Remarks
If buffer is null, GetBytes returns the length of the field.

Supported SQL data types for the conversion are: CHAR, VARCHAR, NCHAR, NVARCHAR, CLOB, and NCLOB.

Use the IsDBNull method to check for database null value before calling this method.

Requirements

.NET Framework
Version 2.0 or later

See Also

Reference

MimerDataReader Class
MimerDataReader Members