Functions.OrdCondSet 方法 | |
设置顺序的条件和范围。
命名空间:
XSharp.RT
程序集:
XSharp.RT (在 XSharp.RT.dll 中) 版本:2.22 GA
语法 FUNCTION OrdCondSet(
cForCondition,
cbForCondition,
lAll,
cbWhileCondition,
cbEval,
nInterval,
nStart,
nNext,
nRecord,
lRest,
lDescend,
lAdditive,
lCurrent,
lCustom,
lNoOptimize,
lBinary,
cCollation,
lCandidate,
lCompact
) AS LOGIC CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public static bool OrdCondSet(
__Usual cForCondition = default,
__Usual cbForCondition = default,
__Usual lAll = default,
__Usual cbWhileCondition = default,
__Usual cbEval = default,
__Usual nInterval = default,
__Usual nStart = default,
__Usual nNext = default,
__Usual nRecord = default,
__Usual lRest = default,
__Usual lDescend = default,
__Usual lAdditive = default,
__Usual lCurrent = default,
__Usual lCustom = default,
__Usual lNoOptimize = default,
__Usual lBinary = default,
__Usual cCollation = default,
__Usual lCandidate = default,
__Usual lCompact = default
)
查看代码参数
- cForCondition (Optional)
- 类型:__Usual
指定顺序的 for 条件的字符串。
此字符串由 DBOrderInfo(DBOI_CONDITION, [cIndexFile], cOrder) 返回。
如果您不需要此信息,可以指定 NULL_STRING。
- cbForCondition (Optional)
- 类型:__Usual
定义范围内每条记录必须满足的条件的代码块。
这个条件(而不是 cForCondition)是实际用于创建顺序的条件。
与 while 条件和其他范围信息不同,for 条件作为索引文件的一部分存储,并在使用 DBReindex() 更新或重建顺序时使用。
对于 for 条件的任何限制由 RDD 决定。
定义范围内每条记录必须满足的条件的代码块,以便进行处理。 - lAll (Optional)
- 类型:__Usual
TRUE 的值指定所有记录的范围。
如果您希望指示其他记录范围条件(即 nNext、nRecord 或 lRest),请使用 FALSE。
默认值为 FALSE。
- cbWhileCondition (Optional)
- 类型:__Usual
定义每条记录必须满足的另一个条件的代码块。
一旦遇到导致条件失败的记录,操作就会终止。
如果未指定范围,cbWhileCondition 将默认范围更改为 lRest。
您可以使用这三个互斥参数之一来定义范围。
默认为所有记录。
定义每条记录必须满足的另一个条件的代码块,以便进行处理。 一旦遇到导致条件失败的记录,操作就会终止。
如果未指定范围,cbWhileCondition 会将默认范围更改为 lRest。
您可以使用这三个互斥参数之一来定义范围。
默认是所有记录。
- cbEval (Optional)
- 类型:__Usual
在 nInterval 指定的间隔内评估的代码块。
这在生成监控排序进度的状态栏或里程表时非常有用。
cbEval 的返回值必须是逻辑值。
如果 cbEval 返回 FALSE,则索引将停止。
默认值为 NIL。
- nInterval (Optional)
- 类型:__Usual
确定评估 cbEval 的次数的数值表达式。
此参数通过在间隔内评估条件而不是对处理的每条记录进行评估,提供了性能提升。
要遍历每条记录,可以指定 0 的值。
默认值为 0。
- nStart (Optional)
- 类型:__Usual
起始记录编号。
要从文件开头开始,请指定 0 的值。
默认值为 0。
您通过这三个互斥参数之一定义范围(对其他参数使用 0 或 FALSE)。
默认值为所有记录。记录范围信息仅用于创建顺序。
它不会存储在索引文件中,也不用于索引更新和重建目的。
- nNext (Optional)
- 类型:__Usual
要处理的记录数,从 nRecord 开始。 指定 0 以忽略此参数。 - nRecord (Optional)
- 类型:__Usual
要处理的单个记录号。指定 0 以忽略此参数。 - lRest (Optional)
- 类型:__Usual
TRUE 仅处理从 nStart 到文件末尾的记录。 FALSE 处理所有记录。 - lDescend (Optional)
- 类型:__Usual
指定键对是否按值的降序或升序排序。 TRUE 结果为降序。 FALSE 结果为升序。
默认值为 FALSE。
- lAdditive (Optional)
- 类型:__Usual
指定在创建新顺序时打开的顺序是否应保持打开。 TRUE 指定它们应保持打开。 FALSE 指定所有打开的顺序应关闭。
默认值为 FALSE。
- lCurrent (Optional)
- 类型:__Usual
指定仅控制顺序中的记录 — 并在当前范围内(由 OrdSetScope() 指定) — 将包含在此顺序中。 TRUE 指定应使用控制顺序和范围来限制新创建顺序的范围。 FALSE 指定数据库文件中的所有记录均包含在顺序中。
默认值为 FALSE。
- lCustom (Optional)
- 类型:__Usual
指定新顺序是否将是一个自定义构建的顺序(对于支持此功能的 RDD)。 TRUE 指定将创建自定义构建的顺序。
自定义构建的顺序最初为空,使您完全控制顺序维护。
系统不会自动添加和删除自定义构建顺序中的键。相反,您使用 OrdKeyAdd() 和 OrdKeyDel() 显式添加和删除键。 FALSE 指定标准的、系统维护的顺序。
默认值为 FALSE。
- lNoOptimize (Optional)
- 类型:__Usual
指定是否优化 FOR 条件(对于支持此功能的 RDD)。 TRUE 优化 FOR 条件,FALSE 不优化。
默认值为 FALSE。
- lBinary (Optional)
- 类型:__Usual
- cCollation (Optional)
- 类型:__Usual
- lCandidate (Optional)
- 类型:__Usual
- lCompact (Optional)
- 类型:__Usual
返回值
类型:
Boolean备注
此函数与 DBSetOrderCondition() 相同,您可以参考它以获取更多信息。
示例 参见 引用
DbSetOrderCondition(__Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual, __Usual)