Tag Archives: SET INDEX

C5_SET INDEX

Posted on by vivaclipper 
SET INDEX
 Open one or more order bags in the current work area
------------------------------------------------------------------------------
 Syntax

     SET INDEX TO [<xcOrderBagName list>] [ADDITIVE]

 Arguments

     <cOrderBagName list> specifies order bags to be emptied into the
     order list of the current work area.

     ADDITIVE adds order bags to an existing order list.

 Description

     By default, SET INDEX, without the ADDITIVE clause, clears the currently
     active order list, and then constructs a new order list from the orders
     in the specified order bags in the current work area.  When several
     order bags are opened, the first order in the first order bag becomes
     the controlling order (has focus).  The record pointer is initially
     positioned at the first logical identity in this order.

     If an order list exists when you SET INDEX ... ADDITIVE, the orders in
     the new order bag are added to the end of the order list.  The previous
     controlling order continues to be the controlling order.

     If no order list exists when you SET INDEX ... ADDITIVE, the first order
     in the first order bag in <cOrderBagName list> becomes the controlling
     order.

     During database processing, all open orders are updated whenever a key
     value is appended or changed, unless the order was created using a
     scoping condition and the key value does not match.  To change the
     controlling order without issuing another SET INDEX command, use SET
     ORDER or ORDSETFOCUS().  To add orders without closing the currently
     open orders, use the ADDITIVE clause.

 Examples

     .  This example opens a database and its associated indexes:

        USE Sales NEW
        SET INDEX TO Sales, Sales1, Sales2

     .  This example opens an index without closing any indexes that
        are already open:

        SET INDEX TO Sales3 ADDITIVE

