IDataRecord.GetChars メソッド

.NET Framework クラス ライブラリ リファレンス

IDataRecord.GetChars メソッド

指定したバッファ オフセットを開始位置として、指定した列オフセットからバッファに、文字のストリームを配列として読み込みます。

名前空間: System.Data
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Function GetChars ( _
    i As Integer, _
    fieldoffset As Long, _
    buffer As Char(), _
    bufferoffset As Integer, _
    length As Integer _
) As Long

Visual Basic (使用法)

Dim instance As IDataRecord
Dim i As Integer
Dim fieldoffset As Long
Dim buffer As Char()
Dim bufferoffset As Integer
Dim length As Integer
Dim returnValue As Long

returnValue = instance.GetChars(i, fieldoffset, buffer, bufferoffset, length)

C#

long GetChars (
    int i,
    long fieldoffset,
    char[] buffer,
    int bufferoffset,
    int length
)

C++

long long GetChars (
    int i, 
    long long fieldoffset, 
    array<wchar_t>^ buffer, 
    int bufferoffset, 
    int length
)

J#

long GetChars (
    int i, 
    long fieldoffset, 
    char[] buffer, 
    int bufferoffset, 
    int length
)

JScript

function GetChars (
    i : int, 
    fieldoffset : long, 
    buffer : char[], 
    bufferoffset : int, 
    length : int
) : long

パラメータ

i

列の 0 から始まる序数。

fieldoffset

読み取り操作を開始する行内のインデックス。

buffer

バイト ストリームの読み込み先のバッファ。

bufferoffset

読み取り操作を開始する buffer のインデックス。

length

読み込むバイト数。

戻り値
実際に読み込んだ文字数。

例外

例外の種類	条件
IndexOutOfRangeException	渡されたインデックスが 0 から FieldCount の範囲にありません。

解説

GetChars は、フィールド内で利用可能な文字数を返します。ほとんどの場合、これは正確なフィールド長です。ただし、フィールドから文字を取得するために GetChars が既に使用されている場合、返される数値はそのフィールドの正確な長さよりも小さいことがあります。

null 参照 (Visual Basic では Nothing) のバッファを渡すと、GetChars は、文字単位のフィールド長を返します。

変換は実行されません。したがって、取得されたデータは既に文字配列である必要があります。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
IDataRecord インターフェイス
IDataRecord メンバ
System.Data 名前空間