VoDb.OrderInfo Method (DWord, String, Object, Usual) | |
Return information about index files and the orders in them.
Namespace:
XSharp
Assembly:
XSharp.RT (in XSharp.RT.dll) Version: 2.19
Syntax STATIC METHOD OrderInfo(
nOrdinal AS DWORD,
cBagName AS STRING,
uOrder AS Object,
oValue AS USUAL
) AS LOGIC
public static bool OrderInfo(
uint nOrdinal,
string cBagName,
Object uOrder,
Usual oValue
)
Request Example
View SourceParameters
- nOrdinal
- Type: DWord
Specifies the type of information. This must match the values in the DBOI_ defines - cBagName
- Type: String
The name of an index file, including an optional drive and directory. - uOrder
- Type: Object
- oValue
- Type: Usual
If specified, this parameter is used to change the value of a setting.
Return Value
Type:
LogicTRUE if successful; otherwise, FALSE.
Remarks
This function is like DbOrderInfo() but strongly typed.
This function, however, does not call the error
handler and will therefore not produce a runtime error message or create an error object if it fails.
Therefore it is important to check the return value to determine if the function succeeded.
The LastRddError property in the runtimestate
will contain needed information about any error that occurs.
Tip |
---|
The difference between VoDb.OrderInfo and CoreDb.OrderInfo is that VoDb.Info takes a USUAL parameter |
See Also