ファイル操作†

32 個の関数。

FOPEN†

書式†

FOPEN(path, option)

引数†

テキストアクセス†

バイナリアクセス†

ランダムアクセス†

戻り値†

• 1: 成功
• 0: 失敗
• 2: ファイルはすでに開いている

解説†

ファイルをオープンする。

• ファイルへの読み書きを行う前に、FOPEN でファイルをオープンする必要がある
• テキストアクセスを行うときは、FOPEN の前に FCHARSET を実行することで、文字コードを変更できる
• 要するに C 言語の fopen と同じ。YAYA 内の実装も C 言語の fopen である
• テキストアクセスの場合、0x0d-0x0a の並び（CR-LF）は、読み込み前に単一の 0x0a に変換される。逆に、書き込み時は 0x0a が 0x0d-0x0a に変換される。また、0x1a は EOF として特別な意味を持つ
• ランダムアクセスの際、ファイルの読み込み位置の指定は FSEEK で、位置の取得は FTELL でできる

互換性†

• YAYA: 初回リリースから利用可能（テキストアクセスのみ）
• AYA: バージョン 5.8 以降（テキストアクセスのみ）
• TC529-2: バイナリアクセス、ランダムアクセスを追加

関連項目†

• FCHARSET
• FCLOSE
• FSEEK
• FTELL
• FREAD

FCLOSE†

書式†

FCLOSE( path )

引数†

戻り値†

返り値はありません（VOID）。

解説†

FOPEN で開いたファイルを閉じます。

互換性†

• YAYA: 初版より対応
• AYA: 5.8以降

関連項目†

• FOPEN

FREAD†

書式†

FREAD(path)

引数†

戻り値†

• 成功時: 読み取った1行の文字列（CR・LF等の行末文字は除去される）。FCHARSETで指定した文字コードからYAYAの内部エンコーディングに変換される
• ファイル終端に達した場合: -1
• 失敗時: 空文字列

事前に FOPEN でファイルを開いておく必要がある。

解説†

ファイルから 1 行読み取る。

• FREAD する前には、FOPEN でファイルをオープンしておく必要がある
• 文字コードは、FCHARSET で指定した文字コードから YAYA 内部の文字コードに変換される
• 行の末尾の改行文字（CR、LF）は取り除かれる

注意†

EOF 検出のために次のようなコードを書くと、「-1 しか書かれていない行」がファイルに存在した場合に、それを EOF と誤認識して、読み込みが終わってしまうことがある。

_line = FREAD(_filename);
if(_line == -1) { break; }

これは、次のようにすると回避できる。

_line = FREAD(_filename);
if(GETTYPE(_line) == 1 && _line == -1) { break; }

EOF の -1 は整数値で、ファイルから読み込んだ "-1" は文字列なので、GETTYPE で値の種類を調べ、「整数値としての -1」の場合にのみ EOF として扱う。

互換性†

• YAYA: 初回リリースから利用可能
• AYA: バージョン 5.8 以降

関連項目†

• FWRITE
• FREADBIN
• FOPEN
• FREADENCODE
• FWRITE2
• FCHARSET

FREADENCODE†

書式†

FREADENCODE(path, size [, type])

引数†

戻り値†

• 成功時: エンコードされた文字列
• ファイル終端に達した場合: -1
• 失敗時: 空文字列

ファイルをBase64またはURLエンコードしながら読み取る。バイナリモードで開いていない場合は行コード変換が適用される。事前に FOPEN でファイルを開いておく必要がある。

互換性†

• YAYA: Tc535-1 以降

関連項目†

• FREAD
• FREADBIN
• FOPEN
• STRENCODE

FREADBIN†

書式†

FREADBIN( path , size [ , char ] )

引数†

戻り値†

• 成功時: 読み取ったデータの文字列
• ファイル終端に達した場合: -1
• 失敗時: 空文字列

文字コード変換を行わずにバイナリデータをそのまま読み取る。行末変換を避けるため、事前に FOPEN でバイナリモードを指定することが推奨される。ヌルバイト（0x00）は指定した文字に置換される（文字列中にバイト値 0 を含めないという YAYA の制限による）。FOPEN をバイナリアクセスで開かない場合は、改行コード変換が行われる。

