Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- SIx Driver RDD v3.00 - Reference Guide - <b>sx_killtag():</b> http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
  Sx_KillTag():

  Syntax:   Sx_KillTag(cTagName | lAll [, cIndName])

            cTagName = Name of the tag to delete
            lAll     = Logical .T. indicating DELETE TAG ALL
            cIndName = Name of the .CDX/.NSX file to delete from

  Returns:   <logical> .T. if the tag (or .CDX/.NSX file) was deleted.
                  .F. if an error occurred.

  Description:    This function deletes one or all tags from one of the
                  currently active or specified compound index files
                  (.CDX/.NSX).  If cIndName is specified, then only that
                  file is searched for the specified tag.  Otherwise, the
                  active .CDX/.NSX files are searched in the order opened.

                  If a logical .T. is passed as the first argument, then
                  the .CDX/.NSX file is deleted.  If cIndName is not
                  specified, then the current .CDX/.NSX file is deleted.

                  If the specified tag is the only tag in the .CDX/.NSX file,
                  then the .CDX/.NSX file is automatically deleted.

                  This function is used in the DELETE TAG and DELETE
                  TAG ALL commands.

    NOTE:  This function is NOT supported under SIXNTX.

    NOTE:  Be sure that an order is actually set when passing
               TRUE (delete all tags). Otherwise Sx_KillTag() will
               return FALSE and the tags will not be killed.
               For instance:

               USE test VIA "SIXNSX"       // TEST.NSX auto opens
               ? sx_killTag(.t.)           // .F. and no tags are killed.

               Instead, do this:

               USE test VIA "SIXNSX"       // TEST.NSX auto opens
               ordsetFocus(1)              // make sure an order is set
               ? sx_killTag(.t.)           // .T. and tags are killed.

  Example:

    #include "SIXCDX.CH"

    USE test VIA "SIXCDX"             // Open database
    INDEX ON last TAG last            // Create one tag
    ? Sx_TagCount()                   // Returns: 1
    INDEX ON state TAG state          // Create a second tag
    ? Sx_TagCount()                   // Returns: 2
    Sx_KillTag( "LAST" )              // Delete tag number 1 (LAST)
    ? Sx_TagCount()                   // Returns: 1



See Also: DELETE TAG OrdDestroy()

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