CL 命令和命令联机帮助

在线编辑

命令提示和联机命令帮助是 CL 命令的强大功能。

如果您已开发一个或多个自己的 CL 命令，那么您知道 IBM CL 命令所使用的所有命令提示功能都可供您用于您的命令。 对于命令帮助也是如此; 对于为 IBM提供的命令提供的帮助，您也可以使用相同的功能来创建联机帮助。

第一步是了解命令和命令帮助之间的连接如何工作。

  • 命令帮助信息存储在面板组对象中。 面板组的符号对象类型为 *PNLGRP。 帮助面板组由帮助模块组成。 每个帮助模块都有一个帮助模块名称。
  • Create Command (CRTCMD) 命令上有两个参数用于在命令 (*CMD) 对象与联机帮助面板组之间建立连接: HLPID (帮助标识) 和 HLPPNLGRP (帮助面板组)。
  • 联机帮助面板组中有四种类型的命令帮助模块:
    1. 命令级帮助模块
    2. 参数级别帮助模块
    3. 命令示例帮助模块
    4. 命令错误消息帮助模块

当您尝试查看 CL 命令的帮助时（例如，在提示命令时按 F1（帮助）键），IBM i操作系统会确定该命令是否有与之关联的帮助面板组。 如果该命令是在为 HLPPNLGRP 参数指定面板组名的情况下创建的，或者被 Change Command (CHGCMD) 命令更改为具有与该命令相关联的帮助面板组，那么将检索，格式化和显示存储在该面板组中的帮助。 操作系统尝试从帮助面板组中的以下帮助模块检索帮助:

  • 与创建或更改命令时为 HLPID 参数指定的值同名的命令级别帮助模块。 例如，如果创建了指定 HLPID (STRPAY) 的命令 STRPAY ，那么操作系统将查找名为 STRPAY 的帮助模块。
  • 每个命令参数的参数级别帮助模块，常量参数除外。 帮助模块名称必须是命令的 HLPID 值，后跟正斜杠字符，后跟参数关键字名称。 例如，如果命令 STRPAY 具有 HLPID 值 STRPAY 和名为 TITLE 的参数，那么操作系统将查找名为 STRPAY/TITLE 的参数级别帮助模块。
  • 包含一个或多个使用该命令的示例的帮助模块。 帮助模块名称必须是命令的 HLPID 值，后跟正斜杠字符，后跟 COMMAND/EXAMPLES。 例如，如果命令 STRPAY 的 HLPID 值为 STRPAY ，那么操作系统将查找名为 STRPAY/COMMAND/EXAMPLES 的命令示例帮助模块。
  • 一个帮助模块，其中包含可从命令发出信号的可监控消息的列表。 帮助模块名称必须是命令的 HLPID 值，后跟正斜杠字符，后跟 ERROR/MESSAGES。 例如，如果命令 STRPAY 的 HLPID 值为 STRPAY ，那么操作系统将查找名为 STRPAY/ERROR/MESSAGES 的命令示例帮助模块。

在 5250 终端 (或使用 5250 仿真器软件) 上查看扩展 CL 命令帮助时，需要命令级别和参数级别的帮助部分，并且示例和错误消息帮助部分是可选的。 如果在联机帮助面板组中找不到命令级别帮助部分或任何参数级别帮助部分，那么将在帮助屏幕底部显示诊断消息 CPF6E01 (帮助信息不完整)。 如果找不到示例或错误消息帮助模块，那么不会显示诊断消息。