互換性†

• YAYA: Tc516-901 以降
• 注意: Tc540-3 まで、0x80 以上のバイトがキャストエラーにより 0xFF80 番台に誤変換されるバグが存在した

関連項目†

• FREAD
• FWRITEBIN

FREADJSON†

書式†

FREADJSON( path [, charset] )

引数†

戻り値†

• 成功時: JSON を変換した値（下記の 値の対応）
• 失敗時: 空（VOID）

解説†

JSON ファイルを丸ごと読み込んで解析し、ハッシュ・配列などの値にして返す。FOPEN で開いておく必要はない。

JSON の解析には parson を使っている。

• 先頭の UTF-8 の BOM は無視する
• /* */ と // のコメントを書ける（JSON の規格外だが、設定ファイルなどで使えるよう許している）
• 最上位はオブジェクトや配列でなくてもよい（123 や "abc" だけのファイルも読める）

値の対応†

• 数値は内部で実数として解析するため、1.0 のように小数点があっても値が整数なら整数になる。また、2^53 を超える整数は誤差を含むことがある。整数の範囲（-2^63 以上 2^63 未満）を超える値は実数になる
• オブジェクトのキーの並びは保たれない。ハッシュのキーの順（数値 < 文字列）になる（HASH_KEYS を参照）
• "1" と "01" のように、YAYA のハッシュで同じキーとみなされないものは別のキーのまま残る。"1" のような正規形の整数文字列のキーは h[1] でも h["1"] でも引ける
• null の値のキーもハッシュに残る。HASH_EXIST は 1 を返す

エラー†

使用例†

data.json:

{
  "name": "さくら",
  "age": 17,
  "tags": ["ghost", "shell"],
  "profile": { "height": 158.5, "visible": true, "memo": null }
}

_j = FREADJSON("data.json")
_j["name"]                  // さくら
_j["tags"][1]               // shell
_j["profile"]["height"]     // 実数の 158.5
_j["profile"]["visible"]    // 1

foreach _j["tags"]; _t {
    // _t に "ghost"、"shell" が順に入る
}

互換性†

• YAYA: Tc601-1以降
• Tc602-1: 小数点が , のロケール（ドイツ語など）の環境で、小数を含む JSON の解析に失敗していたのを修正
• Tc603-1: 知らない文字コードの名前を渡すと警告 W0012 を出して失敗するようにした（それまでは警告を出さずに OS デフォルトとして扱っていた）

関連項目†

• PARSEJSON
• FWRITEJSON
• FREADXML
• 値の入れ子と多次元代入

FREADXML†

書式†

FREADXML( path [, charset] )

引数†

戻り値†

• 成功時: ルート要素を表すハッシュ（下記の 要素の形）
• 失敗時: 空（VOID）

解説†

XML ファイルを丸ごと読み込んで解析し、ルート要素をハッシュにして返す。FOPEN で開いておく必要はない。

XML の解析には TinyXML-2 を使っている。

charset を省略したときの文字コードは次の順に決める。

1. 先頭に UTF-8 の BOM があれば UTF-8
2. XML 宣言（<?xml version="1.0" encoding="Shift_JIS"?>）の encoding。Windows-31J CP932 も Shift_JIS として扱う
3. どちらも無い、または encoding が YAYA の知らない文字コードなら UTF-8

charset を指定したときは XML 宣言の encoding を無視する。

要素の形†

要素は、次の4つのキーを持つハッシュになる。キーは中身が空でも必ずある。

• 実体参照（& あ など）は展開済みになる
• テキストの前後の空白や改行はそのまま残る。要素と要素の間の空白だけの部分は text に入らない
• 子要素とテキストが混在する場合、テキストと子要素の前後関係は失われる（<p>a<b>x</b>c</p> の text は ac）
• コメント、処理命令、DOCTYPE、XML 宣言は無視する。ルート要素より外にあるものも返らない
• 属性の並びは保たれない。ハッシュのキーの順になる

エラー†

使用例†

shop.xml:

