点击或拖拽改变大小

Functions.VoDbOrdListClear 方法

X#
从工作区的排序列表中移除排序并关闭相关的索引文件。
从工作区的订单列表中删除订单并关闭相关的索引文件。

命名空间:  XSharp.RT
程序集:  XSharp.RT (在 XSharp.RT.dll 中) 版本:2.22 GA
语法
 FUNCTION VoDbOrdListClear(
	cIndexFile AS STRING,
	uOrder AS USUAL
) AS LOGIC
查看代码

参数

cIndexFile
类型:String
索引文件的名称,可包含可选的驱动器和目录(不应指定扩展名)。
当不同索引文件中存在两个或多个同名排序时,可与 uOrder 参数一起使用以消除歧义。
单独使用时,仅关闭与指定文件相关的排序。
如果当前进程未打开 cIndexFile,将引发运行时错误。
uOrder
类型:__Usual
要清除的排序名称或其在排序列表中的位置编号。
推荐使用排序名称,因为在使用多重排序索引文件时,确定位置可能比较困难。
如果未指定,将清除指定索引文件中的所有排序(如果未指定索引文件,则清除整个工作区)。
无效值将被忽略。

返回值

类型:Boolean
如果成功则返回 TRUE;否则返回 FALSE。

返回值

类型:Boolean
备注
在关闭索引文件之前,所有待处理的更新都将写入磁盘。
一旦文件关闭且排序列表清除,数据库文件将恢复到其自然顺序。 默认情况下,此函数在当前选定的工作区上操作。
可以通过在别名表达式中指定来使其在未选定的工作区上操作。
备注
VODBOrdListClear() 与 DBClearIndex() 相同,只是它是强类型的,并且参数顺序相反。
但是,此函数不调用错误处理程序,因此如果失败,不会产生运行时错误消息或创建错误对象。因此,检查返回值以确定函数是否成功可能很重要。
全局结构 StrucErrInfo 将包含有关发生的任何错误的必要信息。
示例
以下示例在有打开的索引文件时关闭它们:
X#
 1DBUseArea(TRUE, "DBFNTX", "sales", "Sales", ;
 2            TRUE)
 3Sales->DBSetIndex("FirstName")
 4Sales->DBSetIndex("LastName")
 5// 是否有打开的索引文件?
 6IF Sales->DBOrderInfo(DBOI_NUMBER) > 0
 7    Sales->DBClearIndex()        // 关闭索引文件
 8ENDIF
 9// 以自然顺序复制到 SDF
10COPY TO temp SDF
示例