SqlDataRecord.GetChars メソッド

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

SqlDataRecord.GetChars メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

序数で指定された列の値を Char オブジェクトの配列として取得します。

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

Visual Basic (宣言)

Public Function GetChars ( _
    ordinal As Integer, _
    fieldOffset As Long, _
    buffer As Char(), _
    bufferOffset As Integer, _
    length As Integer _
) As Long

Visual Basic (使用法)

Dim instance As SqlDataRecord
Dim ordinal 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(ordinal, fieldOffset, buffer, bufferOffset, length)

C#

public long GetChars (
    int ordinal,
    long fieldOffset,
    char[] buffer,
    int bufferOffset,
    int length
)

C++

public:
virtual long long GetChars (
    int ordinal, 
    long long fieldOffset, 
    array<wchar_t>^ buffer, 
    int bufferOffset, 
    int length
) sealed

J#

public final long GetChars (
    int ordinal, 
    long fieldOffset, 
    char[] buffer, 
    int bufferOffset, 
    int length
)

JScript

public final function GetChars (
    ordinal : int, 
    fieldOffset : long, 
    buffer : char[], 
    bufferOffset : int, 
    length : int
) : long

パラメータ

ordinal

列の 0 から始まる序数。

fieldOffset

フィールド値のオフセット (取得する文字の開始位置)。

buffer

文字のコピー先バッファ。

bufferOffset

バッファ内のオフセット (文字のコピー開始位置)。

length

バッファにコピーする文字数。

戻り値
コピーされた文字数。

例外

例外の種類	条件
IndexOutOfRangeException	ordinal が 0 未満か、列数 (FieldCount) を超えています。
SqlNullValueException	ordinal で指定された列が null 参照 (Visual Basic では Nothing) です。
InvalidCastException	型が一致していません。

解説

このメソッドでは、1 回の呼び出しで文字値を取得できるほか、複数のチャンクから文字値を取得することもできます。チャンクから値を取得することは、大きな値または未知のサイズを持つ値の場合に有効な手段となります。

複数のチャンクから値を取得するには、チャンク サイズの文字配列を割り当て、毎回 fieldOffset パラメータを調整しながら GetChars を繰り返し呼び出します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
SqlDataRecord クラス
SqlDataRecord メンバ
Microsoft.SqlServer.Server 名前空間