SqlDataReader.GetChars メソッド

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

SqlDataReader.GetChars メソッド

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

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As SqlDataReader
Dim i As Integer
Dim dataIndex As Long
Dim buffer As Char()
Dim bufferIndex As Integer
Dim length As Integer
Dim returnValue As Long

returnValue = instance.GetChars(i, dataIndex, buffer, bufferIndex, length)

C#

public override long GetChars (
    int i,
    long dataIndex,
    char[] buffer,
    int bufferIndex,
    int length
)

C++

public:
virtual long long GetChars (
    int i, 
    long long dataIndex, 
    array<wchar_t>^ buffer, 
    int bufferIndex, 
    int length
) override

J#

public long GetChars (
    int i, 
    long dataIndex, 
    char[] buffer, 
    int bufferIndex, 
    int length
)

JScript

public override function GetChars (
    i : int, 
    dataIndex : long, 
    buffer : char[], 
    bufferIndex : int, 
    length : int
) : long

パラメータ

i

列の 0 から始まる序数。

dataIndex

読み取り操作を開始するフィールド内のインデックス。

buffer

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

bufferIndex

書き込み操作を開始する buffer のインデックス。

length

バッファにコピーする最大データ長。

戻り値
実際に読み込まれた文字数。

解説

GetChars は、フィールド内で利用可能な文字数を返します。ほとんどの場合、これは正確なフィールド長です。ただし、既に GetChars を使用してフィールドから文字を取得している場合は、返される文字数が、フィールドの実際の長さよりも小さくなることがあります。これは、SqlDataReader が大きいデータ構造体をバッファに読み込んでいるときなどに起こります。詳細については、CommandBehavior の SequentialAccess 設定のトピックを参照してください。

フィールドの末尾に達した場合は、実際に読み込まれる文字数が、要求した文字数より少なくなることがあります。null 参照 (Visual Basic では Nothing) のバッファを渡すと、GetChars は、バッファ オフセット パラメータに基づく残りのサイズではなく、フィールド全体の長さを文字単位で返します。

変換は実行されません。そのため、取得するデータは文字配列である必要があります。

メモ
CommandBehavior が SequentialAccess に設定されている場合は、GetChars を使用して VarChar 列をチャンクとして読み取ることはできません。

プラットフォーム

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

参照

関連項目
SqlDataReader クラス
SqlDataReader メンバ
System.Data.SqlClient 名前空間
その他の技術情報
ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用