nlib
|
XMLのストリームへの書き出しを行う抽象クラスです。 [詳解]
#include "nn/nlib/exi/XmlStreamWriter.h"
公開メンバ関数 | |
void | Flush () noexcept |
XMLライタをフラッシュします。 [詳解] | |
void | WriteCData (const ExiChar *data) noexcept |
引数で指定したテキストを書き込みます。 [詳解] | |
void | WriteCharacters (const ExiChar *text) noexcept |
引数で指定したテキストを書き込みます。 [詳解] | |
void | WriteComment (const ExiChar *data) noexcept |
引数で指定したテキストを格納したXMLコメント(<!--...-->)を書き込みます。 [詳解] | |
void | WriteProcessingInstruction (const ExiChar *target, const ExiChar *data) noexcept |
<?target data?>といったPI(Processing Instrcuction)を書き込みます。 [詳解] | |
XML名前空間の書き込み | |
const ExiChar * | GetPrefix (const ExiChar *uri) noexcept |
名前空間URIに対応するプレフィックスを取得します。 [詳解] | |
void | WriteNamespace (const ExiChar *prefix, const ExiChar *namespace_uri) noexcept |
XML名前空間を宣言します。 [詳解] | |
void | WriteDefaultNamespace (const ExiChar *namespace_uri) noexcept |
デフォルト名前空間を宣言します。 [詳解] | |
XML属性の書き込み | |
void | WriteAttribute (const ExiChar *local_name, const ExiChar *value) noexcept |
名前空間なしの属性と値を書き込みます。 [詳解] | |
void | WriteAttribute (const ExiChar *prefix, const ExiChar *namespace_uri, const ExiChar *local_name, const ExiChar *value) noexcept |
名前空間つきの属性と値を書き込みます。 [詳解] | |
開始タグと終了タグの書き込み | |
void | WriteEmptyElement (const ExiChar *local_name) noexcept |
名前空間なしの要素で開始タグと終了タグをを書き込みます。 [詳解] | |
void | WriteEmptyElement (const ExiChar *prefix, const ExiChar *namespace_uri, const ExiChar *local_name) noexcept |
名前空間つきの要素で開始タグと終了タグを書き込みます。 [詳解] | |
void | WriteEndElement () noexcept |
終了タグを書き込みます。 | |
void | WriteStartElement (const ExiChar *local_name) noexcept |
名前空間なしの要素で開始タグを書き込みます。 [詳解] | |
void | WriteStartElement (const ExiChar *prefix, const ExiChar *namespace_uri, const ExiChar *local_name) noexcept |
名前空間つきの要素で開始タグを書き込みます。 [詳解] | |
XMLドキュメントの開始と終了 | |
void | WriteStartDocument () noexcept |
XMLドキュメントの開始を宣言し、XML宣言等を書き込みます。 | |
void | WriteEndDocument () noexcept |
開いている任意の要素を全て閉じ、XMLライタをクローズします。 | |
エラーチェック関連 | |
bool | IsError () const noexcept |
エラーが発生している場合はtrue を返します。 | |
bool | IsOk () const noexcept |
エラーが発生していない場合はtrue を返します。 | |
ExiErrorStatus::ErrorValue | GetError () const noexcept |
エラー値を取得します。 | |
ExiErrorStatus * | GetErrorStatus () const noexcept |
エラー状態オブジェクトを取得します。 | |
operator bool () const | |
エラーが発生していない場合はtrue を返します。 | |
XmlStreamWriterオブジェクトの初期化と終了 | |
| |
static XmlStreamWriter * | Create (OutputStream *stream, const XmlStreamWriterSettings &settings, const ExiAllocatorEx &al) noexcept |
オブジェクト単位のアロケータを指定してXmlStreamWriter のインスタンスを作成します。 [詳解] | |
static XmlStreamWriter * | Create (OutputStream *stream, const XmlStreamWriterSettings &settings) noexcept |
XmlStreamWriter のインスタンスを作成します。 [詳解] | |
static XmlStreamWriter * | Create (OutputStream *stream) noexcept |
XmlStreamWriterSettings をデフォルト設定でXmlStreamReader のインスタンスを作成します。 [詳解] | |
static XmlStreamWriter * | Create (OutputStream *stream, const ExiAllocatorEx &al) noexcept |
オブジェクト単位のアロケータを指定してXmlStreamWriter のインスタンスを作成します。 [詳解] | |
void | Close () noexcept |
XmlStreamWriter をクローズします。基となるストリームは切り離されるだけでクローズされません。 | |
XMLのストリームへの書き出しを行う抽象クラスです。
XMLStreamWriter
(StAX)や.NETの XmlWriter
と似たような書き方でXMLを書きだすことができます。 XmlStreamWriter
のインスタンスを作成するには、XmlStreamWriter::Create()
関数を利用します。 インスタンスはExiAllocator
からメモリを取得して作成されます。 XmlStreamWriter.h の 41 行目に定義があります。
|
staticnoexcept |
オブジェクト単位のアロケータを指定してXmlStreamWriter
のインスタンスを作成します。
[in] | stream | 基となる出力ストリーム |
[in] | settings | 設定オプション |
[in] | al | アロケータ |
XmlStreamWriter
のインスタンス
|
inlinestaticnoexcept |
XmlStreamWriter
のインスタンスを作成します。
[in] | stream | 基となる出力ストリーム |
[in] | settings | 設定オプション |
XmlStreamWriter
のインスタンスExiAllocator
からメモリを取得して作成されます。 成功した場合、NULL
以外のポインタを返します。 一般的には、返ってきたポインタをUniquePtr
で保持して利用します。 XmlStreamWriterSettings
をデフォルトから変更する必要があります。 詳細は、XmlStreamWriterSettings
を参照してください。 XmlStreamWriter.h の 45 行目に定義があります。
|
inlinestaticnoexcept |
XmlStreamWriterSettings
をデフォルト設定でXmlStreamReader
のインスタンスを作成します。
[in] | stream | 基となる出力ストリーム |
XmlStreamWriter
のインスタンスXmlStreamWriter.h の 50 行目に定義があります。
|
inlinestaticnoexcept |
オブジェクト単位のアロケータを指定してXmlStreamWriter
のインスタンスを作成します。
[in] | stream | 基となる出力ストリーム |
[in] | al | アロケータ |
XmlStreamWriter
のインスタンス XmlStreamWriter.h の 54 行目に定義があります。
|
inlinenoexcept |
|
inlinenoexcept |
名前空間URIに対応するプレフィックスを取得します。
[in] | uri | 名前空間URI |
NULL
を、名前空間がデフォルト名前空間である場合には空文字列を返します。uri
がNULL
の場合は空文字列と同様に扱われます。 XmlStreamWriter.h の 69 行目に定義があります。
|
inlinenoexcept |
名前空間なしの属性と値を書き込みます。
[in] | local_name | 属性のローカル名 |
[in] | value | 属性の値 |
XmlStreamWriter.h の 73 行目に定義があります。
|
noexcept |
名前空間つきの属性と値を書き込みます。
[in] | prefix | 属性の名前空間プレフィックス |
[in] | namespace_uri | 属性の名前空間URI |
[in] | local_name | 属性のローカル名 |
[in] | value | 属性の値 |
localName
にNULL
又は空文字列を渡すことはできません。 prefix
, namespaceUri
, value
についてはNULL
は空文字列と同様に扱われます。
|
inlinenoexcept |
引数で指定したテキストを書き込みます。
[in] | data | 書き込むテキスト |
data
にNULL
を渡した場合は空文字列と同様に扱われます。 XmlStreamWriter.h の 78 行目に定義があります。
|
inlinenoexcept |
引数で指定したテキストを書き込みます。
[in] | text | 書き込むテキスト |
text
にNULL
を渡した場合は空文字列と同様に扱われます。 XmlStreamWriter.h の 83 行目に定義があります。
|
noexcept |
引数で指定したテキストを格納したXMLコメント(<!--...-->)を書き込みます。
[in] | data | XMLコメント内のテキスト |
data
にNULL
を渡した場合は空文字列と同様に扱われます。
|
inlinenoexcept |
デフォルト名前空間を宣言します。
[in] | namespace_uri | デフォルト名前空間の名前空間URI |
XmlStreamWriter.h の 96 行目に定義があります。
|
inlinenoexcept |
名前空間なしの要素で開始タグと終了タグをを書き込みます。
[in] | local_name | 要素のローカル名 |
XmlStreamWriter.h の 100 行目に定義があります。
|
noexcept |
名前空間つきの要素で開始タグと終了タグを書き込みます。
[in] | prefix | 要素の名前空間プレフィックス |
[in] | namespace_uri | 要素の名前空間URI |
[in] | local_name | 要素のローカル名 |
|
inlinenoexcept |
XML名前空間を宣言します。
[in] | prefix | 名前空間に対応するプレフィックス |
[in] | namespace_uri | 名前空間URI |
prefix
やnamespaceUri
にNULL
を指定した場合は空文字列と同様に扱われます。 XmlStreamWriter.h の 90 行目に定義があります。
|
noexcept |
<?target data?>といったPI(Processing Instrcuction)を書き込みます。
[in] | target | PIの名前。 |
[in] | data | PIに含めるテキスト。 |
true
にして XmlStreamWriter
を作成する必要があります。そうでない場合、この関数を呼び出しても何も書き込まれません。 WriteStartDocument()
を利用する必要があります。 target
にNULL
や空文字列を指定することはできません。 data
にNULL
を指定した場合は空文字列と同様に扱われます。
|
inlinenoexcept |
|
noexcept |
名前空間つきの要素で開始タグを書き込みます。
[in] | prefix | 要素の名前空間プレフィックス |
[in] | namespace_uri | 要素の名前空間URI |
[in] | local_name | 要素のローカル名 |
prefix
にNULL
か空文字列を指定して呼び出します。 © 2013, 2014, 2015 Nintendo Co., Ltd. All rights reserved.