<?xml version="1.0" encoding="Shift_JIS"?>
<shop name="A">
  <item id="1">りんご</item>
  <item id="2">バナナ</item>
</shop>

_x = FREADXML("shop.xml")
_x["name"]                          // shop
_x["attr"]["name"]                  // A
_x["children"][1]["name"]           // item
_x["children"][1]["attr"]["id"]     // 2
_x["children"][1]["text"]           // バナナ

foreach _x["children"]; _item {
    // _item["attr"]["id"] と _item["text"] を順に扱える
}

互換性†

• YAYA: Tc601-1以降
• Tc603-1: 知らない文字コードの名前を渡すと警告 W0012 を出して失敗するようにした（それまでは警告を出さずに OS デフォルトとして扱っていた）

関連項目†

• PARSEXML
• FWRITEXML
• FREADHTML
• FREADJSON
• 値の入れ子と多次元代入

FREADHTML†

書式†

FREADHTML( path [, charset] )

引数†

戻り値†

• 成功時: <html> 要素を表すハッシュ（下記の 要素の形）
• 失敗時: 空（VOID）

解説†

HTML ファイルを丸ごと読み込んで解析し、<html> 要素をハッシュにして返す。FOPEN で開いておく必要はない。

HTML の解析には Gumbo（HTML5 の構文解析規則に従うパーサ）を使っている。閉じタグの抜けや壊れた入れ子があっても、ブラウザと同じ規則で補って木にするので、解析自体は失敗しない。<html> <head> <body> も無ければ補われる。

charset を省略したときの文字コードは次の順に決める。

1. 先頭に UTF-8 の BOM があれば UTF-8
2. 先頭 1024 バイト以内の <meta charset="Shift_JIS">、または <meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS"> の文字コード。コメントの中は読まない。Windows-31J CP932 も Shift_JIS として扱う
3. どちらも無い、または YAYA の知らない文字コード（UTF-16 を含む）なら UTF-8

charset を指定したときは <meta> を無視する。

要素の形†

要素は FREADXML と同じく、次の4つのキーを持つハッシュになる。キーは中身が空でも必ずある。

• 文字参照（& あ   など）は展開済みになる
• <br> <img> のような中身の無い要素も、children と text が空の要素になる
• 子要素とテキストが混在する場合、テキストと子要素の前後関係は失われる（<p>a<b>x</b>c</p> の text は ac）
• 子要素を持つ要素では、空白だけのテキスト（要素と要素の間の改行や字下げ）は text に入らない。子要素が無い要素では空白だけでも残る（<pre> </pre> の text は半角空白）
• <script> <style> <textarea> の中身も text に入る
• コメント、DOCTYPE、処理命令は無視する
• SVG・MathML の中の xlink:href xml:lang のような属性は、接頭辞付きの名前になる
• 入れ子が 128 段を超える HTML は失敗する（<html> を1段目として数える）
• 属性の並びは保たれない。ハッシュのキーの順になる

エラー†

使用例†

page.html:

<!DOCTYPE html>
<html>
<head><meta charset="Shift_JIS"><title>お知らせ</title></head>
<body>
<h1>お知らせ</h1>
<ul>
  <li><a href="a.html">その1</a></li>
  <li><a href="b.html">その2</a></li>
</ul>
</body>
</html>

_h = FREADHTML("page.html")
_h["children"][0]["children"][1]["text"]     // お知らせ（<title>。[0] は <meta>）
_body = _h["children"][1]
_body["children"][0]["text"]                 // お知らせ（<h1>）
_ul = _body["children"][1]
foreach _ul["children"]; _li {
    _a = _li["children"][0]
    // _a["attr"]["href"] と _a["text"] を順に扱える
}

互換性†

• YAYA: Tc605-1以降

関連項目†

• PARSEHTML
• FREADXML
• FREADJSON
• 値の入れ子と多次元代入

FREADYAML†

書式†

FREADYAML( path [, charset] )

引数†

戻り値†

• 成功時: YAML を変換した値（下記の 値の対応）
• 失敗時: 空（VOID）

解説†

YAML ファイルを丸ごと読み込んで解析し、ハッシュ・配列などの値にして返す。FOPEN で開いておく必要はない。

