ordDestroy()

Remove an Order from an Order Bag

Syntax

      ORDDESTROY(<cOrderName> [, <cOrderBagName> ])

Arguments

<cOrderName> Name of the order to remove

<cOrderBagName> Name of the order bag from which order id to be removed

Description

This function attempts to remove the order named <cOrderName> from the file containing the order bag name <cOrderBagName>. If <cOrderBagName> is not specified, then the name of the file will be based on the value of the ORDNAME() function. If the extension is not included with the name of the order file, then the extension will be obtained from the default extension of the current and active RDD.

The DBFNTX driver do not support multiple order bags; therefore, there cannot be an order to “destroy” from a bag. This function only works for those drivers with support multiple orders bags (e.q. DBFCDX and RDDADS drivers).

Examples

      USE tests VIA "DBFCDX" NEW
      OrdDestroy( "lName", "tests" )

Tests

      See examples

Compliance

Clipper

Platforms

All

Files

Library is rdd

Seealso

ORDCREATE()