DbOrder_Info Enumeration | |
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 Members
| Member name | Value | Description |
---|
| DBOI_CONDITION | 1 | String: The order's conditional expression |
| DBOI_EXPRESSION | 2 | String: The order's key expression |
| DBOI_POSITION | 3 | Number: The current key position in scope and filter |
| DBOI_KEYGOTO | 3 | Alias for DBOI_POSITION |
| DBOI_KEYNO | 3 | Alias for DBOI_POSITION |
| DBOI_RECNO | 4 | Number: The current key position disregarding filters |
| DBOI_NAME | 5 | String: The name of the order |
| DBOI_NUMBER | 6 | Number: The numeric position in the list of orders |
| DBOI_BAGNAME | 7 | String: The name of the file containing this order |
| DBOI_INDEXNAME | 7 | Alias for DBOI_BAGNAME |
| DBOI_BAGEXT | 8 | String: The extension of the file containing this order |
| DBOI_INDEXEXT | 8 | Alias for DBOI_BAGEXT |
| DBOI_DEFBAGEXT | 9 | String: The defauly index extension |
| DBOI_COLLATION | 10 | FoxPro CDX Index collation |
| DBOI_FULLPATH | 20 | String: The full path to the index file (Bag) |
| DBOI_FILEHANDLE | 21 | IntPtr: The handle of the index |
| DBOI_ISDESC | 22 | Logic : Is the order DESCENDing? |
| DBOI_ISCOND | 23 | Logic : Does the order have a FOR condition? |
| DBOI_KEYTYPE | 24 | The type of the order's key (usualType value) |
| DBOI_KEYSIZE | 25 | Number: The length of the order's key |
| DBOI_KEYCOUNT | 26 | Number: The count of keys in scope and filter |
| DBOI_SETCODEBLOCK | 27 | Block : The codeblock that produces the key |
| DBOI_KEYDEC | 28 | Number: The # of decimals in a numeric key |
| DBOI_HPLOCKING | 29 | Logic : Using High Performance locking for this order? |
| DBOI_LOCKOFFSET | 35 | Number: The offset used for logical locking |
| DBOI_KEYADD | 36 | Logic: Custom Index: Add key |
| DBOI_KEYDELETE | 37 | Logic: Custom Index: Delete key |
| DBOI_KEYVAL | 38 | Object: The value of the current key |
| DBOI_SCOPETOP | 39 | Object: Get or Set the scope top |
| DBOI_SCOPEBOTTOM | 40 | Object: Get or Set the scope bottom |
| DBOI_SCOPETOPCLEAR | 41 | Void: Clear top scope |
| DBOI_SCOPEBOTTOMCLEAR | 42 | Void: Clear Bottom scope |
| DBOI_UNIQUE | 43 | Logic : Does the order have the UNIQUE attribute? |
| DBOI_ORDERCOUNT | 44 | Number: The count of ORDERS contained in an index file or in total |
| DBOI_CUSTOM | 45 | Logic: Is this a Custom Index? |
| DBOI_SKIPUNIQUE | 46 | Logic: Was a skip to adjacent unique Key successful? |
| DBOI_KEYSINCLUDED | 48 | Number: Number of keys in the index order |
| DBOI_KEYNORAW | 49 | Number: The key number disregarding filters |
| DBOI_OPTLEVEL | 50 | Number: Optimization level for current query |
| DBOI_KEYCOUNTRAW | 51 | Number: The key count disregarding filter |
| DBOI_FILESTREAM | 52 | FileStream: The stream object of the index |
| DBOI_STRICTREAD | 60 | The following numbers are reserved but not implemented yet. |
| DBOI_OPTIMIZE | 61 | |
| DBOI_AUTOOPEN | 62 | |
| DBOI_AUTOORDER | 63 | |
| DBOI_AUTOSHARE | 64 | |
| DBOI_LOCK_ALL | 100 | |
| DBOI_LOCK_FAIL | 101 | |
| DBOI_HPLOCK_GATE | 102 | |
| DBOI_SKIPEVAL | 200 | |
| DBOI_SKIPEVALBACK | 201 | |
| DBOI_SKIPREGEX | 202 | |
| DBOI_SKIPREGEXBACK | 203 | |
| DBOI_SKIPWILD | 204 | |
| DBOI_SKIPWILDBACK | 205 | |
| DBOI_SCOPEEVAL | 206 | |
| DBOI_FINDREC | 207 | |
| DBOI_FINDRECCONT | 208 | |
| DBOI_SCOPESET | 209 | |
| DBOI_SCOPECLEAR | 210 | |
| DBOI_BAGCOUNT | 211 | |
| DBOI_BAGNUMBER | 212 | |
| DBOI_BAGORDER | 213 | |
| DBOI_ISMULTITAG | 214 | |
| DBOI_ISSORTRECNO | 215 | |
| DBOI_LARGEFILE | 216 | |
| DBOI_TEMPLATE | 217 | |
| DBOI_MULTIKEY | 218 | |
| DBOI_CHGONLY | 219 | |
| DBOI_PARTIAL | 220 | |
| DBOI_SHARED | 221 | |
| DBOI_ISREADONLY | 222 | |
| DBOI_READLOCK | 223 | |
| DBOI_WRITELOCK | 224 | |
| DBOI_UPDATECOUNTER | 225 | |
| DBOI_EVALSTEP | 226 | |
| DBOI_ISREINDEX | 227 | |
| DBOI_I_BAGNAME | 228 | |
| DBOI_I_TAGNAME | 229 | |
| DBOI_RELKEYPOS | 230 | |
| DBOI_USECURRENT | 231 | |
| DBOI_INDEXTYPE | 232 | |
| DBOI_RESETPOS | 233 | |
| DBOI_INDEXPAGESIZE | 234 | |
| DBOI_DUMP | 300 | Dump the current order to a text file in the folder of the index. |
| DBOI_VALIDATE | 301 | Logic: Validate the current order. Errors are written to a text file in the folder of the index. Only supported by DBFCDX |
| DBOI_USER | 1000 | |
| DBOI_AXS_PERCENT_INDEXED | 1805 | |
| DBOI_GET_ACE_INDEX_HANDLE | 1806 | |
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 |
---|
These enums are also available as DEFINES and can therefore also be used without the "DbOrderInfo." prefix.
|
See Also