XmlReader.Settings

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

XmlReader.Settings プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

この XmlReader インスタンスを作成するために使用した XmlReaderSettings オブジェクトを取得します。

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

Visual Basic (宣言)

Public Overridable ReadOnly
 Property Settings As XmlReaderSettings

Visual Basic (使用法)

Dim instance As XmlReader
Dim value As XmlReaderSettings

value = instance.Settings

C#

public virtual XmlReaderSettings Settings { get;
 }

C++

public:
virtual property XmlReaderSettings^ Settings {
    XmlReaderSettings^ get ();
}

J#

/** @property */
public XmlReaderSettings get_Settings ()

JScript

public function get Settings
 () : XmlReaderSettings

プロパティ値
このリーダーのインスタンスを作成するために使用した XmlReaderSettings オブジェクト。Create メソッドを使用しないでこのリーダーを作成した場合、このプロパティは null 参照 (Visual Basic では Nothing) を返します。

解説

セキュリティに関するメモ
XmlReaderSettings オブジェクトには、ユーザー資格情報のような機密性の高い情報を格納できます。アプリケーションでこのオブジェクトをキャッシュしたり別のコンポーネントに渡すときは、注意が必要です。

XmlReaderSettings クラスは、作成したリーダーのインスタンスでサポートする一連の機能を指定するために使用します。このプロパティによって返された XmlReaderSettings オブジェクトは変更できません。個々の設定を変更しようとすると、例外がスローされます。

詳細については、「XML リーダーの作成」を参照してください。

プラットフォーム

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 名前空間
その他の技術情報
XmlReader による XML の読み取り

XmlReaderSettings イベント

パブリック イベント

	名前	説明
	ValidationEventHandler	リーダーが検証エラーを検出すると発生します。

参照

関連項目

XmlReaderSettings クラス
System.Xml 名前空間

その他の技術情報

XML ドキュメントと XML データ
セキュリティと System.Xml アプリケーション

XmlReaderSettings クラス

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

Create メソッドで作成された XmlReader オブジェクトでサポートする一連の機能を指定します。

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

Visual Basic (宣言)

Public NotInheritable Class
 XmlReaderSettings

Visual Basic (使用法)

Dim instance As XmlReaderSettings

C#

public sealed class XmlReaderSettings

C++

public ref class XmlReaderSettings sealed

J#

public final class XmlReaderSettings

JScript

public final class XmlReaderSettings

解説

Microsoft .NET Framework version 2.0 リリースで XmlReader インスタンスを取得する場合は、Create メソッドの使用をお勧めします。Create メソッドは、XmlReaderSettings クラスを使用して、作成された XmlReader オブジェクトに実装する機能を指定します。

詳細については、「XML リーダーの作成」を参照してください。

セキュリティについての考慮事項

XmlReaderSettings クラスを使用する際の考慮事項を次に示します。

• 既定では、XmlReaderSettings オブジェクトの ProcessInlineSchema 検証フラグおよび ProcessSchemaLocation 検証フラグは設定されません。これらのフラグを設定すると、XmlReader のインスタンス ドキュメントで検出されたスキーマの場所を解決するときに、XmlReaderSettings オブジェクトの XmlResolver が使用されます。XmlResolver オブジェクトが null 参照 (Visual Basic では Nothing) の場合は、ProcessInlineSchema 検証フラグと ProcessSchemaLocation 検証フラグが設定されていても、スキーマの場所は解決されません。

• 検証を実行しているときにスキーマを追加すると新しい型が追加されるため、検証しているドキュメントの検証結果を変えることができます。このため、信頼関係のあるソースの外部スキーマだけを解決するようにしてください。

• 検証エラー メッセージによって、コンテンツ モデルの機密情報が公開される場合があります。検証エラー メッセージと検証警告メッセージは、ValidationEventHandler デリゲートを使用して処理されます。ただし XmlReaderSettings オブジェクトにイベント ハンドラが用意されていない場合は、XmlSchemaValidationException として公開されます (検証の警告では XmlSchemaValidationException がスローされません)。信頼関係のないシナリオでは、このコンテンツ モデル情報を公開しないでください。既定では検証警告メッセージは表示されません。ReportValidationWarnings フラグを設定するとこのメッセージを報告できます。

• XmlSchemaValidationException の SourceUri プロパティは、例外が発生する原因となったスキーマ ファイルへの URI パスを返します。信頼関係のないシナリオでは、SourceUri プロパティを公開しないでください。

• 可用性の高い状況で、信頼関係のない大量の XML ドキュメントをドキュメントの大部分について ID 制約のあるスキーマに対して検証する場合は、ProcessIdentityConstraints フラグを無効にすることをお勧めします (既定ではこのフラグは有効)。

• XmlReaderSettings オブジェクトには、ユーザー資格情報のような機密性の高い情報を格納できます。XmlReaderSettings オブジェクトをキャッシュする場合、または 1 つのコンポーネントから別のコンポーネントに XmlReaderSettings オブジェクトを渡す場合は、注意が必要です。