See Also: CLOSE DBCLEARIND() DBSETINDEX() INDEX REINDEX




			

			
						

	
	



		
			


	

		
C5 Commands


		

		Posted on  by vivaclipper		

	


		

		
 ?|??            Display one or more values to the console
 @...BOX         Draw a box on the screen
 @...CLEAR       Clear a rectangular region of the screen
 @...GET         Create a new Get object and display it
 @...PROMPT      Paint a menu item and define a message
 @...SAY         Display data at a specified screen or printer row and column
 @...TO          Draw a single- or double-line box
 ACCEPT*         Place keyboard input into a memory variable
 APPEND BLANK    Add a new record to the current database file
 APPEND FROM     Import records from a database (.dbf) file or ASCII text file
 AVERAGE         Average numeric expressions in the current work area
 CALL*           Execute a C or Assembler procedure
 CANCEL*         Terminate program processing
 CLEAR ALL*      Close files and release public and private variables
 CLEAR GETS      Release Get objects from the current GetList array
 CLEAR MEMORY    Release all public and private variables
 CLEAR SCREEN    Clear the screen and return the cursor home
 CLEAR TYPEAHEAD Empty the keyboard buffer
 CLOSE           Close a specific set of files
 COMMIT          Perform a solid-disk write for all active work areas
 CONTINUE        Resume a pending LOCATE
 COPY FILE       Copy a file to a new file or to a device
 COPY STRUCTURE  Copy the current .dbf structure to a new database (.dbf) file
 COPY STRU EXTE  Copy field definitions to a .dbf file
 COPY TO         Export records to a database (.dbf) file or ASCII text file
 COUNT           Tally records to a variable
 CREATE          Create an empty structure extended (.dbf) file
 CREATE FROM     Create a new .dbf file from a structure extended file
 DELETE          Mark records for deletion
 DELETE FILE     Remove a file from disk
 DELETE TAG      Delete a tag
 DIR*            Display a listing of files from a specified path
 DISPLAY         Display records to the console
 EJECT           Advance the printhead to top of form
 ERASE           Remove a file from disk
 FIND*           Search an index for a specified key value
 GO              Move the pointer to the specified identity
 INDEX           Create an index file
 INPUT*          Enter the result of an expression into a variable
 JOIN            Create a new database file by merging from two work areas
 KEYBOARD        Stuff a string into the keyboard buffer
 LABEL FORM      Display labels to the console
 LIST            List records to the console
 LOCATE          Search sequentially for a record matching a condition
 MENU TO         Execute a lightbar menu for defined PROMPTs
 NOTE*           Place a single-line comment in a program file
 PACK            Remove deleted records from a database file
 QUIT            Terminate program processing
 READ            Activate full-screen editing mode using Get objects
 RECALL          Restore records marked for deletion
 REINDEX         Rebuild open indexes in the current work area
 RELEASE         Delete public and private memory variables
 RENAME          Change the name of a file
 REPLACE         Assign new values to field variables
 REPORT FORM     Display a report to the console
 RESTORE         Retrieve memory variables from a memory (.mem) file
 RESTORE SCREEN* Display a saved screen
 RUN             Execute a DOS command or program
 SAVE            Save variables to a memory (.mem) file
 SAVE SCREEN*    Save the current screen to a buffer or variable
 SEEK            Search an order for a specified key value
 SELECT          Change the current work area
 SET ALTERNATE   Echo console output to a text file
 SET BELL        Toggle sounding of the bell during full-screen operations
 SET CENTURY     Modify the date format to include or omit century digits
 SET COLOR*      Define screen colors
 SET CONFIRM     Toggle required exit key to terminate GETs
 SET CONSOLE     Toggle console display to the screen
 SET CURSOR      Toggle the screen cursor on or off
 SET DATE        Set the date format for input and display
 SET DECIMALS    Set the number of decimal places to be displayed
 SET DEFAULT     Set the CA-Clipper default drive and directory
 SET DELETED     Toggle filtering of deleted records
 SET DELIMITERS  Toggle or define GET delimiters
 SET DESCENDING  Change the descending flag of the controlling order
 SET DEVICE      Direct @...SAYs to the screen or printer
 SET EPOCH       Control the interpretation of dates with no century digits
 SET ESCAPE      Toggle Esc as a READ exit key
 SET EXACT*      Toggle exact matches for character strings
 SET EXCLUSIVE*  Establish shared or exclusive USE of database files
 SET FILTER      Hide records not meeting a condition
 SET FIXED       Toggle fixing of the number of decimal digits displayed
 SET FORMAT*     Activate a format when READ is executed
 SET FUNCTION    Assign a character string to a function key
 SET INDEX       Open one or more order bags in the current work area
 SET INTENSITY   Toggle enhanced display of GETs and PROMPTs
 SET KEY         Assign a procedure invocation to a key
 SET MARGIN      Set the page offset for all printed output
 SET MEMOBLOCK   Change the block size for memo files
 SET MESSAGE     Set the @...PROMPT message line row
 SET OPTIMIZE    Change the setting that optimizes using open orders
 SET ORDER       Select the controlling order
 SET PATH        Specify the CA-Clipper search path for opening files
 SET PRINTER     Toggle echo of output to printer or set the print destination
 SET PROCEDURE*  Compile procedures and functions into the current object file
 SET RELATION    Relate two work areas by a key value or record number
 SET SCOPE       Change the boundaries for scoping keys in controlling order
 SET SCOPEBOTTOM Change bottom boundary for scoping keys in controlling order
 SET SCOPETOP    Change top boundary for scoping keys in controlling order
 SET SCOREBOARD  Toggle the message display from READ or MEMOEDIT()
 SET SOFTSEEK    Toggle relative seeking
 SET TYPEAHEAD   Set the size of the keyboard buffer
 SET UNIQUE*     Toggle inclusion of non-unique keys into an index
 SET WRAP*       Toggle wrapping of the highlight in menus
 SKIP            Move the record pointer to a new position
 SORT            Copy to a database (.dbf) file in sorted order
 STORE*          Assign a value to one or more variables
 SUM             Sum numeric expressions and assign results to variables
 TEXT*           Display a literal block of text
 TOTAL           Summarize records by key value to a database (.dbf) file
 TYPE            Display the contents of a text file
 UNLOCK          Release file/record locks set by the current user
 UPDATE          Update current database file from another database file
 USE             Open an existing database (.dbf) and its associated files
 WAIT*           Suspend program processing until a key is pressed
 ZAP             Remove all records from the current database file


 



        
    
			

	
	



		
			


	

		
