文件名
语法
DBGetStatsInfo( REF statsInfo:UserListRowRec );
参数
statsInfo (O) - 返回的属性列表
返回
1 = 成功
0 = 失败
-n = 失败,数据库错误代码
副作用
无
说明
此函数从数据库获取命令统计。假定此例行程序只调用了一次。
调用的对话框窗体
无
文件名
语法
DBSetStatsInfo( REF deltaInfo:UserListRowRec, VAL showError:BOOLEAN );
参数
deltaInfo(I/O) - 自上次刷新以来的计数更改
showError(I) - 控制是否允许 TSD 脚本 SQL 消息显示在屏幕上
返回
1 = 成功
0 = No-op, 不需要更新的统计
-n = 失败,数据库错误代码
副作用
无
说明
此函数更新存储在数据库中的统计信息。当此处所用的方法试图在此服务器会话期间用所记录的 delta 值“提高”计数时,它会允许多个服务器与同一 TMG 数据库进行对话。这样更新这些值的其他服务器不会进行干预。
调用的对话框窗体
无
文件名
语法
ExportUserActivityData( VAL wHdlParent: WINDOW );
参数
wHdlParent(I) - 父窗口
返回
1 = 成功
0 = 异常终止的用户
-n = 文件输入/输出错误
副作用
无
说明
此例行程序将用户活动数据引出到制表符定界的文本文件中,以用于报告目的。所产生的文件可用作所提供的 Crystal 报告“ema_user.rpt”或所需的任何其他书写器的数据源。
调用的对话框窗体
无
文件名
语法
ModuleTestEventHandler( REF moduleTestData: ModuleTestRec );
参数
ModuleTestData (I/O) - 此对话框类型的实例数据
返回
1 = 成功
0 = 失败
副作用
无
说明
此例行程序为“模块测试”对话框提供事件处理。
调用的对话框窗体
无
文件名
语法
RefreshListBoxFromData( REF userLBData:UserDialogRec );
参数
userLBData (I/O) - 数据记录句柄
返回
1 = 成功
0 = 失败
-n = 来自数据库操作的失败代码
副作用
无
说明
此函数将存储在数据结构行中的信息转移到列表框中。在插入之前清空该框。
调用的对话框窗体
无
文件名
语法
TransferRowToGUIFields( REF userLBData:UserDialogRec );
参数
userLBData (I/O) - 数据记录句柄
返回
1 = 成功
0 = 失败
-n = 来自数据库操作的失败代码
副作用
无
说明
此函数将存储在当前行中的信息转移到各种匹配 GUI 字段中。如果没有当前行,该函数会清除这些字段。
调用的对话框窗体
无
文件名
语法
UpdateSingleStatistic( VAL statisticName:STRING, REF deltaStatisticValue:INTEGER );
参数
statisticName(I) - DB 中的统计名称
deltaStatisticValue (I/0) - 要添加到当前存储值中的值
返回
1 = 成功
0 = No-op, 不需要更新的统计
-17342 = 失败,被动并行错误
-n = 失败,数据库错误代码
副作用
无
说明
此函数更新数据库统计表中的单个条目(列)。注:如果成功,此例行程序会设置
调用的对话框窗体
无
文件名
语法
UserActCreateDialog( VAL parentWindow:WINDOW );
参数
parentWindow - 新对话框的父级的窗口句柄
返回
2 = 对话框已在窗口上
1 = 成功
0 = 失败
副作用
无
说明
此函数创建类型 user 的对话框。调用此函数之前,应该总是调用 UserActInitData。如果无法进行如此操作,此例行程序会为您检测和调用该函数。如果需要更改出现在该对话中的值,可调用 GetData,设置该数据结构中的值,即调用 SetData,然后调用此例行程序。您的程序应该在启动时调用 InitData。
调用的对话框窗体
无
文件名
语法
UserActDBLoadTable( REF userLBData:UserListDataRec );
参数
userLBData (I/O) - 数据记录句柄
返回
1 = 成功
0 = 失败
-n = 来自数据库操作的失败代码
副作用
无
说明
此函数装入数据库表中的数据结构列表。
调用的对话框窗体
无
文件名
语法
UserActDestroyDialog;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
如果某对话框当前可见,则此函数毁坏该对话框。一般说来,应该避免调用此函数,因为毁坏用户可能正在查看的框被视为很不礼貌。如果应用程序是将要终结的,该函数才适用。
调用的对话框窗体
无
文件名
语法
UserActDlgRestoreData( REF userData:UserDataRec );
参数
userData (O) - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数从某文件或数据库恢复与此模块有关的对话框数据。
调用的对话框窗体
无
文件名
语法
UserActDlgSaveData( REF userData:UserDataRec );
参数
userData (O) - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数将与此模块有关的对话框数据保存到某种持久性形式(例如,数据库或文件)中。请注意:这不包括列表框数据,假定已用交互控件立刻保存了该数据。
调用的对话框窗体
无
文件名
语法
UserActEnableControls( VAL enableControls:BOOLEAN, VAL msgString:STRING );
参数
enableControls - TRUE(启用)或 FALSE(禁用)
msgString(I) - 要写入该对话框中的消息行的字符串(如有的话)。
如果这是 $Unknown,则什么也没写。
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数启用或禁用用户控件并将字符串输出到消息行(如有的话)。
调用的对话框窗体
无
文件名
语法
UserActEventHandler( REF userDlgData: UserDialogRec );
参数
userDlgData (I/O) - 此对话框类型的实例数据
返回
1 = 成功
0 = 失败
副作用
无
说明
此例行程序为用户对话框提供事件处理。
调用的对话框窗体
无
文件名
语法
UserActGetData( REF userData:UserDataRec );
参数
userdata - 数据返回值
返回
1 = 成功
n = UserActInitData 的返回值
副作用
无
说明
此函数获取与此模块有关的对话框数据。
调用的对话框窗体
无
文件名
语法
UserActInitData;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数用静态信息初始化模块数据结构。
调用的对话框窗体
无
文件名
语法
UserActLBEnter2ndaryFieldAction( REF userLBData:UserDialogRec, VAL fieldName:STRING );
参数
userLBData (I/O) - 列表框句柄
updateDB (I) - 指示是否保存操作
返回
1 = 成功
2 = 列表是空的
0 = 来自 DlgSetEnabled 的失败返回码
-n = 来自 DlgSetEnabled 的失败返回码
副作用
无
说明
此函数启用“修改”按钮在 GUI 中的非键值字段中进行输入。(将对键值字段进行添加输入。)详细说明,请参见 EnterKeyFieldAction。
调用的对话框窗体
无
文件名
语法
UserActLBModifyAction( REF userLBData:UserDialogRec, VAL updateDB:BOOLEAN);
参数
userLBData (I/O) - 列表框句柄
updateDB (I) - 指示是否保存操作
返回
1 = 成功
0 = 列表是空的、没有进行选择、没有字段被修改过或用户已拒绝修改
-1 = DB/GUI 操作之后无法更新内部选择
-n = 无法更新 DB 行(没有 GUI 更新)(请参见 DB 代码)。
副作用
无
说明
此函数修改列表中的当前所选项。注:此函数假定相应列表(GUI 列表框、KML 列表 与 DB 列表)已位于当前项处。
调用的对话框窗体
无
文件名
语法
UserActLBMsgSelectHandler( REF userLBData:UserDialogRec, VAL fieldName:STRING, VAL updateDB:BOOLEAN );
参数
userLBData (I/O) - 列表框句柄
updateDB (I) - 指示是否保存操作
返回
1 = 成功
2 = 不是已识别的控件之一,继续处理。
-n = 由一个操作例行程序返回的失败代码
副作用
无
说明
应该通过按钮与列表框上的 $MsgSelect 事件的事件处理器调用此函数。它检查已知控件名称之一的字段名并在找到时调遣到正确的操作例行程序。请注意:调用者仍负责处理该对话中的任何其他字段上的 Select。
调用的对话框窗体
无
文件名
语法
UserActLBSelectAction( REF userLBData:UserDialogRec );
参数
userLBData (I/O) - 列表框句柄
返回
1 = 成功
0 = 失败
副作用
无
说明
当已在某列表框中选择新项时,调用此函数。
调用的对话框窗体
无
文件名
语法
UserActNewMessage( REF userName:STRING, VAL userAddr:STRING, VAL serverAccount:STRING, VAL cmdCode:INTEGER, VAL errorThreshold:INTEGER, VAL accessStatus:INTEGER );
参数
userName(I) - 用户电子邮件帐户名
userAddr(I) - 用户电子邮件地址名
cmdCode(I) - 用户命令的已分析代码号
errorThreshold(I) - 切断之前的最大连续错误
accessStatus(I) - 此用户的存储访问状态
serverAccount(I) - 服务器电子邮件帐户的名称
返回
1 = 成功
2 = 失败,记录已更新,但用户超过了最大错误数
或邮件是从服务器帐户发送来的。发送无回答。
3 = 失败,记录已更新,但用户被管理员拒绝。
4 = 失败,消息是通过邮政局长帐户收到的。发送无回答。
0 = 输入自变量集中的错误
-n = 其他类型失败
副作用
无
说明
此函数创建一个来自系统的新消息条目。如果以前未收到来自此用户的消息,则在用户活动列表中创建一个新条目。如果它不是新用户,则修改该用户的当前条目,以反映该用户的最新命令。如果一切正常,系统会返回一个 1 成功代码。如果管理员已拒绝该用户进行访问,则返回一个 3 失败代码。失败代码 2 指示失败,且不会发送回答(例如,用户已超过错误阈值或邮件来自服务器帐户)。注:此例行程序不关心列表框中的当前行。如果调用此例行程序,则服务器将运行,且用户的旧选择也失去意义。(当服务器处于“打开”状态时,选择处于“关闭”状态。)实际上,此例行程序忽略跟踪列表的当前项,因为根据需要总是将它们强制为新值。
调用的对话框窗体
无
文件名
语法
UserActSaveData;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数将与此模块有关的对话框数据保存到某一文件或数据库中。
调用的对话框窗体
无
文件名
语法
UserActSetData( REF userData:UserDataRec );
参数
userdata - 数据返回值
返回
1 = 成功
n = UserActInitData 的返回值
副作用
无
说明
此函数设置与此模块有关的对话框数据。
调用的对话框窗体
无
文件名
语法
UserActShutDown( VAL callerStatus:INTEGER );
参数
callerStatus (I) - 呼叫程序的关闭状态。如果由于内部问题呼叫程序将要关闭,此模块可能异常终止。
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数执行此模块的最终操作,以期望调用应用程序关闭。它是最终安全阀。
调用的对话框窗体
无
文件名
语法
UserActTestThisModule;
参数
无
返回
无
副作用
无
说明
无
调用的对话框窗体
无