SqlDataRecord::GetChars Method
Gets the value for the column specified by the ordinal as an array of Char objects.
Assembly: System.Data (in System.Data.dll)
public: virtual long long GetChars( int ordinal, long long fieldOffset, array<wchar_t>^ buffer, int bufferOffset, int length )
Parameters
- ordinal
- Type: System::Int32
The zero-based ordinal of the column.
- fieldOffset
- Type: System::Int64
The offset into the field value to start retrieving characters.
- buffer
- Type: array<System::Char>
The target buffer to copy chars to.
- bufferOffset
- Type: System::Int32
The offset into the buffer to start copying chars to.
- length
- Type: System::Int32
The number of chars to copy to the buffer.
Implements
IDataRecord::GetChars(Int32, Int64, array<Char>, Int32, Int32)| Exception | Condition |
|---|---|
| IndexOutOfRangeException | The ordinal is less than 0 or greater than the number of columns (that is, FieldCount). |
| SqlNullValueException | The column specified by ordinal is null. |
| InvalidCastException | There is a type mismatch. |
This method enables you to obtain a character value either in a single call or in chunks. Getting the value in chunks is useful for large values or values of unknown size.
To obtain the value in several chunks, allocate a char array of the chunk-size and call GetChars repeatedly adjusting the fieldOffset parameter accordingly in each call.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.