文件名
语法
CommonWrite( VAL str:STRING, VAL strColor:INTEGER, REF errLogData:errLogDataRec, VAL newLine:BOOLEAN);
参数
str - 要写入日志的字符串
strColor - 用于屏幕输出的字符串颜色
errLogData - 数据返回值
newLine - 在字符串结尾写一行新字符
返回
-1 = 无法写入文件
-2 = 无法写入窗口
-3 = 无法写入窗口或文件
1 = 成功
副作用
可以写入文件或窗口
说明
此函数将所提供的字符串写入日志文件、日志窗口或同时写入日志文件与日志窗口。
调用的对话框窗体
无
文件名
语法
CreateLogFile( REF errLogData:ErrLogDataRec, VAL promptUserOnError:BOOLEAN, VAL closeCurrent:BOOLEAN, VAL fromStartup:BOOLEAN );
参数
errLogData - 记录对话框数据结构
promptUserOnError - 要建立错误消息框的标志
closeCurrent - 指示文件是否为打开状态的标志,请关闭该文件。
fromStartup - 执行任何特殊启动活动
返回
1 = 成功
0 = 失败
-3 = 目标文件已满
-2 = 不良文件名
-1 = 请参见 FOpen,操作系统错误代码
副作用
无
说明
此例行程序创建日志窗口。
调用的对话框窗体
无
文件名
语法
CreateLogWindow( REF errLogData:ErrLogDataRec, VAL startMinimized:BOOLEAN, VAL displayLogFile:BOOLEAN );
参数
errLogData - 记录对话框数据结构
startMinimized - 指示创建时的窗口状态的标志
displayLogFile - 如果正创建窗口,此自变量会在该窗口中显示错误文件。
返回
1 = 成功
2 = 成功(已经创建)
0 = 失败
副作用
无
说明
此例行程序创建 errLog 窗口。
调用的对话框窗体
无
文件名
语法
DisplayLogFileInWindow( REF logFile:FILE, VAL logFileName:STRING );
参数
logFile - 文件句柄
logFileName - 猜测
返回
无
副作用
无
说明
此例行程序将现有错误日志文件放入滚动“日志”对话框。
调用的对话框窗体
无
文件名
语法
ErrLogCreateDialog( VAL parentWindow:WINDOW );
参数
parentWindow - 新对话框的父级的窗口句柄
返回
2 = 已创建
1 = 成功
0 = 失败
副作用
无
说明
此函数创建类型 log 的对话框。调用此函数之前,应该总是调用第一个自变量上的 ErrLogGetData 并替换所有必要值。调用 GetData 失败会产生未在使用的常规缺省值。
调用的对话框窗体
无
文件名
语法
ErrLogDBEnableControls( VAL enableControls:BOOLEAN, VAL msgString:STRING, VAL mailData:EMailDataRec );
参数
enableControls - TRUE(启用)或 FALSE(禁用)
msgString - 要写入该框中的消息行的字符串(如有的话)。
如果这是 $Unknown,则什么也没写。
mailData - 供“GetReadCount”按钮使用的邮件数据
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数启用或禁用用户控件并将字符串输出到消息行(如有的话)。
调用的对话框窗体
无
文件名
语法
ErrLogDBErrorFatal( VAL dbErrorCode:INTEGER );
参数
dbErrorCode - (负数)SQL 返回码
返回
无
副作用
无
说明
此例行程序查看数据库错误代码(可能是来自数据库调用的返回值)并试图确定错误的严重性。如果错误指示进一步的数据库活动无用,则返回 TRUE。
调用的对话框窗体
无
文件名
语法
ErrLogDlgRestoreData( REF errLogData:ErrLogDataRec );
参数
errLogData - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数从某文件或数据库恢复与此模块有关的对话框数据。
调用的对话框窗体
无
文件名
语法
ErrLogEventHandler( REF errLogDlgData:ErrLogDlgDataRec);
参数
errLogDlgData - 此对话框类型的实例数据
返回
1 = 成功
0 = 失败
副作用
无
说明
此例行程序为“日志”对话框提供事件处理。
调用的对话框窗体
无
文件名
语法
ErrLogHideDialog;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数隐藏此 KB 的对话框。它毁坏该 GUI,但不触动数据结构。
调用的对话框窗体
无
文件名
语法
ErrLogInitData;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数用外部数据存储中的信息初始化模块数据结构。
调用的对话框窗体
无
文件名
语法
ErrLogShutDown( VAL callerstatus:INTEGER );
参数
callerStatus - 调用程序的关闭状态
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数执行此模块的最终操作,以期望呼叫应用程序关闭。如果由于内部问题呼叫程序将要关闭,此模块可能异常终止。
调用的对话框窗体
无
文件名
语法
ErrLogTestDialog(VAL args:LIST OF STRING);
参数
args - 命令行自变量列表
返回
1 = 成功
0 = 失败
副作用
无
说明
如果直接执行此模块,则调用此过程。它的功能是产生交互作用的对话框并调用此模块的公共界面。
调用的对话框窗体
无
文件名
语法
ErrLogWrite( VAL str:STRING, VAL strColor:INTEGER);
参数
str - 要写入日志的字符串
strColor - 用于屏幕输出的字符串颜色
返回
-1 = 无法写入文件
-2 = 无法写入窗口
-3 = 无法写入窗口或文件
1 = 成功
副作用
可以写入文件或窗口
说明
此函数将所提供的字符串写入日志文件、日志窗口或同时写入日志文件与日志窗口。此函数不像 ErrLogWriteLn 那样在字符串结尾添加一行新字符。
调用的对话框窗体
无
文件名
语法
ErrLogWriteDBError( VAL msgString:STRING, VAL routineName:STRING, VAL dbFunction:STRING, VAL dbTable:STRING, VAL dbErrorCode:INTEGER, VAL strColor:INTEGER);
参数
msgString - 要写入错误日志的字符串
routineName - 出错的例行程序
dbFunction - 出错时正执行的函数
dbTable - 出错时正访问的表
dbErrorCode - 数据库错误代码
strColor - 用于屏幕输出的字符串颜色
返回
-1 = 无法写入文件
-2 = 无法写入窗口
-3 = 无法写入窗口或文件
0 = 未启用写操作
1 = 成功
副作用
可以写入文件或窗口
说明
此函数将所提供的信息写入错误日志。它适合数据库错误的写输出。
调用的对话框窗体
无
文件名
语法
ErrLogWriteLn( VAL str:STRING, VAL strColor:INTEGER);
参数
str - 要写入日志的字符串
strColor - 用于屏幕输出的字符串颜色
返回
-1 = 无法写入文件
-2 = 无法写入窗口
-3 = 无法写入窗口或文件
1 = 成功
副作用
可以写入文件或窗口
说明
此函数将所提供的字符串写入日志文件、日志窗口或同时写入日志文件与日志窗口。此函数在字符串结尾包含一行新字符。
调用的对话框窗体
无
文件名
语法
ErrLogWriteSysError( VAL msgString:STRING, VAL routineName:STRING, VAL sysFunction:STRING, VAL sysErrorCode:INTEGER, VAL strColor:INTEGER);
参数
msgString - 要写入错误日志的字符串
routineName - 出错的例行程序
strColor - 用于屏幕输出的字符串颜色
返回
无
副作用
可以写入文件或窗口
说明
此函数将所提供的信息写入错误日志。已将它设置为可写任何系统错误代码。
调用的对话框窗体
无
文件名
语法
ErrModuleTestEventHandler(REF errModuleTestData: ErrModuleTestRec);
参数
ErrModuleTestData - 此对话框类型的实例数据
返回
1 = 成功
0 = 失败
副作用
无
说明
此例行程序为“ErrModuleTest”对话框提供事件处理。
调用的对话框窗体
无
文件名
语法
PerformAction( REF errLogDlgData:ErrLogDlgDataRec, VAL dlgHandle:WINDOW, VAL controlName:STRING, VAL controlID:INTEGER );
参数
errLogDlgData - 此窗口的实例数据
dlgHandle - 对话框的窗口句柄
controlName - 所选控件的名称
controlID - 所选控件的编号标识
$EventParm(3,T) - 对象的旧值
$EventParm(4,T) - 对象的新值
返回
1 = 成功
0 = 失败
副作用
无
说明
此例行程序执行“记录配置”对话框中控件的操作。
调用的对话框窗体
无
文件名
语法
PlaceholderEvent;
参数
无
返回
无
副作用
无
说明
此例行程序为滚动日志对话框提供最少量事件处理。
调用的对话框窗体
无
文件名
语法
TransferAttribsToModuleRec(VAL errLogAttribList:LIST OF DBDialogAttribRec);
参数
errLogAttribList - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数将 DB 属性列表转移到模块数据结构中。
调用的对话框窗体
无
文件名
语法
TransferModuleRecToAttribs(REF errLogAttribList:LIST OF DBDialogAttribRec);
参数
errLogAttribList - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数将要传输的模块数据结构内容数据库属性列表转移到数据库。
调用的对话框窗体
无