これらの簡易関数は、ヘルプ・ダイアログのそれぞれのシングル・インスタンスを作成します。ヘルプ・ダイアログの要求した型のインスタンスがすでに存在している場合は再利用されます。ダイアログの親は環境変数 $TOPLEVEL から獲得されます。これはシェル・スクリプトによって設定され、その後は変更されません。要求したダイアログのハンドルは、次のいずれかの環境変数に返されます。
_DTKSH_HELP_DIALOG_HANDLE
_DTKSH_QUICK_HELP_DIALOG_HANDLE
ダイアログを破壊する必要がある場合は、関連する環境変数を消去して、簡易関数がダイアログを再利用しないようにしてください。
次に使用方法を示します。
DtkshDisplay*HelpDialog title helpType helpInformation [locationId]
パラメータの意味は helpType パラメータに指定した値に依存します。意味は次のとおりです。
helpType = HELP_TYPE_TOPIC
helpInformation = ヘルプ・ボリューム名
locationId = ヘルプ・トピック位置 ID
helpType = HELP_TYPE_STRING
helpInformation = ヘルプ文字列
locationId = <未使用>
helpType = HELP_TYPE_DYNAMIC_STRING
helpInformation = ヘルプ文字列
locationId = <未使用>
helpType = HELP_TYPE_MAN_PAGE
helpInformation = マニュアル・ページ名
locationId = <未使用>
helpType = HELP_TYPE_FILE
helpInformation = ヘルプ・ファイル名
locationId = <未使用>
次に例を示します。
DtkshDisplayHelpDialog "Help On Dtksh" HELP_TYPE_FILE "helpFileName"