OVERVIEW

Commands Supported

Description:

#TRANSLATE

Specify a user-defined command or translation directive

Syntax:

Arguments:

    See the Clipper 5.0 Guides (#translate/#command) for details
   
 on how to create user-defined commands or psuedo-functions.
   

   

Description:

See Also:

#XTRANSLATE

Specify a user-defined command or translation directive

Syntax:

Arguments:

    See the Clipper 5.0 Guides (#translate/#command) for details
   
 on how to create user-defined commands or psuedo-functions.
   

   

Description:

See Also:

.

Pop up a listing of the dot prompt command stack

Syntax:

Arguments:

    None
   

   

Description:

/

Invoke the turbo-editor

Syntax:

Arguments:

    If NO SPACE is entered between the / and the arguments, then
   
 the arguments are treated as a set of commands to compile
   
 and execute.   (cCommands) is a set of commands to compile and
   
 run (separated by semi-colons).
   

   
 If at least ONE SPACE is entered between the / and the
   
 arguments, then the argument is treated as the name of a
   
 file to edit with the Turbo-Editor.  (cPrgFile) is the name
   
 of a .PRG file that will be edited, compiled and run.
   
 (cDcbFile) is the name of a .DCB file that will be edited and
   
 run.
   

   
 If no argument is passed, then the system Turbo-Editor will be
   
 used and the name of the file defined by the SLASH= command in
   
 DCLIP.SYS or DC_SETT('SLASH',(cProgram)) will be edited,
   
 compiled and executed.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 // Edit-Compile-Run the program file pre-designated by the
   
 // SET SLASH option.
   

   
 . /
   

   

   

   
 -- Example 2 --
   

   
 // Edit-Compile-Run a program file named TEST.PRG
   

   
 . / TEST
   

   

   

   
 -- Example 3 --
   

   
 // Edit-Compile-Run a set of commands entered at dot-prompt
   

   
 . /FOR I = 1 TO 10; QOUT(ALIAS(I)); NEXT
   

   

   

   
 -- Example 4 --
   

   
 // Edit-Run a batch file named TEST.DCB
   

   
 . / TEST.DCB
   

   

   

See Also:

=>

Display the pre-processed output of a command

Syntax:

Arguments:

    (command) is any internal dCLIP command or any command in a
   
 loaded .CH file.
   

   

Description:

Examples:

    . =) USE
   
 dbCloseArea()
   

   
 . =) CLEAR
   
 Scroll()
   
 SetPos(0,0)
   
 __KillRead()
   
 Getlist := {}
   

   
 .
   

   

@...BOX

Draw a box on the screen

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

@...CLEAR

Clear a rectangular region of the screen

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

@...GET

Create a GET object and display it on the screen

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

@...PROMPT

Paint a menu item and define a message

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

@...SAY

Display data at a specified screen/printer location

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

Source/Library:

@...TO

Draw a single or double line box

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

ABROWSE

Browse an array or object

Syntax:

Arguments:

    (array)/(object) is the name of a private or public array to
   
 browse.
   

   
 ASYMMETRICAL will browse the array using the columnar-style
   
 browser.
   

   
 NONSYMMETRICAL will browse the array using the indented-
   
 style browser.
   

   

Description:

Examples:

    . DIR := DIRECTORY('*.PRG')
   
 . ABROWSE DIR
   
 . OBJ := TBROWSEDB()
   
 . ABROWSE OBJ
   

   

See Also:

ACCEPT

Place keyboard input into a memory variable

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

AEDIT

Edit a multi-dimensional array or object

Syntax:

Arguments:

    (array / object) is the name of any multidimensional array
   
 or subarray to browse.
   

   

Description:

Examples:

    . aDir := directory()
   
 . AEDIT aDir
   

   

   

Source/Library:

See Also:

AEVAL

Evaluate all elements of an array

Syntax:

Arguments:

    (array) is the name of the array to evaluate.
   

   
 (parameter) is an optional parameter used by expressions in
   
 the expression list.
   

   
 (xpr list) is a list of expressions (separated by commas) to
   
 evaluate for each array element.
   

   
 START (elem) is the starting element number.
   

   
 COUNT (elems) is the number of elements to evaluate.
   

   

   

   

Description:

Examples:

    . DIR := DIRECTORY()
   
 . AEVAL DIR QOUT(DIR[1],DIR[2]) START 10 COUNT 5
   

   

APPEND

Import records from a .DBF or ASCII file

Syntax:

Arguments:

    If no arguments are passed, then APPEND will append a blank
   
 record and enter the full-screen editor to modify the
   
 contents of the new record.
   

   
 If arguments are passed, see the Clipper 5.0 Guides or 5.2
   
 guides for details.
   

   

Description:

Notes:

See Also:

APPEND BLANK

Add a new record to the current database

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

APPEND IMPORT

Append a record with data from another work area

Syntax:

Arguments:

    None
   

   

Description:

Examples:

    . use dcusers         // registered users database
   
 . use customer new    // customer database
   

   
 // map customer.dbf fields to dcuser.dbf fields
   
 . import create dcusers from customer to dcusers
   

   
 . import load dcusers  // load dcusers.dcf map file
   
 . select customer
   
 . browse  // select a record to import to dcusers.dbf
   
 . select dcusers
   
 . APPEND IMPORT
   

   

See Also:

APPEND SHARED

Append records to a shared database

Syntax:

Arguments:

    (cFromAlias) is the alias of the database to append from.  This
   
 database must already be opened.
   

   

Returns:

    A Logical value of .TRUE. if records were appended, .FALSE. if the
   
 operation is aborted.
   

   

Description:

Examples:

    USE customer SHARED
   
 COPY TO temp FOR state='NE'
   
 USE temp NEW
   
 SELECT customer
   
 APPEND SHARED FROM temp
   

   

See Also:

ASSIST

Database Assistant

Syntax:

Description:

Examples:

    . ASSIST
   

   

See Also:

ASTABILIZE

Automatically stablize a Tbrowse object after each command

Syntax:

Arguments:

    (tbrowse object) is a private or public object created by the
   
 TBROWSEDB() or TBROWSE() function.
   

   
 CLEAR will clear all autostabilizing events.
   

   

Description:

Examples:

    . USE CUSTOMER
   
 . OBJ := TBROWSEDB()
   
 . A := TBCOLUMNNEW('NAME',{||NAME})
   
 . B := TBCOLUMNNEW('BALANCE',{||BALANCE})
   
 . OBJ:ADDCOLUMN(A)
   
 . OBJ:ADDCOLUMN(B)
   
 . ASTABILIZE OBJ
   
 . OBJ:DOWN()
   
 . OBJ:RIGHT()
   
 . OBJ:GOBOTTOM()
   

   

See Also:

AVERAGE

Average numeric expressions in the current work area

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

Description:

See Also:

BATCH

Execute all commands in a .DCB batch file

Syntax:

Arguments:

    (batch file) is the name of the batch file to execute.  If no
   
 extension is given, then .DCB is assumed.  If no directory
   
 path is included, then dCLIP will search the current dos
   
 directory followed by the directory established in the dos SET
   
 DCLIP=(directory) environment command.
   

   
 (param1) - (param5) are arguments which are replaced in the
   
 batch file by %1 - %5 in the same manner as replacement is
   
 accomplished in dos .BAT files.
   

   

Description:

Notes:

Examples:

    . BATCH OUTPUT MYFILE.PRG PRN
   

   

See Also:

BLANK

Blank out all fields

Syntax:

Arguments:

    See the Clipper guides for information on how to use the
   
 FOR, WHILE, NEXT, ALL, REST, and RECORD clauses.
   

   

Description:

Examples:

    . BLANK FOR deleted()
   
 . BLANK FOR user_id='GOOFY'
   

   

See Also:

BROWSE

Browse the currently selected database

Syntax:

Arguments:

    EDIT will re-paint all previously created Editing Screens
   
 that were created with the EDIT command.
   

   
 FIELDS (fields) is a list of fields to browse.  If no field
   
 list is passed, then all fields will be included in the
   
 browse.
   

   
 CLEAR will clear any previously configured browse window for
   
 the current work area and create a browse window with the
   
 default configuration using the full screen and all fields.
   

   
 CLEAR ALL will clear all browse windows for all work areas.
   

   
 PROTECT will protect data from being modified by the user.
   

   

Description:

Examples:

    . USE CUSTOMER
   
 . BROWSE CUST_NAME, BALANCE
   

   

See Also:

BROWSE DELETE

Delete a Browse configuration in the Browse Dictionary

Syntax:

Arguments:

    (cConfig) is the Tag Name of the Browse Configuration to
   
 delete.  If no argument is passed then a pick-list of all
   
 Browse configurations will be displayed.
   

   

Description:

Examples:

    . BROWSE DELETE mybrowse
   

   

Source/Library:

See Also:

BROWSE RELATION

Invoke a Tile-Browse with One-to-many relations

Syntax:

Arguments:

    WINDOW (mode) is an optional argument for defining the method
   
 to display the browse windows being opened for the relational
   
 browsing.
   

   
 Mode
   

   
  1  Four windows ( screen split in half vertically and
   
     horizonally )
   
  2  Four windows ( screen split horizontally )
   
  3  Three windows ( screen split horizontally )
   
  4  Two windows ( screen split vertically )
   
  5  Two windows ( screen split horizontally )
   
  6  Six windows ( three across / two down )
   

   
 If no WINDOW (mode) argument is given, then a set of windows
   
 will automatically be created in a "best-fit" screen config-
   
 uration.
   

   
 (alias) is the alias name of the primary file.
   

   
 INTO (into1) is the name of a relational file.
   

   
 ON (fieldn) is an optional argument to identify the name of a
   
 field common to both databases for establishing the relation-
   
 ship.  If no argument is given then the index key of the rela-
   
 tional file will be used as the relational key.
   

   
 NOTE: If no relation arguments are passed, then the current
   
 database relations will be used.
   

   

Description:

Examples:

    The following example demonstrates how BROWSE RELATION can be
   
 used to open 3 windows into a CUSTOMER, INVOICE, and INVITEMS
   
 database for monitor invoices for selected customers.
   

   
 The CUSTOMER and INVOICE databases contain a common field
   
 named CUST_NMBR.  The INVOICE and INVITEMS databases contain a
   
 common field named INV_NMBR.
   

   
  To create a relational browse enter the following commands
   

   
  . USE CUSTOMER
   
  . USE INVOICE NEW
   
  . INDEX ON CUST_NMBR TO INVOICE
   
  . USE INVITEMS NEW
   
  . INDEX ON INV_NMBR TO INVITEMS
   
  . BROWSE RELATION CUSTOMER INTO INVOICE, INVOICE INTO INVITEMS
   

   

   
  Alternate method:
   

   
  . SELECT 3
   
  . USE INVITEMS
   
  . INDEX ON INV_NMBR TO INVITEMS
   
  . SELECT 2
   
  . USE INVOICE
   
  . INDEX ON CUST_NMBR TO INVOICE
   
  . SET RELATION TO INV_NMBR INTO INVITEMS
   
  . SELECT 1
   
  . USE CUSTOMER
   
  . SET RELATION TO CUST_NMBR INTO INVOICE
   
  . BROWSE RELATION
   

   

See Also:

