Click or drag to resize

VoDbOrderInfo Function <UInt32, String, USUAL, USUAL>

Return information about index files and the orders in them.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.0
Syntax
 FUNCTION VoDbOrderInfo(
	nOrdinal AS DWORD,
	cBagName AS STRING,
	uOrder AS USUAL,
	uRet REF USUAL
) AS LOGIC

Parameters

nOrdinal
Type: UInt32
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 (no extension should be specified).
uOrder
Type: USUAL
The name of the order about which you want to obtain information or a number representing its position in the order list.
uRet
Type: USUAL

Return Value

Type: Boolean
TRUE 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 Tip
The difference between VoDbOrderInfo and CoreDb.OrderInfo is that VoDbOrderInfo takes USUAL parameters
See Also