点击或拖拽改变大小

Functions.VoDbOrderInfo 方法 (UInt32, String, __Usual, __Usual)

X#
返回有关索引文件及其中的订单的信息。

命名空间：  XSharp.RT
程序集：  XSharp.RT (在 XSharp.RT.dll 中) 版本：2.22 GA
语法
复制
 FUNCTION VoDbOrderInfo(
	kInfoType AS DWORD,
	cIndexFile AS STRING,
	uOrder AS USUAL,
	ptrRetVal REF USUAL
) AS LOGIC
查看代码

参数

kInfoType
类型：UInt32
确定检索的信息类型。这应该是备注部分中列出的 DBOI_ 常量之一
cIndexFile
类型：String
打开的索引文件的名称（只需要八个字母的文件名）。
与 cOrder 一起使用此参数，以消除不同索引文件中存在两个或多个同名订单时的歧义。
要省略此参数，请指定 NULL_STRING。
uOrder
类型：__Usual
您想获取其信息的订单名称，或表示其在订单列表中位置的数字。
要省略 cOrder | nPosition 参数，请指定 NIL。
ptrRetVal
类型：__Usual
指向多态值的指针。
如果函数成功，此值将接收请求的信息，否则保持不变。
如果您只想检索信息，在调用函数之前此值必须为 NIL。
目前任何提供的 RDD 都不支持使用非 NIL 值。
此功能保留给允许更改信息而不仅仅是检索信息的 RDD。

返回值

类型：Boolean
如果成功则为 TRUE；否则为 FALSE。
备注
VODBOrderInfo() 类似于 DBOrderInfo()。
但是，此函数不调用错误处理程序，因此如果失败，不会产生运行时错误消息或创建错误对象。因此，检查返回值以确定函数是否成功可能很重要。
全局结构 StrucErrInfo 将包含有关发生的任何错误的必要信息。有关更多信息，请参见 DBOrderInfo()。
Constant描述
DBOI_CONDITION返回指定顺序的条件作为字符串。
DBOI_CUSTOM 返回并可选地设置指定顺序是否为自定义构建（对于支持自定义构建顺序的 RDD）。请注意， 虽然您可以通过在 uNewSetting 参数中指定 TRUE 来为标准顺序打开自定义构建标志， 但您不能将自定义构建顺序转换为标准顺序。 指定 FALSE 为 uNewSetting 的值与不指定参数一样—在更改参数之前返回当前设置。
DBOI_EXPRESSION返回指定顺序的键表达式作为字符串。
DBOI_FILEHANDLE返回指定索引文件的句柄作为 IntPtr。
DBOI_FILESTREAM返回指定索引文件的文件流。
DBOI_FULLPATH返回指定索引文件的完整路径作为字符串。
DBOI_HPLOCKING返回一个逻辑标志，指示指定索引文件是否使用高性能索引锁定模式（参见 IndexHPLock() 函数）。
DBOI_INDEXEXT返回默认的索引文件扩展名作为字符串。
DBOI_INDEXNAME返回指定索引文件的名称作为字符串。
DBOI_ISCOND返回一个逻辑标志，确定指定顺序是否使用 for 条件定义。
DBOI_ISDESC 返回一个逻辑标志，确定指定顺序是否为降序。对于支持在运行时动态设置降序标志的驱动程序，可以使用逻辑值指定新值，使用 DBServer:OrderInfo(DBOI_ISDESC, [<oFSIndexFile> | <cIndexFile>], [<cOrder> | <nPosition>], <lNewSetting>)。在更改参数之前返回当前设置。
DBOI_KEYCOUNT返回指定顺序的键数。
DBOI_KEYDEC返回指定顺序的键中的小数位数。
DBOI_KEYSINCLUDED返回指定顺序中包含的键的数量。这主要用于条件顺序。它可以在状态显示过程中使用（使用 INDEX 命令的 EVAL 子句）。
DBOI_KEYSIZE返回指定顺序的键的大小作为数字。
DBOI_KEYTYPE返回指定顺序的键的数据类型作为字符串。
DBOI_KEYVAL返回指定顺序中当前记录的键值。
DBOI_LOCKOFFSET返回指定索引文件的锁定偏移量（参见 NewIndexLock() 函数）作为数值。
DBOI_NAME返回指定顺序的名称作为字符串。
DBOI_NUMBER返回指定顺序在顺序列表中的数值位置。
DBOI_ORDERCOUNT返回指定索引文件中定义的顺序数。
DBOI_POSITION返回指定顺序中当前记录的逻辑记录号。
DBOI_RECNO返回指定顺序中当前记录的物理记录号。
DBOI_SCOPEBOTTOMs返回指定顺序的作用域的底部边界。
DBOI_SCOPETOP返回指定顺序的作用域的顶部边界。
DBOI_SETCODEBLOCK返回指定顺序的键作为代码块。
DBOI_UNIQUE返回一个逻辑标志，指示指定顺序是否具有唯一属性。
DBOI_USER用于自定义的开始。
提示 提示：
DBOI_USER 是一个常量，返回第三方 RDD 开发人员可以用于自定义的最小值。 小于 DBOI_USER 的值保留给 X# 开发。
示例
以下示例返回订单访问信息：
X#
复制
 1FUNCTION ShowOrderInfo() AS VOID
 2    LOCAL uResult AS USUAL
 3    uResult := NIL
 4    IF VODBOrderInfo(DBOI_EXPRESSION,"",0,@uResult)
 5        ? "IndexKey(): ", uResult
 6    ELSE
 7        DoError()
 8    ENDIF
 9    // 指定位置的记录号：
10    uResult := 100
11    IF VODBOrderInfo(DBOI_RECNO,"",0,@uResult)
12        ? "位置 100 的记录号：", uResult
13    ELSE
14        DoError()
15    ENDIF
16    IF VODBOrderInfo(DBOI_FULLPATH,"",0,@uResult)
17        ? "索引文件的完整路径：", uResult
18    ELSE
19        DoError()
20    ENDIF
21    RETURN
22STATIC FUNCTION DoError() AS USUAL
23    LOCAL uRetCode<br />
24AS USUAL
25    LOCAL oError  <br />
26AS USUAL
27    oError := ErrorBuild(@strucErrInfo)
28    oError:FuncSym := #VODBOrderInfo
29    RETURN EVAL(ErrorBlock(), oError)
参见