BROWSE RESTORE

Browse a database using a pre-defined Configuration

Syntax:

Arguments:

    (xcFileName) is the name of the configuration file that was
   
 previously created with the "Save Configuration" selection
   
 from the FILE OPTIONS menu of the Browse Screen.
   

   
 EDIT will re-paint all previously created Editing Screens
   
 that were created with the EDIT command.
   

   

Description:

Examples:

    . USE CUSTOMER
   
 . BROWSE CUST_NAME, BALANCE
   

   

See Also:

BROWSE SCAN

Merge a browse and edit screen display mode

Syntax:

Arguments:

    (field) is the name of a reference field to browse on the
   
 left third of the screen.
   

   

Description:

Examples:

    . USE CUSTOMER
   
 . BROWSE SCAN CUST_NAME
   

   

See Also:

BROWSE TILE

Browse multiple work areas with tiled browse windows

Syntax:

Arguments:

    WINDOW (mode) is an optional argument for defining the method
   
 to display the browse windows being opened for the relational
   
 browsing.
   

   
 Mode
   

   
  1  Four windows ( screen split in half vertically and
   
     horizonally )
   
  2  Four windows ( screen split horizontally )
   
  3  Three windows ( screen split horizontally )
   
  4  Two windows ( screen split vertically )
   
  5  Two windows ( screen split horizontally )
   
  6  Six windows ( three across / two down )
   

   
 The CASCADE option can be used when browsing 6 areas or less.
   
 This option will create overlapping windows that use a larger
   
 area of the screen.
   

   
 If no WINDOW (mode) argument is given, then a set of windows
   
 will automatically be created in a "best-fit" screen config-
   
 uration.
   

   
 The optional EDIT clause is used to paint an "Editing" window
   
 adjacent to each "Browsing" window.  The Editing window is
   
 automatically updated when the record pointer is moved through
   
 the browse screen of the same work area.  The ALT-W key will
   
 select the Full-screen editing window when browsing.
   

   
 (aliases...) is a list of datafile aliases (separated by
   
 commas) to browse.  The database files for each alias given
   
 must already be opened.  If no (aliases) are listed then all
   
 open databases will be included.
   

   

   

Description:

Notes:

Examples:

    . USE ALL LIKE DC*
   
 . BROWSE TILE WINDOW 3
   
 . CLOSE ALL
   
 . USE ALL
   
 . BROWSE TILE CUSTOMER, INVOICE, SALES
   

   

   

See Also:

CALCULATOR

A "moused", full-function calculator

Syntax:

Arguments:

    None
   

   

Description:

Source/Library:

See Also:

CANCEL

Terminate program processing

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

CASE

Evaluate expression list for first case which evaluates true

Syntax:

Arguments:

    (case list 1) - (case list n) are expression lists to evaluate.
   
 Expression lists are separated by commas.   The value returned
   
 by the last expression in each list is used to determine
   
 whether the case evaluates true.  The last expression in each
   
 list must return a logical value to evaluate.
   

   
 (do list 1) - (do list 2) are expression lists to execute for
   
 the first (case list) expression that evaluates .true.
   

   

   

Description:

Examples:

    . a = INKEY(0)
   
 . CASE a ) 32 DO PROG1() ; a ( 100 DO PROG2() ;
   
   a = 55 DO PROG3()
   

   

See Also:

CD

Change directory

Syntax:

Arguments:

    (directory) - The name of the dos directory to change to.
   

   

Description:

Examples:

    . CD \DCLIP3\DATA
   
 . CD..
   
 . CD..\OBJECTS
   

   

See Also:

CHR

Pop-up a pick-list of ASCII characters

Syntax:

Description:

See Also:

CLEAR

Clear the screen and home the cursor

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

CLEAR GETS

Release GET objects from the current get list array

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

CLEAR MEMORY

Release all public and private variables

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

CLEAR SCOPE*

Clear both scope values set by SET SCOPE

Syntax:

Description:

Examples:

    . USE CUSTOMER
   
 . SET SCOPETOP TO NAME = 'G'
   
 . SET SCOPEBOTTOM TO NAME = 'L'
   
 . BROWSE
   
 . CLEAR SCOPE
   

   

See Also:

CLEAR TYPEAHEAD

Empty the keyboard buffer

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

CLIPPER

Compile all changed or specified .PRG files

Syntax:

Arguments:

    ( ALL ) - Recompile all .PRG files in PDIR directory even if
   
 they are current.
   

   
 (file name) - Compile (filename).PRG
   

   
 (options)   - Clipper.exe compiler options
   

   
 NOTE:
   

   
 Options are not required if they have been previously been set
   
 by the dot-prompt SET CLIPOPT command or the CLIPOPT=(options)
   
 command in DCLIP.SYS.
   

   

Description:

Notes:

Examples:

    . CLIP /l/n
   
 . CLIP ALL
   
 . CLIP MYPROG /l
   

   

See Also:

CLOSE

Close a specified set of files

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

CODE DELETE

Delete a Code Table in the Code Dictionary

Syntax:

Arguments:

    (cTable) is the name of the code table in DCCODES.DBF
   
 to delete (up to 8 characters).  If no parameter is
   
 passed then a pick-list of available code tables will be
   
 displayed.
   

   

   

   

Description:

Notes:

Examples:

    // Delete code table "POSITION"
   
 CODE EDIT POSITION
   

   

   

   

   

Source/Library:

CODE EDIT

Edit the Code Table Dictionary

Syntax:

Arguments:

    (cTable) is the name of the code table in DCCODES.DBF
   
 to load and edit (up to 8 characters).  If no parameter is
   
 passed then a pick-list of available code tables will be
   
 displayed.
   

   

   

   

Description:

Notes:

Examples:

    -- Example 1 --
   
 // Load a code table from the dictionary and edit it //
   
 CODE EDIT
   

   
 -- Example 2 --
   
 // Edit code table "POSITION"
   
 CODE EDIT POSITION
   

   

   

   

   

Source/Library:

See Also:

COLOR SETUP

Change the color setup of dCLIP menus

Syntax:

Arguments:

    NONE - If no argument is given then COLOR will pop-up a color
   
 selection chart and return the string value of the color
   
 selected.
   

   
 SETUP - Invokes the color setup utility.
   

   

Description:

Examples:

    . COLOR SETUP
   

   

COMMIT

Perform a solid disk-write for all work areas

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

CONTINUE

Resume a pending LOCATE

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

COPY

Copy file using the DOS copy command

Syntax:

Arguments:

    (file parameters) is a set of arguments that would be passed
   
 in the same manner as used by the COPY command of DOS.
   

   

Description:

Examples:

    . COPY CUSTOMER.DBF CUSTSAVE.DBF /v
   
 . COPY *.* F:\MYFILES
   

   

COPY FILE

Copy file to a new file

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

COPY STRUCTURE

Copy the current data file structure to a new data file

Syntax:

Arguments:

    (xcDatabase) is the new database to create.
   

   
 TYPE DBMEMO3 specifies that any memos in the structure will
   
 be dBASE-III type memos.  This clause is active only if the
   
 current work area is using the DBFMDX driver.
   

   

Description:

Examples:

    . USE CUSTOMER VIA 'DBFMDX'
   
 . COPY STRUCTURE TO NEWCUST DBMEMO3
   

   
 . USE MAILLIST
   
 . COPY STRUCTURE TO NEWMAIL
   

   

COPY STRUCTURE EXTE

Copy field definitions to a new database file

Syntax:

Arguments:

    (xcExtendedDatabase) is the extended database to create.
   

   
 TYPE DBMEMO3 specifies that any memos in the structure will be
   
 dBASE-III type memos.   This clause is active only if the
   
 current work area is using the DBFMDX driver.
   

   

Description:

Examples:

    . USE CUSTOMER VIA 'DBFMDX'
   
 . COPY STRUCTURE EXTENDED TO CUSTSTRU DBMEMO3
   

   
 . USE MAILLIST
   
 . COPY STRUCTURE EXTENDED TO MAILSTRU
   

   

See Also:

COPY TO

Export records to a new database or ASCII file

Syntax:

Arguments:

    See Clipper 5.x Guides
   

   
 The VIA (rdd) clause is supported only in Clipper 5.2.
   

   

Description:

COUNT

Tally records to a variable

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

Description:

See Also:

CREATE

Create a new database from a menu

Syntax:

Arguments:

    (xcDatabase) is the name of the new database to create.  If you
   
 do not include an extension, then the default extension for the
   
 currently selected database driver will be used.
   

   

Description:

Examples:

    . CREATE MAILLIST
   

   

See Also:

CREATE FROM

Create a new database from a structure extended file

Syntax:

Arguments:

    (xcDatabase) is the name of the database to create.
   

   
 (xcExtendedDatabase) is the name of a STRUCTURE EXTENDED
   
 database, that was created with COPY STRUCTURE EXTENDED, which
   
 contains the information necessary to create the new database.
   

   
 VIA (rdd) specifies the name of the replaceable database driver
   
 to use to process the current work area.  This option is available
   
 only in Clipper 5.2.
   

   
 ALIAS (xcAlias) is the name to associate with the work area when
   
 (xcDatabase) is opened.  This option is available only in Clipper
   
 5.2.
   

   
 NEW opens (xcDatabase) in the next available work area making it
   
 it the current work area.  If not specified, then the database is
   
 opened in the current work area.
   

   
 TYPE DBMEMO3 specifies that any memos in the structure will be
   
 dBASE-III type memos.   This clause is active only if the
   
 current work area is using the DBFMDX driver from the dBASE-IV
   
 compiler kit.
   

   

Description:

Examples:

    USE CUSTOMER VIA 'DBFMDX'
   
 COPY STRUCTURE EXTENDED TO CUSTSTRU TYPE DBMEMO3
   
 SET RDD TO DBFMDX
   
 USE CUSTSTRU
   
 BROWSE
   
 CLOSE
   
 SET RDD TO DBFMDX
   
 CREATE NEWCUST FROM CUSTSTRU TYPE DBMEMO3
   

   

See Also:

CREATE STRUCTURE

Create an empty structure extended (.dbf) file

Syntax:

Arguments:

    This is the same as the CREATE command supported by Clipper.
   

   
 See Clipper 5.0 Guides
   

   

DATE

A "moused" calendar for selecting a date

Syntax:

Arguments:

    None
   

Description:

Source/Library:

See Also:

DBEVAL

Evaluate expression list for all records in current database

Syntax:

Arguments:

    (Exp list) is a list of expressions, separated by commas to
   
 evaluate for each record.
   

   
 FOR (lCondition)  specifies the conditional set of records to
   
 evaluate.
   

   
 WHILE (lCondition) specifies the set of records meeting the
   
 condition from the first record in the file until the condition
   
 fails.
   

   
 NEXT (recs) specifies the number of records to evaluate
   
 starting at the current record.
   

   

Description:

Notes:

Examples:

    . USE CUSTOMER
   
 . DBEVAL ;
   
    MEMOWRIT('MEMO'+ALLTRIM(STR(RECNO()))+'.TXT', NOTES ) ;
   
    FOR BALANCE ) 0 .AND. !EMPTY(NOTES)
   

   

   

See Also:

DBTCONVERT

Convert .DBT memo file(s) to .FPT memos

Syntax:

Arguments:

    (cFileName) is the name of the .DBT file to convert.  If no
   
 parameter is passed, a dialog box will appear with an option
   
 to pick a file from a directory pick-list.  If ALL is passed
   
 then all files with the .DBT extension in the DEFAULT directory
   
 will be converted.
   

   

Returns:

    A logical .TRUE. if the conversion was successful, .FALSE.
   
 otherwise.
   

   

Description:

Source/Library:

See Also:

DEFINE | #DEFINE

Define a manifest constant or display Define List

Syntax:

Arguments:

    See the Clipper 5.0 Guides (#define) for details on how
   
 to create manifest constants, manifest symbols or pseudo-
   
 functions.
   

   
 If no parameters are passed, then a pick-list of all defines
   
 previously loaded with the INCLUDE command and all standard
   
 Clipper defines will be displayed.  The (idConstant) and
   
 (resulttext) will both be displayed in the pick-list as a
   
 handy reference.
   

   
 When at the Dot-Prompt, the ALT-# or ALT-3 key is the Hot-key
   
 for displaying the pick-list and returning the chosen value
   
 into the text-line at the current cursor location.
   

   

Description:

Examples:

    . DEFINE ESCAPEKEY 27
   
 . DEFINE COLUMN BROWARRAY[SELE(),1,53]
   
 . DEFINE MAX(arg1,arg2)  ( IIF(arg1)arg2,arg1,arg2) )
   

   

See Also:

DELETE

Mark records for deletion

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

Description:

See Also:

DELETE FILE

Remove a file from disk

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

DELETE TAG

Remove TAG(s) from a .CDX combined index

Syntax:

Arguments:

    (tagname) specifies the name of the tag to delete.
   

   
 OF (combined index 1 - N) specifies which .CDX file (DBFSIX) or
   
 .MDX file (DBFMDX) contains the specified tag.  This is used to
   
 eliminate any conflicts between two index files that may each
   
 have a tag of the same name.  If an index file name is not
   
 specified, then the open indexes are searched, starting with
   
 the structural (production) index (if one exists).
   

   
 If the specified tag is the only tag in the index file, then
   
 the index file is deleted.
   

   

Description:

Examples:

    . USE CUSTOMER VIA 'DBFSIX'
   
 . INDEX ON NAME TAG NAME
   
 . INDEX ON PHONE TAG PHONE
   
 . INDEX ON ZIP TAG ZIP
   
 . DELETE TAG PHONE
   

   

See Also:

DIR

Display a listing of files from a specified wildcard

Syntax:

Arguments:

    (xcFileSpec) defines the specification of files to display and
   
 can include standard wildcard (* and ?) characters.
   
 (xcFileSpec) can be specified either as a literal file
   
 specification string or as a character expression enclosed in
   
 parentheses.
   

   
 NONE - No arguments will display a listing of all database
   
 files that match the currently selected RDD (database driver)
   
 with the date, time, size, number of records, and date of last
   
 update.  Only data files which exist in the currently selected
   
 SET DEFAULT TO directory will be listed.
   

   
 /W - Display directory in a scrollable window.
   

   

   

Description:

Notes:

See Also:

DISABLE

Disable a command set

Syntax:

Arguments:

    (cCommandSet) is the name of the .CH or .OBJ file as is was
   
 loaded with the INCLUDE...CH or INCLUDE...OBJ command.
   

   

Description:

Examples:

    . INCLUDE MYBROWSE // Load MYBROWSE.CH
   
 . USE MYLIST
   
 . BROWSE  // Translate BROWSE command to MYBROWSE() function
   
 . SELECT 0
   
 . DISABLE MYBROWSE
   
 . USE BASEBALL
   
 . BROWSE  // Translate BROWSE command to DC_BROWSEDB() function
   

   

See Also:

DISPLAY

Display records to the console or printer

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

DISPLAY ARRAY

Display a listing of all elements of a display or object

Syntax:

Arguments:

    (aArray) is a PRIVATE or PUBLIC multi-dimensional array.
   
 (oObject) is a PRIVATE or PUBLIC object.
   

   
 TO (cFileName) is the name of a text file to create for storing
   
 the displayed information.
   

   
 TO PRINT - Outputs the information to the selected printer.
   

   

Description:

Examples:

    . DIR := DIRECTORY( '*.PRG' )
   
 . DISPLAY ARRAY DIR
   
 . DISPLAY ARRAY DIR TO PRGS.TXT
   

   

See Also:

DISPLAY MEMORY

Display a listing of all PUBLIC/PRIVATE variables

Syntax:

Arguments:

    TO PRINT: The TO PRINT clause routs the output to the printer.
   

   
 TO (cFileName) will cause the contents of memory to be stored
   
 to a text file named (cFileName).
   

   

Description:

Examples:

    . RESTORE FROM MYVARS.MEM
   
 . DISPLAY MEMORY
   
 . DISPLAY MEMORY TO MYVARS.TXT
   

   

See Also:

DISPLAY MEMORY FILE

Display a listing of the contents of a .MEM file

Syntax:

Arguments:

    ALL - Use this parameter to output ALL *.MEM files to a file
   
 or printer.
   

   
 (cFileName) - The name of the memory file to display.  May be
   
 preceded  by drive and/or directory.  The .MEM extension is not
   
 necessary.
   

   

Description:

Examples:

    . DISPLAY MEMORY FILE MYVARS.MEM
   

   

See Also:

DISPLAY STATUS

Display the status of the environment and all work areas

Syntax:

Arguments:

    TO PRINT: The TO PRINT clause outputs the displayed information
   
 to the printer.
   

   
 TO (cFileName) routs the output to the (cFileName) specified.
   

   

Description:

Examples:

    . RESTORE WORK FROM MYWORK
   
 . DISPLAY STATUS TO MYWORK.TXT
   

   

See Also:

DISPLAY STRUCTURE

Display or print the structure of a database file

Syntax:

Arguments:

    (TO PRINT) - Routs the displayed output to the printer.
   

   
 (TO cFile) - Routs the displayed output to a file.
   

   
 (TO cFile.PRG) -
   

   
  If the .PRG extension is on the filename, the structure will be
   
  created like this:
   

   
    { 'YEAR','C',   4, 0 },;
   
    { 'MONTH','C',  10, 0 },;
   
    { 'SALES','N',  10, 2 },;
   
    { 'EXPENSES','N',  10, 2 }
   

   

   

   

   

   

   

Description:

Examples:

    . USE CUSTOMER
   
 . DISPLAY STRUCTURE
   
 . DISPLAY STRUCTURE TO CUSTOMER.STR
   
 . DISPLAY STUCTURE TO TEST.PRG
   

   

See Also:

DLIB

Create or update a dynamic library

Syntax:

Arguments:

    (cDlibName)  is a dynamic library file that contains a related
   
 set of Clipper-compiled object files and search tables.  This
   
 is usually a complete Clipper application or a set of routines
   
 which may be used by different applications.  The file built
   
 will have the extension .DLB and will be created by calling the
   
 DLIB.EXE utility program via the dCLIP gateway system.
   

   
 (cListFile) is the name of an ASCII text file with a listing of
   
 the .OBJs to include in the dynamic library.  The contents of
   
 the (cListFile) will look like this:
   

   
  MAIN.OBJ
   
  MYFUNCS.OBJ
   
  MYPROCS.OBJ
   
  MYMENUS.OBJ
   

   

Description:

DLL FREE

Release a Blinker-compatible Dynamic-link Library

Syntax:

Arguments:

    (cDllName) is the name of the .DLL to release.  If the parameter
   
 ALL is passed, then ALL dynamic-link libraries will be
   
 released.
   

   

   

   

See Also:

DLL LOAD

Load a Blinker-compatible Dynamic-Link Library

Syntax:

Arguments:

    (cDllName) is the name of the .DLL to load.  If this parameter
   
 is not passed, a dialogue box will be displayed to prompt the
   
 user for a name.
   

   

   

Description:

See Also:

DO

Execute a procedure or function

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

Description:

See Also:

DOS

Invoke a DOS command line

Syntax:

Arguments:

    (nMemoryForShell) is the amount of memory to release to DOS.
   
 The default is 0 (all available memory).  It is recommended
   
 that you release all memory if you wish to run other large
   
 programs.  If you need to invoke a DOS prompt for small
   
 operations such as copying files, reviewing directories,
   
 formatting disks, etc. then (nMemoryForShell) should be about
   
 50 to 60.
   

   

Description:

Examples:

    . DOS
   
 . DOS 50
   

   

See Also:

DUMP

Display or output the contents of any file in ASCII-HEX format

Syntax:

Arguments:

    (cFileName) - The name of the file to DUMP.  May be preceded by
   
 a drive and/or directory and must include any extension.
   

   
 (cOutFileName) - The name of a file to create or append to with
   
 the contents of the dump.
   

Description:

Examples:

    . DUMP CUSTOMER.NTX TO CUSTNTX.TXT
   

   

   

See Also:

EDIT

Invoke full-screen editing of the current database

Syntax:

Arguments:

    CLEAR will clear any previously configured edit window for the
   
 current work area and create an edit window with the default
   
 configuration using the full screen and all fields.
   

   
 CLEAR ALL will clear all edit windows for all work areas.
   

   
 FIELDS (fields) is a list of fields to edit.  If no field
   
 list is passed, then all fields will be included in the
   
 edit screen.
   

   
 PROTECT will protect data from being modified by the user.
   

   

Description:

See Also:

EDIT DELETE

Delete an Edit configuration in the Edit Dictionary

Syntax:

Arguments:

    (cConfig) is the Tag Name of the Edit Configuration to
   
 delete.  If no argument is passed then a pick-list of all
   
 Edit configurations will be displayed.
   

   

   

Description:

Examples:

    . EDIT DELETE myedit
   

   

Source/Library:

See Also:

EDIT FILE

Edit any text file

Syntax:

Arguments:

    (file name) is the name of the ascii text file to edit.  You
   
 may precede the name with a drive and/or directory name and you
   
 must include the extension if it exists.  If the file does not
   
 already exist it will be created.
   

   
 If an extension is not used, then the extension .PRG is assumed
   
 and the search directory is assumed to be the directory
   
 established by the SET PDIR command or PDIR=(directory) command
   
 in DCLIP.SYS.
   

   
 (nLineNumber) will cause the editor to jump to the
   
 (nLineNumber) after it opens the file.
   

   
 /S will write the contents of the screen (as it was displayed
   
 before invoking the dot-prompt) to a file named DCLIP.SCR.
   

   

Description:

Examples:

    . SET PDIR TO \MYPROGS
   
 . EDIT MAIN
   

   

See Also:

EDIT MEMO

Edit the contents of a memo field

Syntax:

Arguments:

    (cField) is the name of the memo field to edit.
   

   
 NONE - if no field name is given then the first memo field in
   
 the data file will be edited.
   

   

Description:

Examples:

    . USE DCHELP
   
 . EDIT MEMO ARGS
   

   

See Also:

EDIT PRG

Edit contents of currently executing program source file

Syntax:

Description:

Examples:

    . MAP LOAD MYAPP
   
 . DO MAINMENU
   

   
 // Press the ALT-D key while running the application to get
   
 // a dot prompt.
   

   
 : EDIT PRG   // edit source code that contains MAINMENU
   
 : (enter)    // return to application
   

   

   

   

