XmlWriterSettings.Encoding プロパティとは何？わかりやすく解説 Weblio辞書

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

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

XmlWriterSettings.Encoding プロパティ

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

使用するテキストエンコーディングを取得または設定します。

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

Visual Basic (宣言)

Public Property Encoding As
 Encoding

Visual Basic (使用法)

Dim instance As XmlWriterSettings
Dim value As Encoding

value = instance.Encoding

instance.Encoding = value

public Encoding Encoding { get; set;
 }

C++

public:
property Encoding^ Encoding {
    Encoding^ get ();
    void set (Encoding^ value);
}

/** @property */
public Encoding get_Encoding ()

/** @property */
public void set_Encoding (Encoding value)

JScript

public function get Encoding
 () : Encoding

public function set Encoding
 (value : Encoding)

プロパティ値
使用するテキストエンコーディング。既定値は Encoding.UTF8 です。

解説

このプロパティは、ストリームにテキストの内容を出力する、XmlWriter のインスタンスにのみ適用されます。それ以外の場合、この設定は無視されます。XmlWriter は、文字単位ではなくバッファ単位で文字をエンコードします。エンコーディングエラーがまったく発生しなかった場合に、Flush メソッドを呼び出すと、例外がスローされます。

セキュリティに関するメモ
信頼関係のないソースからは Encoding オブジェクトを受け入れないようにしてください。

使用例

XML フラグメントをメモリストリームに書き込む例を次に示します。

Visual Basic

Dim settings As XmlWriterSettings = New
 XmlWriterSettings()
settings.OmitXmlDeclaration = true
settings.ConformanceLevel = ConformanceLevel.Fragment
settings.CloseOutput = false

' Create the XmlWriter object and write some content.
Dim strm as MemoryStream = new
 MemoryStream()
Dim writer As XmlWriter = XmlWriter.Create(strm,
 settings)
writer.WriteElementString("orderID", "1-456-ab")
writer.WriteElementString("orderID", "2-36-00a")
writer.Flush()
writer.Close()

' Do additonal processing on the stream.

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");
writer.Flush();
writer.Close();

// Do additonal processing on the stream.