ema_cli.kb 的例行程序


AppendOriginalBodyToOutput

文件名

ema_cli.kb

语法

AppendOriginalBodyToOutput(REF commandData:SingleCommandRec, REF target:STRING );

参数

commandData - 命令说明块

返回

副作用

说明

此例行程序将原始消息正文(如果有)附加到输出字段中。

调用的对话框窗体


CleanupMessage

文件名

ema_cli.kb

语法

CleanupMessage( REF msg:STRING );

参数

msg - 新信息内容

返回

副作用

说明

此函数扫描消息,以获取“不良字符”并用空白字符替换每个“不良字符”。

调用的对话框窗体


CleanupUserReply

文件名

ema_cli.kb

语法

CleanupUserReply( REF msg:STRING );

参数

str - 字符串内容

返回

修改的输入字符串

副作用

说明

此函数扫描字符串,以获取嵌入的“标志”文本,该文本指示原始用户消息的开始与结束。除原始消息外的所有文本都被删除。

调用的对话框窗体


CLIBuildAlternateBody

文件名

ema_cli.kb

语法

CLIBuildAlternateBody(REF commandData:SingleCommandRec,

参数

commandData - 命令说明块

返回

副作用

说明

此例行程序为 alternateBody 字段建立消息,发送附件时(outputBody 成为附件),该消息成为主要消息。

调用的对话框窗体


CLIExecuteCommand

文件名

ema_cli.kb

语法

CLIExecuteCommand( REF commandblock:CLIDataRec);

参数

commandBlock - 包含所有用户输入的块

呼叫者基本上应该填写命令主体部分,所有其他部分将在

此处重置。

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 命令要求用户进行注册

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行已分析到此命令块中的命令。即使 ParseCommand 函数已返回错误代码,您也应调用此函数。

调用的对话框窗体


CLIInitialize

文件名

ema_cli.kb

语法

CLIInitialize( REF commandblock:CLIDataRec);

参数

commandBlock - 包含所有用户输入的块

返回

1 = 成功

0 = 失败

副作用

说明

此例行程序对要用作主要命令结构的数据结构执行初始化。

调用的对话框窗体


CLIParseCommand

文件名

ema_cli.kb

语法

CLIParseCommand( REF commandblock:CLIDataRec);

参数

commandBlock - 包含所有用户输入的块

呼叫者必须填写命令主体部分,所有其他部分将在

此处重置。

返回

1 = 成功

CLI_ERR_USER_INPUT = 某种用户输入错误

副作用

说明

当命令字符串存在于命令块中时,此例行程序对该命令字符串执行一般分析。

调用的对话框窗体


CLIProcessBrowseHelp

文件名

ema_cli.kb

语法

CLIProcessBrowseHelp(REF commandData:SingleCommandRec, VAL operation:INTEGER);

参数

commandData - 命令说明块

operation - 要执行的操作:分析、执行与帮助

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 命令要求用户进行注册

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行“帮助”的全部处理。

调用的对话框窗体


CLIProcessBrowseProb

文件名

ema_cli.kb

语法

CLIProcessBrowseProb(REF commandData:SingleCommandRec, VAL operation:INTEGER);

参数

commandData - 命令说明块

operation - 要执行的操作:分析、执行与帮助

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 命令要求用户进行注册

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行“浏览问题”用户命令的全部处理。

调用的对话框窗体


CLIProcessBrowseSoln

文件名

ema_cli.kb

语法

CLIProcessBrowseSoln(REF commandData:SingleCommandRec, VAL operation:INTEGER);

参数

commandData - 命令说明块

operation - 要执行的操作:分析、执行与帮助

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 命令要求用户进行注册

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行“浏览解决方案”用户命令的全部处理。

调用的对话框窗体


CLIProcessComment

文件名

ema_cli.kb

语法

CLIProcessComment(REF commandData:SingleCommandRec, VAL operation:INTEGER);

参数

commandData - 命令说明块

operation - 要执行的操作:分析、执行与帮助

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 命令要求用户进行注册

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行“提交注解”用户命令的全部处理。

调用的对话框窗体


CLIProcessDiagnoseProb

文件名

ema_cli.kb

语法

CLIProcessDiagnoseProb(REF commandData:SingleCommandRec, VAL operation:INTEGER);

参数

commandData - 命令说明块

operation - 要执行的操作:分析、执行与帮助

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 用户注册必需的命令

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行“诊断问题”用户命令的全部处理。

调用的对话框窗体


CLIProcessSubmitProb

文件名

ema_cli.kb

语法

CLIProcessSubmitProb(REF commandData:SingleCommandRec, VAL operation:INTEGER);

参数

commandData - 命令说明块

operation - 要执行的操作:分析、执行与帮助

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 命令要求用户进行注册

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行“提交问题”用户命令的全部处理。

调用的对话框窗体


CLIProcessUpdateProb

文件名

ema_cli.kb

语法

CLIProcessUpdateProb(REF commandData:SingleCommandRec, VAL operation:INTEGER);

参数

commandData - 命令说明块

operation - 要执行的操作:分析、执行与帮助

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 用户注册必需的命令

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行“更新问题”用户命令的全部处理。

调用的对话框窗体


CLIProcessUseSoln

文件名

ema_cli.kb

语法

CLIProcessUseSoln(REF commandData:SingleCommandRec, VAL operation:INTEGER);

参数

commandData - 命令说明块

operation - 要执行的操作:分析、执行与帮助

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 命令要求用户进行注册

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行“使用解决方案”用户命令的全部处理。

调用的对话框窗体


CLIProcessViewProb

文件名

ema_cli.kb

语法

CLIProcessViewProb(REF commandData:SingleCommandRec, VAL operation:INTEGER);

参数

commandData - 命令说明块

operation - 要执行的操作:分析、执行与帮助

返回

1 = 成功

CLI_ERR_USER_INPUT - 某种用户输入错误

CLI_ERR_USER_NOT_REGISTERED - 用户注册必需的命令

ERR_NONFATAL - 所发生的非致命执行错误

ERR_FATAL - 所发生的致命执行错误

CLI_ERR_INTERNAL - 所发生的内部错误

副作用

说明

此例行程序执行“查看问题”用户命令的全部处理。

调用的对话框窗体


CLIShutDown

文件名

ema_cli.kb

语法

CLIShutDown;

参数

返回

1 = 成功

-n = 失败:来自 TerminateADL 的返回码

副作用

说明

此例行程序执行最终关机操作。对此例行程序的调用应该是您主程序的最后一行。

调用的对话框窗体


CLITest

文件名

ema_cli.kb

语法

CLITest( VAL args:LIST OF STRING);

参数

args - 命令行自变量列表

返回

副作用

说明

此例行程序是此模块的交互测试。

调用的对话框窗体


ModuleTestEventHandler

文件名

ema_cli.kb

语法

ModuleTestEventHandler( REF eventData: CLIDataRec);

参数

eventData - 此对话框类型的实例数据

返回

1 = 成功

0 = 失败

副作用

说明

此例行程序更新屏幕。

调用的对话框窗体


ParseNextAsNoun

文件名

ema_cli.kb

语法

ParseNextAsNoun(REF commandData:SingleCommandRec);

参数

commandBlock - 包含所有用户输入的块

返回

>0 = 成功

0 = 没有要分析的内容(字符串的结尾?)

-1 = 未识别的名词

副作用

说明

此例行程序确定已输入了哪个命令名词。

调用的对话框窗体


ParseNextAsVerb

文件名

ema_cli.kb

语法

ParseNextAsVerb(REF commandData:SingleCommandRec);

参数

commandBlock - 包含所有用户输入的块

返回

>0 = 成功

0 = 没有要分析的内容(字符串的结尾?)

-1 = 未识别的名词

副作用

说明

此例行程序确定已输入了哪个命令动词。

调用的对话框窗体


ParseRemainder

文件名

ema_cli.kb

语法

ParseRemainder(REF commandData:SingleCommandRec, VAL operation:INTEGER );

参数

commandBlock - 包含所有用户输入的块

operation - CLIProcessXxxx 的操作码

返回

>0 = 成功

-1 = 无法分析名词

-n = 来自 CLIProcessXxxx 例行程序的任何错误代码。

副作用

.errorCode 与 .outputBody 字段将在 arg1 中设置。

说明

此例行程序不仅仅完成命令动词的分析。因为一些动词采用自变量,而一些不采用自变量,此例行程序调遣到分析例行程序,以获取各种动词类型。

调用的对话框窗体


RefreshTestFields

文件名

ema_cli.kb

语法

RefreshTestFields( VAL dlgWindow:WINDOW, REF eventData: SingleCommandRec );

参数

eventData - 此对话框类型的实例数据

返回

1 = 成功

0 = 失败

副作用

说明

此例行程序更新屏幕。

调用的对话框窗体