コンテンツにスキップ

FWRITEYAML

Category: ファイル操作

書式

FWRITEYAML( path, value [, charset [, pretty]] )

引数

Parameter Description
path 書き込むファイルのパス(yaya.dll からの相対パス、または絶対パス)
value YAML にする値。ハッシュや配列(入れ子を含む)も1つの引数として渡せる
charset ファイルの文字コード(省略可)。文字列("UTF-8" "Shift_JIS" など)または数値で指定する。省略時、または空文字列のときは UTF-8(BOM なし)
pretty 1 ならブロック形式、0 ならフロー形式の1行にする。省略時は 1

戻り値

  • 成功時: 1
  • 失敗時: 0

解説

値を YAML にしてファイルに書き込む。ファイルが既にあれば上書きする。FOPEN で開いておく必要はない。

値の対応と整形の形は DUMPYAML と同じ。ブロック形式のときはファイルの末尾に改行(LF)を付ける。

書き込んだファイルは FREADYAML で読み戻せる(UTF-8 以外で書いたときは同じ charset を指定する)。

ディレクトリは作らない。存在しないディレクトリの中には書き込めない。

エラー

状況 警告 GETLASTERROR
引数が足りない W0008 8
path が文字列でない W0009 9
charset が不正 W0012 / W0009 12 / 9
ファイルを開けない W0025 25
文字コードを変換できない W0027 27
書き込みに失敗した W0013 13

使用例

_conf = IHASH()
_conf["volume"] = 80
_conf["friends"] = ("うにゅう", "まゆら")
_conf["memo"] = "1行目" + CHR(10) + "2行目"

FWRITEYAML("config.yaml", _conf)
// config.yaml:
// friends:
//   - うにゅう
//   - まゆら
// memo: |-
//   1行目
//   2行目
// volume: 80

FWRITEYAML("config.flow.yaml", _conf, "", 0)
// {friends: [うにゅう, まゆら], memo: "1行目\n2行目", volume: 80}

互換性

  • YAYA: Tc602-5以降

関連項目