ACCEPT

ACCEPT*

Place keyboard input into a memory variable

Syntax

      ACCEPT [<expPrompt>] TO <idVar>

Arguments

<expPrompt> is an optional prompt displayed before the input area. The prompt can be an expression of any data type.

<idVar> is the variable that will hold input from the keyboard. If the specified <idVar> does not exist or is not visible, a private variable is created.

Description

ACCEPT is a console command and wait state that takes input from the keyboard and assigns it as a character string to the specified variable. When ACCEPT is executed, it first performs a carriage return/linefeed, displays the prompt, and then begins taking characters from the keyboard at the first character position following the prompt. You may input up to 255 characters. When input reaches the edge of the screen, as defined by MAXCOL(), the cursor moves to the next line.

ACCEPT supports only two editing keys: Backspace and Return. Esc is not supported. Backspace deletes the last character typed. Return confirms entry and is the only key that can terminate an ACCEPT. If Return is the only key pressed, ACCEPT assigns a null value (“”) to <idVar>.

Examples

      .  This example uses ACCEPT to get keyboard input from the user:
      LOCAL cVar
      ACCEPT "Enter a value: " TO cVar
      IF cVar == ""
         ? "User pressed Return"
      ELSE
         ? "User input:", cVar
      ENDIF

Seealso

@…GET, @…SAY, INKEY(), INPUT*, KEYBOARD, WAIT*

Transform()

Transform()

Formats a value based on a specific picture template.

Syntax

      Transform( <xExpression>,  <cTemplate> )  --> cFormatted

Arguments

<xExpression> Any expression to be formated.

<cTemplate> Character string with picture template

Returns

<cFormatted> Formatted expression in character format

Description

This function returns <xExpression> in the format of the picture expression passed to the function as <cTemplate>.

Their are two components that can make up <cTemplate> : a function string and a template string. Function strings are those functions that globally tell what the format of <xExpression> should be. These functions are represented by a single character precede by the @ symbol.

There are a couple of rules to follow when using function strings and template strings:

– First, a single space must fall between the function template and the template string if they are used in conjunction with one another.

– Second, if both components make up the value of <cTemplate>, the function string must precede the template string. Otherwise, the function string may appear with out the template string and vice versa.