See Also:

EDIT RESTORE

Edit a database using a pre-defined Configuration

Syntax:

Arguments:

    (xcFileName) is the name of the configuration file that was
   
 previously created with the "Save Configuration" selection from
   
 the FILE OPTIONS menu of the Editing Screen.
   

   

Description:

Examples:

    . USE CUSTOMER
   
 . BROWSE CUST_NAME, BALANCE
   

   

See Also:

EDIT TILE

Edit multiple work areas with tiled windows

Syntax:

Arguments:

    WINDOW (mode) is an optional argument for defining the method
   
 to display the editing windows being opened for the relational
   
 editing.
   

   
 Mode
   

   
  1  Four windows ( screen split in half vertically and
   
     horizonally )
   
  2  Four windows ( screen split horizontally )
   
  3  Three windows ( screen split horizontally )
   
  4  Two windows ( screen split vertically )
   
  5  Two windows ( screen split horizontally )
   
  6  Six windows ( three across / two down )
   

   
 If no WINDOW (mode) argument is given, then a set of windows
   
 will automatically be created in a "best-fit" screen
   
 configuration.
   

   
 (aliases...) is a list of datafile aliases (separated by
   
 commas) to edit.  The database files for each alias given must
   
 already be opened.  If no (aliases) are listed then all open
   
 databases will be included.
   

   

Description:

Examples:

    . USE ALL LIKE DC*
   
 . EDIT TILE WINDOW 3
   
 . CLOSE ALL
   
 . USE ALL
   
 . EDIT TILE CUSTOMER, INVOICE, SALES
   

   

   

Source/Library:

See Also:

EDIT VIRTUAL

Edit the Virtual record

Syntax:

Arguments:

    NONE.
   

   

Description:

Examples:

    . USE CUSTOMER
   
 . GO 10
   
 . SAVE VIRTUAL
   
 . EDIT VIRTUAL
   
 . GO 20
   
 . REPLACE WITH VIRTUAL
   

   

EJECT

Advance the print head to top of form

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

ENABLE

Enable a command set

Syntax:

Arguments:

    (cCommandSet) is the name of the .CH or .OBJ file as is was
   
 loaded with the INCLUDE...CH or INCLUDE...OBJ command.
   

   
 WHEN (lExpression) is an optional expression to evaluate before
   
 scanning a command set.  This is an expression that returns a
   
 logical value. Use this option when you want to enable a
   
 command set only under certain conditions.  For example, let's
   
 say that you wish to call your own browse function with the
   
 BROWSE command only when a specified file is opened in the
   
 currently selected work area, rather than the dCLIP
   
 dc_browsedb() function.  See the example below for how to use
   
 this feature.
   

   

Description:

Examples:

    . INCLUDE MYBROWSE
   
 . ENABLE MYBROWSE WHEN ALIAS() = "MYMAIL"
   

   

See Also:

ERASE

Remove a file from the disk

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

EVENT

Establish event for evaluation after each dot command

Syntax:

Arguments:

    (expression) is an expression which will be evaluated after
   
 each dot prompt command is entered.
   

   
 WHEN (lExpression) is an optional parameter which must evaluate
   
 .True. for the event to be processed.
   

   
 NONE - If no arguments are given then EVENT will display the
   
 status of all current active events with a number to identify
   
 the event.
   

   

Description:

Examples:

    // Display the current row/column of tbrowse object X
   
 . EVENT EVAL({||DEVPOS(22,2), ;
   
         DEVOUT('Row:'+LTRIM(STR(X:ROWPOS))+ ;
   
                'Col:'+LTRIM(STR(X:COLPOS)))})
   

   
 . EVENT QOUT(TIME())  // Display the time after each command
   

   
 . OBJ MYSTATUS PERM   // load the object with MYSTATUS()
   
                       // function
   

   
 . EVENT MYSTATUS() WHEN !EMPTY(ALIAS())  // display status
   

   

   

   

   

EVENT CLEAR

Clear specified event triggers

Syntax:

Arguments:

    (number) is the order of the event in the active event stack.
   
 To determine the number of an event, use the command EVENT with
   
 no arguments to display the event status.
   

   
 ALL will clear all events.
   

   

Description:

Examples:

    . EVENT CLEAR 3
   
 . EVENT CLEAR ALL
   

   

See Also:

EXCLUDE

Remove an previously loaded .CH file from memory

Syntax:

Arguments:

    (cCHfile) is the name of a *.CH file which was previously
   
 loaded with the INCLUDE or #INCLUDE command.
   

   
 ALL will unload all *.CH files.
   

   

Description:

Examples:

    // ET.CH contains:
   
 //  #define HOME 714-263-1011
   
 //  #translate PHONE (num) =) ;
   
                DC_OBJLOAD(DIALOUT) ; DIALOUT(((num)))
   

   
 . INCLUDE ET
   
 . PHONE HOME
   
 . EXCLUDE ET
   

   

See Also:

FIELD DELETE

Delete a Field Group from the Field Dictionary

Syntax:

Arguments:

    (cFieldGroup) is the name of the field group in DCFIELDS.DBF
   
 to delete (up to 8 characters).  If no parameter is passed
   
 then a pick-list of available groups will be displayed.
   

   

   

Description:

Notes:

Examples:

    // Delete field group "CUSTOMER"
   
 FIELD DELETE CUSTOMER
   

   

Source/Library:

FIELD EDIT

A Database Field Definition editor

Syntax:

Arguments:

    (cFieldGroup) is the name of the field group in DCFIELDS.DBF
   
 to load and edit (up to 8 characters).  If no parameter is
   
 passed then a pick-list of available groups will be displayed.
   

   

   

Description:

Notes:

Examples:

    -- Example 1 --
   
 // Load a field group from the dictionary and edit it //
   
 FIELD EDIT
   

   
 -- Example 2 --
   
 // Edit field group "CUSTOMER"
   
 FIELD EDIT CUSTOMER
   

   

   

Source/Library:

See Also:

FILE DELETE

Delete a File Group from the File Dictionary

Syntax:

Arguments:

    (cFileGroup) is the name of the file group in DCFILES.DBF
   
 to delete (up to 8 characters).  If no parameter is passed
   
 then a pick-list of available groups will be displayed.
   

   

   

Description:

Notes:

Examples:

    // Delete file group "CUSTOMER"
   
 FILE DELETE CUSTOMER
   

   

Source/Library:

FILE EDIT

A Database File / Work area Definition editor

Syntax:

Arguments:

    (cFileGroup) is the name of the file group in DCFILES.DBF
   
 to load and edit (up to 8 characters).  If no parameter is
   
 passed then a pick-list of available groups will be displayed.
   

   

   

Description:

Notes:

Examples:

    -- Example 1 --
   
 // Load a file group from the dictionary and edit it //
   
 FILE EDIT
   

   
 -- Example 2 --
   
 // Edit file group "CUSTOMER"
   
 FILE EDIT CUSTOMER
   

   

Source/Library:

See Also:

FILE RESTORE

Open a set of database files and indexes from a File Group

Syntax:

Arguments:

    (cFileGroup) is the name of the file group in DCFILES.DBF
   
 to open (up to 8 characters).  If no parameter is passed
   
 then a pick-list of available groups will be displayed.
   

   
 ADDITIVE will open the files without closing any existing
   
 files, otherwise all files will be closed first.
   

   

Description:

Notes:

Examples:

    // Restore file group "CUSTOMER"
   
 FILE RESTORE CUSTOMER ADDITIVE
   

   

   

Source/Library:

See Also:

FILE SAVE

Save all work areas to the File Dictionary

Syntax:

Arguments:

    (cFileGroup) is the name of the file group in DCFILES.DBF
   
 to open (up to 8 characters).  If no parameter is passed
   
 then a pick-list of available groups will be displayed.
   

   
 ADDITIVE will open the files without closing any existing
   
 files, otherwise all files will be closed first.
   

   

Description:

Examples:

    use customer index custname,custnmbr
   
 use invoice new index invoice
   
 select customer
   
 set relation to cust_nmbr into invoice
   
 FILE SAVE CUSTOMER
   

   

   

Source/Library:

See Also:

FIND

Search an index for a specified key value

Syntax:

Arguments:

    (xcSearchString) is part or all of the index key of a record to
   
 search for and can be specified either as a literal string or
   
 as a character expression enclosed in parentheses.  If an
   
 expression is specified instead of a literal string, FIND
   
 operates the same as SEEK.
   

   
 NONE - If no argument is given then FIND will call the
   
 DC_FIND() function to provide a menu-driven utility which will
   
 list all open index keys or tags.
   

   

Description:

Examples:

    . USE BASEBALL INDEX TEAM
   
 . FIND DODGERS
   
 . USE BASEBALL FOX INDEX BASEBALL.CDX
   
 . FIND
   

   

   

See Also:

FOR

Execute a set of expressions for a range of numbers

Syntax:

Arguments:

    (nVar) is the name to assign to the variable which will be
   
 incremented starting at (nStart) and ending at (nEnd).
   

   
 (nStep) is the incremental value.  The default is 1.
   

   
 (exp1) - (expN) is a set of expressions to evaluate.
   

   
 (lCondition) is an expression which must evaluate to .true. to
   
 continue the loop, otherwise the loop will be terminated.
   

   

Description:

Examples:

    . FOR i = 1 TO 100 STEP 5 DO QOUT(i)
   
 . USE BASEBALL
   
 . FOR i = 1 TO 10 DO QOUT(PLAYER),DBSKIP() WHILE !EOF()
   

   

   

   

See Also:

GATEWAY

Pop up a menu of other DOS programs to execute

Syntax:

Arguments:

    (cMenuItem) = A,B,C,E,F,G,I,J,K,L,N,O,P,R,T,U,V,W,X,Y,Z,1,2 3
   

   
 If no parameters are passed,the user is given a friendly
   
 menu in which to select the desired program or to configure
   
 his/her own gateway system for up to 24 different programs.
   

   
 The DCGATE.DBF files stores the information about the COMMAND,
   
 DIRECTORY, MEMORY NEEDED, SWAP DRIVE, etc. to allow quick
   
 access to other DOS programs.
   

   
 All the instructions for configuring the gateway are in the
   
 pop-up menu.
   

   
 IF a (menu letter) is passed, then the selected program as
   
 defined by the (menu letter) will be executed.
   

   

   

Description:

Notes:

Examples:

    . GATEWAY
   
 . GATEWAY C
   

   

See Also:

GO[TO]

Move the record pointer to a specified record

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

HELP

Display help for a specified command or function

Syntax:

Arguments:

    (cFunction) is an optional value which can be entered as a
   
 subset  of the complete command and all commands or functions
   
 which start with the entered (command) string will be
   
 displayed.  A listing of all commands and which match the
   
 (cFunction) value will be output to the screen.
   

   
 NONE -  IF no (cFunction) argument is entered then HELP will
   
 enter a menu-driven help-management system which is an open
   
 window into the DCHELP.* database files which contain the help
   
 data.  From this menu, you can add new commands or functions,
   
 search, print, edit or view any command or function.
   

   
 INCLUDE will pop-up a scrollable listing of all commands which
   
 were loaded by the INCLUDE command or the TRANSLATE command.
   

   