YAML の解析は YAYA が自前で行う。設定ファイルなどでよく使われる範囲（下記の 対応している書き方）に対応したもので、YAML の仕様をすべて満たしてはいない。

• 先頭の UTF-8 の BOM は無視する。改行は CRLF / LF のどちらでもよい
• 空のファイルや、コメントだけのファイルは空（VOID）になる。エラーにはならない

対応している書き方†

次のものには対応していない。書かれていると W0026 になる。

• 1つのファイルに複数の文書（2つ目の ---）
• 複合キー（? で始まるキー、キーにフロー形式を書いたもの）
• 字下げにタブを使ったもの（値の中のタブは使える）

値の対応†

型は YAML 1.2 の Core Schema の規則で決める。

• YAML 1.1 の処理系とは次の点が違う。yes no on off は文字列、017 は 10 進の 17、1_000 は文字列、2001-12-14 のような日付も文字列になる
• マッピングのキーの並びは保たれない。ハッシュのキーの順になる（HASH_KEYS を参照）。1 のような正規形の整数のキーは h[1] でも h["1"] でも引ける
• 同じキーが2回書かれていたら、後に書いたほうになる
• 深い入れ子（256 段を超えるもの）と、エイリアスの複製が合計 100 万要素を超えるものはエラーにする（悪意のあるファイルでメモリを使い果たさないため）

エラー†

使用例†

config.yaml:

# ゴーストの設定
name: さくら
age: 17
height: 158.5
visible: true
memo: ~
tags: [ghost, shell]
talk:
  greeting: |
    こんにちは。
    今日もいい天気ですね。
  random:
    - おはよう
    - こんばんは
defaults: &defaults
  volume: 80
  speed: 2
voice:
  <<: *defaults
  speed: 3

_y = FREADYAML("config.yaml")
_y["name"]                   // さくら
_y["tags"][1]                // shell
_y["height"]                 // 実数の 158.5
_y["visible"]                // 1
_y["memo"]                   // 空（VOID）
_y["talk"]["greeting"]       // "こんにちは。" + 改行 + "今日もいい天気ですね。" + 改行
_y["talk"]["random"][0]      // おはよう
_y["voice"]["volume"]        // 80（defaults から取り込んだもの）
_y["voice"]["speed"]         // 3

互換性†

• YAYA: Tc602-5以降
• Tc603-1: 知らない文字コードの名前を渡すと警告 W0012 を出して失敗するようにした（それまでは警告を出さずに OS デフォルトとして扱っていた）

関連項目†

• PARSEYAML
• FWRITEYAML
• FREADJSON
• FREADTOML
• 値の入れ子と多次元代入

FREADTOML†

書式†

FREADTOML( path [, charset] )

引数†

戻り値†

• 成功時: TOML を変換したハッシュ（下記の 値の対応）
• 失敗時: 空（VOID）

解説†

TOML ファイルを丸ごと読み込んで解析し、ハッシュにして返す。FOPEN で開いておく必要はない。

TOML の解析は YAYA が自前で行う。TOML v1.0.0 に対応している。v1.1 で加わった、インライン表の中の改行と末尾のカンマ、\e \xHH のエスケープも受け付ける。

• 先頭の UTF-8 の BOM は無視する。改行は CRLF / LF のどちらでもよい
• 最上位は常にハッシュになる。空のファイルや、コメントだけのファイルは空のハッシュになる
• 同じキーや表を2回定義する、ドットのキーで作った表を [表] で定義し直す、インライン表に後から足す、などの規格で禁じられていることはエラーにする

値の対応†

• 整数の範囲（-2^63 以上 2^63 未満）を超える整数はエラーにする
• キーの並びは保たれない。ハッシュのキーの順になる（HASH_KEYS を参照）

エラー†

使用例†

config.toml:

# ゴーストの設定
title = "設定"
updated = 2026-09-27T12:00:00+09:00

[ghost]
name = "さくら"
age = 17
visible = true
tags = ["ghost", "shell"]
path = 'C:\ssp\ghost'

[[friends]]
name = "うにゅう"

[[friends]]
name = "まゆら"

_t = FREADTOML("config.toml")
_t["title"]                 // 設定
_t["updated"]               // 文字列の 2026-09-27T12:00:00+09:00
_t["ghost"]["name"]         // さくら
_t["ghost"]["visible"]      // 1
_t["ghost"]["tags"][1]      // shell
_t["ghost"]["path"]         // C:\ssp\ghost
_t["friends"][1]["name"]    // まゆら

foreach _t["friends"]; _f {
    // _f に {name: うにゅう}、{name: まゆら} のハッシュが順に入る
}

互換性†

• YAYA: Tc602-5以降
• Tc603-1: 知らない文字コードの名前を渡すと警告 W0012 を出して失敗するようにした（それまでは警告を出さずに OS デフォルトとして扱っていた）

関連項目†

• PARSETOML
• FWRITETOML
• FREADJSON
• FREADYAML
• 値の入れ子と多次元代入

FWRITE†

書式†

FWRITE( path, string )

引数†

戻り値†

なし（VOID）

解説†

ファイルに1行書き込む関数。事前にFOPENでファイルを開いておく必要がある。

文字コードはYAYA内部形式からFCHARSETで指定した形式に変換して書き込む。行末には自動的に改行文字が付加される。

改行文字を付加せずに書き込む場合はFWRITE2を使用すること。

互換性†

• YAYA: 初期バージョンから使用可能
• AYA: バージョン5.8以降

関連項目†

• FWRITE2
• FREAD
• FOPEN
• FCHARSET

FWRITE2†

書式†

FWRITE2( path, string )

引数†

戻り値†

なし（VOID）

解説†

ファイルに1行書き込む関数。事前にFOPENでファイルを開いておく必要がある。

文字コードはYAYA内部形式からFCHARSETで指定した形式に変換して書き込む。FWRITEと異なり、行末に改行文字は付加されない。

改行文字を自動付加したい場合はFWRITEを使用すること。

互換性†

• YAYA: 初期バージョンから使用可能
• AYA: バージョン5.8以降

関連項目†

• FWRITE
• FREAD
• FWRITEBIN
• FOPEN

FWRITEBIN†

書式†

FWRITEBIN( path, string [, char] )

引数†

戻り値†

なし

解説†

文字コード変換を行わずにデータを書き込む関数。事前にFOPENでファイルを開いておく必要がある。

バイナリモードで開いていない場合は改行コード変換が発生する。

charに指定した文字は、YAYAが文字列中にnullバイトを持てないという制限により、バイト値0に変換される。

互換性†

• YAYA: Tc516-901 以降

関連項目†

• FWRITE
• FREADBIN
• FOPEN

FWRITEDECODE†

書式†

FWRITEDECODE( path, string [, type] )

引数†

戻り値†

なし

解説†

base64またはURLエンコードからデコードしながらデータを書き込む関数。FREADENCODEの逆操作を行う。

事前にFOPENでファイルを開いておく必要がある。FOPENをバイナリアクセスで開かない場合は、改行コード変換が行われる。デコード結果にバイト値0（0x00）が含まれていても、正常に書き込める。

互換性†

• YAYA: Tc554-1 以降
• Tc554-1 では実装ミスで type を省略できなかった

関連項目†

• FWRITE
• FREADENCODE
• STRDECODE

FWRITEJSON†

書式†

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

引数†

戻り値†

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

解説†

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

値の対応と整形の形は DUMPJSON と同じ。整形したときはファイルの末尾に改行（LF）を付ける。

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

charset で表せない文字（Shift_JIS での絵文字など）は、JSON のエスケープ \uXXXX（BMP の外の文字はサロゲートペアの \uD83D\uDE00 のような2つ組）で書く。読み戻すと元の文字に戻る。

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

エラー†

使用例†

_conf = IHASH()
_conf["volume"] = 80
_conf["friends"] = ("うにゅう", "まゆら")

FWRITEJSON("config.json", _conf)
// config.json:
// {
//     "friends": [
//         "うにゅう",
//         "まゆら"
//     ],
//     "volume": 80
// }

FWRITEJSON("config.min.json", _conf, "", 0)   // UTF-8 で1行に

互換性†

• YAYA: Tc602-1以降
• Tc603-1: charset で表せない文字を、黙って ? にせず、形式のエスケープで書くようにした。知らない文字コードの名前を渡すと警告 W0012 を出して失敗するようにした（それまでは警告を出さずに OS デフォルトとして扱っていた）

関連項目†

• DUMPJSON
• FREADJSON
• FWRITEXML

FWRITEXML†

書式†

FWRITEXML( path, element [, charset [, pretty]] )

引数†

戻り値†

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

解説†

要素のハッシュを XML にしてファイルに書き込む。ファイルが既にあれば上書きする。FOPEN で開いておく必要はない。

要素のハッシュの形、エスケープ、整形の形は DUMPXML と同じ。先頭には charset に合わせた XML 宣言を付ける。

書き込んだファイルは、XML 宣言の encoding を見るので、FREADXML で charset を指定せずに読み戻せる。

charset で表せない文字（Shift_JIS での絵文字など）は、テキストと属性値の中では文字参照 😀 で書く。読み戻すと元の文字に戻る。要素名・属性名の中の文字は文字参照にできないので、W0027 で失敗する。

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

エラー†

使用例†

_x = FREADXML("shop.xml")
_x["children"][0]["text"] = "みかん"

FWRITEXML("shop.xml", _x, "Shift_JIS")
// shop.xml:
// <?xml version="1.0" encoding="Shift_JIS"?>
// <shop name="A">
//     <item id="1">みかん</item>
//     <item id="2">バナナ</item>
// </shop>

互換性†

• YAYA: Tc602-1以降
• Tc603-1: charset で表せない文字を、黙って ? にせず、形式のエスケープで書くようにした。知らない文字コードの名前を渡すと警告 W0012 を出して失敗するようにした（それまでは警告を出さずに OS デフォルトとして扱っていた）

関連項目†

• DUMPXML
• FREADXML
• FWRITEJSON

FWRITEYAML†

書式†

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

引数†

戻り値†

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

解説†

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

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

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

charset で表せない文字（Shift_JIS での絵文字など）を含む文字列は、クォートしない形やブロックスカラー（|）にはせず、"..." で囲んでその文字を \uXXXX（BMP の外の文字は \U0001F600 のような8桁）で書く。キーも同じ。読み戻すと元の文字に戻る。

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

エラー†

使用例†

_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以降
• Tc603-1: charset で表せない文字を、黙って ? にせず、形式のエスケープで書くようにした。知らない文字コードの名前を渡すと警告 W0012 を出して失敗するようにした（それまでは警告を出さずに OS デフォルトとして扱っていた）

関連項目†

• DUMPYAML
• FREADYAML
• FWRITEJSON
• FWRITETOML

FWRITETOML†

書式†

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

引数†

戻り値†

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

解説†

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

値の対応と整形の形は DUMPTOML と同じ。

書き込んだファイルは FREADTOML で読み戻せる。

charset で表せない文字（Shift_JIS での絵文字など）を含む文字列は、'...' にはせず "..."（改行を含むときは """..."""）で囲んで、その文字を \uXXXX（BMP の外の文字は \U0001F600 のような8桁）で書く。キーも同じ。読み戻すと元の文字に戻る。

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

エラー†

使用例†

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

FWRITETOML("config.toml", _conf)
// config.toml:
// friends = ["うにゅう", "まゆら"]
// memo = """
// 1行目
// 2行目"""
// volume = 80

互換性†

• YAYA: Tc602-5以降
• Tc603-1: charset で表せない文字を、黙って ? にせず、形式のエスケープで書くようにした。知らない文字コードの名前を渡すと警告 W0012 を出して失敗するようにした（それまでは警告を出さずに OS デフォルトとして扱っていた）

関連項目†

• DUMPTOML
• FREADTOML
• FWRITEJSON
• FWRITEYAML

FCOPY†

書式†

FCOPY( path, dir )

引数†

戻り値†

• 1: 成功
• 0: 失敗

解説†

ファイルをコピーする。パスはフルパスで指定できる。相対パスの場合は DLL load で渡された位置（多くの場合、DLL のある位置）が基準になる。

互換性†

• YAYA: 初版より対応
• AYA: 5.8以降

関連項目†

• FMOVE
• FRENAME
• FDEL

FMOVE†

書式†

FMOVE( path , dir )

引数†

戻り値†

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

解説†

ファイルを移動する。パスはフルパスで指定できる。相対パスの場合は DLL load で渡された位置（多くの場合、DLL のある位置）が基準になる。

互換性†

• YAYA: 初回リリースから利用可能
• AYA: バージョン 5.8 以降

関連項目†

• FCOPY
• FRENAME
• FDEL

FDEL†

書式†

FDEL( path )

引数†

戻り値†

• 1: 成功
• 0: 失敗

解説†

ファイルを削除する。パスはフルパスで指定できる。相対パスの場合は DLL load で渡された位置（多くの場合、DLL のある位置）が基準になる。

互換性†

• YAYA: 初版より対応
• AYA: 5.8以降

関連項目†

• FCOPY
• FMOVE
• FRENAME

FRENAME†

書式†

FRENAME( from , to )

引数†

戻り値†

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

解説†

ファイルの名前を変更する。パスはフルパスで指定できる。相対パスの場合は DLL load で渡された位置（多くの場合、DLL のある位置）が基準になる。

FOPEN で開いたままのファイルは名前を変更できず、0 が返る。リネームする前に FCLOSE で閉じておく。

互換性†

• YAYA: 初回リリースから利用可能
• AYA: バージョン 5.8 以降

関連項目†

• FCOPY
• FMOVE
• FDEL

FSIZE†

書式†

FSIZE(path)

引数†

戻り値†

• 成功時: ファイルサイズ（バイト数）を表す非負の整数
• 失敗時: -1

解説†

ファイルサイズを取得する。パスはフルパスで指定できる。相対パスの場合は DLL load で渡された位置（多くの場合、DLL のある位置）が基準になる。

互換性†

• YAYA: 初回リリースから利用可能
• AYA: バージョン 5.8 以降

関連項目†

• FATTRIB
• FSEEK
• FTELL

FENUM†

書式†

FENUM( path [ , delim ] )

引数†

戻り値†

• 成功時: ファイル名とディレクトリ名を区切り文字で連結した文字列。ディレクトリ名にはバックスラッシュのプレフィックスが付く
• 失敗時: VOID（空）

解説†

指定した位置にあるファイル名とディレクトリ名を列挙し、区切り文字で連結した文字列として返す。パスはフルパスで指定できる。相対パスの場合は DLL load で渡された位置（多くの場合、DLL のある位置）が基準になる。ディレクトリ名の先頭には \ が付く。

互換性†

• YAYA: 初回リリースから利用可能
• AYA: バージョン 5.8 以降

FCHARSET†

書式†

FCHARSET( code )

引数†

戻り値†

返り値はありません（VOID）。

解説†

ファイルの読み書きに使用する文字コードを指定します。FOPEN の前に呼び出す必要があります。ファイルごとに文字コードを変更でき、文字コードは FOPEN が呼ばれた時点で決定されます。設定はゴーストの現在のセッション中は維持されますが、終了後にリセットされます。FCHARSET を呼ばない場合のデフォルト文字コードは、基本設定ファイルの charset.file または charset の設定に従います。

UTF-8 の場合、読み取り時にファイル先頭の BOM（Byte Order Mark）が見つかると自動的に取り除かれます。UTF-8 での書き込みでは BOM を書きません。

互換性†

• YAYA: 初版より対応
• AYA: 5.8以降
• Tc574-8 / Tc603-1: 知らない文字コードの名前を渡すと、警告 W0012 を出して設定を変えないようにした（それまでは警告を出さずに OS デフォルトとして扱っていた）

関連項目†

• FOPEN
• FCLOSE
• FATTRIB

FATTRIB†

書式†

FATTRIB( path )

引数†

戻り値†

11要素の汎用配列を返す。失敗した場合は -1 を返す。

日時の単位は、1970/1/1 0 時を基準とした秒数（epoch）。ふつうの日付情報に直したい場合は、GETTIME(_attrib[10]) のようにする。

解説†

ファイルやディレクトリの各種情報を取得する。フルパス指定もできる。相対パスの場合は、DLL の load で渡された位置（多くの場合、DLL のある位置）が基準となる。

使用例†

_attrib = FATTRIB('hoge.txt')
_attrib[10]          // 最終更新日時（エポック秒）
GETTIME(_attrib[10]) // 読みやすい形式に変換

互換性†

• YAYA: 初版より対応
• AYA: 5.8以降（ただし5.8より前のバージョンでは [9]〜[10] は使用不可）

関連項目†

• FSIZE
• GETTIME

FSTATUS†

書式†

FSTATUS(path)

引数†

戻り値†

直前のファイルI/O操作（FOPEN・FREAD・FWRITE・FSEEK・FTELLなど）の結果ステータスを返す。

解説†

ファイル読み書き関数（FOPEN・FREAD 系・FWRITE 系・FSEEK・FTELL）の直前の操作の状態を取得する。

互換性†

• YAYA: Tc573-3 以降

関連項目†

• FOPEN
• FSEEK
• FTELL

FDIGEST†

書式†

FDIGEST(path [, type])

引数†

戻り値†

• 成功時: ダイジェスト値を16進数文字列（英大文字）で返す
• 失敗時（ファイルが存在しない・値の生成に失敗した場合）: -1

解説†

指定したファイルのダイジェスト（ハッシュ）値を得る。パスはフルパスで指定できる。相対パスの場合は DLL load で渡された位置（多くの場合、DLL のある位置）が基準になる。

type の書き方と、CRC-32 だけ値の下位バイトから先に並ぶ点は STRDIGEST と同じ。文字列の内部表現ではなくファイルの中身のバイト列をそのまま計算するので、他のツールの結果と照らし合わせられる。

確認用の値†

123456789（9バイト、改行なし）だけを書いたファイルの値。

互換性†

• YAYA: Tc527-1 で初回リリース。Tc530-1 で CRC32 サポートを追加
• Tc607-1: SHA-224 / SHA-256 / SHA-384 / SHA-512、SHA3-*、Adler-32 と、CRC-32B ほかの各種 CRC を追加。種類名の大文字小文字と - _ / を無視するようにした

関連項目†

• STRDIGEST

FSEEK†

書式†

FSEEK(path, offset, origin)

引数†

戻り値†

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

非バイナリモードでは改行コードの自動変換により FSEEK/FTELL が期待通りに動作しない場合がある。これらの関数を使用する場合は FOPEN でバイナリモードを指定することを推奨する。

解説†

ファイル読み書きの際の位置（ファイル位置指示子）を移動する。

関連項目†

• FTELL
• FOPEN

FTELL†

書式†

FTELL(path)

引数†

戻り値†

• 成功時: ファイル先頭からのバイトオフセット（現在のファイル位置）
• 失敗時: -1

非バイナリモードでは改行コードの自動変換により FSEEK/FTELL が期待通りに動作しない場合がある。これらの関数を使用する場合は FOPEN でバイナリモードを指定することを推奨する。

解説†

ファイル読み書きの際の位置（ファイル位置指示子）を取得する。

関連項目†

• FSEEK
• FOPEN

MKDIR†

書式†

MKDIR(path)

引数†

戻り値†

• 成功: 1
• 失敗: 0

解説†

ディレクトリを作成します。フルパスの指定に対応しています。相対パスの場合、基準点はDLLの位置になります。

制限事項: 一階層づつしか作成できません。存在しない複数階層のネストを一度に指定するとエラーになります。

互換性†

• YAYA: 初期リリースから使用可能
• AYA: バージョン5.8から使用可能

関連項目†

• RMDIR

RMDIR†

書式†

RMDIR( path )

引数†

戻り値†

• 1: 削除成功
• 0: 失敗

解説†

ディレクトリを削除します。空のディレクトリしか削除できません。ファイルが含まれているディレクトリを削除しようとするとエラーになります。

互換性†

• YAYA: 初期バージョンより対応
• AYA: 5.8以降

関連項目†

• MKDIR