SqlCeDataReader.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.
Public Overridable Function GetChars( _
ByVal ordinal As Integer, _ ByVal dataIndex As Long, _ ByVal buffer() As Char, _ ByVal bufferIndex As Integer, _ ByVal length As Integer _) As Long Implements IDataRecord.GetChars
[C#]
public virtual long GetChars(intordinal,longdataIndex,char[] buffer,intbufferIndex,intlength);
[C++]
public: virtual __int64 GetChars(intordinal,__int64dataIndex,__wchar_tbuffer __gc[],intbufferIndex,intlength);
[JScript]
public function GetChars(
ordinal : int,dataIndex : long,buffer : Char[],bufferIndex : int,length : int) : long;
Parameters
- ordinal
The zero-based column ordinal. - dataIndex
The index within the row from which to begin the read operation. - buffer
The buffer into which to copy data. - bufferIndex
The index for buffer to begin the read operation. - length
The number of characters to read.
Return Value
The actual number of characters read.
Implements
Exceptions
| Exception Type | Condition |
|---|---|
| InvalidOperationException | The operation is not valid. The SqlCeDataReader may be positioned after the last row in the result set. |
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, when the SqlCeDataReader 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 null, GetChars returns the length of the field in characters.
No conversions are performed; therefore, the data retrieved must already be a character array.
Requirements
Platforms: .NET Compact Framework
.NET Framework Security:
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries From Partially Trusted Code
See Also
SqlCeDataReader Class | SqlCeDataReader Members | System.Data.SqlServerCe Namespace