XmlWriter.WriteChars メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

XmlWriter.WriteChars メソッド

派生クラスでオーバーライドされると、一度に 1 つのバッファにテキストを書き込みます。

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

Visual Basic (宣言)

Public MustOverride Sub
 WriteChars ( _
    buffer As Char(), _
    index As Integer, _
    count As Integer _
)

Visual Basic (使用法)

Dim instance As XmlWriter
Dim buffer As Char()
Dim index As Integer
Dim count As Integer

instance.WriteChars(buffer, index, count)

public abstract void WriteChars (
    char[] buffer,
    int index,
    int count
)

C++

public:
virtual void WriteChars (
    array<wchar_t>^ buffer, 
    int index, 
    int count
) abstract

public abstract void WriteChars (
    char[] buffer, 
    int index, 
    int count
)

JScript

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

パラメータ

buffer: 書き込むテキストを格納している文字配列。

index: 書き込むテキストの開始を示すバッファ内の位置。

count: 書き込む文字の数。

例外

例外の種類	条件
ArgumentNullException	buffer が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	index または count が 0 未満です。またはバッファ長から index を差し引いた値が count 未満です。この呼び出しにより、サロゲートペア文字が分割されるか、無効なサロゲートペアが書き込まれます。

例外の種類

条件

ArgumentNullException

buffer が null 参照 (Visual Basic では Nothing) です。

ArgumentOutOfRangeException

index または count が 0 未満です。

または

バッファ長から index を差し引いた値が count 未満です。この呼び出しにより、サロゲートペア文字が分割されるか、無効なサロゲートペアが書き込まれます。

解説

このメソッドを使用すると、一度に 1 つのバッファに大量のテキストを書き込むことができます。

WriteChars メソッドが複数のバッファへの書き込みでサロゲートペア文字を分割しないようにするには、特殊な処理を実行する必要があります。XML 仕様では、サロゲートペアの有効範囲を定義しています。

サロゲートペア文字を書き込み、その文字がバッファ内で分割された場合は、例外がスローされます。継続して次のサロゲートペア文字を出力バッファに書き込むには、この例外をキャッチする必要があります。

ランダムに生成されたサロゲートペア文字が出力バッファへの書き込み時に分割される例を次に示します。例外をキャッチし、継続してバッファに書き込むことにより、サロゲートペア文字は出力ストリームに正しく書き込まれます。

 //Handling surrogate pair across buffer streams.
 char [] charArray = new char[4];
 char lowChar, highChar;
 Random random = new Random();
 lowChar = Convert.ToChar(random.Next(0xDC01, 0xDFFF));
 highChar = Convert.ToChar(random.Next(0xD801, 0xDBFF));
 XmlTextWriter tw = new XmlTextWriter("test.xml", null);
 tw.WriteStartElement("Root");
 charArray[0] = 'a';
 charArray[1] = 'b';
 charArray[2] = 'c';
 charArray[3] = highChar;
 try
 {
  tw. WriteChars(charArray, 0, charArray.Length);
 }
 catch (Exception ex) {
 }
 Array[0] = highChar;
 Array[1] = lowChar;
 charArray[2] = 'd';
 tw.WriteChars(charArray, 0, 3); 
 tw.WriteEndElement();