getkword (AutoLISP)

ユーザがキーワードを入力するまで待機(一時停止)し、入力されたキーワードを返します。

サポートされているプラットフォーム: Windows および Mac OS

構文と要素

(getkword [msg])

msg

タイプ: 文字列

ユーザに表示するプロンプト文字列です。省略した場合、getkword はプロンプトを表示しません。

戻り値

タイプ: 文字列または nil

ユーザが入力したキーワードを示す文字列。ユーザがキーワードを入力せずに[Enter]を押した場合は、nil。この関数は、キーワードを定義する initget 関数を事前に呼び出さなかった場合も、nil を返します。

ユーザが有効なキーワード以外の値を入力した場合、getkword 関数は警告メッセージを表示し、再度入力を求めます。

注意

有効なキーワードは、getkword 関数を呼び出す前に initget 関数で設定します。getkword 関数の要求に対して、ユーザは別の AutoLISP 式を入力することはできません。

例

次の例では、初めの initget 関数の呼び出しでキーワードのリスト(Yes と No)を設定すると同時に、次の getkword 関数呼び出しでの null 入力を禁止しています(bits 引数の値が 1)。

(initget 1 "Yes No")
nil

(setq x (getkword "Are you sure? (Yes or No) "))
Are you sure? (Yes or No) yes
"Yes"

次のコマンド シーケンスは、getkword 関数に対する応答で、ユーザが無効な入力を行ったときにどうなるかを示しています。

(initget 1 "Yes No")
nil

(setq x (getkword "Are you sure? (Yes or No) "))
Are you sure? (Yes or No) Maybe
Invalid option keyword.
Are you sure? (Yes or No) yes
"Yes"

ユーザの応答が、先の initget 関数で定義されたキーワードの 1 つではなかったので、getkword 関数はエラー メッセージを表示し、次に、msg 引数で与えられた文字列を使用して、ユーザに再度プロンプトを表示しました。