XmlReader.ReadValueChunk メソッド

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

XmlReader.ReadValueChunk メソッド

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

XML ドキュメントに埋め込まれたテキストの大量のストリームを読み込みます。

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

Visual Basic (宣言)

Public Overridable Function
 ReadValueChunk ( _
    buffer As Char(), _
    index As Integer, _
    count As Integer _
) As Integer

Visual Basic (使用法)

Dim instance As XmlReader
Dim buffer As Char()
Dim index As Integer
Dim count As Integer
Dim returnValue As Integer

returnValue = instance.ReadValueChunk(buffer, index, count)

C#

public virtual int ReadValueChunk (
    char[] buffer,
    int index,
    int count
)

C++

public:
virtual int ReadValueChunk (
    array<wchar_t>^ buffer, 
    int index, 
    int count
)

J#

public int ReadValueChunk (
    char[] buffer, 
    int index, 
    int count
)

JScript

public function ReadValueChunk (
    buffer : char[], 
    index : int, 
    count : int
) : int

パラメータ

buffer

テキストの内容が書き込まれるバッファとして機能する文字の配列。この値を null 参照 (Visual Basic では Nothing) にすることはできません。

index

XmlReader が結果のコピーを開始できる、バッファ内のオフセット。

count

バッファにコピーする最大文字数。コピーされた実際の文字数は、このメソッドから返されます。

戻り値
バッファ内へ読み取られた文字数。それ以上テキストの内容がない場合は、値として 0 が返されます。

例外

例外の種類	条件
InvalidOperationException	現在のノードに値がありません (HasValue が false)。
ArgumentNullException	buffer 値が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	バッファ内のインデックス、またはインデックスとカウントの合計値が、割り当てられているバッファ サイズを超えています。
NotSupportedException	その XmlReader 実装が、このメソッドをサポートしていません。
XmlException	XML データは、整形式ではありません。

解説

このメソッドでは、XML ドキュメントに埋め込まれた非常に大量のテキスト ストリームをストリーム転送方式で読み取ることができます。つまり、値全体に単一の文字列を割り当てて読み取る代わりに、1 回に少ない文字数を読み取ります。このメソッドは、値を持つ (HasValue が true) 任意のノードで呼び出すことができますが、ノード値の実際のストリーム転送は、テキスト、空白、および有意な空白の各ノードで呼び出したときにだけ発生します。属性ノードや CDATA ノードを含めたこれ以外のノード型の値はキャッシュされます。

このメソッドは Value プロパティの内容だけを返し、XmlReader を移動しません。

このメソッドは、ノード値の指定された文字数 (count) を指定のオフセット (index) で文字バッファ (buffer) に読み込み、バッファに書き込んだ文字数を返します。値の末尾に到達すると 0 を返します。再開して値を再度読み取ることはできません。

ReadValueChunk に対する呼び出しと呼び出しの間、Value プロパティ以外の XmlReader プロパティは何も変更しません。Value プロパティにアクセスすると、実装に応じて、ReadValueChunk がまだ返していない文字部分の値か、値全体のいずれかを返します。System.Xml 名前空間内のすべての XmlReader 実装では、Value プロパティ実装に対して部分的な値が返されます。

ReadValueChunk に対する呼び出しと呼び出しの間に、任意の Read メソッドを呼び出すことができます。この呼び出しが行われると、XmlReader はストリーム内の次の XmlNodeType に移動し、まだ返されていないすべての文字がスキップされます。

ReadValueChunk は、要求されたものより少ない文字数の値を返す場合があります。たとえば、位置 127 と 128 にサロゲート ペアの 200 文字の値があり、128 文字のバッファを使用して ReadValueChunk を呼び出すと、このメソッド呼び出しは要求した 128 文字ではなく 127 文字を返します。サロゲート ペアは、次の ReadValueChunk 呼び出しで返されます。この場合、ReadValueChunk は要求された 128 文字を返しません。これは、128 文字を返すとバッファの末尾でサロゲート ペアが不完全になるためです。

プラットフォーム

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
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
XmlReader クラス
XmlReader メンバ
System.Xml 名前空間