Click or drag to resize

DbOrder_Info Enumeration

X#
This enum specifies the various values that the OrderInfo method for the IRDD interface accepts.

Namespace:  XSharp.RDD.Enums
Assembly:  XSharp.Core (in XSharp.Core.dll) Version: 2.21
Syntax
 enum DbOrder_Info
Members
  Member nameValueDescription
DBOI_CONDITION1String: The order's conditional expression
DBOI_EXPRESSION2String: The order's key expression
DBOI_POSITION3Number: The current key position in scope and filter
DBOI_KEYGOTO3Alias for DBOI_POSITION
DBOI_KEYNO3Alias for DBOI_POSITION
DBOI_RECNO4Number: The current key position disregarding filters
DBOI_NAME5String: The name of the order
DBOI_NUMBER6Number: The numeric position in the list of orders
DBOI_BAGNAME7String: The name of the file containing this order
DBOI_INDEXNAME7Alias for DBOI_BAGNAME
DBOI_BAGEXT8String: The extension of the file containing this order
DBOI_INDEXEXT8Alias for DBOI_BAGEXT
DBOI_DEFBAGEXT9String: The defauly index extension
DBOI_COLLATION10FoxPro CDX Index collation
DBOI_FULLPATH20String: The full path to the index file (Bag)
DBOI_FILEHANDLE21IntPtr: The handle of the index
DBOI_ISDESC22Logic : Is the order DESCENDing?
DBOI_ISCOND23Logic : Does the order have a FOR condition?
DBOI_KEYTYPE24The type of the order's key (usualType value)
DBOI_KEYSIZE25Number: The length of the order's key
DBOI_KEYCOUNT26Number: The count of keys in scope and filter
DBOI_SETCODEBLOCK27Block : The codeblock that produces the key
DBOI_KEYDEC28Number: The # of decimals in a numeric key
DBOI_HPLOCKING29Logic : Using High Performance locking for this order?
DBOI_LOCKOFFSET35Number: The offset used for logical locking
DBOI_KEYADD36Logic: Custom Index: Add key
DBOI_KEYDELETE37Logic: Custom Index: Delete key
DBOI_KEYVAL38Object: The value of the current key
DBOI_SCOPETOP39Object: Get or Set the scope top
DBOI_SCOPEBOTTOM40Object: Get or Set the scope bottom
DBOI_SCOPETOPCLEAR41Void: Clear top scope
DBOI_SCOPEBOTTOMCLEAR42Void: Clear Bottom scope
DBOI_UNIQUE43Logic : Does the order have the UNIQUE attribute?
DBOI_ORDERCOUNT44Number: The count of ORDERS contained in an index file or in total
DBOI_CUSTOM45Logic: Is this a Custom Index?
DBOI_SKIPUNIQUE46Logic: Was a skip to adjacent unique Key successful?
DBOI_KEYSINCLUDED48Number: Number of keys in the index order
DBOI_KEYNORAW49Number: The key number disregarding filters
DBOI_OPTLEVEL50Number: Optimization level for current query
DBOI_KEYCOUNTRAW51Number: The key count disregarding filter
DBOI_FILESTREAM52FileStream: The stream object of the index
DBOI_STRICTREAD60The following numbers are reserved but not implemented yet.
DBOI_OPTIMIZE61
DBOI_AUTOOPEN62
DBOI_AUTOORDER63
DBOI_AUTOSHARE64
DBOI_LOCK_ALL100
DBOI_LOCK_FAIL101
DBOI_HPLOCK_GATE102
DBOI_SKIPEVAL200
DBOI_SKIPEVALBACK201
DBOI_SKIPREGEX202
DBOI_SKIPREGEXBACK203
DBOI_SKIPWILD204
DBOI_SKIPWILDBACK205
DBOI_SCOPEEVAL206
DBOI_FINDREC207
DBOI_FINDRECCONT208
DBOI_SCOPESET209
DBOI_SCOPECLEAR210
DBOI_BAGCOUNT211
DBOI_BAGNUMBER212
DBOI_BAGORDER213
DBOI_ISMULTITAG214
DBOI_ISSORTRECNO215
DBOI_LARGEFILE216
DBOI_TEMPLATE217
DBOI_MULTIKEY218
DBOI_CHGONLY219
DBOI_PARTIAL220
DBOI_SHARED221
DBOI_ISREADONLY222
DBOI_READLOCK223
DBOI_WRITELOCK224
DBOI_UPDATECOUNTER225
DBOI_EVALSTEP226
DBOI_ISREINDEX227
DBOI_I_BAGNAME228
DBOI_I_TAGNAME229
DBOI_RELKEYPOS230
DBOI_USECURRENT231
DBOI_INDEXTYPE232
DBOI_RESETPOS233
DBOI_INDEXPAGESIZE234
DBOI_DUMP300Dump the current order to a text file in the folder of the index.
DBOI_VALIDATE301Logic: Validate the current order. Errors are written to a text file in the folder of the index. Only supported by DBFCDX
DBOI_USER1000
DBOI_AXS_PERCENT_INDEXED1805
DBOI_GET_ACE_INDEX_HANDLE1806
Remarks
The types in the list of possible value are the types of the return value when you call DbOrderInfo() with this enum value.
Tip Tip
These enums are also available as DEFINES and can therefore also be used without the "DbOrderInfo." prefix.
See Also