Clipper and Networking


		

		Posted on  by vivaclipper		

	


		

		
Clipper and Networking

			

	
	



		
			


	

		
C5 Index Commands and Functions


		

		Posted on  by vivaclipper		

	


		

		
Index Commands and Functions


Commands :


DELETE TAG :


Delete a Tag


DELETE TAG <cOrderName> [IN <xcOrderBagName>]
    [, <cOrderName> [IN xcOrderBagName] list>]


INDEX ON … :


Create an index file


INDEX ON <expKey>
    [TAG <cOrderName>]
    TO <xcOrderBagName>
    [FOR <lCondition>] [ALL]
    [WHILE <lCondition>]
    [NEXT <nNumber>]
    [RECORD <nRecord>]
    [REST]
    [EVAL <bBlock>
    [EVERY <nInterval>]
    [UNIQUE]
    [ASCENDING|DESCENDING]


REINDEX :


Rebuild open indexes in the current workarea


REINDEX
    [EVAL <lCondition>]
    [EVERY <nRecords>]]


SET INDEX : 


Open index file(s) in the current work area


SET INDEX TO [<xcIndex list>]


SET ORDER : 


Set a new controlling index


SET ORDER TO [<nOrder> | [TAG <cOrderName>]
    [IN <xcOrderBagName>]]>


SET UNIQUE* : 


Toggle the inclusion of nonunique keys into an index


SET UNIQUE on | OFF | <xlToggle>


Functions :


DBCLEARINDEX() :


Close all indexes for the current work area


DBCLEARINDEX() --> NIL


DBCREATEINDEX() :


Create an index file


DBCREATEINDEX( <cIndexName>, <cKeyExpr>,
    <bKeyExpr>, 
    [<lUnique>] ) --> NIL


DBREINDEX() : 


Recreate all active indexes for the current work area


DBREINDEX() --> NIL


DBSEEK() : 


Move to the record having the specified key value


DBSEEK( <expKey>, [<lSoftSeek>] ) --> lFound


DBSETINDEX() : 


Open an index for the current work area


 DBSETINDEX( <cIndexName> ) --> NIL
 DBSETINDEX( <cOrderBagName> ) --> NIL


DBSETORDER() : 


Set the controlling order for the current work area


DBSETORDER( <nOrderNum> ) --> NIL


DESCEND() : 


Return a descending index key value


DESCEND( <exp> ) --> ValueInverted


FOUND() : 


Determine if the previous search operation succeeded


FOUND() --> lSuccess


INDEXEXT() : 


Return the default index extension


INDEXEXT() --> cExtension


INDEXKEY() : 


Return the key expression of a specified index


INDEXKEY( <nOrder> ) --> cKeyExp


INDEXORD() : 


Return the order position of the controlling index


INDEXORD() --> nOrder


ORDBAGEXT() :


Return the default Order Bag RDD extension


ORDBAGEXT() --> cBagExt


ORDBAGNAME() :


Return the Order Bag name of a specific Order


ORDBAGNAME(<nOrder> | <cOrderName>) --> cOrderBagName


ORDCOND()


Specify conditions for ordering


ORDCOND([FOR <lCondition>]


             [ALL] [WHILE <;lCondition>]
             [EVAL <bBlock> [EVERY <nInterval>]]
             [RECORD <nRecord>] [NEXT <nNumber>]
             [REST] [DESCENDING])


ORDCONDSET()


