文件名
语法
CloseLogFile( REF LogData:LogDataRec );
参数
LogData - 记录对话框数据结构
返回
1 = 成功
-1 = 请参见 FOpen,操作系统错误代码
副作用
无
说明
此例行程序关闭日志窗口。
调用的对话框窗体
无
文件名
语法
CommonWrite( VAL str:STRING, VAL strColor:INTEGER, REF LogData:LogDataRec, VAL newLine:BOOLEAN);
参数
str - 要写入日志的字符串
strColor - 用于屏幕输出的字符串颜色
LogData - 模块结构句柄
newLine - 在字符串结尾写一行新字符
返回
-1 = 无法写入文件
-2 = 无法写入窗口
-3 = 无法写入窗口或文件
1 = 成功
副作用
可以写入文件或窗口
说明
此函数将所提供的字符串写入日志文件、日志窗口或同时写入日志文件与日志窗口。如果 newLine 标志是 true,则该函数在字符串结尾写一行新字符。LogWrite 与 LogWriteLn 使用此函数。实施注意:此一般例行程序试图向窗口、文件或窗口文件进行写操作,或不向它们进行写操作。向文件或窗口进行写操作的能力是由管理员控制的变量与操作环境的当前状态一起决定的。如果管理员已请求向文件进行写操作,则会有文件大小限制(由 admin 设置的)要确认。因此,要向文件进行写操作,管理员必须已请求了文件写操作、该文件必须是已经打开的且新行必须不能超过请求的限制。向窗口进行写操作之前必须检查类似条件。窗口写操作有设置行颜色的其他方法。
调用的对话框窗体
无
文件名
语法
CreateLogFile( REF LogData:LogDataRec, VAL promptUserOnError:BOOLEAN, VAL closeCurrent:BOOLEAN, VAL fromStartup:BOOLEAN );
参数
LogData - 记录对话框数据结构
promptUserOnError - 标志:显示错误消息框
closeCurrent - 标志:如果文件是打开的,请关闭它。
fromStartup - 进行任何特殊“启动”活动
返回
1 = 成功
0 = 失败
-3 = 目标文件已满
-2 = 不良文件名
-1 = 请参见 FOpen,操作系统错误代码
副作用
无
说明
此例行程序创建日志窗口。
调用的对话框窗体
无
文件名
语法
CreateLogWindow( REF LogData:LogDataRec, VAL startMinimized:BOOLEAN );
参数
LogData - 记录对话框数据结构
startMinimized - 指示创建时的窗口状态的标志
返回
1 = 成功
2 = 成功(已经创建)
0 = 失败
副作用
无
说明
此例行程序创建日志窗口。
调用的对话框窗体
无
文件名
语法
LogCreateDialog( VAL parentWindow:WINDOW );
参数
parentWindow - 新对话框的父级的窗口句柄
返回
2 = 已经创建
1 = 成功
0 = 失败
副作用
无
说明
此函数创建类型 log 的对话框。调用此函数之前,应该总是调用第一个自变量上的 LogGetData 并替换所有必要值。调用 GetData 失败会产生未在使用的常规缺省值。
调用的对话框窗体
无
文件名
语法
LogDestroyDialog;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数毁坏此 KB 的对话框与专用模块数据结构。换句话说,它进行重新初始化。
调用的对话框窗体
无
文件名
语法
LogDlgRestoreData( REF errLogData:ErrLogDataRec );
参数
LogData - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数从某文件或数据库恢复与此模块有关的对话框数据。
调用的对话框窗体
无
文件名
语法
LogEventHandler( REF LogDlgData:LogDlgDataRec);
参数
LogDlgData - 此对话框类型的实例数据
返回
1 = 成功
0 = 失败
副作用
无
说明
此例行程序为日志对话框提供事件处理。注:此事件处理器的最后一个语句将实例记录信息转移到整个模块静态数据中,因此一定要避免使用“退出”,除非希望防止记录更新。
调用的对话框窗体
无
文件名
语法
LogGetData( REF logData:LogDataRec );
参数
LogData - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数获取与此模块有关的对话框数据。
调用的对话框窗体
无
文件名
语法
LogHideDialog;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数隐藏此 KB 文件的对话框。它毁坏该 GUI,但不触动数据结构。
调用的对话框窗体
无
文件名
语法
LogInitData;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数用外部数据存储中的信息初始化模块数据结构。
调用的对话框窗体
无
文件名
语法
LogSetData( REF logData:LogDataRec );
参数
LogData - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数设置与此模块有关的对话框数据。
调用的对话框窗体
无
文件名
语法
LogShutDown( VAL callerstatus:INTEGER );
参数
callerStatus - 调用程序的关闭状态
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数执行此模块的最终操作,以期望调用应用程序关闭。它是最终安全阀。(如果由于内部问题调用程序将要关闭,此模块将异常终止。)
调用的对话框窗体
无
文件名
语法
LogTestDialog;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
如果此模块直接执行,则调用此过程。它的功能是产生交互作用的对话框并调用到此模块的公共界面。
调用的对话框窗体
无
文件名
语法
LogWinWrite( VAL str:STRING, VAL strColor:INTEGER, REF LogData:LogDataRec, VAL newLine:BOOLEAN);
参数
str - 要写入日志的字符串
strColor - 用于屏幕输出的字符串颜色
LogData - 模块结构句柄
newLine - 在字符串结尾写一行新字符
返回
1 = 成功
副作用
写入窗口
说明
这是一种低级功能,它将所提供的字符串写入日志窗口。
调用的对话框窗体
无
文件名
语法
LogWrite( VAL str:STRING, VAL strColor:INTEGER);
参数
str - 要写入日志的字符串
strColor - 用于屏幕输出的字符串颜色
返回
-1 = 无法写入文件
-2 = 无法写入窗口
-3 = 无法写入窗口或文件
1 = 成功
副作用
可以写入文件或窗口
说明
此函数将所提供的字符串写入日志文件、日志窗口或同时写入日志文件与日志窗口。此函数不在字符串结尾添加一行新字符。
调用的对话框窗体
无
文件名
语法
LogWriteIncoming( VAL cmdCode:INTEGER, VAL msgFrom:STRING, VAL msgSubject:STRING, VAL msgBody:STRING, VAL parseStatus:INTEGER );
参数
返回
-1 = 无法写入文件
-2 = 无法写入窗口
-3 = 无法写入窗口或文件
0 = 未启用写操作
1 = 成功
副作用
可以写入文件或窗口
说明
此函数按照管理员的请求将所提供的信息写入日志。如果外来标志尚未设为 true,此例行程序将不进行任何操作。
调用的对话框窗体
无
文件名
语法
LogWriteLn( VAL str:STRING, VAL strColor:INTEGER);
参数
str - 要写入日志的字符串
strColor - 用于屏幕输出的字符串颜色
返回
-1 = 无法写入文件
-2 = 无法写入窗口
-3 = 无法写入窗口或文件
1 = 成功
副作用
可以写入文件或窗口
说明
此函数将所提供的字符串写入日志文件、日志窗口或同时写入日志文件与日志窗口。此函数的这种形式在字符串结尾写一行新字符。
调用的对话框窗体
无
文件名
语法
LogWriteOutgoing( VAL cmdCode:INTEGER, VAL msgFrom:STRING, VAL msgSubject:STRING, VAL msgBody:STRING, VAL parseStatus:INTEGER );
参数
返回
-1 = 无法写入文件
-2 = 无法写入窗口
-3 = 无法写入窗口或文件
0 = 未启用写操作
1 = 成功
副作用
可以写入文件或窗口
说明
此函数按照管理员的请求将所提供的信息写入日志。如果外出标志尚未设为 true,此例行程序将不进行任何操作。
调用的对话框窗体
无
文件名
语法
PerformAction( REF logDlgData:LogDlgDataRec, VAL dlgHandle:WINDOW, VAL controlName:STRING, VAL controlID:INTEGER );
参数
LogDlgData - 此窗口的实例数据
dlgHandle - 对话框的窗口句柄
controlName - 所选控件的名称
controlID - 所选控件的编号标识
$EventParm(3,T) - 对象的旧值
$EventParm(4,T) - 对象的新值
返回
1 = 成功
0 = 失败
副作用
无
说明
此例行程序执行“记录配置”对话框中控件的操作。它基于复选框(布尔值)屏幕对象启用对话框控件并将值转移到 m_errLogData 中。请注意:由于访问各种内置 $EventXxx 变量的需要,此例行程序嵌套在 ErrLogEventHandler 内。不知道这些变量的 TSD 脚本类型,就不能将这些变量作为自变量输入。
调用的对话框窗体
无
文件名
语法
PlaceholderEvent;
参数
无
返回
无
副作用
无
说明
此例行程序为滚动日志窗口提供基本事件处理。
调用的对话框窗体
无
文件名
语法
TransferAttribsToModuleRec(VAL logAttribList:LIST OF DBDialogAttribRec);
参数
logAttribList - 包含数据的结构
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数将“DB 属性”列表转移到模块数据结构中。
调用的对话框窗体
无
文件名
语法
TransferModuleRecToAttribs(VAL logAttribList:LIST OF DBDialogAttribRec);
参数
logAttribList - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数将要传输的模块数据结构内容“DB 属性”列表转移到数据库。
调用的对话框窗体
无
文件名
语法
UpdateDialogFromData(REF logDlgData:LogDlgDataRec, VAL dlgHandle:WINDOW );
参数
logDlgData - 实例对话框数据
dlgHandle - 对话框的窗口句柄
返回
1 = 成功
0 = 失败
副作用
无
说明
此例行程序强制 GUI 对话框对象状态与存储在数据字段中的值保持一致。通常这是由事件处理器与它的 PerformSelectActions 例行程序处理的。重新例示某一对话框时,此例行程序提供了一种设置适当的 GUI 状态的机制。对话框控件的启用基于复选框(布尔值)屏幕对象。
调用的对话框窗体
无