Click or drag to resize

OrdDestroy Function

Remove an order from an open index file.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.7
 FUNCTION OrdDestroy(
	uOrder AS USUAL := NIL,
	cIndexFile AS USUAL := NIL
Request Example View Source


uOrder (Optional)
Type: Usual
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.
cIndexFile (Optional)
Type: Usual
The name of an index file, including an optional drive and directory (no extension should be specified).
Use this argument with <cOrder> to remove ambiguity when there are two or more orders with the same name in different index files.
If <cIndexFile> is not open by the current process, a runtime error is raised.
The default is NULL_STRING.

Return Value

Type: Boolean
This function is identical to DBDeleteOrder(), which you can refer to for more information.