Description:

Notes:

Examples:

    . HELP
   
 . HELP USE
   
 . HELP DC_GATE
   
 . INCLUDE ET
   
 . HELP INCLUDE
   

   

See Also:

HUNT

Search all Index Tags for the first match of value entered

Syntax:

Arguments:

    (xValue) is the value to HUNT.  This can be a value or an
   
 expression. If entered as an expression ( includes quotes or
   
 parenthesis ) it will be evaluated and converted to the proper
   
 value before performing the seek.  If entered as a literal
   
 argument, then a "smart" process in invoked which will
   
 determine the type of argument based on the kind of information
   
 entered.
   

   

Description:

Notes:

Examples:

    . USE MAILLIST
   
 . INDEX FIELDS LAST, FIRST, COMPANY, MAIL_DATE, SOURCE ;
   
                TO MAILLIST.CDX
   
 . HUNT COMP
   
 . RESUME
   
 . HUNT DATE()
   
 . HUNT LARRY
   
 . HUNT EGGHEAD
   

   

Source/Library:

See Also:

IF

Evaluate a list of expressions if a condition is true

Syntax:

Arguments:

    (lCondition) is an expression which is evaluated.  If
   
 (lCondition) is .true. then (explist1) is evaluated, otherwise
   
 (explist2) is evaluated.
   

   
 (exp1) - (expN) are lists of expressions to evaluate.
   

   

   

   

   

Description:

Examples:

    . IF EMPTY(CUST_CODE) ;
   
            DO FIELDPUT(FIELDPOS('CUST_CODE'),'USER')
   

   
 . IF !EMPTY(ALIAS()) DO DBPACK()
   

   

See Also:

IF...GOLINE

Go to specified line in .DCB file if expression is true

Syntax:

Arguments:

    (lExpression) - A logical condition which must be true for the
   
 branch to occur.
   

   
 (cLabel) - The name of any label in a batch file which is
   
 preceded by a colon (:).
   

   

   

Description:

Notes:

Examples:

   
   
 . BATCH TEST
   

   
 // Contents of TEST.DCB:
   

   
 :START
   
 USE CUSTOMER
   
 BROWSE
   
 IF EOF() GOLINE END
   
 EDIT
   
 :END
   
 CLOSE
   

   

IMPORT CREATE

Create a field replacement map (.DCF) file

Syntax:

Arguments:

    (cMapFile) is the name of the Field Map file to create.  If no
   
 extension is given, then .DCF is assumed.
   

   
 FROM (cImportAlias) designates the alias name of the database
   
 that will be used to import data from.
   

   
 TO (cTargetAlias) is the alias name of the database that will
   
 be used to import data to.
   

   
 NOTE: (cImportAlias) and (cTargetAlias) may be the same.  This
   
       would accomodate the COPYING of information from one
   
       field to another using the DC_COPY() function within the
   
       same database.
   

   

Description:

Examples:

    // Open Sales.dbf
   
 . USE SALES
   

   
 // Open Transactions file from Paradox application
   
 . USE TRANSACT NEW VIA 'PDX'
   

   
 // Create the Transact.dcf Field Map file
   
 . IMPORT CREATE TRANSACT FROM TRANSACT TO SALES
   

   
 // Import today's transactions from Transact.db to Sales.dbf
   
 . SELECT SALES
   
 . IMPORT FROM TRANSACT MAP TRANSACT FOR DATE = DATE()
   

   

See Also:

IMPORT FROM

Import data from another work area via a field map

Syntax:

Arguments:

    (cAlias) is the alias name of another database to import
   
 records from.
   

   
 (xcMapFile) is the the name of a Field Map file (.DCF) to use
   
 to determine how information from the (cAlias) database will be
   
 imported to the current database.  If no map file is specified
   
 then a menu will pop-up to match fields for importing.
   

   
 FOR (lCondition) specifies the conditional set of records to
   
 import with the given scope.
   

   
 WHILE (lCondition) specifies the set of records meeting the
   
 condition from the current record until the condition fails.
   

   
 NEXT (nRecords) is the number of records to import starting
   
 from the current record.
   

   
 RECORD (nRecord) the number of a single record to import.
   

   
 REST specifies the set of records starting from the current
   
 record to the end of the file.
   

   
 ALL specifies all records in the file meeting the FOR
   
 (condition).
   

   

   

Description:

Examples:

    . IMPORT CREATE MAILLIST
   
 . USE MAILLIST VIA 'DBFFOX'
   
 . SELE 0
   
 . USE NEWLEADS VIA 'DBFNTX'
   
 . SELE MAILLIST
   
 . IMPORT FROM NEWLEADS MAP MAILLIST FOR ZIP_CODE = '9'
   

   

See Also:

IMPORT LOAD

Load an Import Map (.DCF) file

Syntax:

Arguments:

    (xcMapFile) is the name of a Field Map file (.DCF) to use to
   
 determine how information from the (cAlias) database will be
   
 imported to the current database.  This map file is created
   
 with the IMPORT CREATE command or DC_IMPCREATE() function.
   

   

Description:

Examples:

    . use dcusers         // registered users database
   
 . use customer new    // customer database
   

   
 // map customer.dbf fields to dcuser.dbf fields
   
 . import create dcusers from customer to dcusers
   

   
 . IMPORT LOAD DCUSERS  // load dcusers.dcf map file
   
 . select customer
   
 . browse  // select a record to import to dcusers.dbf
   
 . select dcusers
   
 . append import
   

   

See Also:

INCLUDE DEFAULT

Load Default Clipper .CH set(s)

Syntax:

Arguments:

    (SetName) is the name of the set to load.
   

   
 If none is given then all *.CH sets will be loaded.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 . ? K_ESC
   
 Variable does not exist  Base[1003]
   

   
 . INCLUDE DEFAULT INKEY
   
 . ? K_ESC
   
 27
   

   

   
 -- Example 2 --
   

   
 . INCLUDE DEFAULT FILEIO
   
 . nHandle := FOPEN( "DCLIP.SYS", FO_READWRITE )
   

   

Source/Library:

See Also:

INCLUDE...CH

Load a .CH file for use with preprocessor

Syntax:

Arguments:

    (cCHfile)[.CH] is the name of a file with pre-processor
   
 directives such as #command, #define, #xtranslate, etc.  If a
   
 path is not given then the path defined in the SET
   
 INCLUDE=(path) dos environment variable will be searched.
   

   
 TO (cPrgFile) will "convert" the pre-processor directives to a
   
 .PRG file that can be "compiled" and loaded into memory with
   
 the INCLUDE..OBJ command.  The INCLUDE..OBJ command will load a
   
 .OBJ directive file much faster than the INCLUDE..CH command
   
 will load a .CH file.
   

   
 NO ARGUMENTS will display the current status of command sets
   
 that are currently loaded.
   

   

Description:

Notes:

Examples:

    // ET.CH contains:
   
 //  #define HOME 714-263-1011
   
 //  #translate PHONE (num) =) ;
   
                DC_OBJLOAD(DIALOUT) ; DIALOUT(((num)))
   

   
 . INCLUDE ET
   
 . PHONE HOME
   
 . EXCLUDE ET
   

   

See Also:

INCLUDE...OBJ

Load a "compiled" .CH file for use with preprocessor

Syntax:

Arguments:

    (cOBJfile)[.OBJ] is the name of an object file that was
   
 compiled from a .PRG file created with the INCLUDE..CH..TO
   
 command.
   

   
 If a path is not given  then the directory defined in the SET
   
 ODIR environment variable will be searched.
   

   

Description:

Examples:

    // ET.CH contains:
   
 //  #define HOME 714-263-1011
   
 //  #translate PHONE (num) =) ;
   
                DC_OBJLOAD(DIALOUT) ; DIALOUT(((num)))
   

   
 . INCLUDE ET TO ET.PRG
   
 . CLIPPER ET
   
 . INCLUDE ET.OBJ
   
 . PHONE HOME
   

   

See Also:

INDEX FIELDS

Create index tags for specified set of fields in a database

Syntax:

Arguments:

    FIELDS (list) is a list of index tag names to create.  The tag
   
 name(s) must be the same as the name(s) of valid fields in the
   
 current work area. If no FIELD list is given then tags for ALL
   
 fields will be created.
   

   
 LENGTH (nLength) is an optional argument only to determine the
   
 maximum length of character type indexes.  For example, if you
   
 have a character field of 100 bytes, you most likely will not
   
 want to index on all 100 bytes, but instead on only the first
   
 10 characters.  If this argument is not passed, then a default
   
 length of 10 will be used.  If the length of any character
   
 field is less than (nLength) then the index length for that
   
 specific tag will be the field length.
   

   
 (xcIndex) is the name of the Combined Index file to create.  If
   
 no extension is given, then if the default extension for
   
 combined indexes supported by the Data driver in use will be
   
 appended.
   

   
 If no (xcIndex) name is given, then the index will be created
   
 using the same prefix as the open database and with the default
   
 extension for combined indexes supported by the Data driver in
   
 use.
   

   

Description:

Examples:

    . USE MAILLIST VIA 'DBFSIX'
   
 . INDEX FIELDS LAST, COMPANY, SOURCE TO MAILLIST.CDX
   
 . HUNT SCOTT
   

   

See Also:

INDEX...TAG

Create a new index tag and add it to a .CDX index file

Syntax:

Arguments:

    (expKey) is an expression that returns the key value to place
   
 in the index for each record.  The expression can be any valid
   
 Clipper expression (including UDF's) with a value whose type is
   
 character, date, logical or numeric.
   

   
 TAG (cTagname) specifies the name of a new tag for a compound
   
 index (.CDX). The name can be up to 10 characters long with the
   
 same requirements as field names.
   

   
 OF (xcCombinedIndex) specifies the .CDX (DBFCDX/DBFSIX) or .MDX
   
 (DBFMDX) that the specified tag is to be created in.  If
   
 (xCombinedIndex) is not specified, then the new tag is added to
   
 the .CDX/.MDX file with the same name as the table (also known
   
 as a Structural or auto-open .CDX/.MDX).   The specified (or
   
 implied) .CDX/.MDX file is created if it does not already
   
 exist.
   

   
 FOR (lCondition) is an expression that returns a logical value
   
 (.T. or .F.) to determine whether of not a key is included in
   
 the index. Any valid Clipper expression (including UDF's) can
   
 be used.
   

   
 ASCENDING (default) specifies that the index should be built in
   
 ascending order.
   

   
 DECENDING specifies that the index should be built in
   
 descending order.
   

   
 UNIQUE specifies that only unique keys are to be included in
   
 the index.
   

   
 USECURRENT allows you to leave the current index active while
   
 creating a new index file.  This effectively gives you the
   
 ability of creating "subindexes" based on other conditional
   
 indexes.  Very handy on networks or large datafiles!
   
 (Supported with DBFSIX driver only).
   

   
 OPTION (expUDF) is an expression (normally a UDF) that is
   
 evaluated for each record indexed.  This allows the program to
   
 display an Index-o-meter without having the UDF embedded in the
   
 index expression. (Supported with DBFSIX driver only).
   

   
 The expression is first eval'd at the beginning of the index
   
 process, with the record pointer positioned at EOF.  The
   
 following eval's take place at record 1, 2, etc.  The record
   
 number can be tested within your UDF using RECNO().
   

   
 STEP (nRecs) is used to specify how often the OPTION expression
   
 will be eval'd.  (nRecs) is a numeric value representing the
   
 number of records that will be processed before the OPTION
   
 expression is evaluated.  For example:
   

   
   INDEX ON LNAME TO LNAME OPTION MyFunc() STEP 10
   

   
 In this example MyFunc() would be called every 10 records.  The
   
 default step value is 1.
   

   

Description:

Notes:

Examples:

    . USE CUSTOMER FOX
   

   
 . INDEX ON CUST_NMBR TAG CUSTNMBR OF CUSTOMER
   

   
 . INDEX ON CUR_BAL TAG BALANCE FOR CUR_BAL ) 0
   

   
 . INDEX ON PHONE TAG 714 FOR PHONE='714' ;
   
            USECURRENT OPTION SHOWPROGRESS()
   

   
 . INDEX ON PHONE TAG 619 FOR PHONE='619' ;
   
            USECURRENT OPTION SHOWPROGRESS()
   

   

INDEX...TO

Create a new index file

Syntax:

Arguments:

    (expKey) is an expression that returns the key value to place
   
 in the index for each record.  The expression can be any valid
   
 Clipper expression (including UDF's) with a value whose type is
   
 character, date, logical or numeric.
   

   
 TO (cIndexFile) specifies the name of the index to create.
   
 This clause is used to create an a single index.  The type of
   
 index created will be determined by the current RDD (data
   
 driver) selected via the SET RDD TO command.  For example, if
   
 the RDD is DBFSIX, then the index will be an .IDX style index.
   
 If the RDD is DBFNTX (default driver) then the index will be an
   
 .NTX style index.  If no (cIndexFile) name is given then an
   
 index file of the same prefix as the file alias will be
   
 created.
   

   
 UNIQUE specifies that only unique keys are to be included in
   
 the index.
   

   
 The following arguments can be used only with the "DBFSIX" RDD:
   

   
 FOR (expCondition) is an expression that returns a logical
   
 value (.T. or .F.) to determine whether of not a key is
   
 included in the index. Any valid Clipper expression (including
   
 UDF's) can be used.
   

   
 DECENDING specifies that the index should be built in
   
 descending order.
   

   
 ASCENDING (default) specifies that the index should be built in
   
 ascending order.
   

   
 USECURRENT allows you to leave the current index active while
   
 creating a new index file.  This effectively gives you the
   
 ability of creating "subindexes" based on other conditional
   
 indexes.  Very handy on networks or large datafiles!
   

   
 OPTION (expUDF) is an expression (normally a UDF) that is
   
 evaluated for each record indexed.  This allows the program to
   
 display an Index-o-meter without having the UDF embedded in the
   
 index expression.
   

   
 The expression is first eval'd at the beginning of the index
   
 process, with the record pointer positioned at EOF.  The
   
 following eval's take place at record 1, 2, etc.  The record
   
 number can be tested within your UDF using RECNO().
   

   
 STEP (nRecs) is used to specify how often the OPTION expression
   
 will be eval'd.  (nRecs) is a numeric value representing the
   
 number of records that will be processed before the OPTION
   
 expression is evaluated.  For example:
   

   
  INDEX ON LNAME TO LNAME OPTION MyFunc() STEP 10
   

   
 In this example MyFunc() would be called every 10 records.  The
   
 default step value is 1.
   

   

   

Description:

Notes:

Examples:

    . USE CUSTOMER
   

   
 . INDEX ON CUST_NMBR TO  CUSTNMBR
   

   
 . INDEX ON NAME TO CUSTNAME
   

   
 . SET INDEX TO CUSTNAME, CUSTNMBR
   

   

INKEY

Display the INKEY() and LASTKEY() value of pressed keys

Syntax:

Description:

See Also:

INPUT

Enter the result of keyboard input into a variable

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

INSERT

Insert blank or virtual records into current database

Syntax:

Arguments:

    (nRecords) is the number of new records to insert.
   

   
 VIRTUAL option will replace all new records with the value of
   
 the virtual record created by using the SAVE VIRTUAL command.
   

   

Description:

Examples:

    . INSERT 20
   
 . INSERT VIRTUAL 5
   

   

   

See Also:

JOIN

Join two databases together

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

KEY CLEAR

Clear Set-Keys previously loaded from Key Dictionary

Syntax:

Arguments:

    (cKeyGroup) is an 8-character name that defines the key group
   
 to clear.  This must be a group that was previously loaded
   
 with the DC_KEYLOAD() function or KEY LOAD command.
   

   
 If no argument or ALL is passed then all Setkeys() that were
   
 loaded via all calls to KEY LOAD will be restored to their
   
 original value.
   

   

Description:

Examples:

   
   
 KEY LOAD MYKEYS
   
 DO SOMETHING
   
 KEY CLEAR ALL
   

   

Source/Library:

See Also:

KEY DELETE

Delete a Key Group from the Key Dictionary

Syntax:

Arguments:

    (cKeyGroup) is an 8-character name that defines the key group
   
 to deleteg from the Key Dictionary file.
   

   
 If no parameter is passed, then a pick-list of Key Groups
   
 (in the Key Dictionary) will be displayed.
   

   

Description:

Examples:

    KEY DELETE MYKEYS
   

   

Source/Library:

See Also:

KEY DISPLAY

Display the contents of function keys

Syntax:

Description:

See Also:

KEY EDIT

Edit the contents of a Key Group in the Key Dictionary

Syntax:

Arguments:

    (cKeyGroup) is the name of the Key Group contained in the
   
 DCKEY.DBF Key Dictionary file.  Each Key Group is defined
   
 by up to 8 characters.  If no parameter is passed then a
   
 pick-list of all Key Groups will be displayed.
   

   

Description:

Notes:

Examples:

    . KEY EDIT MYKEYS
   
 . key load MYKEYS
   

   

See Also:

KEY FILE

Establish the file and alias name for the Key Dictionary

Syntax:

Arguments:

    (cKeyFile) is the name that defines the database file to
   
 be used as the Key Dictionary file.  The default file name
   
 is DCKEY.DBF and the alias is DCKEY.  If the file doesn't
   
 exist it will be created.
   

   
 (cKeyAlias) is the alias name (up to 8 characters) to use.
   
 If this parameter is not passed, then the alias will be
   
 given the same name as (cKeyFile).
   

   

Description:

Notes:

Examples:

    KEY FILE C:\MYDATA\MYKEYS.DBF
   

   
 key load DEFAULT     // Load Default keys
   
 DO something
   
 key clear
   

   

Source/Library:

See Also:

KEY HELP

Display the status of Keys that are loaded

Syntax:

Arguments:

    None.
   

   

Description:

Examples:

    key load FUNCTION     // Load Function keys
   
 key load MAIN         // Load Main keys
   
 KEY HELP
   

   

Source/Library:

See Also:

KEY LOAD

Load SET KEYS from a Key Group in the Key Dictionary

Syntax:

Arguments:

    (cKeyGroup) is an 8-character name that defines the key group
   
 to load from the Key Dictionary file.  If the Key Group does
   
 not exist in the DCKEY.DBF dictionary file, then if an
   
 array file named (cKeyGroup).DCK does exist, it will be
   
 used to load the keys.
   

   

Description:

Notes:

Examples:

    . KEY EDIT MYKEYS.DBF
   
 . KEY LOAD MYKEYS.DBF
   

   

See Also:

KEYBOARD

Load a string of characters into the keyboard buffer

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

LABEL FORM

Display labels to the printer or console

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

LIB LOAD

Load a dynamic library

Syntax:

Arguments:

    (dynamic library name)  is a dynamic library file that contains
   
 a related set of Clipper-compiled object files and search
   
 tables. This is usually a complete Clipper application or a set
   
 of routines which may be used by different applications.  The
   
 file must have the extension .DLB and must be created using the
   
 DLIB.EXE utility program.   The file name may be preceded by a
   
 drive and/or directory name and does not require the .DLB
   
 extension.
   

   

Description:

Notes:

Examples:

    . LIB LOAD MYAPP
   
 . DO MAIN
   

   

See Also:

LIB UNLOAD

Unload a dynamic library

Syntax:

Arguments:

    (dynamic library name)  is a dynamic library file that was
   
 previously loaded with the LIB LOAD command.
   

   

Description:

Examples:

    . LIB LOAD MYAPP
   
 . DO MAIN
   
 . LIB UNLOAD MYAPP
   

   

See Also:

LIST

List records to the console

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

LOCATE

Search for a record matching a condition

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

Description:

See Also:

LOCK

Lock the current record or file

Syntax:

Description:

Examples:

    . USE CUSTOMER SHARED
   
 . LOCK FILE
   
 . DELE ALL
   
 . UNLOCK
   

   

See Also:

LOCK EDIT

Maintain the "Lock" definition database

Syntax:

Arguments:

    None
   

   

Description:

Examples:

    LOCK EDIT
   

   

   

Source/Library:

See Also:

LOG

Write workarea, memory, and environment status to a log file

Syntax:

Arguments:

    TO (file) is used to rout the output to a specified file name.
   
 If no argument is given, then an input menu will appear
   
 prompting the user for the name of the file.
   

   

Description:

Examples:

    . LOG TO MYLOG.TXT
   

   

See Also:

MAKEDLIB

Create a dynamic library from a set of .OBJ files

Syntax:

Arguments:

    (dynamic library name)  is a dynamic library file that contains
   
 a related set of Clipper-compiled object files and search
   
 tables. This is usually a complete Clipper application or a set
   
 of routines which may be used by different applications.  The
   
 file must have the extension .DLB and must be created using the
   
 DLIB.EXE utility program.   The file name may be preceded by a
   
 drive and/or directory name and does not require the .DLB
   
 extension.
   

   
 (wildcard.OBJ) is the list of .OBJ files to include in the new
   
 dynamic library.  If this argument is not given, then all .OBJ
   
 files will be included.
   

   

Description:

Examples:

    . MAKEDLIB MYAPP
   

   

MAP ADD

Add a procedure to a Map file

Syntax:

Arguments:

    (file) is the name of the .LST (map) file to create or append.
   

   
 (source file) is the name of the .PRG or .OBJ file that
   
 contains the procedure to add to the map file.
   

   
 (procedure1) - (procedureN) is a list of public
   
 procedure/function names contained in the (source file).
   

   

Description:

Examples:

    // MYMENUS.OBJ contains MAINMENU() function
   

   
 . DO MAINMENU  // causes "can't find object MAINMENU" error
   
 . MAP ADD MYAPPS SOURCE MYMENUS PROC MAINMENU
   
 . DO MAINMENU
   

   

See Also:

MAP CREATE

Create a Map file by scanning a set of .OBJ or .PRG files

Syntax:

Arguments:

    OBJ specifies that the files to scan are clipper-compiled .OBJ
   
 files.
   

   
 PRG specifies that the files to scan are clipper source code
   
 .PRG files.
   

   
 (map file) is the name of the ASCII text file to create.
   

   
 LIST (list file)    specifies the name of an ASCII text file
   
 with a listing of the files to scan.  The list file is
   
 constructed as follows:
   

   
  MAIN.OBJ
   
  MYFUNCS.OBJ
   
  MYPROCS.OBJ
   

   
  or
   

   
  MAIN.PRG
   
  MYFUNCS.PRG
   
  MYPROCS.PRG
   

   
 (wildcard) will define a subset of files in the current
   
 directory to scan.   If neither a (list file) or (wildcard)
   
 argument is given, then all .OBJs in the current directory or
   
 directory identified by the SET ODIR command will be scanned,
   
 or all .PRGs in the current directory or directory identified
   
 by the SET PDIR command will be scanned.
   

   

Description:

Examples:

    . MAP OBJ MYAPPS LIST MYAPPS
   
 . MAP LOAD MYAPPS
   
 . DO MAIN
   
 . MAP OBJ MYAPP2 MA2*.OBJ
   
 . MAP LOAD MYAPPS2
   
 . DO MAIN2
   

   

See Also:

MAP LOAD

Load a Map file into memory

Syntax:

Arguments:

    (file name) is the name of the map file to load.  If no
   
 extension is given, then the .LST extension is assumed.
   

   

Description:

Examples:

    . MAP OBJ MYAPPS
   
 . MAP LOAD MYAPPS
   
 . DO MAIN
   

   

See Also:

MAP UNLOAD

Unload a Map file from memory

Syntax:

Arguments:

    (map file) is the name of the .LST file to unload.
   

   
 ALL - unload all map files.
   

   

Description:

Examples:

    . MAP LOAD MYAPP
   
 . DO MAIN
   
 . MAP UNLOAD ALL
   

   

See Also:

MEMO COPY

Copy a memo field from one database to another

Syntax:

Arguments:

    TO (field) - The name of the memo field in the currently selected
   
 database to copy to.
   

   
 FROM (field) - The name of the memo field in the import database
   
 to copy from.
   

   
 REFERENCE (ref) - The name of any other field in the import database
   
 to use as a reference in the browse-screen that is displayed to
   
 choose the memo to copy.
   

   
 FILE (file) - The name of the file group in DCFILES to use to select
   
 or open a file for importing from.
   

   
 RECORD (rec) - The record number of the import file containing the
   
 memo to copy.
   

   
 MODE (mode) - The append mode.  A - Append (default), I - Insert,
   
 R - Replace.
   

   
 INSERT (text) - Optional text to insert at the beginning of the
   
 memo being copied.
   

   
 APPEND (text) - Optional text to insert at the end of the memo
   
 being copied.
   

   

Returns:

    A logical .TRUE. if the copy was successful.
   

   

Description:

See Also:

MEMO EXPORT

Export a memo field to an ascii text file

Syntax:

Arguments:

    (cMemoField) is the name of the memo field of the currently
   
 selected work area to export.
   

   
 (cTextFile) is the name of the text file to export to.  If left
   
 blank, then a window will pop up to prompt for the name of the
   
 file.
   

   
 REPLACE | INSERT are optional parameters to designate how the
   
 export is to be accomplished.  REPLACE will replace the current
   
 contents of the text file with the contents of the memo field.
   
 INSERT will insert the contents of the memo field ahead of the
   
 current contents of the text file. If no argument is given,
   
 then the contents of the memo field will be APPENDED to the
   
 current contents of the text file.
   

   

Description:

Examples:

    . USE DCHELP
   
 . MEMO EXPORT EXAMPLES TO EXAMPLES.PRG
   
 . SKIP
   
 . MEMO EXPORT EXAMPLES TO EXAMPLES.PRG
   

   

See Also:

MEMO IMPORT

Import an ascii text file to a memo field

Syntax:

Arguments:

    (cMemoField) is the name of the memo field of the currently
   
 selected work area to import to.
   

   
 (cTextFile) is the name of the text file to import.  If left
   
 blank, then a window will pop up to prompt for the name of the
   
 file.
   

   
 REPLACE | INSERT are optional parameters to designate how the
   
 import is to be accomplished.  REPLACE will replace the current
   
 contents of the memo field with the contents of the text file.
   
 INSERT will insert the contents of the text file ahead of the
   
 current contents of the memo field.  If no argument is given,
   
 then the contents of the text file will be APPENDED to the
   
 current contents of the memo field.
   

   

   

Description:

Examples:

    . USE DCHELP
   
 . MEMO IMPORT EXAMPLES FROM EX1.PRG
   
 . SKIP
   
 . MEMO IMPORT EXAMPLES FROM EX2.PRG
   

   

See Also:

MENU EDIT

A Complex Pull-Down-Menu Designer/Builder

Syntax:

Arguments:

    (MenuName) is the name of the menu.  This is a name of
   
 up to eight (8) digits.  If a menu name is passed then
   
 the DCMENU.DBF database will be searched and all menu
   
 items that match the menu name be loaded into an array
   
 for editing. If no name is passed, then a pick-list of
   
 all menus stored in the DCMENU.DBF database will be
   
 displayed.  If none is chosen, then it will be assumed
   
 that you wish to create a new menu.
   

   

   

   

   

Description:

Notes:

Examples:

    /* -- Edit the Main Menu -- */
   
 MENU EDIT MAINMENU
   

   
 /* -- Compile the menu -- */
   
 aMenuMain := DC_MenuCompile( DC_MenuLoad("MAINMENU"))
   

   
 /* -- Run the menu -- */
   
 DC_MenuMain( aMenuMain )
   

   

   

Source/Library:

See Also:

MENU RUN

Execute a menu from the Menu Dictionary

Syntax:

Arguments:

    (MenuName) is the name of the menu.  This is a name of
   
 up to eight (8) digits.  If a menu name is passed then
   
 the DCMENU.DBF database will be searched and all menu
   
 items that match the menu name be loaded into an array
   
 and passed to the menu execution program.  If no name is
   
 passed, then a pick-list of all menus stored in the
   
 DCMENU.DBF database will be displayed.
   

   

   

   

   

Description:

Notes:

Examples:

    /* -- Run the Main Menu -- */
   
 MENU MAINMENU
   

   

   
 /* -- Run a menu selected from the picklist -- */
   
 MENU
   

   

Source/Library:

See Also:

MENU TO

Execute a light-bar menu for defined PROMPTs

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

MODIFY COMMAND

Edit a Program (.PRG) file

Syntax:

Arguments:

    (file name) is the name of the ascii text file to edit.  You
   
 may precede the name with a drive and/or directory name and you
   
 must include the extension if it exists.  If the file does not
   
 already exist it will be created.
   

   
 If an extension is not used, then the extension .PRG is assumed
   
 and the search directory is assumed to be the directory
   
 established by the SET PDIR command or PDIR=(directory) command
   
 in DCLIP.SYS.
   

   
 (nLineNumber) will cause the editor to jump to the
   
 (nLineNumber) after it opens the file.
   

   

Description:

See Also:

MODIFY LABEL

Edit a Label (.LBL) file

Syntax:

Arguments:

    (cLabelFile) is the name of the label form file to create.  If
   
 no extension is given, then the .LBL extension will be used.
   
 If no file path is included then the file will be created in
   
 the directory established by the SET DEFAULT command.
   

   

Description:

Notes:

Examples:

    . USE MAILLIST FOX
   
 . MODIFY LABEL MAILLIST
   
 . SET INDEX TO ZIPCODE
   
 . SET SCOPETOP TO '90000'
   
 . SET SCOPEBOTTOM TO '99999'
   
 . LABEL FORM MAILLIST TO PRINT
   

   

See Also:

MODIFY REPORT

Edit a Report (.FRM) file

Syntax:

Arguments:

    (cReportFile) is the name of the label form file to create.  If
   
 no extension is given, then the .FRM extension will be used.
   
 If no file path is included then the file will be created in
   
 the directory established by the SET DEFAULT command.
   

   

Description:

Notes:

Examples:

    . USE MAILLIST
   
 . MODIFY REPORT MAILLIST
   
 . REPORT FORM MAILLIST TO PRINT
   

   

See Also:

MODIFY STRUCTURE

Modify the structure of the current database

Syntax:

Arguments:

    (cNewFileName) is an optional file name to create.  If no
   
 argument is given then the current database will be the target.
   
 If a (cNewFileName) is given, then the new file will be
   
 created from the modified information and the records from the
   
 current file will be appended to the new file.
   

   

Description:

Notes:

Examples:

    . USE MAILLIST VIA 'PDX' EXCLUSIVE
   
 . MODIFY STRUCTURE TO NEWLIST
   

   
 . USE CUSTOMER EXCLUSIVE
   
 . MODIFY STRUCTURE
   

   

See Also:

OBJ LOAD

"Dynamic-link" a Clipper-compiled .OBJ file into memory

Syntax:

Arguments:

    (cObjectFile)  is the name of the object file to link.  This
   
 must be an object code file which was compiled  with the 5.01
   
 version of Clipper.  There are no restrictions to the manner in
   
 which the source code is written or the compiler options.  You
   
 are free to use statics, locals, publics, privates, arrays,
   
 objects, etc. The only restriction is that the final .OBJ file
   
 size may not exceed 64k or may not exceed the following
   
 equation:
   

   
 MAX OBJ SIZE = DC_OBJMEM()/2 - 4k
   

   
 The PERMANENT clause is used to prevent the object from being
   
 released from memory by the OBJ RELEASE ALL command or by
   
 automatically being released when memory space is needed for
   
 loading a new object.  This is necessary for modules which
   
 must always be in memory.  If a map file is loaded with the MAP
   
 LOAD command, then the PERMANENT clause is not necessary,
   
 because released objs will automatically be reloaded when
   
 needed.
   

   

Description:

Examples:

    . EDIT MYAPP.PRG      // Create MYAPP.PRG
   
 . CLIP MYAPP /w/n    // Compile MYAPP.PRG to MYAPP.OBJ
   
 . OBJ MYAPP           // Dynamic link MYAPP.OBJ
   
 . DO MAINMENU     // Run a procedure in MYAPP.OBJ
   

   

See Also:

OBJ RELEASE

Release a "dynamic-linked" .OBJ file from memory

Syntax:

Arguments:

    (object) is the name of an object (.OBJ) file that was
   
 previously linked into memory with the OBJ command or
   
 automatically linked during the execution of an application
   
 from dynamic libraries or loaded map files.
   

   
 ALL will release all object modules that have a "usage" count
   
 of 1 or were not loaded with the OBJ (object) PERMANENT
   
 command.  The "usage" count is automatically incremented and
   
 decremented every time a function or procedure in a module is
   
 called and returned. If an application is suspended by pressing
   
 the ALT-D key, then OBJ RELEASE will not release any procedures
   
 that have a usage count of 2 or higher.
   

   

Examples:

    . OBJ MYAPPS
   
 . DO MAINMENU
   
 . OBJ RELE ALL
   

   

See Also:

PACK

Remove deleted records from a database file

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

Description:

See Also:

PRINTER

Invoke Printer Manager menu or Send Escape codes to Printer

Syntax:

Arguments:

    SELECT will pop-up a list of printers in the printer database
   
 to choose a printer for future print operations.
   

   
 CODE will pop-up a list of available pseudo-codes to determine
   
 which codes will be mapped to ESCape sequences.
   

   
 (cPseudoCodes) is a sequence of pseudo-codes to translate into
   
 Escape sequences to send to the selected printer.
   

   

Description:

Examples:

    . PRINTER CODE   // Display pseudo-codes
   

   
 . PRINTER SELECT // Select a printer-driver
   

   
 . PRINTER CV     // Send ESCape codes for Compressed/8-lines
   
                  //  per inch
   

   

See Also:

PROC

Add procedure name to PROC table to skip when debugging

Syntax:

Arguments:

    (procedure) is the name of the procedure to bypass.
   

   
 If no argument is given then PROC will display a listing of all
   
 current procedures in the PROC exclusion table.
   

   

Description:

Examples:

    //  Don't animate MAINMENU() or PRINTOUT() because these are
   
 //  debugged and working ok.
   

   
 . PROC MAINMENU
   
 . PROC PRINTOUT
   

   

See Also:

PROC CLEAR

Clear procedure(s) from PROC table

Syntax:

Arguments:

    (number) is the entry number of the procedure name in the PROC
   
 exclusion table.  To determine the entry number for a specific
   
 procedure, use the command PROC with no parameters.
   

   
 If PROC CLEAR is used with no arguments, then all procedure
   
 names in the table will be cleared.
   

   

Description:

Examples:

    . PROC MAINMENU
   
 . PROC PRINTOUT
   
 . PROC MYHELP
   
 . PROC CLEAR PRINTOUT
   

   

See Also:

PROGRAM

Run an "Interpreted" program in Program Catalog

Syntax:

Arguments:

    (cProgName) is the Tag Name of the program in the DCPROG.DBF
   
 Program Catalog file.  If no parameter is passed, then a pick-
   
 list of available programs will be displayed.
   

   
 (parameter list) is a list of parameters to pass to the program
   
 being interpreted.  There should be one element in the array for
   
 each parameter included in the PARAMETERS statement in the
   
 interpreted program.  If less parameters are passed than
   
 specified in the PARAMETERS statement, the unpassed parameters
   
 will be initialized to NIL.
   

   

   

Returns:

    The value returned by the RETURN (xValue) statement in the
   
 intrepreted program.  If no RETURN value is entered into the
   
 program, then a NIL is returned.
   

   

   

Description:

Examples:

    -- Example 1 --
   

   
 /* Program stored in 'TEST' record of DCPROG.DBF :
   

   
 PARAMETERS a,b,c,d
   
 CLS
   
 USE CUSTOMER
   
 nReceivables := 0
   
 DO WHILE !EOF()
   
   ? 'Record',RecNo()
   
   ?? FieldGet(a)
   
   ?? FieldGet(b)
   
   ?? FieldGet(c)
   
   ?? FieldGet(d)
   
   IF !EMPTY(phone1)
   
     ?? phone1
   
   ELSEIF !EMPTY(phone2)
   
     ?? phone2
   
   ENDIF
   
   nReceivables += balance
   
 ENDDO
   
 RETURN nReceivables
   
 */
   

   
 PROGRAM TEST WITH 3,5,9,10
   

   

   

   

Source/Library:

See Also:

PROGRAM MAINTENANCE

Maintain the DCPROG.DBF Program Catalog File

Syntax:

Arguments:

    None.
   

   

Description:

Source/Library:

See Also:

PURGE

Remove duplicate records from database based by condition

Syntax:

Arguments:

    ON (exp1) is an expression of field names to use in determining
   
 how to determine the duplication of records.  For example, if
   
 you want to purge records that have duplication of information
   
 in which LAST_NAME, FIRST_NAME and STREET are identical, then
   
 use UPPER(LAST_NAME+FIRST_NAME+STREET) as the expression.
   

   
 If an (expression) is not given then a window will appear with
   
 a user prompt to enter an expression or to press ALT-F for the
   
 index builder.  If ALT-F is pressed, a pick-list of fields will
   
 appear to aid in building the expression.
   

   
 TO (file) will create a new database that contains the purged
   
 records.
   

   
 RETAIN (exp2) is an expression that determines which record of
   
 the set of duplicate records to retain (not mark for deletion).
   
 The default is "RECNO()".  MAX will retain the maximum value.
   
 MIN will retain the minimum value.  The default is MIN.
   

   
 FIELD (field) is the name of an optional numeric field in the
   
 database being purged. This field is used to write a number from
   
 0 to N.  If there are no duplicates, then a 0 will be written to
   
 the record.  If there ARE duplicates then a 1 will be written to
   
 the RETAINED record and a number from 2 to N will be written to
   
 each duplicate.
   

   

Description:

Notes:

Examples:

    /* Purge all duplicate records that have an exact match
   
    for Last Name, First Name, Phone Number and Street.
   
    Retain the record that has the latest Mail Date */
   

   
 . USE MAILLIST
   
 . PURGE ON LAST+FIRST+PHONE+STREET RETAIN MAIL_DATE MAX
   
 . BROWSE
   
 . PACK
   

   

See Also:

QEVENT

Establish Console-Output event to process after each command

Syntax:

Arguments:

    (expression1) - (expressionN) is a list of expressions
   
 including memvars, functions, UDF() ,etc that return any value.
   

   

Description:

Examples:

    . QEVENT 'Fields:',FCOUNT(),' Records:',RECCOUNT()
   

   

See Also:

QUERY

Invoke a menu-driven Condition builder

Syntax:

Arguments:

    TO (memvar) will save the query expression selected or created
   
 to variable (memvar) to be used later in database commands.  If
   
 the variable does not exist it will be created as a type "C"
   
 variable. If the variable already exists, but is not a type "C"
   
 it will be recreated as a type "C".  If the variable already
   
 exists and is a type "C", the information in the memory
   
 variable will be passed along to the condition builder as the
   
 default condition and the operator will be allowed to add new
   
 conditions to the existing condition.
   

   

Description:

Notes:

Examples:

    . USE MAILLIST
   
 . QUERY TO MYQUERY
   
 . LOCA FOR &MYQUERY
   

   

See Also:

QUIT

Terminate program processing and return to DOS

Syntax:

Arguments:

    See Clipper 5.0 Guides
   

   

See Also:

CODE IMPORT

Import Code Table(s) from the Import Code Table Dictionary

Syntax:

Arguments:

    (cTableName) is the name of the code table.  This is a name of
   
 up to eight (8) digits.  If a code table name is passed then
   
 the DXCODES.DBF database will be searched and all code table
   
 items that match the code table name will be imported into
   
 DCCODES.DBF.  If no name is passed, then a pick-list of all tables
   
 stored in the DXCODES.DBF database will be displayed.
   

   
 If "ALL" is passed as the table name, then all tables in the
   
 DXCODES.DBF will be imported into DCCODES.DBF.
   

   

   

Returns:

    A logical .TRUE. if the menu was imported successfully.
   

   

   

   

Description:

Notes:

Source/Library:

See Also:

EDIT IMPORT

Import Edit(s) from the Import Editing Dictionary

Syntax:

Arguments:

    (cEditName) is the name of the edit.  This is a name of
   
 up to eight (8) digits.  If an edit name is passed then
   
 the DXEDIT.DBF database will be searched and all edit
   
 items that match the edit name be imported into DCEDIT.DBF.
   
 If no name is passed, then a pick-list of all edits stored
   
 in the DXEDIT.DBF database will be displayed.
   

   
 If "ALL" is passed as the edit name, then all edits in the
   
 DXEDIT.DBF will be imported into DCEDIT.DBF.
   

   

Description:

Notes:

Source/Library:

See Also:

FIELD IMPORT

Import Field Group(s) from the Import Field Dictionary

Syntax:

Arguments:

    (cFieldGroup) is the name of the field group.  This is a name of
   
 up to eight (8) digits.  If a group name is passed then
   
 the DXFIELDS.DBF database will be searched and all group
   
 items that match the group name be imported into DCFIELDS.DBF.
   
 If no name is passed, then a pick-list of all field groups stored
   
 in the DXFIELDS.DBF database will be displayed.
   

   
 If "ALL" is passed as the group name, then all groups in the
   
 DXFIELDS.DBF will be imported into DCFIELDS.DBF.
   

   

   

Description:

Notes:

Source/Library:

See Also:

FILE IMPORT

Import File Group(s) from the Import File Dictionary

Syntax:

Arguments:

    (cFileGroup) is the name of the file group.  This is a name of
   
 up to eight (8) digits.  If a group name is passed then
   
 the DXFILES.DBF database will be searched and all group
   
 items that match the group name be imported into DCFILES.DBF.
   
 If no name is passed, then a pick-list of all file groups stored
   
 in the DXFILES.DBF database will be displayed.
   

   
 If "ALL" is passed as the group name, then all groups in the
   
 DXFILES.DBF will be imported into DCFILES.DBF.
   

   

Description:

Notes:

Source/Library:

See Also:

LOGIN

Log On to system to establish user rights

Syntax:

Arguments:

    (UserID) is the User ID of the logging on user.  If this
   
 parameter IS NOT passed and the (cPassword) parameter IS
   
 passed, then the DCUSER.DBF will be searched only for a
   
 match to the (cPassword).  If (cUserID) is passed and
   
 (cPassword) is not passed, then the user will be prompted to
   
 enter a password.  If neither (cUserID) or (cPassword) is
   
 passed, then the user will be prompted for both a User ID
   
 and a password.
   

   

   

Returns:

    A logical .TRUE. if the user logs on successfully, .FALSE.
   
 otherwise.
   

   

Description:

Examples:

    LOGIN USER LARRY PASSWORD STOOGE
   

   

   

   

Source/Library:

See Also:

MENU DELETE

Delete a menu in the Menu Dictionary

Syntax:

Arguments:

    (cMenuName) is the name of the menu.  This is a name of
   
 up to eight (8) digits.  If a menu name is passed then
   
 the DCMENU.DBF database will be searched and all menu
   
 items that match the menu name be deleted.
   

   
 If no name is passed, then a pick-list of all menus stored in
   
 the DCMENU.DBF database will be displayed.
   

   

   

   

   

Description:

Notes:

Source/Library:

See Also:

MENU IMPORT

Import Menu(s) from the Import Menu-Dictionary

Syntax:

Arguments:

    (cMenuName) is the name of the menu.  This is a name of
   
 up to eight (8) digits.  If a menu name is passed then
   
 the DXMENU.DBF database will be searched and all menu
   
 items that match the menu name be loaded into an array.
   
 If no name is passed, then a pick-list of all menus stored
   
 in the DXMENU.DBF database will be displayed.
   

   
 If "ALL" is passed as the menu name, then all menus in the
   
 DXMENU.DBF will be imported into DCMENU.DBF.
   

   

Description:

Notes:

Source/Library:

See Also:

BROWSE IMPORT

Import Browse(s) from the Import Browse Dictionary

Syntax:

Arguments:

    (cBrowName) is the name of the browse.  This is a name of
   
 up to eight (8) digits.  If a browse name is passed then
   
 the DXBROWSE.DBF database will be searched and all browse
   
 items that match the browse name be imported into DCBROWSE.DBF.
   
 If no name is passed, then a pick-list of all browses stored
   
 in the DXBROWSE.DBF database will be displayed.
   

   
 If "ALL" is passed as the browse name, then all browses in the
   
 DXBROWSE.DBF will be imported into DCBROWSE.DBF.
   

   

Description:

Notes:

Source/Library:

See Also: