Export (0) Print
Expand All

OdbcDataReader.GetChars Method

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

Namespace:  System.Data.Odbc
Assembly:  System.Data (in System.Data.dll)

'Declaration
Public Overrides Function GetChars ( _
	i As Integer, _
	dataIndex As Long, _
	buffer As Char(), _
	bufferIndex As Integer, _
	length As Integer _
) As Long

Parameters

i
Type: System.Int32

The zero-based column ordinal.

dataIndex
Type: System.Int64

The index within the row where the read operation is to start.

buffer
Type: System.Char()

The buffer into which to copy data.

bufferIndex
Type: System.Int32

The index within the buffer where the write operation is to start.

length
Type: System.Int32

The number of characters to read.

Return Value

Type: System.Int64
The actual number of characters read.

Implements

IDataRecord.GetChars(Int32, Int64, Char(), Int32, Int32)

GetChars returns the number of available characters in the field. Most of the time 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.

NoteNote

No exception will be thrown if the value of bufferIndex is outside the array. No data will be read and the method will return 0.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft