開発者向け機能:サーバスクリプト:$ps.file.readAllText
概要¶
サーバスクリプトで$ps.fileを使用してファイル読み込みをする際に使用します。ファイルの内容をすべて読み込み、文字列型で値を戻します。
前提条件¶
Script.jsonのDisableServerScriptFileを false に設定することが必要です。
構文¶
パラメータ¶
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
| section | string | ○ | セクション名。セクションについては$ps.fileの「セクションについて」を参照ください。 |
| path | string | ○ | ファイル名。ディレクトリの区切り文字はWindow、Linux共に「/」を利用する。 |
| encode | string | ファイルのエンコーディングの指定(※1)省略時は"utf-8" |
※1
System.Text.Encoding.GetEncoding のパラメータで指定できるコードページ名を指定します。
戻り値¶
ファイルの内容を文字列型で返却します。ファイルが存在しない場合はnullを返却します。
例外¶
C#内で例外が発生した場合はサーバスクリプト内に例外クラス名とエラーメッセージをErrorオブジェクトに入れて例外を発生させます。
使用例¶
以下の例では、Webサーバ内のファイルを読む込み、結果をログに出力します。
JavaScript¶
文字コード:Shift-JIS の例
let text = $ps.file.readAllText('01_develop', 'parts/01_parts.txt', 'shift-jis');
context.Log('text: ' + text);
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.4.12.0 以降 | 機能追加 |
