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_settag() http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 AX_SetTag()
 Set a tag active by name
------------------------------------------------------------------------------

 Syntax

     AX_SetTag( [<cTagName> [,<nFileOrder>|<cCDXName>]] ) -> logical

     <cTagName> An optional character string of the tag to which the
     index order is set.  If a .cdx file is not specified, the open .cdx
     indexes are searched for the tag in the order they were opened.  Once
     the tag is found, the order is set to the .cdx file, and control is
     given to the specified tag.  If the tag name is not specified, the
     order is set to zero (0).

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

     <cCDXName>  A character string specifying which .cdx file contains
     the specified tag.  This is used to eliminate conflicts between two
     .cdx files with duplicate tag names.  Order is set to the specified
     .cdx and the specified tag is given control.

 Returns

     Returns a logical .T. if the operation was successful, else returns .F.
     If an error occurred, AX_Error() will return information on why the
     function failed.

 Description

     AX_SetTag() activates the specified tag of the currently active or
     specified .cdx index.  If <cCDXName> or <nOrder> is specified, then
     only that index file is searched for the specified tag name.
     Otherwise, the structural .cdx is searched, followed by the active
     .cdx files in the order opened.

     Once the specified tag is found, the order is set to the .cdx file,
     and control is given to the specified tag.

     If <cTagName> is "", the index order is set to 0 (record number order).

     If <nOrder> is 0, the index order remains unchanged.  If only
     <nTagName> is specified, and there is no active index, the structural
     .cdx is searched for the tag name, if it exists.

     If you want to set the index order to a .ntx or .idx file, specify the
     .ntx or .idx base file name as <cTagName>.

 Example

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

     AX_SetTAG( "AGE" )                 // Select the AGE tag in TEST.CDX
     ? AX_TagName()                     // Returns "AGE"


See Also: AX_SetTagNo() AX_SetTagOrder() AX_TagName() SET TAG

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