OBJECT Get help tip
OBJECT Get help tip ( {* ;} object ) -> 戻り値
| 引数 | 型 | 説明 | |
|---|---|---|---|
| * | 演算子 | → | 指定時objectはオブジェクト名 (文字列)省略時objectは変数 |
| object | any | → | オブジェクト名 (* 指定時)または変数 (* 省略時) |
| 戻り値 | Text | ← | オブジェクトのヘルプメッセージ |
このコマンドはスレッドセーフではないため、プリエンプティブなコードには使えません。
説明
OBJECT Get help tipコマンドはobject と*** 引数で指定したオブジェクトに割り当てられたカレントプロセスのヘルプメッセージを返します。
オプションの * 引数を渡すと、object 引数はオブジェクト名 (文字列) です。この引数を渡さない場合、object は変数であり、文字列ではなく変数参照を渡します。
このコマンドは指定したオブジェクトにデザインモードあるいはOBJECT SET HELP TIPコマンドでカレントプロセスに関連付けられた、現在のヘルプメッセージを返します。返される文字列はフォームが実行されたときに表示されるメッセージです。4D参照やxliff resnameなどの可変な値 が含まれる場合、文脈に基づき解析された結果が返されます。
例題
ピクチャーボタンのタイトルがヘルプメッセージとして格納されています。このタイトルはxliffファイルに記述されていて、アプリケーションのカレント言語に基づき変わります:
OBJECT SET HELP TIP(*;"button1";":xliff:btn_yes")
$helpmessage:=OBJECT Get help tip(*;"button1")
// $helpmessageには例えば日本語環境では"はい"、英語環境では"YES"が返されます (xliffにそのように記述されていれば)。