FileRead_gets

ファイルから一行読み出す

val = FileRead_gets(Buffer, BufferSize, FileHandle)

char *Buffer : 読み出した文字列を格納するメモリ領域の先頭アドレス
int Num : 文字列を格納するメモリ領域のサイズ
int FileHandle : ファイルハンドル

(プラグイン / モジュール : DxLibW)

解説

FileRead_open関数で開いたファイルから文字列を一行読み込みます。

改行があるか、ファイルの終端に達するか、Num で指定されたサイズ-1バイト分の文字列があった所までの文字列を Buffer に格納します。

(文字列の終端にはヌル文字(\0)が格納されるので、最大でも Num で指定されたサイズ-1バイト分となります)

読み込み後のファイルポインタは、改行があった場合は次の行の先頭、ファイルの終端に達した場合はファイルの終端、Num
で指定されたサイズを超えたために読み込み終了となった場合は、
読み込んだ最後の文字の次の文字となります。

(読み込んだ最後の文字の次が改行コードの場合は、次の FileRead_gets では Buffer にヌル文字(\0)のみ格納されることになります)

戻り値:
  -1以外:読み出した文字列の長さ

情報

プラグイン / モジュールDxLibW
バージョン3.24f
作成日2026/04/12
著作者DxLib: Takumi Yamada / HSP binding: IronHSP Project
URLhttps://dxlib.xsrv.jp/
備考hspdxlib.as をインクルードして使用
タイプDxLib ゲームライブラリ
グループDxLib ファイル
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\hspdxlib.hs