The table below shows the possible function strings available with the Transform() function.

      @B   Left justify the string within the format.
      @C   Issue a CR after format is numbers are positive.
      @D   Put dates in SET DATE format.
      @E   Put dates in BRITISH format.
      @L   Make a zero padded string out of the number.
      @R   Insert non template characters.
      @X   Issue a DB after format is numbers are negative.
      @Z   Display any zero as blank spaces.
      @(   Quotes around negative numbers
      @!   Convert alpha characters to uppercased format.

The second part of <cTemplate> consists of the format string. Each character in the string may be formatted based on using the follow characters as template markers for the string.

      A,N,X,9,#   Any data type
      L           Shows logical as "T" or "F"
      Y           Shows logical as "Y" or "N"
      !           Convert to uppercase
      $           Dollar sing in place of leading spaces in 
                  numeric expression
      *           Asterisks in place of leading spaces in 
                  numeric expression
      ,           Commas position
      .           Decimal point position

Examples

      LOCAL cString := "This is harbour"
      LOCAL nNumber := 9923.34
      LOCAL nNumber1 := -95842.00
      LOCAL lValue := .T.
      LOCAL dDate := Date()
      ? "working with String"
      ? "Current String is",  cString
      ? "All uppercased",  Transform( cString,  "@!" )
      ? "Date is",  ddate
      ? "Date is ",  Transform( ddate,  "@D" )
      ? Transform( nNumber,  "@L 99999999" )  //  "009923.34"
      ? Transform( 0      ,  "@L 9999"     )  //  "0000"

Compliance

The @L function template is a FoxPro/Xbase++ Extension

Platforms

All

Files

Library is core

Seealso

@…SAY, DevOutPict()

SET INTENSITY

SET INTENSITY

Toggles the enhanced display of PROMPT’s and GETs.

Syntax

      SET INTENSITY  ON | off | (<lInte>)

Arguments

<lInte> Logical expression for toggle command

Description

This command set the field input color and @…PROMPT menu color to either highlighted (inverse video) or normal color. The default condition is ON (highlighted).

Examples

      SET INTENSITY ON

Compliance

Clipper

Seealso

@…GET, @…PROMPT, @…SAY, Set()

SET DEVICE

SET DEVICE

Directs all @…SAY output to a device.

Syntax

      SET DEVICE TO [printer | SCREEN ]

Arguments

None.

Description

This command determines whether the output from the @…SAY command and the DevPos() and DevOut() function will be displayed on the printer.

When the device is set to the PRINTER, the SET MARGIN value adjusts the position of the column values accordingly. Also, an automatic page eject will be issued when the current printhead position is less than the last printed row. Finally, if used in conjunction with the @…GET commands, the values for the GETs will all be ignored.

Examples

      SET DEVICE TO SCREEN
      ? 25141251 / 362
      SET DEVICE TO PRINTER
      SET PRINTER TO LPT1
      ? 214514.214 / 6325
      SET PRINTER OFF
      SET DEVICE TO SCREEN

Compliance

Clipper

Seealso

@…SAY, SET PRINTER, SetPRC(), Set()

@…GET

@…GET

Creates a GET object and displays it to the screen

Syntax

      @ <nRow>,<nCol> [SAY <cSay> [PICTURE <cSayPict>] COLOR <cSayColor> ]
      GET <xVar> [PICTURE <cGetPict>] [WHEN <lWhen>] [COLOR <cGetColor>]
      [VALID <lValid> / RANGE <xStart>,<xEnd>]

Arguments

<nRow> The row coordinate.

<nCol> The column coordinate.

<cSay> Message to display.

<cSayPict> Character expression of PICTURE displayed.

<cSayColor> Color to be Used for the SAY expression.

<xVar> An variable/field name.

<cGetPict> Character expression of PICTURE to get.

<lWhen> Logical expression to allow GET.

<lValid> Logical expression to validate GET input.

<xStart> Lower RANGE value.

<xEnd> Upper RANGE value.

<cGetColor> Color string to be used for the GET expression.

Description

This command adds a GET object to the reserved array variable named GETLIST[] and displays it to the screen. The field or variable to be added to the GET object is specified in <xVar> and is displayed at row, column coordinate <nRow>, <nCol>.

If the SAY clause is used <cSay> will be displayed starting at <nRow>, <nCol>, with the field variable <xVar> displayed at ROW(), COL()+ 1. If <cSayPicr>, the picture template for the SAY expression <cSay>, is used, all formatting rules contained will apply See the TRANSFORM I function for further information.

If <cGetPict> is specified, the PICTURE clause of <xVar> will be used for the GET object and all formatting rules will apply. See the table below for GET formatting rules.

If the WHEN clause is specified, when <lWhen> evaluates to a logical true (.T.) condition, the GET object will he activated otherwise the GET object will be skipped and no information will be obtained via the screen. The name of a user-defined function returning a logical true (.T.) or false ( F.) or a code block may be , specified in <lWhen> This clause not activated until a READ command or READMODAL() function call is issued.

If the VALID clause is specified and <lValid> evaluates to it logical true (.T.) condition the current GET will be considered valid and the get operation will continue onto the next active GET object. If not, the cursor will remain on this GET object until aborted or until the condition in <lValid> evaluates to true (.T.). The name of a user-defined function returning a logical true (.T.) or false (.F.) or it code block may be specified in <lValid>. This clause is not activated until a READ command or READMODAL( ) function call is issued.

If the RANGE clause is specified instead of the VALID clause, the two inclusive range values for <xVar> must be specified in <xStart> and <xEnd>. Id <xVar> is a date data type, <xStart> and <xEnd> must also be date data types; if <xVar> is a numeric data type <xStart> and <xEnd> must also be numeric data types. If a value fails the RANGE test , a message of OUT OF RANGE will appear in the SCOREBOARD area (row = 0, col = 60). The RANGE message may be turned off it the SET SCOREBOARD command or SET() function appropriately toggled.

NOTE: GET functions/formatting rules:

      @A          Allows only alphabetic characters.
      @B          Numbers will be left justified
      @C          All positive numbers will be followed by CR.
      @D          All dates will be in the SET DATE format.
      @E          Dates will be in British formal: numbers in European format.
      @K          Allows a suggested value to be seen within the GET
                  area but clears It if any non cursor key is pressed when
                  the cursor is in the first Position in the GET area.
      @R          Non template characters will be inserted.
      @S<nSize>   Allows horizontal scrolling of a field or variable that
                  is <nSize> characters wide.
      @X          All negative numbers will be followed by DB
      @Z          Displays zero values as blanks.
      @!          Forces uppercase lettering
      @(          Displays negative numbers in parentheses with leading spaces.
      @)          Displays negative numbers in parentheses without leading spaces.

GET templates/formatting rules:

      A   Only alphabetic characters allowed.
      N   Only alphabetic and numeric characters allowed
      X   Any character allowed.
      L   Only T or F allowed For logical data.
      Y   Only Y or N allowed for logical data.
      9   Only digits, including signs, will be allowed.
      #   Only digits, signs. and spaces will he allowed.
      !   Alphabetic characters are converted to Uppercase.
      $   Dollar  will be displayed in place of leading
          spaces for numeric data types.
      *   Asterisk,, will Be displayed in place of leading spaces
          for numeric data types.
      .   Position of decimal point.
      ,   Position of comma.

Format PICTURE functions may he grouped together as well as used in Conjunction with a PICTURE templates;however, a blank space must be included in the PICTURE string if there are both functions and templates.

Examples

      PROCEDURE Main()
         LOCAL cVar := Space( 50 )
         LOCAL nId := 0
         CLS
         @ 3,1 SAY "Name" GET cVar PICTURE "@!S 30"
         @ 4,1 SAY "Id"   GET nId  PICTURE "999.999"
         READ
         ? "The name you entered is",cVar
         ? "The id you entered is",nId
         RETURN

Tests

      See Examples

Compliance

Clipper

Platforms

All

Seealso

@…SAY, READ, TRANSFORM()

dbEdit()

Template

Function

Name

dbEdit()*

Category

API

Subcategory

User interface

Oneliner

Browse records in a table

Syntax

      dbEdit( [<nTop>],  [<nLeft>],  [<nBottom>],  [<nRight>],;  
              [<acColumns>], [<xUserFunc>], [<xColumnSayPictures>],;  
              [<xColumnHeaders>], [<xHeadingSeparators>], ; 
              [<xColumnSeparators>], [<xFootingSeparators>],;  
              [<xColumnFootings>] ) --> lOk

Arguments

<nTop> coordinate for top row display. <nTop> could range from 0 to MaxRow(), default is 0.

<nLeft> coordinate for left column display. <nLeft> could range from 0 to MaxCol(), default is 0.

<nBottom> coordinate for bottom row display. <nBottom> could range rom 0 to MaxRow(), default is MaxRow().

<nRight> coordinate for right column display. <nRight> could range from 0 to MaxCol(), default is MaxCol().

<acColumns> is an array of character expressions that contain database fields names or expressions to display in each column. If not specified, the default is to display all fields from the database in the current work area.

<xUserFunc> is a name of a user defined function or a code block
that would be called every time unrecognized key is been pressed or
when there are no keys waiting to be processed and dbEdit() goes
into idle mode. If <xUserFunc> is a character string, it must
contain root name of a valid user define function without
parentheses. Both the user define function or the code block should
accept two parameters: nMode, nCurrentColumn. Both should return
a numeric value that correspond to one of the expected return codes
(see table below for a list of nMode and return codes).

<xColumnSayPictures> is an optional picture. If <xColumnSayPictures>
is a character string, all columns would used this value as a
picture string. If <xColumnSayPictures> is an array, each element
should be a character string that correspond to a picture string
for the column with the same index. Look at the help for @…SAY
to get more information about picture values.

<xColumnHeaders> contain the header titles for each column, if this
is a character string, all columns would have that same header, if
this is an array, each element is a character string that contain
the header title for one column. Header may be split to more than
one line by placing semicolon (;) in places where you want to break
line. If omitted, the default value for each column header is taken
from <acColumns> or field name if <acColumns> was not specified.

<xHeadingSeparators> is an array that contain characters that draw
the lines separating the headers and the fields data. Instead of an
array you can use a character string that would be used to display
the same line for all fields. Default value is a double line.

<xColumnSeparators> is an array that contain characters that draw
the lines separating displayed columns. Instead of an array you can
use a character string that would be used to display the same line
for all fields. Default value is a single line.

<xFootingSeparators> is an array that contain characters that draw
the lines separating the fields data area and the footing area.
Instead of an array you can use a character string that would be
used to display the same line for all footers. Default is to have to
no footing separators.

<xColumnFootings> contain the footing to be displayed at the bottom
of each column, if this is a character string, all columns would
have that same footer, if this is an array, each element is a
character string that contain the footer for one column. Footer may
be split to more than one line by placing semicolon (;) in places
where you want to break line. If omitted, no footer are displayed.

Returns

dbEdit() return .F. if there is no database in use or if the number
of columns to display is zero, else dbEdit() return .T.

Description

dbEdit() display and edit records from one or more work areas in
a grid on screen. Each column is defined by element from <acColumns>
and is the equivalent of one field. Each row is equivalent of one
database record.

      Following are active keys that handled by dbEdit():       
      ---------------------------------------------------

      Key              Meaning

      Left             Move one column to the left (previous field)
      Right            Move one column to the right (next field)
      Up               Move up one row (previous record)
      Down             Move down one row (next record)
      Page-Up          Move to the previous screen
      Page-Down        Move to the next screen
      Ctrl Page-Up     Move to the top of the file
      Ctrl Page-Down   Move to the end of the file
      Home             Move to the leftmost visible column
      End              Move to the rightmost visible column
      Ctrl Left        Pan one column to the left
      Ctrl Right       Pan one column to the right
      Ctrl Home        Move to the leftmost column
      Ctrl End         Move to the rightmost column

When <xUserFunc> is omitted, two more keys are active:

      Key              Meaning

      Esc              Terminate Browse()
      Enter            Terminate Browse()

When dbEdit() execute <xUserFunc> it pass the following arguments:
nMode and the index of current record in <acColumns>. If <acColumns>
is omitted, the index number is the FIELD() number of the open
database structure.

      dbEdit() nMode could be one of the following:    
      ---------------------------------------------
      dbedit.ch      Meaning

      DE_IDLE        dbEdit() is idle,  all movement keys have been handled.
      DE_HITTOP      Attempt to cursor past top of file.
      DE_HITBOTTOM   Attempt to cursor past bottom of file.
      DE_EMPTY       No records in work area,  database is empty.
      DE_EXCEPT      Key exception.

The user define function or code block must return a value that tell
dbEdit() what to do next.

      
      User function return codes:    
      ---------------------------   

      dbedit.ch    Value   Meaning

      DE_ABORT     0       Abort dbEdit().
      DE_CONT      1       Continue dbEdit() as is.
      DE_REFRESH   2       Force reread/redisplay of all data rows.

The user function is called once in each of the following cases:
– The database is empty.
– The user try to move past top of file or past bottom file.
– Key exception, the uses had pressed a key that is not handled by dbEdit().
– The keyboard buffer is empty or a screen refresh had just occurred
dbEdit() is a compatibility function, it is superseded by the
TBrowse class and there for not recommended for new applications.

Examples

      // Browse a file using default values
      USE Test
      dbEdit()

Compliance

<xUserFunc> can take a code block value, this is a Harbour
extension.

CA-Cl*pper will throw an error if there’s no database open, Harbour
would return .F.

CA-Cl*pper is buggy and will throw an error if the number of columns
is zero, Harbour would return .F.

The CA-Cl*pper 5.2 NG state that the return value is NIL, this is
wrong and should be read logical.

There is an undocumented result code (3) from the user defined
function in CA-Cl*pper (both 87 and 5.x). This is an Append Mode which:
“split the screen to allow data to be appended in windowed area”.
This mode is not supported by Harbour.

Files

Header files are dbedit.ch, inkey.ch, Library is core

Seealso

@…SAY, Browse(), TBrowse class, Transform()

SP_PRNTFRML

PRNTFRML()

  Short:
  ------
  PRNTFRML() Prints a formletter created by formletr()

  Returns:
  --------
  Nothing

  Syntax:
  -------
  PRNTFRML(cForm,[nPageWidth],[nLeftMargin])

  Description:
  ------------
  Prints the form <cForm> from FORMS.DBF with a
  pagewidth of [nPageWidth] and a left margin of [nLeftMargin]

  <cForm> is normally the contents of the template stored in FORMS.DBF
  (previous documentation refered to this parameter as the NAME of the
  form, which is incorrect.

  Examples:
  ---------
  This is used internally by FORMLETR() and FASTFORM().
  Refer to its usage there.

  SELECT 0
  USE FORM
  locate for descript = "MY FORM LETTER" // find letter
  cForm = form->memo_orig      // load contents
  USE
  SELECT MYDBF
  PRNTFRML(cForm,79)


  Source:
  -------
  S_PRNTF.PRG


 

 

SP_PRNT

PRNT()

  Short:
  ------
  PRNT() Writes a string of a given color at row, column

  Returns:
  --------
  Nothing

  Syntax:
  -------
  PRNT(nRow, nColumn, cString, nColor)

  Description:
  ------------
  <nRow>       row

  <nColumn>    column

  <cString>    string

  <nColor>     color attribute

  Examples:
  ---------
   PRNT(10,10,"Hello there",47)  // +W/G

  Notes:
  -------
  Here mainly for compatibility with older version. Was
  previously a C function.

  Source:
  -------
  S_PRNT.PRG

 

 

C5_@…SAY

 @...SAY
 Display data at a specified screen or printer row and column
------------------------------------------------------------------------------
 Syntax

     @ <nRow>, <nCol>
        SAY <exp> [PICTURE <cSayPicture>]
        [COLOR <cColorString>]

 Arguments

     <nRow> and <nCol> are the row and column coordinates of the
     display.  Row values can range from zero to a maximum of MAXROW(), if
     the current DEVICE is the SCREEN, or 32,766, if the current DEVICE is
     the PRINTER.  Also, column values can range from zero to a maximum of
     MAXCOL() or 32,766 if the current DEVICE is the PRINTER.

     SAY <exp> displays the result of a character, date, logical, or
     numeric expression to the current DEVICE.

     PICTURE <cSayPicture> defines the formatting control for the display
     of <exp>. Clipper provides two mechanisms, functions and templates,
     to control formatting.  Functions apply to an entire SAY, while
     templates format characters position by position.

     COLOR <cColorString> defines the display color of <exp>.  If not
     specified, <exp> displays in the standard color as defined by
     SETCOLOR().  <cColorString> is a character expression containing the
     standard color setting.  If you specify a literal color setting, it must
     be enclosed in quote marks.

     On a combined @...SAY...GET command, two COLOR clauses are required to
     specify colors for both the SAY and the GET: one for the SAY and one for
     the GET.

 Description

     @...SAY is a full-screen command that outputs the results of <exp> to
     either the screen or the printer at the specified row and column
     coordinates.  It can optionally format output using the PICTURE clause.
     @...SAY creates data entry screens or reports that can be sent to the
     screen or printer.

     When an @...SAY command executes , the output from <exp> is sent to the
     current device defined with SET DEVICE.  The current DEVICE can be the
     SCREEN or PRINTER.  Unlike console commands, @...SAY output to the
     printer is not echoed to the screen and SET CONSOLE has no effect on
     @...SAY output to the screen.

     If the current DEVICE is the SCREEN (the system default), @...SAY
     displays output to the screen leaving the cursor one column position to
     the right of the last character displayed.  ROW() and COL() are then
     updated with this position.  Output that displays off the screen, as
     defined by MAXROW() and MAXCOL(), is clipped and the cursor is
     positioned beyond the visible screen.  All @...SAY output displays are
     in standard color.  Refer to the SETCOLOR() reference in this chapter
     for more information on color.

     If the current DEVICE is set to PRINTER, the display is directed to the
     printer at the specified <nRow> and <nCol> position.  If the current
     MARGIN value is greater than zero, it is added to <nCol> first.  The
     printhead is then advanced one column position to the right of the last
     character output and PROW() and PCOL() are updated.  @...SAY commands to
     the printer behave differently from those to the screen if output is
     addressed to a printer row or column position less than the current
     PROW() and PCOL() values:

     .  If <nRow> is less than PROW(), an automatic EJECT (CHR(12)) is
        sent to the printer followed by the number of linefeed characters
        (CHR(10)) required to position the printhead on <nRow> on the
        following page

     .  If <nCol> including the SET MARGIN value is less than PCOL(),
        a carriage return character (CHR(13)) and the number of spaces
        required to position <exp> at <nCol> are sent to the printer

     To override this behavior and send control codes to the printer, or for
     any other reason, you can use SETPRC() to reset PROW() and PCOL() to new
     values.  See the SETPRC() function reference  for more information.

     If the current DEVICE is the PRINTER, redirect output from @...SAY
     commands to a file using the SET PRINTER TO <xcFile> command.

     @...SAY command output can be formatted using the PICTURE clause with a
     <cSayPicture>.  This performs the same action as the TRANSFORM()
     function.  A <cSayPicture> may consist of a function and/or a template.
     A PICTURE function imposes a rule on the entire @...SAY output.  A
     PICTURE template defines the length of the @...SAY output and the
     formatting rule for each position within the output.

     .  Function string: A PICTURE function string specifies
        formatting rules which apply to the SAY's entire display value,
        rather than to particular character positions within it.  The
        function string consists of the @ character, followed by one or more
        additional characters, each of which has a particular meaning (see
        table below).  The function string must not contain spaces.  A
        function string may be specified alone or with a template string.  If
        both are present, the function string must precede the template
        string, and the two must be separated by a single space.

        SAY and TRANSFORM() PICTURE Format Functions
        ---------------------------------------------------------------------
        Function     Action
        ---------------------------------------------------------------------
        B            Displays numbers left-justified
        C            Displays CR after positive numbers
        D            Displays dates in SET DATE format
        E            Displays dates and numbers in British format
        R            Nontemplate characters are inserted
        X            Displays DB after negative numbers
        Z            Displays zeros as blanks
        (            Encloses negative numbers in parentheses
        !            Converts alphabetic characters to uppercase
        ---------------------------------------------------------------------

     .  Template string: A PICTURE template string specifies
        formatting rules on a character-by-character basis. The template
        string consists of a series of characters, some of which have special
        meanings (see table below).  Each position in the template string
        corresponds to a position in the displayed SAY value.  Characters in
        the template string that do not have assigned meanings are copied
        verbatim into the displayed SAY value.  If you use the @R picture
        function, characters without special PICTURE template string meaning
        are inserted between characters of the display value; otherwise, they
        overwrite the corresponding characters of the display value.  You may
        specify a template string alone or with a function string.  If both
        are present, the function string must precede the template string,
        and the two must be separated by a single space.

        SAY and TRANSFORM() Template Symbols
        ---------------------------------------------------------------------
        Template     Action
        ---------------------------------------------------------------------
        A,N,X,9,#    Displays digits for any data type
        L            Displays logicals as "T" or "F"
        Y            Displays logicals as "Y" or "N"
        !            Converts alphabetic characters to uppercase
        $            Displays a dollar sign in place of a leading space in a
                     number
        *            Displays an asterisk in place of a leading space in a
                     number
        .            Specifies a decimal point position
        ,            Specifies a comma position
        ---------------------------------------------------------------------

 Examples

     .  This example uses an @...SAY with a PICTURE clause to display
        formatted output:

        nNetIncome = 7125.50
        nNetLoss = -125.50
        cPhone = "2134567890"
        cName = "Kate Mystic"
        //
        @ 1, 1 SAY nNetIncome PICTURE "@E 9,999.99"
        // Result: 7.125,50

        @ 2, 1 SAY nNetLoss PICTURE "@)"
        // Result: (125.50)

        @ 3, 1 SAY cPhone PICTURE "@R (999)999-9999"
        // Result: (213)456-7890

        @ 4, 1 SAY cName PICTURE "@!"
        // Result: KATE MYSTIC

     .  This example is a small label printing program that uses SET
        DEVICE to direct output to the printer and SETPRC() to suppress
        automatic EJECTs:

        USE Salesman INDEX Salesman NEW
        SET DEVICE TO PRINTER
        DO WHILE !EOF()                     // Print all records
           @ 2, 5 SAY RTRIM(FirstName) + ", " + LastName
           @ 3, 5 SAY Street
           @ 4, 5 SAY RTRIM(City) + ", " + State + "  " + ;
                    PostalCode
           @ 6, 0 SAY SPACE(1)            // Move to label bottom
           SETPRC(0, 0)                   // Suppress page eject
           SKIP                           // Next record
        ENDDO
        SET DEVICE TO SCREEN
        CLOSE Salesman

 Files   Library is CLIPPER.LIB.

See Also: ?|?? @…GET CLEAR COL() PCOL() PROW() QOUT()

 

C5 Commands

 ?|??            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