KeyInputString

キーボードによる文字列入力

val = KeyInputString(x, y, CharMaxLength, StrBuffer, CancelValidFlag)

int x , y        : 入力中の文字列を描画する領域の左上座標
int CharMaxLength : 入力できる最大文字数(全角文字は2文字とする)
char *StrBuffer   : 入力した文字列を保存するバッファへのアドレス
int CancelValidFlag :  入力中のESCキーによるキャンセルが可能か
否か(TRUE:可能 FALSE:不可能)

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

解説

キーボードによる文字列の入力を行います。引数 x , y を起点に入力中の文字列が表示されます。

エンターキーを押すと入力が終了したとみなされ入力された文字列は StrBuffer の示すアドレスに格納されます。
なお入力できる最大文字数は CharMaxLength で指定します。
バッファ領域には CharMaxLength の分の文字が入る領域を確保しておかなければなりません。

CancelValidFlag はキャンセルを有効にするかどうかというもので、これを TRUE にすると有効になり、
FALSE にするとキャンセルは出来なくなります。
キャンセルが有効な場合は ESC キーを押すと関数から出てきます。その場合は戻り値が2になります。

戻り値:
  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