9.196 SHOW_HELP

注意： 9.1 組み込み関数の規則利用オプション

フィールド、コンポーネント、プロセス、またはファンクションに関連付けられたヘルプ・テキストをモーダルで表示します。

引数

番号

タイプ

必須/任意

記述

最小長

最大長

最小小数桁数

最大小数桁数

1

A

必須

オブジェクトのタイプ

この引数には次の値を指定してください。
PD - プロセス
PF - ファンクション
DF - フィールドまたはコンポーネント

上記以外の値は無効です。無効な値を指定すると、実行時エラーが発生します。

2

A

必須

オブジェクト名

ブランクまたはNULLのオブジェクト名を指定すると、実行時エラーが発生します。その他の無効なオブジェクト名または存在しないオブジェクト名を指定すると、ヘルプ・テキストは存在しないことを示すヘルプ・テキストが表示される可能性があります。

1

10

3

A

任意

オブジェクト名の拡張子。タイプPF(ファンクション)またはDF(コンポーネントのみ、フィールドは対象外)の場合のみ、この引数を指定してください。

ファンクションの場合、この引数は、そのファンクションが属するプロセスの名前で、10文字以下で指定する必要があります。

コンポーネントの場合、この引数は、所有コンポーネント内の特定コンポーネントの名前です。

これ以外のオブジェクト・タイプの場合、どの値を指定してもこの引数は無視されます。

1

65

戻り値はありません。

コンポーネントに関連付けられたヘルプ・テキストは、コンポーネントのコンテキスト(つまり、RDMLXプログラムから)でのみ表示する必要があります。
フィールド、プロセス、ファンクションに関連付けられたヘルプ・テキストは、どのコンテキスト(つまり、RDMLXプログラムまたはRDMLファンクションから)でも表示することができます。
このバージョンの組み込み関数では、ヘルプ・テキストはモーダルで表示されます。ユーザーがヘルプ・テキストの表示を終了し、ヘルプ・テキストのウィンドウを閉じるまで、アプリケーションは停止します。
今後のバージョンの組み込み関数では、ヘルプ・テキストはモーダルで表示されない可能性があります。現在のバージョンのモーダル機能に構造上依存するアプリケーションを設計しないことをお勧めします。
ユーザー・インターフェース機能が存在しない環境(例：トリガーまたはリモート・プロシージャの環境)では、この組み込み関数を絶対実行しないでください。

以下の例は、フィールドEMPNOに関連付けられたヘルプ・テキストを表示します。

     USE BUILTIN(SHOW_HELP) WITH_ARGS(DF EMPNO);

以下の例は、プロセスPSLSYSに関連付けられたヘルプ・テキストを表示します。

     USE BUILTIN(SHOW_HELP) WITH_ARGS(PD MYPROC);

以下の例は、コンポーネントVL_DEM20内のTREEVIEWコンポーネントに関連付けられたヘルプ・テキストを表示します。

     USE BUILTIN(SHOW_HELP) WITH_ARGS(DF VL_DEM20 TREEVIEW);