Click or drag to resize

CoreDb.OrdListClear Method

Remove orders from the order list in a work area and close associated index files.

Namespace:  XSharp
Assembly:  XSharp.Core (in XSharp.Core.dll) Version: 2.5
Syntax
 STATIC METHOD OrdListClear(
	cBagName AS STRING,
	oOrder AS Object
) AS LOGIC
View Source

Parameters

cBagName
Type: String
The name of an index file, including an optional drive and directory.  Use this argument with <cOrder> to remove ambiguity when there are two or more orders with the same name in different index files.
oOrder
Type: Object
The name of the order or a number representing its position in the order list.  Using the order name is the preferred method since the position may be difficult to determine using multiple-order index files.  Invalid values are ignored.

Return Value

Type: Boolean
TRUE if successful; otherwise, FALSE.
Remarks
This function is like DBClearIndex() 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.
See Also