• 既定では、DTD 処理が無効になります。DTD 処理を有効にする場合は、信頼関係のないソースからの DTD の組み込みおよびサービス拒否攻撃を受ける可能性があることに注意が必要です。XmlSecureResolver を使用して、XmlReader がアクセスできるリソースを制限してください。

• 信頼関係のないソースからのサポート コンポーネント (NameTable オブジェクト、XmlNamespaceManager オブジェクト、XmlResolver オブジェクトなど) は受け入れないようにしてください。

使用例

必要な資格情報で XmlUrlResolver を使用する XmlReader を作成する例を次に示します。

Visual Basic

' Create an XmlUrlResolver with the credentials necessary to access
 the Web server.
Dim resolver As New XmlUrlResolver()
Dim myCred As System.Net.NetworkCredential
myCred = New System.Net.NetworkCredential(UserName, SecurelyStoredPassword,
 Domain)
resolver.Credentials = myCred

Dim settings As New XmlReaderSettings()
settings.XmlResolver = resolver

' Create the reader.
Dim reader As XmlReader = XmlReader.Create("http://serverName/data/books.xml",
 settings)

C#

// Create an XmlUrlResolver with the credentials necessary to access
 the Web server.
XmlUrlResolver resolver = new XmlUrlResolver();
System.Net.NetworkCredential myCred;
myCred  = new System.Net.NetworkCredential(UserName,SecurelyStoredPassword,Domain);
  
resolver.Credentials = myCred;

XmlReaderSettings settings = new XmlReaderSettings();
settings.XmlResolver = resolver;

// Create the reader.
XmlReader reader = XmlReader.Create("http://serverName/data/books.xml",
 settings);

継承階層

System.Object
  System.Xml.XmlReaderSettings

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

関連項目
XmlReaderSettings メンバ
System.Xml 名前空間
その他の技術情報
XML ドキュメントと XML データ
セキュリティと System.Xml アプリケーション

XmlReaderSettings コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

XmlReaderSettings クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New XmlReaderSettings

C#

public XmlReaderSettings ()

C++

public:
XmlReaderSettings ()

J#

public XmlReaderSettings ()

JScript

public function XmlReaderSettings ()

解説

XmlReaderSettings のインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
CheckCharacters	true
ConformanceLevel	Document
IgnoreComments	false
IgnoreProcessingInstructions	false
IgnoreWhitespace	false
LineNumberOffset	0
LinePositionOffset	0
NameTable	null 参照 (Visual Basic では Nothing)
ProhibitDtd	true
Schemas	空の XmlSchemaSet オブジェクト
ValidationFlags	ProcessIdentityConstraints
ValidationType	None
XmlResolver	新しい XmlUrlResolver オブジェクト

使用例

処理命令、コメント、および意味のない空白を取り除くリーダーを構築するために使用できる設定オブジェクトの作成方法を次に示します。

Visual Basic

' Set the reader settings.
Dim settings as XmlReaderSettings = new
 XmlReaderSettings()
settings.IgnoreComments = true
settings.IgnoreProcessingInstructions = true
settings.IgnoreWhitespace = true

C#

// Set the reader settings.
XmlReaderSettings settings = new XmlReaderSettings();
settings.IgnoreComments = true;
settings.IgnoreProcessingInstructions = true;
settings.IgnoreWhitespace = true;

C++

// Set the reader settings.
XmlReaderSettings^ settings = gcnew XmlReaderSettings;
settings->IgnoreComments = true;
settings->IgnoreProcessingInstructions = true;
settings->IgnoreWhitespace = true;

プラットフォーム

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

参照

関連項目
XmlReaderSettings クラス
XmlReaderSettings メンバ
System.Xml 名前空間
その他の技術情報
XML リーダーの作成

XmlReaderSettings プロパティ

パブリック プロパティ

	名前	説明
	XmlResolver	外部ドキュメントへのアクセスに使用する XmlResolver を設定します。

参照

関連項目

XmlReaderSettings クラス
System.Xml 名前空間

その他の技術情報

XML ドキュメントと XML データ
セキュリティと System.Xml アプリケーション

XmlReaderSettings メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Clone	XmlReaderSettings インスタンスのコピーを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Reset	設定クラスのメンバを既定値にリセットします。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

XmlReaderSettings クラス
System.Xml 名前空間

その他の技術情報

XML ドキュメントと XML データ
セキュリティと System.Xml アプリケーション

XmlReaderSettings メンバ

Create メソッドで作成された XmlReader オブジェクトでサポートする一連の機能を指定します。

XmlReaderSettings データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	XmlReaderSettings	XmlReaderSettings クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	XmlResolver	外部ドキュメントへのアクセスに使用する XmlResolver を設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Clone	XmlReaderSettings インスタンスのコピーを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Reset	設定クラスのメンバを既定値にリセットします。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

パブリック イベント

	名前	説明
	ValidationEventHandler	リーダーが検証エラーを検出すると発生します。

参照

関連項目

XmlReaderSettings クラス
System.Xml 名前空間

その他の技術情報

XML ドキュメントと XML データ
セキュリティと System.Xml アプリケーション