Set the condition and scope for an order


     ORDCONDSET([<cForCondition>],
        [<bForCondition>],
        [<lAll>],
        [<bWhileCondition>],
        [<bEval>],
        [<nInterval>],
        [<nStart>],
        [<nNext>],
        [<nRecord>],
        [<lRest>],
        [<lDescend>],
        [<lAdditive>],
        [<lCurrent>],
        [<lCustom>],
        [<lNoOptimize>]) --> lSuccess


ORDCREATE():


Create an Order in an Order Bag


ORDCREATE(<cOrderBagName>,[<cOrderName>], <cExpKey>,


    [<bExpKey>], [<lUnique>]) --> NIL


ORDDESCEND()


Return and optionally change the descending flag of an order


ORDDESCEND([<cOrder> | <nPosition>],[<cIndexFile>],
            [<lNewDescend>]) --> lCurrentDescend


ORDDESTROY() :


Remove a specified Order from an Order Bag


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


ORDFOR() :


Return the FOR expression of an Order


ORDFOR(<cOrderName> | <nOrder>
    [, <cOrderBagName>]) --> cForExp


ORDISUNIQUE()


          Return the status of the unique flag for a given order


    ORDISUNIQUE([<cOrder> | <nPosition>],
        [<cIndexFile>]) --> lUnique


ORDKEY() :


Return the Key expression of an Order


ORDKEY(<cOrderName> | <nOrder>
 [, <cOrderBagName>]) --> cExpKey


ORDKEYADD()


Add a key to a custom built order


         ORDKEYADD([<cOrder> | <nPosition>],
            [<cIndexFile>],[<expKeyValue>]) --> lSuccess


 


ORDKEYCOUNT()


Return the number of keys in an order


         ORDKEYCOUNT([<cOrder> | <nPosition>],
              [<cIndexFile>]) --> nKeys


ORDKEYDEL()


Delete a key from a custom built order


        ORDKEYDEL([<cOrder> | <nPosition>],
            [<cIndexFile>],
            [<expKeyValue>]) --> lSuccess


ORDKEYGOTO()


Move to a record specified by its logical record number


ORDKEYGOTO(<nKeyNo>) --> lSuccess


ORDKEYNO()


 Get the logical record number of the current record


         ORDKEYNO([<cOrder> | <nPosition>],
             [<cIndexFile>]) --> nKeyNo


 ORDKEYVAL()


Get key value of the current record from controlling order


ORDKEYVAL() --> xKeyValue


 


ORDLISTADD() :


Add Order Bag contents or single Order to the Order List


ORDLISTADD(<cOrderBagName>
    [, <cOrderName>]) --> NIL


ORDLISTCLEAR() :


Clear the current Order List


ORDLISTCLEAR() --> NIL


ORDLISTREBUILD() :


Rebuild all Orders in the Order List of the current work area


ORDLISTREBUILD() --> NIL


ORDNAME() :


Return the name of an Order in the work area


ORDNAME(<nOrder>[,<cOrderBagName>])
    --> cOrderName


ORDNUMBER() :


Return the position of an Order in the current Order List


ORDNUMBER(<cOrderName>[, <cOrderBagName>]) --> nOrderNo


 ORDSCOPE()


Set or clear the boundaries for scoping key values


ORDSCOPE(<nScope>, [<expNewValue>]) --> uCurrentValue


ORDSETFOCUS() :


Set focus to an Order in an Order List


ORDSETFOCUS([<cOrderName> | <nOrder>]
    [,<cOrderBagName>]) --> cPrevOrderNameInFocus


ORDSETRELAT()


Relate a specified work area to the current work area


    ORDSETRELATION(<nArea> | <cAlias>,<bKey>, [<cKey>])


             --> NIL


ORDSKIPUNIQUE()


Move record pointer to the next or previous unique key


ORDSKIPUNIQUE([<nDirection>]) –> lSuccess