文件名
语法
AdminCreateDialog(VAL parentWindow:WINDOW);
参数
parentWindow - 新对话框的父级的窗口句柄
返回
2 = 对话框已在窗口上
1 = 成功
0 = 失败
副作用
无
说明
此函数创建类型 Admin 的对话框。调用此函数之前,应该总是调用 InitData。
调用的对话框窗体
无
文件名
语法
AdminDBAddRow(REF adminLBData:AdminListDataRec, VAL newRow:AdminListRowRec);
参数
adminLBData - 数据记录句柄
newRow - 新行的数据
返回
1 = 成功
0 = 失败
-n = 来自数据库操作的失败代码
副作用
无
说明
此函数执行添加行数据库功能。
调用的对话框窗体
无
文件名
语法
AdminDBDeleteRow(VAL curRow:AdminListRowRec);
参数
curRow - 当前行的内容
返回
1 = 成功
0 = 失败
-n = 来自数据库操作的失败代码
副作用
无
说明
此函数执行删除行数据库功能。
调用的对话框窗体
无
文件名
语法
AdminDBLoadTable(REF adminLBData:AdminListDataRec);
参数
adminLBData - 数据记录句柄
返回
1 = 成功
0 = 失败
-n = 来自数据库操作的失败代码
副作用
无
说明
此函数装入数据库表中的数据结构列表。
调用的对话框窗体
无
文件名
语法
AdminDBUpdateRow(VAL newRow:AdminListRowRec, VAL oldRow:AdminListRowRec);
参数
newRow - 已更新行的新数据
oldRow - 已更新行的旧数据
返回
1 = 成功
0 = 失败
-n = 来自数据库操作的失败代码
副作用
无
说明
此函数执行更新行数据库功能。
调用的对话框窗体
无
文件名
语法
AdminDestroyDialog;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
如果某对话框当前可见,则此函数毁坏该对话框。
调用的对话框窗体
无
文件名
语法
AdminDlgRestoreData(REF adminData:AdminDataRec);
参数
adminData - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数从某文件或数据库恢复与此模块有关的对话框数据。
调用的对话框窗体
无
文件名
语法
AdminDlgSaveData(REF adminData:AdminDataRec);
参数
adminData - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数将与此模块有关的对话框数据保存到持久性形式(例如,数据库或文件)中。
调用的对话框窗体
无
文件名
语法
AdminEnableControls(VAL enableControls:BOOLEAN, VAL msgString:STRING);
参数
enableControls - TRUE(启用)或 FALSE(禁用)
msgString - 要写入该框中的消息行的字符串。
如果这是 $Unknown,则什么也没写。
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数启用或禁用用户控件并将字符串输出到消息行(如有的话)。
调用的对话框窗体
无
文件名
语法
AdminEventHandler(REF adminDlgData:AdminDialogRec);
参数
adminDlgData - 此对话框类型的实例数据
返回
1 = 成功
0 = 来自 DlgSetEnabled 的失败返回码
副作用
无
说明
此例行程序为“管理”对话框提供事件处理。
调用的对话框窗体
无
文件名
语法
AdminGetData(REF adminData:AdminDataRec);
参数
adminData - 数据返回值
返回
1 = 成功
n = AdminInitData 的返回值
副作用
无
说明
此函数获取与此模块有关的对话数据。
调用的对话框窗体
无
文件名
语法
AdminGetListData(REF adminListData:AdminListDataRec);
参数
adminListData - admin(与计数/当前)列表
返回
1 = 成功
0 = 未填写的列表结构或列表是空的。
副作用
无
说明
此函数从专用 AdminDataRec 检索管理员列表数据。
调用的对话框窗体
无
文件名
语法
AdminInitData;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数用静态数据记录中的信息初始化模块数据结构。
调用的对话框窗体
无
文件名
语法
AdminLBAddAction(REF adminLBData:AdminDialogRec, VAL updateDB:BOOLEAN);
参数
adminLBData - 数据记录句柄
updateDB - 指示是否保存操作
返回
1 = 成功
0 = 插入失败,因为项已经在那里了。
-1 = 键值字段是空的(未添加)
-n = 向数据库(无 GUI 更新)进行添加失败(请参见数据库代码)。
副作用
无
说明
此函数执行“添加到列表框”功能。它选取当前数据字段的内容、将新记录插入该列表框、将新匹配内部记录插入行数据结构并相应设置当前变量。
调用的对话框窗体
无
文件名
语法
AdminLBDeleteAction(REF adminLBData:AdminDialogRec, VAL updateDB:BOOLEAN);
参数
adminLBData - 数据记录句柄
updateDB - 指示是否保存操作
返回
1 = 成功
0 = 列表是空的
-1 = DB/GUI 操作之后更新内部选择失败
-n = 从数据库(无 GUI 更新)删除失败。(请参见 DB 代码。)
副作用
无
说明
此函数删除列表中的当前所选项。
调用的对话框窗体
无
文件名
语法
AdminLBEnter2ndaryFieldAction(REF adminLBData:AdminDialogRec, VAL fieldname:STRING);
参数
adminLBData - 数据记录句柄
fieldname - 已选择的字段名
返回
1 = 成功
2 = 列表是空的
0 = 来自 DlgSetEnabled 的失败返回码
-n = 来自 DlgSetEnabled 的失败返回码
副作用
无
说明
此函数启用“修改”按钮在 GUI 中的非键值字段中进行输入。
调用的对话框窗体
无
文件名
语法
AdminLBEnterKeyFieldAction(REF adminLBData:AdminDialogRec, VAL fieldname:STRING);
参数
adminLBData - 数据记录句柄
fieldname - 已选择的字段名
返回
1 = 成功
0 = 来自 DlgSetEnabled 的失败返回码
-n = 来自 DlgSetEnabled 的失败返回码
副作用
无
说明
此函数对光标移动到 GUI 中的主键值字段作出响应。
调用的对话框窗体
无
文件名
语法
AdminLBModifyAction(REF adminLBData:AdminDialogRec, VAL updateDB:BOOLEAN);
参数
adminLBData - 数据记录句柄
updateDB - 指示是否保存操作
返回
1 = 成功
0 = 列表是空的、没有进行选择、没有字段被修改过或用户已拒绝修改
-1 = 失败,试图为键值提供空(零)值。
-n = 更新数据库行(没有 GUI 更新)失败(请参见数据库代码)。
副作用
无
说明
此函数修改列表中的当前所选项。它假定相应列表(GUI 列表框、KML 列表 与 DB 列表)已位于当前项处。
调用的对话框窗体
无
文件名
语法
AdminLBMsgSelectHandler(REF adminLBData:AdminDialogRec, VAL fieldname:STRING, VAL updateDB:BOOLEAN);
参数
adminLBData - 数据记录句柄
fieldname - 已选择的字段名
updateDB - 指示是否保存操作
返回
1 = 成功
2 = 不是已识别的控件之一,继续处理。
-n = 由一个操作例行程序返回的失败代码
副作用
无
说明
应该通过按钮与列表框上的 $MsgSelect 事件的事件处理器调用此函数。
调用的对话框窗体
无
文件名
语法
AdminLBSelectAction(REF adminLBData:AdminDialogRec);
参数
adminLBData - 数据记录句柄
返回
1 = 成功
0 = 失败
副作用
无
说明
当已在某列表框中选择新项时调用此函数。
调用的对话框窗体
无
文件名
语法
AdminSaveData;
参数
无
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数将与此模块有关的对话框数据保存到某文件或数据库。
调用的对话框窗体
无
文件名
语法
AdminSetData(REF adminData:AdminDataRec);
参数
adminData - 数据返回值
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数设置与此模块有关的对话框数据。
调用的对话框窗体
无
文件名
语法
AdminShutDown(VAL callerStatus:INTEGER);
参数
callerStatus - 调用程序的关闭状态。
(如果由于内部问题调用程序将要关闭,此模块将异常终止。)
返回
1 = 成功
0 = 失败
副作用
无
说明
此函数执行此模块的最终操作,以期望调用应用程序关闭。
调用的对话框窗体
无
文件名
语法
ModuleTestEventHandler( REF moduleTestData: ModuleTestRec );
参数
ModuleTestData - 此对话框类型的实例数据
返回
1 = 成功
0 = 失败
副作用
无
说明
此例行程序为“模块测试”对话框提供事件处理。
调用的对话框窗体
无
文件名
语法
RefreshListBoxFromData(REF adminLBData:AdminDialogRec);
参数
adminLBData - 数据记录句柄
返回
1 = 成功
0 = 失败
-n = 来自数据库操作的失败代码
副作用
无
说明
此函数将存储在数据结构行中的信息转移到列表框中。在插入之前该框已经清空。
调用的对话框窗体
无
文件名
语法
TransferRowToGUIFields(REF adminLBData:AdminDialogRec);
参数
adminLBData - 数据记录句柄
返回
1 = 成功
0 = 失败
-n = 来自数据库操作的失败代码
副作用
无
说明
此函数将存储在当前行中的信息转移到各种匹配 GUI 字段中。如果没有当前行,该函数会清除这些字段。
调用的对话框窗体
无