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

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

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

XmlReader.ReadSubtree メソッド

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

現在のノードおよびそのすべての子孫ノードを読み取るために使用できる、新しい XmlReader インスタンスを返します。

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

Visual Basic (宣言)

Public Overridable Function
 ReadSubtree As XmlReader

Visual Basic (使用法)

Dim instance As XmlReader
Dim returnValue As XmlReader

returnValue = instance.ReadSubtree

public virtual XmlReader ReadSubtree ()

C++

public:
virtual XmlReader^ ReadSubtree ()

public XmlReader ReadSubtree ()

JScript

public function ReadSubtree () : XmlReader

戻り値
ReadState.Initial に設定された新しい XmlReader インスタンス。Read メソッドを呼び出すと、ReadSubtree メソッドを呼び出す前に処理対象だったノードに新しい XmlReader が配置されます。

例外

例外の種類	条件
InvalidOperationException	このメソッドを呼び出すときに XmlReader が要素に配置されていません。

解説

ReadSubtree は、要素ノードでのみ呼び出すことができます。サブツリー全体が既に読み取られている場合に Read メソッドを呼び出すと、false が返されます。新しい XmlReader を閉じると、元の XmlReader はサブツリーの EndElement ノードに配置されます。したがって、ReadSubtree メソッドを book 要素の開始タグで呼び出した場合は、サブツリーが読み取られ、新しい XmlReader が閉じられた後、元の XmlReader が book 要素の終了タグに配置されます。

新しい XmlReader が閉じられるまで、元の XmlReader で操作を実行しないでください。このアクションはサポートされていないため、予測できない動作が発生する可能性があります。

メモ
ReadSubtree メソッドは、XML データのコピーを作成して、別個に扱うような使い方は想定されていません。このメソッドの主な目的は、XML 要素の境界を定義することにあります。たとえば、データを別のコンポーネントに渡して処理させたり、コンポーネントがアクセスできるデータのサイズを制限したりする場合に使用します。ReadSubtree メソッドから返された XmlReader を別のアプリケーションに渡すことにより、そのアプリケーションが、XML ドキュメント全体にアクセスすることなく、特定の XML 要素だけにアクセスできます。

メモ

ReadSubtree メソッドは、XML データのコピーを作成して、別個に扱うような使い方は想定されていません。このメソッドの主な目的は、XML 要素の境界を定義することにあります。たとえば、データを別のコンポーネントに渡して処理させたり、コンポーネントがアクセスできるデータのサイズを制限したりする場合に使用します。ReadSubtree メソッドから返された XmlReader を別のアプリケーションに渡すことにより、そのアプリケーションが、XML ドキュメント全体にアクセスすることなく、特定の XML 要素だけにアクセスできます。

使用例

ReadSubtree メソッドを使用する方法の例を次に示します。

Visual Basic

Dim settings As New XmlReaderSettings()
settings.IgnoreWhitespace = True
Using reader As XmlReader = XmlReader.Create("books.xml",
 settings)

  ' Position the reader on the second book node.
  reader.ReadToFollowing("book")
  reader.Skip()
                
  ' Create another reader that contains just the second book node.
  Dim inner As XmlReader = reader.ReadSubtree()
            
  ' Do additional processing on the inner reader. After you 
  ' are done, you can call Close on the inner reader and 
  ' continue processing using the original reader.

End Using

XmlReaderSettings settings = new XmlReaderSettings();
settings.IgnoreWhitespace = true;
using (XmlReader reader = XmlReader.Create("books.xml",
 settings)) {

  // Position the reader on the second book node
  reader.ReadToFollowing("book");
  reader.Skip();
       
  // Create another reader that contains just the second book node.
  XmlReader inner = reader.ReadSubtree();

  // Do additional processing on the inner reader. After you 
  // are done, you can call Close on the inner reader and 
  // continue processing using the original reader.

}