構文
bool XML_SaveAsXmlFile(
XML_HANDLE hXml,
const char *prolog,
const char *filename,
bool format,
int *ErrCode
);
パラメータ
- hXml
- [in] XMLハンドル
- prolog
- [in] XMドキュメントの"prolog"のUTF-8文字列を指すポインタ。"prolog"が不要の場合はNULLを指定します。
- filename
- [in] ファイル名の文字列を指すポインタ。
- format
- [in] 改行とTABによるインデントでXMLドキュメントを整形する場合はtrueを、それ以外はfalseを指定します。
- ErrCode
- [out] エラーコードを返す変数を指すポインタ。エラーコードが不要のときはNULLを指定します。
戻り値
関数が成功したらtrueを、それ以外はfalseを返します。解説
hXmlで指定されたXMLオブジェクトの内容をUTF-8のXMLドキュメントに変換してfilenameで指定したファイルに保存します。
prologでUTF-8の文字列を指定すると、ファイルの先頭に指定の文字列が出力されます。XML宣言などを出力するために使用します。
関数が失敗したときはfalseを返し、ErrCodeに次のエラーコードを返します。
| エラーコード | 説明 |
|---|---|
| XML_INVALID_PARAMETER_ERROR | パラメーターエラー |
| XML_MEMORY_ALLOCATION_ERROR | メモリーアロケーションエラー |
| XML_FILE_ERROR | ファイルエラー |
| XML_INVALID_XML_OBJECT_ERROR | 不正なXMLハンドルが指定された。 |
必要条件
- ヘッダファイル:
-
XML.h
CodeConversion.h : ver.1.1.1以降 - ライブラリファイル:
-
libXML.a
libCodeConversion.a : ver.1.1.1以降
libSTARTUPOPH5000.a
サンプル
XML_SaveAsXmlFile(hXml, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>", "RESULT.XML", true, &ErrCode);
関連事項
最終更新日：2021/10/21