9.103 GET_HELP
指定のフィールド、ファンクション、またはプロセスに関するヘルプ・テキストのリストを取得します。
Þこれは、 開発環境のみで使用される特殊BIF です。
各製品の対応
|
LANSA/AD |
使用可 |
|
Visual LANSA for Windows |
使用可 |
|
Visual LANSA for Linux |
未対応 |
引数
|
番号 |
タイプ |
必須/任意 |
記述 |
最小長 |
最大長 |
最小小数桁数 |
最大小数桁数 |
|---|---|---|---|---|---|---|---|
|
1 |
A |
必須 |
オブジェクト名。フィールド、ファンクション、またはプロセスの名前です。 |
1 |
10 |
||
|
2 |
A |
必須 |
オブジェクト拡張名。オブジェクト・タイプがファンクションの場合、この値はファンクションが定義されているプロセスの名前にする必要があります。オブジェクト・タイプがファンクション以外の場合、この値はブランクにします。 |
1 |
10 |
||
|
3 |
A |
必須 |
オブジェクト・タイプの値： DF - フィールド PD - プロセス PF - ファンクション |
2 |
2 |
戻り値
|
番号 |
タイプ |
必須/任意 |
記述 |
最小長 |
最大長 |
最小小数桁数 |
最大小数桁数 |
|---|---|---|---|---|---|---|---|
|
1 |
L |
必須 |
ヘルプ・テキストを含める作業リスト リストは以下のエントリー数を越えてはいけません。 呼び出し元のRDMLファンクションは、項目の長さの合計が正確に77バイトの作業リストを提供しなければなりません。 戻されるそれぞれのリスト項目は、次のような形式にする必要があります。 1〜77 バイト：ヘルプ・テキスト |
1 |
77 |
||
|
2 |
A |
必須 |
戻りコード OK = このオブジェクトに関するヘルプ・テキストのリスト(満載または一部)が戻された。このオブジェクトに関するヘルプ・テキストはこれ以上存在しない OV = リスト(満載)が戻された。ただしリストに収まらなかったヘルプ・テキストがさらに存在する。通常、スタイル・リストを表示する時に、この値を使ってページに次のファンクションがあることを示す ER = 引数の詳細が無効であるか、権限上の問題が発生した "ER" の場合は、戻りコード・エラー・メッセージが自動的に発行されます。 |
2 |
2 |
例
特定のオブジェクトのヘルプ・テキストを取得して、HELPキーを使わずにそのヘルプ・テキストを表示します。
********* Define arguments and lists
DEFINE
FIELD(#OBJNAM) TYPE(*CHAR) LENGTH(10)
DEFINE FIELD(#OBJEXT) TYPE(*CHAR)
LENGTH(10)
DEFINE FIELD(#OBJTYP) TYPE(*CHAR) LENGTH(2)
DEFINE
FIELD(#HLPTXT) TYPE(*CHAR) LENGTH(77)
DEFINE FIELD(#RETCOD) TYPE(*CHAR)
LENGTH(2)
DEF_LIST NAME(#WKHLPL) FIELDS((#HLPTXT)) TYPE(*WORKING)
DEF_LIST
NAME(#BWHLPL) FIELDS((#HLPTXT))
GROUP_BY NAME(#RQSOBJ) FIELDS((#OBJNAM)
(#OBJEXT) (#OBJTYP))
GROUP_BY NAME(#DSPHLP) FIELDS((#OBJNAM) (#OBJEXT)
(#OBJTYP))
********* Clear working and browse lists
BEGIN_LOOP
********* Request Object Name, Extension and Type
REQUEST
FIELDS(#RQSOBJ)
CLR_LIST NAMED(#WKHLPL)
CLR_LIST
NAMED(#BWHLPL)
********* Execute built-in-function - GET_HELP
USE
BUILTIN(GET_HELP) WITH_ARGS(#OBJNAM #OBJEXT #OBJTYP)
TO_GET(#WKHLPL
#RETCOD)
********* Help text was retrieved successfully
IF COND('#RETCOD
*EQ ''OK''')
********* Move Help text from the working list to the
browselist
SELECTLIST NAMED(#WKHLPL)
ADD_ENTRY
TO_LIST(#BWHLPL)
ENDSELECT
********* Allow Help text to be reviewed for
the specified object
DISPLAY FIELDS((#DSPHLP))
BROWSELIST(#BWHLPL)
********* Working list overflowed, more help text to
retrieve
ELSE
IF COND('#RETCOD *EQ ''OV''')
MESSAGE MSGTXT('List not
big enough to fit all help text')
********* GET_HELP failed with errors,
report error
ELSE
MESSAGE MSGTXT('GET_HELP failed with errors, try
again')
ENDIF
ENDIF
END_LOOP