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 v6.11 - ax_i_tagname() http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 AX_I_TagName()
 Returns name of current tag being indexed or reindexed
------------------------------------------------------------------------------

 Syntax

     AX_I_TagName() -> charstring

 Returns

     Returns the name of the current tag being indexed or reindexed.  If no
     index or reindex is being done, it returns an empty string ("").

 Description

     AX_TagName() identifies the tag name currently being indexed or
     reindexed.  When a .cdx index is created or reindexed, each tag in the
     .cdx index is sorted.

     This function is most helpful in a UDF specified with the EVAL clause
     of INDEX or REINDEX.  The current tag in use can be displayed to show
     progress toward index build completion.

     If the current index file is an .ntx or .idx (single index file), then
     the index file name is returned without a file extension.

 Example

     USE test VIA "DBFCDXAX"       // Open TEST.DBF and TEST.CDX
                                   // Assume tags are LASTNAME, FIRSTNAME
                                   // and STATE
     REINDEX EVAL ShowIt() EVERY 10


     FUNC ShowIt()
        // Display the appropriate message
        ? IF( AX_IsReindex(), "Reindexing ", "Indexing " )

        // Display the index file and tag name.
        // Displays "TEST.CDX : LASTNAME"
        ? AX_I_IndexName() + " : " + AX_I_TagName()

        // Show how many keys have been included.
        @ ROW(), 1 SAY AX_KeysIncluded()

     RETURN .T.


See Also: AX_I_IndexName() AX_IsReindex() AX_TagName()

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