Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- Advantage CA-Clipper Guide v5.5 - ax_indexfilter() http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 AX_IndexFilter()
 Return FOR clause expression of a conditional index
------------------------------------------------------------------------------

 Syntax

     AX_IndexFilter( [<nFileOrder>] ) -> charstring

     <nFileOrder> An optional numeric value specifying the index file
     order position of the desired index.  The index file order position
     is based on the order in which the indexes are opened.

 Returns

     Returns the FOR clause expression of the current or specified index.
     If the index does not have a FOR clause or no index exists, it
     returns an empty string ("").

 Description

     This function returns the FOR clause expression of the active tag in
     the current or specified index.  This is helpful to display what the
     FOR clause is for the specified index order.  If the index order is not
     specified, the active index FOR clause is returned.

 Example

     USE test VIA "DBFCDXAX"       // Open TEST.DBF

     // Create conditional index
     INDEX ON last TO last FOR test->state == "CA"
     CLOSE ALL                     // Close table and index

     // Reopen table and index
     USE test INDEX last VIA "DBFCDXAX"

     // Display FOR clause built into last.idx
     ? AX_IndexFilter()            // Displays: STATE=="CA"


See Also: AX_TagInfo()

Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson