dc_e()

Determine if DC_EDITDB() is running.

Syntax:

Arguments:

    None.
   

   

Returns:

    A logical .TRUE. if DC_EDIT() is running, .FALSE. otherwise.
   

   

Description:

Source/Library:

See Also:

dc_edit() *

Full-screen record editor (obsolete)

Syntax:

Arguments:

    NOTE : This function is listed for compatability with old
   
 versions of dCLIP.  It is recommended that you use DC_EDITDB()
   
 instead.
   

   
 The arguments are not listed.  See your old documentation.
   

   

Description:

Notes:

Source/Library:

dc_edit2()

A function for calling edit-system sub-routines

Syntax:

Arguments:

    (cMenu) is a single character designating the menu group.
   

   
 cMenu      Description
   
 -----    -------------------------------------
   
  E         Edit Options
   
  V         View Options
   
  F         File Options
   
  S         Search Options
   

   
 (cCode) is a single or double character-set designating a
   
 specific routine to execute.     See below.
   

   
 EDIT OPTIONS
   
 ------------
   
   RF       Roll-Back value into current field
   
   RR       Roll-Back value into current record
   
   F        Edit Currently selected Field
   
   A        Append a new record
   
   R        Replace record with VIRTUAL Record
   
   U        Update (Edit) VIRTUAL Record
   
   B        Blank Record (Empty all fields)
   
   O        Replace record with MAPPED Record (from import map)
   
   D        Delete Record using DEFAULT method
   
   DD       Delete/Recall Record (Toggle DELETED flag)
   
   DM       Set the Default Delete Method
   
   BD       Blow-Down
   
   T        Capture Current record to VIRTUAL record
   
   S        Set Append Mode
   
   Y        Set Data-Entry Mode
   
   L        Insert Blank Record(s)
   
   N        Insert Virtual Record(s)
   
   I        Import Text file to selected Memo Field
   
   X        Export selected Memo Field to Text File
   
   C        Create Field Replacement Macro
   
   K        Create Keyboard Macro
   

   

   
 VIEW OPTIONS
   
 ------------
   
   UDF      Define a UDF (User-Defined Function Code-block)
   
   BD       Browse the Default configuration
   
   BC       Browse a configuration from the Catalog
   
   BK       Toggle Background paint mode
   
   SB       Toggle display of Scroll-Bar
   
   HW       Edit Help-Window Configuration
   
   A        Auto-update of relational windows
   
   I        Toggle inclusion of relational fields in edit
   
   F        Sort field list (or tag fields to edit)
   
   V        Size memo window
   
   Z        Toggle Zoom mode
   
   BF       Browse field configuration
   
   D        Edit currently selected field properties
   
   E        Add a new field to data-entry screen
   
   J        Insert a new field on data-entry screen
   
   K        Delete selected data-entry field
   
   P        Pick a color set
   
   W        Change editing window size
   
   N        Toggle Display of shadow on window
   
   G        Set Video display mode (25,34,50 rows)
   
   U        Edit using default configuration
   
   T        Tile-Edit
   
   DD       Set Drag Field/Descriptors Mode ON
   
   DF       Set Drag Field Mode ON
   
   DB       Set Drag Descriptors Mode ON
   
   S        Set spacing between rows
   

   

   
 FILE OPTIONS
   
 ------------
   
   C        Close database
   
   F        Close indexes
   
   O        Open a new database
   
   D        Select a different work area to Edit
   
   I        Select a different index
   
   T        Select an index tag
   
   A        Delete an index tag
   
   N        Create an index tag
   
   E        Edit a Text file
   
   M        Edit a Label form file
   
   R        Edit a Report form file
   
   P        Load an Import map
   
   U        Save current record to Virtual Record   File
   
   V        Restore Virtual Record from Virtual Record File
   
   W        Display work area status
   
   S        Save Edit to Dictionary, Array file or source
   
   SX       Export Edit to Dictionary, Array file or source
   
   LA       Load Edit configuration from an Array file
   
   LI       Load Edit configuration from Import dictionary
   
   LF       Load Edit configuration from a Function
   
   X        Delete an Edit configuration in dictionary
   
   G        Edit Field list (Field Dictionary)
   

   

   
 SEARCH OPTIONS
   
 --------------
   
   S        Set a filter
   
   O        Go to Top Record in File
   
   B        Go to Bottom Record in File
   
   G        Go to a specified record in File
   
   H        Hunt for a record
   
   U        Resume the Hunt
   
   F        Find a Record by Index
   
   Q        Quick-Locate a Record
   
   L        Locate a Record by Condition
   
   C        Continue the Locate
   
   P        Pan to a selected field
   
   M        Mark current record
   
   R        Return to Marked record
   
   AS       Toggle Auto-Seek mode
   
   AT       Toggle Record-Tag mode
   
   AC       Clear all record tags
   
   AN       Skip to next tagged record
   
   AP       Skip to previous tagged record
   
   AK       Set Key to use for record tagging
   

   

Returns:

    NIL
   

   

Description:

Source/Library:

See Also:

dc_editappend()

Determine if the user is currently appending a new record

Syntax:

Arguments:

    None.
   

   

Returns:

    NIL
   

   

Description:

Source/Library:

See Also:

dc_editarest()

Restore a data-entry editing configuration array

Syntax:

Arguments:

    (nArea) is the browse work area to restore.  If this argument
   
 is not passed then the current work area is default.
   

   
 (aEdit) is the array with the contents of an editing array
   
 saved by DC_EDITASAVE() or DC_EDITSAVE().  If (cEdit) is a
   
 character string instead of an array, then the value of (cEdit)
   
 must be equivalent to an EDIT TAG NAME for an edit configuration
   
 stored in the DCEDIT.DBF edit-dictionary file.  See DC_EDITSAVE()
   
 for more information.
   

   
 (lWorkRestore) if .TRUE. will also restore any work areas if a
   
 WORK AREA Tag was saved in the Edit Array.  A WORK AREA tag
   
 is the name of a Work Group in the DCFILES.DBF database.
   
 See DC_FILESAVE() for more information.  The default is .FALSE.
   
 meaning that databases matching the restored edit configuration
   
 must already be open.
   

   

   

   

Returns:

    A logical .TRUE. if the browse array(s) were restored
   
 successfully, .FALSE. otherwise.
   

   

Description:

Examples:

    PROCEDURE main
   

   
 LOCAL aEdit
   
 use sales
   
 dc_editdb()
   
 aEdit := DC_EDITASAVE( SELE('SALES') )
   
 close all
   
 do something
   
 use sales new
   
 DC_EDITAREST( SELE(), aEdit )
   
 dc_editdb()
   

   

Source/Library:

See Also:

dc_editasave()

Save the edit array object for a selected work area

Syntax:

Arguments:

    (nArea) is the edit work area to save.  If no parameter is
   
 passed, then edit configurations for all open work areas
   
 will be saved.
   

   

   

Returns:

    A multi-dimensional array that is equivalent to the DC_EDITDB()
   
 data-entry object for the specified work area.
   

   

Description:

Examples:

    PROCEDURE main
   

   
 LOCAL aEdit
   
 use sales
   
 dc_editdb()
   
 aEdit := DC_EDITASAVE( SELE('SALES') )
   
 close all
   
 do something
   
 use sales new
   
 DC_EDITAREST( SELE(), aEdit )
   
 dc_editdb()
   

   

Source/Library:

See Also:

dc_editcnd()

Post an array of fields to edit

Syntax:

Arguments:

    (aFields) is a single-dimensional array of field names.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    use customer
   
 DC_EDITCND({'NAME','STREET','CITY','STATE','ZIP'})
   
 DC_EditDb()
   

   

   

Source/Library:

See Also:

dc_editconfig()

Define the system editor

Syntax:

Arguments:

    (aConfiguration) is a four (4) element array consisting of the
   
 following arguments:
   

   
 Element   Type        Description
   
 -------  ---------- ----------------------------------------
   
  [1]       Character    File Name
   

   
    This is the name of the editor .COM, .BAT or .EXE file to
   
    run when using the EDIT command.
   

   
  [2]      Character   Memory Swap
   

   
    This is the amount of memory to release and save to disk
   
    to run the program.  The default is (K).  Enter "0" to
   
    release all memory except shell.
   

   
  [3]      Character   Swap drive
   

   
     This is the name of primary and secondary Disk
   
     Drive/Directory (separated by a semicolon) to save the
   
     memory image.  A temporary file is created on the first
   
     drive if space is available.  If no space is left on the
   
     first drive/directory then the remainder of the memory
   
     image is created on the second specified drive/directory.
   
     The temporary file is erased returning from your editor.
   

   
  [4]      Character   Video Mode
   

   
     "H" - Set High Resolution mode (43/50 lines)
   
     "L" - Set Low Resolution mode (25 lines)
   
     ""  - Don't change video mode
   

   

Returns:

    An array containing the current editor configuration.  If no array
   
 argument is passed, then the previous configuration will be returned.
   

   
 See Arguments for a description of each element of the returned array.
   

   

Description:

Examples:

    DC_EDITCONFIG( { 'Q2.BAT','300','C:\;D:\','L' } )
   
 dc_editprg( 'test' )
   

   

Source/Library:

See Also:

dc_editdb()

Invoke a multi-window full-screen edit of all work areas

Syntax:

Arguments:

    (aOptions) is an array of parameters to define the size and
   
 style of the editing window.
   

   
 Element  Type   Description
   
 -------  ----- ---------------------------------------------
   
  [ 1]      U    Reserved
   
  [ 2]      L    .t. - Protect data from being changed by user
   
                 .f. - Allow data modification ( Default )
   
  [ 3]      N    Start Display Row  ( 0 is default )
   
  [ 4]      N    Start Display Column  ( 0 is default )
   
  [ 5]      N    End Display Row  ( 24 is default )
   
  [ 6]      N    End Display Column  ( 79 is default )
   
  [ 7]      L    .t. - Display File Data at bottom of window
   
                 .f. - Don't Display File Data ( Default )
   
  [ 8]      L    .t. - Don't display a shadow around the window
   
                 .f. - Display a shadow around window ( Default )
   
  [ 9]      L    .t. - Display a record number column ( Default )
   
                 .f. - Don't display record numbers
   
  [10]      L    .t. - Set the TAB for this window ( Default )
   
                 .f. - Don't set the TAB
   
  [11]      L    .t. - Automatic update of Relational Windows
   
                 .f. - Don't update Relational Windows ( Default )
   
  [12]      U    Reserved
   
  [13]      L    .t. - Sticky-Edit mode ON
   
                 .f. - Sticky-Edit mode OFF ( Default )
   
  [14]      L    .t. - Merge all relational (child) fields into
   
        the edit window.  (If item 11 is .FALSE.
   
       then the Default is .TRUE., otherwise the
   
       Default is .FALSE.)
   
     .f. - Don't include child fields.
   
  [15]     L     .t. - Display menu bar at the top of the physical
   
                       screen (Row 0, Column 0)
   
                 .f. - Display menu bar at the top of the browse
   
                       window (Default).
   
  [16]     N     The edit screen page number to select.  The
   
                 default is Page 1.
   
  [17]     N     .t. - Display the contents of the selected field
   
                       on the second to last row of the edit
   
                       window (default).
   
                 .f. - Don't display field contents.
   

   
 (aFields) is an array of field names to edit.  If this argument
   
 is not passed, then all fields will appear in the display.
   

   
 (cUdf) is the name of a User-Defined Function to call after
   
 each keystroke.
   

   
 (lExit) if .TRUE. will paint the display and items on the screen
   
 then return.   .FALSE. is Default.
   

   
 (lReSize) if .TRUE. will maintain the last configuration of the
   
 Edit window for the selected work area except it will resize to
   
 the new passed coordinates.
   

   
 (lStartUp) is a RESERVED parameter.
   

   
 (lRestScr) if .TRUE. (default) will restore the screen after
   
 exiting, otherwise the information will remain on the screen.
   

   
 (lApp) if .TRUE. will Enter APPEND and EDIT mode and append
   
 a new record.   .FALSE. (default) will establish mode as VIEW
   
 mode.
   

   
 (cAppMode) is a single character defining how new append
   
 records are to be added before the user fills in the blanks.
   

   
   "B" - Append a new record with blank fields (Default)
   
   "V" - Append a new record with data from the VIRTUAL record
   
   "I" - Append a new record with data  from the IMPORT map
   
   "C" - Append a new record with CARRY from current record
   

   
 (cConfig) is the name of a Data-Entry configuration
   
 to restore from the DCEDIT.DBF dictionary or a *.DBE file.
   
 If (cConfig).DBE file is found, then the Edit configuration
   
 will be restored from this file.  If it is not found then
   
 the Edit configuration will be restored from an EDIT
   
 configuration with the Tag Name (cConfig) in the DCEDIT.DBF
   
 dictionary.  If this parameter is not passed, then an
   
 Edit configuration of the same name as the database ALIAS
   
 will be restored from the DCEDIT.DBF dictionary if it
   
 exists, otherwise the fields will be placed in the data-
   
 entry window in a default configuration.
   

   
 (lProtect) if .TRUE. will protect the database from being
   
 modified by the user.  The default is .FALSE.
   

   
 (aMenu) is an optional array which is used to replace the
   
 default Edit pull-down menus.  The menu array must conform
   
 to the specification of the array returned by the
   
 function DC_MENUEDIT() or DC_MENULOAD().  If (aMenu) is
   
 a character string, then the string must contain the
   
 NAME of the menu as contained in the menu dictionary file
   
 (DCMENU.DBF).
   

   
 (aKeys) is an optional array which is used to replace, add
   
 or delete hot-keys from the Edit defaults.  The key array
   
 must conform to the specification of the array returned by
   
 the function DC_KEYEDIT() or DC_KEYLOAD().  If (aKeys) is
   
 a character string, then the string must contain the
   
 NAME of the key-set as contained in the key dictionary file
   
 (DCKEY.DBF).
   

   
 (aMouse) is an optional array which is used to add to the
   
 default mouse-actions.  The mouse array must conform
   
 to the specification of the array defined for use by the
   
 function DC_MOUSEKEYS() or returned by the function
   
 DC_MOUSEEDIT() or DC_MOUSELOAD().  If (aMouse) is a
   
 character string, then the string must contain the
   
 NAME of the mouse-set as contained in the mouse dictionary
   
 file (DCMOUSE.DBF).
   

   
 (lBkGrnd) if .TRUE. (default) will paint a default
   
 background and all edit screens for all work areas.  If
   
 .FALSE., then only the edit screen for the current work
   
 area will be displayed over the existing screen.
   

   
 (lEditExit) if .TRUE. will force EDITING mode (same as pressing
   
 ENTER) then exit the function when the user presses F10 to
   
 save or ESCAPE to abort.  No other functionality but data-
   
 entry will be allowed in this mode.  Default is .FALSE.
   

   

Returns:

    NIL
   

   

Description:

Notes:

Examples:

    use customer
   
 DC_EDITDB()
   
 use invoice new
   
 DC_EDITDB( { , , 0, 0, 24, 39 } )
   
 use invitems new
   
 set relation to inv_nmbr into invoice
   
 DC_EDITDB( { , , 0, 40, 24, 79, , , .t., .f., , .t., .t. } )
   

   

Source/Library:

See Also:

dc_editdel()

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:

    DC_EDITDEL("myedit")
   

   

Source/Library:

See Also:

dc_editfile()

Pop-up a user-prompt menu to edit an ASCII file

Syntax:

Arguments:

    (cFileName) is the name of the ascii file to edit.  If no
   
 argument is given, then the user will be prompted for the name
   
 of the file.
   

   

Description:

Examples:

    @ 11,10 prompt "Edit a Database"
   
 @ 12,10 prompt "Edit an Ascii File"
   
 menu to nChoice
   
 do case
   
   case nChoice = 1
   
     dc_dbfsel()
   
     dc_browsedb()
   
   case nChoice = 2
   
     DC_EDITFILE()
   
 endcase
   

   

Source/Library:

See Also:

dc_editflag()

Set or Get specific information about an edit object

Syntax:

Arguments:

    (cCode) is a word describing the value to GET or SET.
   

   
   cCode      GET  SET  Type Description
   
  ----------  ---  ---  ---- ----------------------------------
   
  ZOOM         X         L   .t. if ZOOM mode ON, .f. if OFF
   
  PAINTITEMS        X        Repaint the current data entry items
   
  PAINTSCRN         X        Repaint the current data entry screen
   

   
 (nArea) is the editing work area.  If this parameter is not
   
 passed then the currently selected area is the default.
   

   
 (lGetValue) if .TRUE. will GET the value of the configuration
   
 parameter.  If .FALSE. (default), then it is assumed to be
   
 a SET option.
   

   
 (xDefault) is a default value to return in the event that
   
 the editing screen has not been initialized.  Use this to
   
 prevent errors in your code.
   

   

   

Returns:

    The GET value.
   

   

   

   

Description:

Examples:

    /* In this example DC_EDITFLAG() is used to determine
   
    whether the user has ZOOMED the display.  The code is
   
    being called in a UDF that is evaluated from the
   
    DC_EDITDB() function.  The UDF is used to display a
   
    status box in the area of the screen below the edit
   
    screen. The status box must display ONLY if the edit
   
    screen has not been ZOOMED to use the full-screen. */
   

   
 IF !DC_EDITFLAG('ZOOM')
   
   StatusDisplay()
   
 ENDIF
   

   

   

Source/Library:

See Also:

dc_editload()

Load an editing array from edit dictionary or array file

Syntax:

Arguments:

    (cEditName) is the name of the editing configuration to
   
 load (up to 8 characters).  If no parameter is passed, then
   
 a pick-list of all Edit configurations in the DCEDIT.DBF
   
 dictionary will be displayed.
   

   
 (cMode) is a single character designating the source:
   
   A - From an Array File.  If this option is chosen then
   
       the user will be prompted with a dialogue screen to
   
       enter the name of the array file.  The default file
   
       name will be filled in as (cEditName).DBE.
   
   F - From a Function.  If this option is chosen then the
   
       function (cEditName)_E() will be called to get the
   
       array, if it exists.
   
   D - From the DCEDIT.DBF dictionary.  An Edit Configuration
   
       with the Tag Name (cEditName) will be loaded into the
   
       array, if it exists.
   
   NONE - If no parameter is passed, then the array will be
   
   loaded first from the function (cEditName)_E(), if it
   
   exists, and secondly from the file (cEditName).DBE if it
   
   exists, and thirdly from the DCEDIT.DBF dictionary.
   

   
 (lCache) if .TRUE. (default) will save the configuration
   
 to a static cache so the next time it is requested it will
   
 be reloaded from the cache for faster speed.  If .FALSE. or
   
 if the DC_MEMCACHE() setting is 0, then it will not be saved
   
 to the static array.
   

   
 (lMessage) if .TRUE. (default) will warn the operator if
   
 the edit configuration does not exist in the edit dictionary.
   

   
 (lCreateDbf) if .TRUE. (default) will create the DCEDIT.DBF
   
 dictionary if it does not exist.  If .FALSE. and the
   
 DCEDIT.DBF dictionary does not exist, then the function will
   
 return a NIL.
   

   
 (lImport) if .TRUE. will attempt to load the configuration
   
 from a dictionary file named DXEDIT.DBF rather than the
   
 standard dictionary named DCEDIT.DBF.
   

   

Returns:

    An editing array that conforms to the specification documented
   
 in ARGUMENTS of the function named DC_EDITSAVE().
   

   

Description:

Notes:

Examples:

    use customer
   
 aEdit := DC_EDITLOAD( 'CUSTOMER' )
   
 DC_EditRestore( aEdit )
   

   

Source/Library:

See Also:

dc_editlocal()

Allows GET/SET access to the Local array in DC_EDITDB()

Syntax:

Arguments:

    NONE.
   

   

Returns:

    NIL.
   

   

Description:

Notes:

Examples:

    /* Determine whether or not the user is in APPEND mode */
   

   
 LOCAL aEditLocal := DC_EditLocal()
   

   
 IF Valtype(aEditLocal) = 'A' .AND. aEditLocal[87]
   
   DC_MsgBox('Yes, the user is Appending Records')
   
 ELSE
   
   DC_MsgBox('No, the user is Not Appending Records')
   
 ENDIF
   

   

Source/Library:

See Also:

dc_editmenu()

Restore an Edit Menu from an Array or Data-Dictionary

Syntax:

Arguments:

    (aMenu) is a menu array created by DC_MENUEDIT() or
   
 restored from the Menu-Dictionary database via DC_MENULOAD().
   

   
 If (aMenu) is not passed then (nMode) is used to determine
   
 how to load the menu:
   

   
  0 - Reserved
   
  1 - Restore default menu
   
  2 - Load a menu from the Data-Dictionary (choose from
   
      pick-list)
   
  3 - Edit and load menu in the Data-Dictionary (choose from
   
      pick-list)
   

   

   

   

   

Returns:

    A "compiled" menu array that can be passed to DC_MENUMAIN().
   

   

Description:

Examples:

    (-- Saving an Editing and Menu Configuration --)
   

   
 /* -- Open databases -- */
   
 OpenData()
   

   
 /* -- design editing windows to fit requirements -- */
   
 dc_edittile()
   

   
 /* -- save editing configuration to source-code -- */
   
 dc_editsource()   // Save to MYEDIT()
   

   
 /* -- design editing menu to fit requirements -- */
   
 dc_menuedit()     // Save to MYEDITMENU()
   

   
 RETURN
   

   

   

   
 (-- Compile and Run the new Editing System --)
   

   
 /* -- compile and link new source-code -- */
   

   
 /* -- Run editing configuration in new .EXE -- */
   
 OpenData()
   
 DC_EDITMENU( MyEditMenu() )
   
 DC_EditRestore( MyEdit() )
   
 RETURN
   

   

   

   
 FUNCTION OpenData()
   
 use customer
   
 use invoice new index invoice
   
 use invitems new index invitems
   
 select customer
   
 set relation to cust_nmbr into invoice
   
 select invoice
   
 set relation to inv_nmbr into invitems
   
 select customer
   
 RETURN nil
   

   

   

Source/Library:

See Also:

dc_editmode()

Set the default mode for tile-editing

Syntax:

Arguments:

    (nMode) is an optional argument for defining the method to
   
 display the edit windows being opened for the multiple
   
 database editing.
   

   
 nMode
   

   
  0  Best fit (default)
   
  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 )
   

   

   

Returns:

    The current browse-tile mode setting.
   

   

Description:

Examples:

    . use all like DC*
   
 . DC_EDITMODE(4)
   
 . dc_edittile()
   

   

Source/Library:

See Also:

dc_editpick()

Pick an editing configuration from the edit dictionary

Syntax:

Arguments:

    (cTitle) is the title to display on the pick-list box.
   

   

Returns:

    A character string.
   

   

   

Description:

Examples:

    cEditName := DC_EDITPICK()
   
 IF !Empty(cEditName)
   
   aEdit := DC_EditLoad( cEditName )
   
 ENDIF
   

   

   

   

   

   

Source/Library:

See Also:

dc_editprg()

Edit a .PRG source-code file

Syntax:

Arguments:

    (cFileName) is the name of the ascii file to edit.  If no
   
 argument is given, then the user will be prompted for the name
   
 of the file. If no extension is included, then .PRG is
   
 assumed.
   

   
 (nLineNmbr) is the line number to go to.  If no parameter is
   
 passed then the editing will start at line 1.
   

   
 (cParameters) is an optional set of parameters to pass to the
   
 editor.
   

   
 (lWriteScreen) if .TRUE. will write the contents of the
   
 current screen to a file named DCLIP.SCR.  The editor can then
   
 be used to bring up this screen in a separate window as a
   
 reference.  .FALSE. is default.
   

   

   

   

   

   

Description:

Notes:

Examples:

    dc_editconfig( { 'Q2.BAT','300','C:\;D:\','L' } )
   
 DC_EDITPRG( 'test' )
   

   

Source/Library:

See Also:

dc_editrec()

Pop-up a record editing window

Syntax:

Arguments:

    (lAppend) if .TRUE. will append a new record.  If .FALSE.
   
 (default) then the currently selected record will be  edited.
   

   
 (nStRow), (nStCol), (nEnRow), (nEnCol) are the screen
   
 coordinates for the edit window.  If no parameters are passed
   
 then the default coordinates will be 2,10,21,70.
   

   

   

   

   

   

   

Returns:

    A logical .TRUE. if the record was modified, .FALSE. otherwise.
   

   

Description:

Notes:

Examples:

    use customer
   
 DC_EDITREC()     // Edit current record
   
 DC_EDITREC(.t.)  // Append and edit a new record
   

   

Source/Library:

See Also:

dc_editrestore()

Restore and execute an Editing configuration from an array

Syntax:

Arguments:

    (aEdit) is a browse-definition array that conforms to the
   
 specifications documented in ARGUMENTS of DC_BROWSAVE().
   

   
   or
   

   
 (cEdit) is the "tag name" of an edit configuration that was
   
 previously saved in the DCEDIT.DBF dictionary.
   

   
 (lWorkRestore) if .TRUE. (default) will also restore any
   
 work areas if a FILES tag is included in the (aEdit)
   
 array.  If .FALSE. then it is assumed that the files
   
 associated with this edit configuration are already open.
   

   
 (lBackground) if .TRUE. (default) will display a background
   
 screen that will fill the entire screen area.  This is the
   
 same background displayed when using the EDIT command.
   
 If .FALSE. then the edit screen will be displayed over
   
 any existing screen.
   

   
 (lSaveKeys) if .TRUE. will save all SET KEYS, then clear
   
 them and restore them after returning from the Edit.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    (-- Design and Save the Editing Configuration --)
   

   
 /* -- Open databases -- */
   
 OpenData()
   

   
 /* -- design editing windows to fit requirements -- */
   
 dc_edittile()
   

   
 /* -- save editing configuration to source-code -- */
   
 dc_editsource()   // Save to MYEDIT()
   

   
 RETURN
   

   

   

   
 (-- Compile and Run the new Editing Configuration --)
   

   
 /* -- compile and link new source-code -- */
   

   
 /* -- Run Editing configuration in new .EXE -- */
   
 OpenData()
   
 DC_EDITRESTORE( MyEdit() )
   
 RETURN
   

   

   

   
 FUNCTION OpenData()
   
 use customer
   
 use invoice new index invoice
   
 use invitems new index invitems
   
 select customer
   
 set relation to cust_nmbr into invoice
   
 select invoice
   
 set relation to inv_nmbr into invitems
   
 select customer
   
 RETURN nil
   

   

   

Source/Library:

See Also:

dc_editrev()

Enable automatic updated of revision fields

Syntax:

Arguments:

    (lEditRev) if .TRUE. will automatically update the "revised"
   
 fields if they exist.  .FALSE. is the default.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    // Set Edit Revision Fields mode ON
   
 DC_EDITREV(.t.)
   

   

Source/Library:

See Also:

dc_editsave()

Save a data-entry array to dictionary, array file or source code

Syntax:

Arguments:

    (aEdit) is an array of 2 sub-arrays:
   

   
 Sub-Array #1 is an array of options:
   

   
 Element  Type   Description
   
 ------- ----   -----------------------------------
   
   1       C     Edit Tag Name (up to 10 chars)
   
   2       C     Edit Files Tag Name (up to 8 chars)
   
                 used for opening files when restoring
   
                 edit configuration.
   
   3       C     Edit Menu Tag Name (up to 8 chars)
   
                 used for restoring a specified menu.
   
   4       C     Edit Keys Tag Name (up to 8 chars)
   
                 used for restoring a set of keys.
   
   5       C     Description
   

   
 The elements in Sub-array #1 will be edited by the user
   
 before saving the edit configuration.  If no array is
   
 passed, then the user will be given blanks to fill out.
   
 If no FILES, MENU or KEYS tags are entered by the user, the
   
 EDIT configuration will be restored with default
   
 conditions.
   

   

   
 Sub-array #2 consists of a sub-array containing the edit
   
 configuration for each work area.
   

   
 Each edit configuration array consists of 2 sub-arrays:
   

   
 Sub-sub-array #1 is an array of general options for the
   
 edit configuration.  See DCEDIT.CH for the definitions of
   
 this array.
   

   
 Sub-sub-array #2 is an array consisting of one field-array for
   
 each edit field.  See DCFIELDS.CH for the definition of the
   
 Fields sub-array.
   

   

   
 (cSaveMode) is a character string of up to 3 characters to
   
 establish the default save mode.  Include 1 character for
   
 each mode to save.
   

   
   D - Save to DCEDIT.DBF dictionary
   
   A - Save to a *.DBE array file
   
   S - Save to source code
   

   

   
 (lGets) if .TRUE. (default) will allow the operator to
   
 edit the save parameters or abort the operation.  If .FALSE.,
   
 then the edit configuration will be saved.
   

   
 (lMessage) if .TRUE. (default) will display a message if the
   
 edit configuration already exists in the dictionary and allow
   
 the operator to abort the save.  If .FALSE. the edit will be
   
 overwritten if it already exists.
   

   
 (nArea) is the work area of the edit configuration to save.
   
 If this parameter is not passed, then the currently selected
   
 work area is the default.
   

   

Returns:

    A logical .TRUE. if the configuration was successfully saved,
   
 .FALSE. otherwise.
   

   

   

Description:

Examples:

    use customer
   
 dc_editdb() // create dCEDIT array configuration
   
 aEdit := {{},dCEDIT }
   
 DC_EDITSAVE( aEdit )
   

   

Source/Library:

See Also:

dc_editsource()

Write Multiple-Window Editing configuration to source code

Syntax:

Arguments:

    None.
   

   

Returns:

    Nil
   

   

Description:

Examples:

    (-- Design and Save the Editing Configuration --)
   

   
 /* -- Open databases -- */
   
 OpenData()
   

   
 /* -- design editing windows to fit requirements -- */
   
 dc_edittile()
   

   
 /* -- save editing configuration to source-code -- */
   
 DC_EDITSOURCE()   // Save to MYEDIT()
   

   
 RETURN
   

   

   

   
 (-- Compile and Run the new Editing Configuration --)
   

   
 /* -- compile and link new source-code -- */
   

   
 /* -- Run editing configuration in new .EXE -- */
   
 OpenData()
   
 DC_EditRestore( MyEdit() )
   
 RETURN
   

   

   

   
 FUNCTION OpenData()
   
 use customer
   
 use invoice new index invoice
   
 use invitems new index invitems
   
 select customer
   
 set relation to cust_nmbr into invoice
   
 select invoice
   
 set relation to inv_nmbr into invitems
   
 select customer
   
 RETURN nil
   

   

   

Source/Library:

See Also:

dc_editstru()

Edit the dCLIP structure-extended database

Syntax:

Arguments:

    (cFileName) is the name of the "STRUCTURE EXTENDED" database.
   
 This database must have at least the four (4) following fields:
   

   
 Field Name        Type          Length
   
 -----------      ------------   -------
   
 FIELD_NAME        C              10
   
 FIELD_TYPE        C              1
   
 FIELD_LEN         N              3
   
 FIELD_DEC         N              3
   

   

Returns:

    A logical .TRUE. if the structure file was modified by the user,
   
 .FALSE. otherwise.
   

   

Description:

Examples:

     use customer
   
  // create a structure extended database
   
  dc_strudbf( 'new_stru' )
   
  if DC_EDITSTRU( 'new_stru' )
   
    create custnew from new_stru
   
  endif
   

   

Source/Library:

dc_edittile()

Invoke set of edit windows for specified list of work areas

Syntax:

Arguments:

    (nMode) is an optional argument for defining the method to
   
 display the editing windows being opened for relational or
   
 multi-window editing.
   

   
 nMode
   

   
  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 (nMode) argument is given, then a set of windows will
   
 automatically be created in a "best-fit" screen configuration.
   

   
 (aAlias) is an array of database ALIASes to edit.  If no array
   
 argument is passed, then all open work areas will be included
   
 in the tiled edit configuration.
   

   
 (lEdit) if .TRUE. (default) will initiate the edit (apply focus
   
 to first edit window) after painting all the edit windows on
   
 the screen.  If .FALSE., then the edit windows will be created
   
 and painted only.
   

   
 (lRelation) if .TRUE. will set a flag to automatically update
   
 all other edit windows that have relations set.  When the
   
 parent record pointer is moved, the child edit windows will
   
 be repainted.  If .FALSE. then all child fields will be merged
   
 into the parent edit window and the child edit windows will
   
 be updated only when selected.
   

   

Description:

Examples:

    . use all like DC*
   
 . DC_EDITTILE()
   
 . close all
   
 . use all
   
 . DC_EDITTILE( 3, { 'CUSTOMER','INVOICE','SALES' } )
   

   

Source/Library:

See Also:

dc_editwhen()

Post an array of fields to edit

Syntax:

Arguments:

    (aFields) is a single-dimensional array of field names.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    use customer
   
 DC_EDITWHEN({'NAME','STREET','CITY','STATE','ZIP'})
   
 DC_EditDb()
   

   

   

Source/Library:

See Also:

dc_encrypt()

Encrypt a character string or number

Syntax:

Arguments:

    (xValue) is a character string or numeric value.
   

   
 (cKey) is a character sequence, of any length, to use as
   
 a "seed" for the encryption.  If this parameter is not
   
 passed, then a default seed will be used.
   

   

Returns:

    An encrypted value of the same type as the original value.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 a := DC_ENCRYPT( "This is a test","CLIPPER" )
   
 ? a
   
 —¤ £ð¬¡ã­é¤µ¶¦
   

   
 ? DC_Decrypt( a, "CLIPPER" )
   
 This is a test
   

   

   
 -- Example 2 --
   

   
 a := DC_ENCRYPT( 23456.289, "CLIP53" )
   
 ? a
   
 59236.515
   

   
 ? DC_Decrypt( a, "CLIP53" )
   
 23456.289
   

   

Source/Library:

See Also:

dc_envirrest()

Restore the Clipper environment from an array or file

Syntax:

Arguments:

    (aEnvir) is an array of environment variables that was saved by
   
 DC_ENVIRSAVE().
   

   
 (cEnvirSave) is an array file containing the contents of the
   
 environment that was saved by DC_ENVIRSAVE( (cEnvirSave) ).
   

   

Returns:

    NIL
   

   

Description:

Examples:

    -- EXAMPLE 1 --
   

   
 aEnvir := dc_envirsave()
   
 do something
   
 DC_ENVIRREST( aEnvir )
   

   
 -- EXAMPLE 2 --
   

   
 dc_envirsave( 'ENVIR.AR' )
   
 do something
   
 DC_ENVIRREST( 'ENVIR.AR' )
   

   

Source/Library:

See Also:

dc_envirsave()

Save the entire Clipper environment to an array or file

Syntax:

Arguments:

    (cFileName) the name of the file to save the Clipper
   
 environment to.
   

   
 If no argument is passed then no file will be created, however
   
 the current Clipper environment will still be returned in an
   
 array.
   

   

Returns:

    The 38 Clipper environment variables in an array.  See ARRAY.CH
   
 (included in Clipper distribution) for the values.
   

   

   

Description:

Examples:

    -- Example 1 --
   

   
 aEnvir := DC_ENVIRSAVE()
   
 do something
   
 dc_envirrest( aEnvir )
   

   
 -- Example 2 --
   

   
 DC_ENVIRSAVE( 'ENVIR.AR' )
   
 do something
   
 dc_envirrest( 'ENVIR.AR' )
   

   

Source/Library:

See Also:

dc_erase()

Pop-up a user-prompt menu for erasing a file

Syntax:

Arguments:

    NONE
   

   

Returns:

    A logical .TRUE. if a file was erased, .FALSE. otherwise.
   

   

Description:

Examples:

    @ 12,10 prompt "Copy a File"
   
 @ 13,10 prompt "Erase a File"
   
 menu to nChoice
   
 do case
   
   case nChoice = 1
   
     dc_copyfile()
   
   case nChoice = 2
   
     DC_ERASE()
   
 endcase
   

   

Source/Library:

See Also:

dc_error()

The dCLIP error handler

Syntax:

Arguments:

    (cFileName) is the name of the default error log file in the
   
 event that the operator chooses to write out error information
   
 to a file. If no parameter is passed, then DCLIP.LOG is the
   
 default.
   

   

   

Description:

Examples:

    FUNCTION startup()
   

   
 Errorblock( { |e| DC_ERROR( e ) } )  // Install dCLIP error
   
                                      // handler
   
 do main
   
 return nil
   

   

Source/Library:

See Also:

dc_errormsg()

Display an array of error messages in a window

Syntax:

Arguments:

    (aMessage) is an array of messages to display in the popup
   
 box.
   

   
 [lSound] - if .FALSE. don't sound error beep; default is
   
 .TRUE.
   

   
 [cTitle] is the title displayed in top line center of popup
   
 box; defaults to 'ERROR'
   

   

Returns:

    nil
   

   

Description:

Notes:

Examples:

    if !isprinter()
   
   DC_ERRORMSG( {'Printer Is Offline - Please Ensure Power',;
   
                 'Is On And Paper Is Inserted Properly'},;
   
                 '',;
   
                 ' Printer Error ')
   
 else
   
   ...
   
   ...
   
 endif
   

   

   

   

Source/Library:

See Also:

dc_execute()

Execute a function based on passed parameters

Syntax:

Arguments:

    (cCommand) is the command line to interpret and execute.
   

   
 The command line arguments are defined as follows:
   

   
 /W [(WorkGroup)] - Restore files, indexes, relations, etc. from a
   
                    *.DCW Work file (if it exists) or from a File
   
                    Group Tag named (WorkGroup) in the DCFILES.DBF
   
                    file dictionary.  If no (WorkGroup) name is
   
                    is given then a pick-list of File Groups
   
                    will be displayed.
   

   
 /M [(Menu)]      - Run a menu from the DCMENU.DBF Menu Dictionary.
   
                    If no (Menu) name is given then a pick-list of
   
                    Menus will be displayed.
   

   
 /B [(Browse)]    - If a (Browse) name is given, then load the
   
                    Browse configuration from the DCBROWSE.DBF
   
                    Browse dictionary and run the Browse System.
   
                    If no (Browse) name is given, then run the
   
                    browse using the built-in default browse
   
                    configuration.
   

   
 /E [(Edit)]      - If an (Edit) name is given, then load the
   
                    Editing configuration from the DCEDIT.DBF
   
                    Edit dictionary and run the Data-Entry System.
   
                    If no (Edit) name is given, then run the
   
                    edit using the built-in default edit
   
                    configuration.
   

   
 /D [(Database)]  - If a (Database) name is given, then open
   
                    the database, otherwise display a pick-list
   
                    of available databases.
   

   
 /R [(Rdd)]       - If an (Rdd) name is given, then select the
   
                    (Rdd) as the default data driver, otherwise
   
                    display a pick-list of available RDD's.
   

   
 /I [(Index1),... - If a list of (Index)es is given, then open
   
     (IndexN)]      the index list (after opening the (database)
   
                    otherwise, display a list of indexes that
   
                    match the database.
   

   
 /H               - Display command line help
   

   
 /Q               - Quit to calling program, otherwise Return to
   
                    the dot-prompt.
   

   
 /T               - Start-Up dCLIP using the Turbo-Assistant,
   
                    otherwise start-up at the dot-prompt.
   

   
 /A (Batch)       - Execute (Interpret) a *.DCB (Batch) file
   
    (p1,..p5)       with parameters
   

   
 /C (command)     - Interpret a Dot-Prompt Command
   

   
 /S (file)        - Use (file) as alternative to DCLIP.SYS parameter file
   

   
 /O (object)      - Dynamic-Link a Clipper-Compiled *.OBJ file
   

   
 /F (function)    - Run a function (with parameters)
   

   

   
 The following single arguments are also recognized for compatability
   
 with drag and drop features of Windows and OS/2:
   

   
 (database).DBF   - Open database and Browse it
   

   
 (workfile).DCW   - Restore work areas from Work File and Browse
   

   
 (object).OBJ     - Load Clipper-compiled .OBJect and run
   

   
 (batch).DCB      - Execute a dCLIP Batch file
   

   

   

Returns:

    A logical .TRUE. if the /Q parameter was included in the
   
 (cCommand) string, otherwise a .FALSE.
   

   

Description:

Examples:

    * Restore Work Areas from CUSTOMER.DCW
   
 * Browse databases
   
 * Quit
   

   
 DC_EXECUTE( '/W CUSTOMER /B /Q' )
   

   

Source/Library:

See Also:

dc_expl()

Explode a window with pre-defined colors

Syntax:

Arguments:

    (nStartRow), (nStartCol), (nEndRow), (nEndCol) are the screen
   
 coordinates for the box to explode.
   

   
 (cTitle) is the title heading on the top of the box.  If no
   
 argument is given, then there will be no title area.
   

   
 (lNoShadow) if .TRUE. will prevent the shadow from being
   
 created. Default is .FALSE. (shadow enabled).
   

   
 (lPaintOnly) if .TRUE. will paint the box on the screen but not
   
 perform the "exploding" process.  Default is .FALSE. (explode).
   

   

Returns:

    A character string that is a "composite" of the coordinates,
   
 colors, etc. to be used later to restore the screen with DC_IMPL().
   

   

Description:

Notes:

Examples:

    cSaveScreen := DC_EXPL( 10,10,12,70, ' Enter a command ' )
   
 cCommand := SPACE(50)
   
 @ 11,12 get cCommand
   
 read
   
 dc_impl( cSaveScreen )
   

   

   

Source/Library:

See Also:

dc_explmode()

Enable/Disable exploding windows

Syntax:

Arguments:

    (lExplode) if .TRUE. will force all windows created with
   
 DC_EXPL() and DC_EXPLODE() to "explode" (default).  If .FALSE.
   
 then all windows will be painted in "instant on" mode.
   

   

Returns:

    A logical value.  .T. - Instant On Mode, .F. - Explode Mode.
   

   

Description:

Examples:

    DC_EXPLMODE( .t. )  // Set instant on mode
   
 dc_browtile()       // Paint all the browse windows
   
 DC_EXPLMODE( .f. )  // Set explode mode
   

   

Source/Library:

See Also:

dc_explode()

Explode a window

Syntax:

Arguments:

    (nSrow), (nScol), (nErow), (nEcol) are the screen coordinates.
   

   
 (cColor1) is the color of the window frame.
   

   
 (cColor2) is the color of the window contents.
   

   
 (lTone) if .TRUE. will create a warning tone.  .FALSE. is
   
 default.
   

   
 (cTitle) is the a title to display at the top of the box.
   

   
 (nSlideRate) is a number from 1 to 10 to determine the speed at
   
 which a small box starting at the current cursor location moves
   
 across the screen to start the explode process.  A value of 0
   
 (default) will disable the sliding box. The smaller the number
   
 the faster the sliding box will move.
   

   
 (lShadow) if .TRUE. (default) will paint a shadow on the
   
 screen.
   

   
 (lPaintOnly) if .TRUE. will override the setting of
   
 DC_EXPLMODE() and "instantly" paint the box on the screen
   
 rather than "exploding" the box.
   

   
 (lDouble) if .TRUE. will paint a double line border.  A single
   
 line border (.FALSE.) is default.
   

   

Returns:

    A character string that is a "composite" of the coordinates,
   
 colors, etc. to be used later to restore the screen with
   
 DC_IMPLODE().
   

   

Description:

Examples:

    cSaveScrn := DC_EXPLODE(5,10,7,70,'B/W','N/W',.F.,;
   
              ' Enter a Command ',10)
   
 cCommand := space(50)
   
 @ 6,12 get cCommand
   
 read
   
 dc_implode( cSaveScrn )
   

   

Source/Library:

See Also:

dc_fax()

A Fax Server based on Faxual II

Syntax:

Arguments:

    (nComPort) is the Com port to use.  This should be the com port of
   
 the fax/modem.
   

   
 (cLocalId) is an optional parameter.  This is the default ID to
   
 send in case no ID is entered in the LOCALID field.
   

   
 (cAreaCode) is the area code of the fax server.  This will strip
   
 out all area codes in phone numbers of the same area so they will
   
 be sent as local calls.
   

   

Description:

Notes:

Examples:

    // Start up Fax Server
   

   
 DC_FAX( 2, 'DONNAY Software', '208' )
   

   

Source/Library:

See Also:

dc_faxadd()

Add an outgoing Fax to the Fax Server database

Syntax:

Arguments:

    (cFaxFile) is the name of the .DBF file to add the fax record.
   
 If no parameter is passed, then DCFAXIN.DBF is the default.
   

   
 (cPhone) is the phone number to call (required parameter).
   

   
 (dDateReq) is the date to send the fax.  Today's date is default.
   

   
 (cTimeReq) is the time to send the fax.  Current time is default.
   

   
 (cLogoFile) is the name of a .BMP file to insert at the top of
   
 the fax.  This must be a black and white only .BMP file.
   

   
 (cFaxMemo) is the text of the fax to send.
   

   
 (cFootFile) is an optional text file to include after the fax
   
 memo.
   

   
 (cLocalId) is the ID to print at the top of the fax (sender name).
   

   
 (cRef1), (cRef2), (cRef3), (cRef4) are optional reference fields.
   

   
 (cUser) is the USER ID of the person sending the fax.
   

   
 (lReview) if .TRUE. will display a dialogue screen of all the
   
 fax parameters for the operator to review before adding the fax
   
 to the database, otherwise the fax will be added with no review.
   

   

Description:

Notes:

Examples:

    // Start up Fax Server on Workstation 1 or in a Window
   

   
 DC_FAX( 2, 'DONNAY Software', '208' )
   

   

   
 // Send a fax request to the server from another workstation.
   

   
 cMemo := DC_MemoBase() // Write the memo
   

   
 // Send the fax
   
 DC_FAXADD(  ;
   
  nil, ;
   
  '208-331-2621',;
   
  nil, ;
   
  nil, ;
   
  'MYLOGO.BMP',;
   
  cMemo,;
   
  'AGREE.TXT',;
   
  'Donnay Software' )
   

   

Source/Library:

See Also:

dc_faxbatch()

Process a batch of outgoing Faxes to the Fax Server database

Syntax:

Arguments:

    (cData) is the alias of the data file to merge.
   

   
 (cFax) is the name of the .DBF file to add the fax record.
   
 If no parameter is passed, then DCFAXIN.DBF is the default.
   

   
 (cPhone) is a valid Clipper expression that is evaluated to
   
 get the phone number.  Usually this is a pointer to a database
   
 field.
   

   
 (dDate) is the date to send the fax.  Today's date is default.
   

   
 (cTime) is the time to send the fax.  Current time is default.
   

   
 (cLogo) is the name of a .BMP file to insert at the top of
   
 the fax.  This must be a black and white only .BMP file.
   

   
 (cMemo) is the text of the fax to send.  The contents of this
   
 memo is merged with the data using the function DC_TEXTMERGE().
   

   
 (cFoot) is an optional text file to include after the fax
   
 memo.
   

   
 (cId) is the ID to print at the top of the fax (sender name).
   

   
 (cR1), (cR2), (cR3), (cR4) are optional Clipper expressions to
   
 evaluate for storing reference information.  Usually these are
   
 pointers to database fields.
   

   
 (cUser) is the USER ID of the person sending the fax.
   

   
 (lReview) if .TRUE. will display a dialogue screen of all the
   
 fax parameters for the operator to review before adding the fax
   
 to the database, otherwise the fax will be added with no review.
   

   
 (cOutP) is the output path of the DCFAXIN.DBF file that will
   
 be created.  This should be the directory that contains the
   
 DCFAX.DBF which is being processed by the Fax server.
   

   
 (nRec) is the start record of the database to merge.  If no
   
 parameter is passed the merge will start at the top of the
   
 database.
   

   
 (cQuery) is the name of an optional QUERY expression to use as
   
 a filter on the database.  This must be a query that was
   
 previously created and stored in the DCQUERY.DBF database using
   
 DC_QUERY().
   

   
 (xScope0) and (xScope1) are an optional SCOPING condition to use
   
 on the database.  (xScope0) is the SCOPE TOP and (xScope1) is the
   
 SCOPE BOTTOM.  These values must match the type of the index key of
   
 the current controlling index of the merge database.
   

   
 (cFilt) is an optional filter expression to use on the database.
   

   

Description:

Notes:

Examples:

    // Start up Fax Server on Workstation 1 or in a Window
   

   
 DC_FAX( 2, 'DONNAY Software', '208' )
   

   

   
 // Send a batch of faxes to the server from another workstation.
   

   
 cMemo := MemoRead( 'LETTER.TXT' )  // Load the merge memo
   
 USE addresses INDEX names  // Open the address database
   

   
 // Send the faxes
   

   
 DC_FAXBATCH(  ;
   
  'ADDRESSES',;
   
  nil, ;
   
  'ADDRESSES-)phone',;
   
  nil, ;
   
  nil, ;
   
  'MYLOGO.BMP',;
   
  cMemo,;
   
  'AGREE.TXT',;
   
  'Donnay Software' )
   

   

Source/Library:

See Also:

dc_feof()

Is current opened binary/text file at end-of-file?

Syntax:

Arguments:

    (nHandle) is the DOS file handle returned by FOPEN().
   

   

Description:

Examples:

    nHandle := fopen( 'dclip.sys' )
   
 do while !DC_FEOF( nHandle )
   
   ? dc_freadline( nHandle )
   
 enddo
   

   

Source/Library:

dc_ferror()

Display the status of the last file operation

Syntax:

Arguments:

    (nHandle) is the handle number of the file.  This parameter
   
 is needed only if you wish to return the file name in
   
 @(cFileName) from the file handle.
   

   
 (nErrorCode) is the error code to display.  If no parameter
   
 is passed, then the message corresponding to the code returned
   
 by FERROR() will be displayed.
   

   
 @(cFileName) is the name of a memvar to place the file name
   
 calculated from (nHandle).
   

   

   

Returns:

    A logical .TRUE. if the last file operation was successful, .FALSE.
   
 otherwise.
   

   

Description:

Examples:

    accept "Enter a file to view" to cFileName
   
 nHandle := fopen( cFileName )
   
 begin sequence
   
 if DC_FERROR()
   
   break
   
 endif
   
 aView := {}
   
 do while !dc_feof()
   
   aadd( aView, dc_freadline( nhandle ) )
   
 enddo
   
 fclose( nHandle )
   
 achoice( 0,0,24,79, aView )
   
 end sequence
   

   

   

Source/Library:

dc_fieldarray()

Capture the current work area to a field definition array

Syntax:

Arguments:

    (lRelFields) if true will also include all the fields in all
   
 child relation work areas, otherwise only the fields in the
   
 currently selected area will be returned in the array.
   

   

   

Returns:

    An array consisting of two sub-arrays:
   

   
 Sub-array #1 is a 2-dimensional array consisting of one
   
 sub-array for each field.  See RETURNS in the documentation
   
 of DC_FIELDEDIT() for a definition of this array.
   

   
 Sub-array #2 is a single-dimensional array that contains
   
 the ALIAS() of each work-area used to create the field
   
 arrays.
   

   

   

Description:

Examples:

    USE customer
   
 aFieldGroup := DC_FIELDARRAY()
   

   

   

Source/Library:

See Also:

dc_fieldconfig()

Edit or add a field array element

Syntax:

Source/Library:

dc_fielddfn()

Create a .PRG file with FIELD definitions from Dictionary

Syntax:

Arguments:

    None.
   

   

   

Returns:

    A logical .TRUE. if the file was created successfully.
   

   

   

Description:

Source/Library:

dc_fieldedit()

A Field Definition editor

Syntax:

Arguments:

    (cFieldGroup) is the name of the field group in DCFIELDS.DBF
   
 to load and edit (up to 8 characters) or (aFieldGroup) is a
   
 Field Group array.  See RETURNS for a specification of this
   
 array.  If no parameter is passed, a pick-list of all Field
   
 Groups in DCFIELDS.DBF will be displayed.
   

   

Returns:

    A 2-dimension array consisting of 2 sub-arrays:
   

   
 Sub-array #1 contains general information about this field
   
 group.
   

   
 * - Maximum Length allowed, Minimum Length is 0
   

   
 Element         Type   Len   Description
   
 -------------   ----   --- -------------------------------
   
    1             C       8*  Field Group Name
   
    2             C      10*  File Alias
   
    3             C      50*  Field Group Description
   

   

   
 Sub-array #2 contains one sub-array for each field
   
 definition.
   

   
 See DCFIELDS.CH for the definitions of the array elements.
   

   
 Element         Type   Len   Description
   
 -------------   ----   ---   --------------------------------
   
 DCFLD_GROUP      C       8*  Field Group Name
   
 DCFLD_ALIAS      C      10*  File Alias
   
 DCFLD_VIRTUAL    L           Virtual Field = .t.
   
                              Real database field = .f.
   
 DCFLD_NAME       C     300*  Field Name if Real Field
   
                              Expression if Virtual Field
   
 DCFLD_TYPE       C       2*  Field Type ( C,D,L,N,M,CA,A,V )
   
 DCFLD_LEN        N           Field Length
   
 DCFLD_DEC        N           Field Decimals
   
 DCFLD_ORDER      N           Field Order in Database
   
 DCFLD_DESC       C     100*  Field Descriptor (used in browse
   
                              column headings and edit screens)
   
                              Use semi-colons (;) for multiple
   
                              lines.
   
 DCFLD_PROMPT     C    1000*  Field Prompt (used in help window)
   
 DCFLD_PICT       C     100*  Field Picture Clause
   
                              See Clipper TRANSFORM() function
   
 DCFLD_VALTYPE    C       1   Field Validation Type
   
                              See EDITING for more info
   
                              N - None
   
                              F - Calculated Field
   
                              X - Logical Expression
   
                              R - Range
   
                              L - File Look-Up
   
                              T - Table Look-Up
   
                              V - View (Browse) Look-Up
   
                              A - Auto-Fill
   
                              C - Choice
   
                              E - Encrypted
   
                              M - Memo Window
   
 DCFLD_DEFAULT    C     200*  Field Default value
   
 DCFLD_WHEN       C     300*  Field When Clause
   
 DCFLD_VALID      C     300*  Field Valid Clause or Formula
   
 DCFLD_EMPTY      L           Empty Value Allowed
   
 DCFLD_ACCESS     N           Access Level
   
 DCFLD_NROW       N           Field Display Row (EDIT only)
   
 DCFLD_NCOL       N           Field Display Column (EDIT only)
   
 DCFLD_DROW       N           Descriptor Display Row (EDIT only)
   
 DCFLD_DCOL       N           Descriptor Display Column (EDIT only)
   
 DCFLD_SORT       N           Sorting element
   
 DCFLD_PAGE       N           Display Page (EDIT Only)
   
 DCFLD_BRTAG      L           Tagged (BROWSE Only)
   
 DCFLD_EDTAG      L           Tagged (EDIT Only)
   
 DCFLD_BRLOCK     L           Locked (BROWSE Only)
   
 DCFLD_EDLOCK     L           Locked (EDIT Only)
   
 DCFLD_MSROW      N           Memo Start Row (EDIT Only)
   
 DCFLD_MSCOL      N           Memo Start Column (EDIT Only)
   
 DCFLD_MEROW      N           Memo End Row (EDIT Only)
   
 DCFLD_MECOL      N           Memo End Column (EDIT Only)
   
 DCFLD_MDISP      N           Memo Display Option (EDIT Only)
   
 DCFLD_WIDTH      N           Column Width (BROWSE Only)
   
 DCFLD_TOTAL      N           Column Total (BROWSE Only)
   
 DCFLD_EDOPT      C      50*  Edit Option String
   
 DCFLD_BRDCOLOR   C      10*  Descriptor Color (BROWSE Only)
   
 DCFLD_BRFCOLOR   C      10*  Field Color (BROWSE Only)
   
 DCFLD_EDDCOLOR   C      10*  Descriptor Color (EDIT Only)
   
 DCFLD_EDFCOLOR   C      10*  Field Color (EDIT Only)
   
 DCFLD_HELPCODE   C      22*  Help Code
   
 DCFLD_VALUE      X           Place to store Old Field Value
   
 DCFLD_RANGE1     C      50*  Range Scope Start Value
   
 DCFLD_RANGE2     C      50*  Range Scope End Value
   
 DCFLD_RANGE3     L           Indexed Range scope (logical)
   
 DCFLD_OLDNAME    C      10*  Old field name
   
 DCFLD_OLDTYPE    C       2*  Old field type
   

   

   

Description:

Notes:

Examples:

    -- Example 1 --
   
 // Load a field group from the dictionary and edit it //
   
 DC_FIELDEDIT()
   

   
 -- Example 2 --
   
 // Edit field group "CUSTOMER"
   
 DC_FIELDEDIT("CUSTOMER")
   

   
 -- Example 3 --
   
 // Edit a field group array //
   
 aFieldGroup := DC_FieldPick()
   
 aFieldGroup := DC_FIELDEDIT( aFieldGroup )
   

   

   

Source/Library:

See Also:

dc_fieldimp()

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.
   

   

   

Returns:

    A logical .TRUE. if the field group was imported successfully.
   

   

   

   

Description:

Notes:

Source/Library:

See Also:

dc_fieldload()

Load a field group array from the field dictionary

Syntax:

Arguments:

    (cFieldGroup) is the name of the field group in DCFIELDS.DBF
   
 to load (up to 8 characters).  If no parameter is passed, a
   
 pick-list of all Field Groups in the DCFIELDS.DBF dictionary
   
 will be displayed.
   

   
 (lCache) if .TRUE. (default) will save the group to a static
   
 (cache) array so the next time it is requested it will
   
 be reloaded from the cache for faster speed.  If .FALSE. then
   
 it will not be saved to the static array.
   

   
 (lMessage) if .TRUE. (default) will display an error message
   
 if the Field Group could not be loaded or does not exist
   
 in the dictionary file.  If .FALSE, then no error message
   
 will be displayed.
   

   
 (lCreateDbf) if .TRUE. (default) will create any empty
   
 DCFIELDS.DBF if it cannot be found.  If .FALSE. the
   
 database will not be created.
   

   
 (lErrorOk) if .FALSE. (default) will return a NIL if the
   
 field array being loaded does not match the structure of the
   
 currently selected database.  If .TRUE. then the field array
   
 loaded from the dictionary will always be returned.
   

   
 (lImport) if .TRUE. will attempt to load the array from a
   
 an import file named DXFIELDS.DBF.  If .FALSE. (default) then
   
 the array will be loaded from the standard DCFIELDS.DBF
   
 dictionary.
   

   

   

   

Returns:

    A field group array that conforms to the specifications in
   
 the RETURNS section of the function DC_FIELDEDIT().
   

   

   

Description:

Examples:

    aFieldGroup := DC_FIELDLOAD()
   
 aFieldGroup := DC_FieldEdit( aFieldGroup )
   
 DC_FieldSave( aFieldGroup )
   

   

   

   

   

Source/Library:

See Also:

dc_fieldpick()

Pick a field group from the field dictionary

Syntax:

Arguments:

    (cTitle) is the title to display on the pick-list box.
   

   

Returns:

    A character string.
   

   

   

Description:

Examples:

    cFieldGroup := DC_FIELDPICK()
   
 IF !Empty(cFieldGroup)
   
   aFieldGroup := DC_FieldEdit( cFieldGroup )
   
 ENDIF
   

   

   

   

   

   

Source/Library:

See Also:

dc_fields()

Pick a field from a list of primary/relational fields

Syntax:

Arguments:

   
   
 (nStCol) is the starting column of the display ( 0 - 40 ).
   

   
 (cValidType) is a string containing valid field types to
   
 return. If the operator selects a field type which is not in
   
 the passed string, a message will be displayed showing that the
   
 selected field is not valid for this operation.  If this
   
 parameter is not used then all fields will be valid.
   

   
 @(cDescription) is the name of a memvar to place the
   
 decription of the field selected.  This description will be
   
 the same as the field name unless descriptors were previously
   
 loaded into the DCDICT array with DC_DICTADD().
   

   
 (cTitle) is the title to display at the top of the field pick
   
 list.  If no parameter is passed, then "Select a Field" will
   
 be displayed.
   

   
 (lExplode) if .TRUE. (default) will explode a box around the
   
 picklist with the title and scroll-bars.  If .FALSE., then
   
 only the pick-list items will be updated.  This parameter is
   
 provided to allow DC_FIELDS() to be used in a loop.
   

   
 (lExit) if .TRUE. will display the field pick-list but then
   
 immediately exit with the field-list remaining on the screen.
   

   

   

Returns:

    The field name of the field selected.
   

   

Description:

Examples:

    local cSaveScreen, cString, cFieldName, GetList := {}
   
 cSaveScreen := dc_expl(10,5,16,35)
   
 cString := space(20)
   
 @ 11,7 say 'Enter search string'
   
 @ 12,7 get cString
   
 read
   
 @ 14,7 say 'Pick a Character or Memo'
   
 @ 15,7 say 'field to search'
   
 cFieldName := DC_FIELDS( 40, 'CM' )
   
 dc_impl(cSaveScreen)
   
 if !empty(cFieldName)
   
   loca for upper(alltrim(cString)) $ upper(&cFieldName)
   
 endif
   

   

Source/Library:

dc_fieldsave()

Save a field group array to the field dictionary

Syntax:

Arguments:

    (aFieldGroup) is a field group array that conforms to
   
 the specifications in the RETURNS section of the function
   
 DC_FIELDEDIT().
   

   

   

Returns:

    A logical .TRUE. if the field group was saved successfully,
   
 .FALSE. otherwise.
   

   

Description:

Examples:

    cFieldGroup := DC_FieldPick()
   
 aFieldGroup := DC_FieldLoad( cFieldGroup )
   
 aFieldGroup := DC_FieldEdit( aFieldGroup )
   
 DC_FIELDSAVE( aFieldGroup )
   

   

   

   

Source/Library:

See Also:

dc_fieldsort()

Establish whether Field Pick-lists should be sorted

Syntax:

Arguments:

    (lMode) if .TRUE. will sort fields alphabetically.  The
   
 default is .FALSE.
   

   

Returns:

    The current mode.
   

   

Description:

Examples:

    use customer
   
 DC_FIELDSORT(.t.)
   
 cField := DC_Fields()
   

   

Source/Library:

See Also:

dc_filearray()

Capture work area(s) to a file definition array

Syntax:

Arguments:

    (lAllAreas) if .TRUE. (default) will also include all the
   
 files in all open work areas, otherwise only the files in the
   
 currently selected area will be returned in the array.
   

   
 (lVerbose) if .TRUE. (default) will display information
   
 being captured in a window, otherwise nothing will be
   
 displayed.
   

   

Returns:

    An array consisting of three sub-arrays:
   

   
 Sub-array #1 is an array of two elements: Element #1
   
 contains the ALIAS() of the current work area and element
   
 #2 is a null string.
   

   
 Sub-array #2 is a 2-dimensional array consisting of one
   
 sub-array for each file, index or relation.  See RETURNS in
   
 the documentation of DC_FILEEDIT() for a definition of this
   
 array.
   

   
 Sub-array #3 is a set of 3 sub-arrays:
   
 Element #1 is an array containing the current Browse
   
 configuration of all work areas (DCBROWSE).
   
 Element #2 is an array containing the current Edit
   
 configuration of all work areas (DCEDIT).
   
 Element #3 is an array containing the current Import
   
 configuration of all work areas (DCIMPORT).
   

   

Description:

Examples:

    use customer shared readonly
   
 set index to custname, custnmbr
   
 aFileGroup := DC_FILEARRAY()
   

   

   

Source/Library:

See Also:

dc_fileedit()

A Database File / Work area Definition editor

Syntax:

Arguments:

    (cFieldGroup) is the name of the field group in DCFIELDS.DBF
   
 to load and edit (up to 8 characters) or (aFieldGroup) is a
   
 Field Group array.  See RETURNS for a specification of this
   
 array.  If no parameter is passed, a pick-list of all Field
   
 Groups in DCFIELDS.DBF will be displayed.
   

   

Returns:

    A 2-dimension array consisting of 2 sub-arrays:
   

   
 See DCWORK.CH for the definitions of the array elements.
   

   
 Sub-array #1 contains general information about this file
   
 group.
   

   
 * - Maximum Length allowed, Minimum Length is 0
   

   
 Element           Type   Len   Description
   
 -------------     ----   ---   ------------------------------
   
 DCWORK_GROUPNAME    C      8*  File Group Name
   
 DCWORK_GROUPDESC    C     50*  File Group Description
   
 DCWORK_GROUPDEFA    C    100*  Default Directory for files
   

   

   

   
 Sub-array #2 contains one sub-array for each file, index
   
 or relation definition.
   

   
 Element         Type   Len   Description
   
 -------------   ----   ---   --------------------------------
   
 DCWORK_TYPE      C       1   Item Type
   
                              E - Open Database exclusive
   
                              S - Open Database shared
   
                              I - Open Index
   
                              R - Set a relation
   
 DCWORK_NAME      C     150*  File Name
   
 DCWORK_DESC      C      50*  Description of File
   
 DCWORK_ALIAS     C      10*  Alias Name
   
 DCWORK_RELALIAS  C      10*  Relational Alias Name
   
 DCWORK_FIELD1    C      10*  Relational Field
   
 DCWORK_KEY       C     300*  Index Key Expression
   
 DCWORK_RECNO     N           Database record to select
   
 DCWORK_FILTER    C     500*  Database filter expression
   
 DCWORK_RDD       C      10*  Name of RDD (Data-Driver to use)
   
 DCWORK_SUPERRDD  C      10*  Name of SUPER RDD (Data-Driver)
   
 DCWORK_INDEXNO   N           Index Order to select
   
 DCWORK_TAGNAME   C      10*  Index Tag Name to select
   
 DCWORK_INDEXFOR  C     500*  Index Condition expression
   
 DCWORK_DESCEND   L           Descending Index - .T.
   
 DCWORK_UNIQUE    L           Unique Index - .T.
   
 DCWORK_ISCDX     L           Combined Index - .T.
   
 DCWORK_BROWSE    C      10*  Browse Configuration Name
   
 DCWORK_EDIT      C      10*  Edit (Data-Entry) Configuration
   
 DCWORK_IMPORT    C      10*  Import Configuration
   
 DCWORK_DICT      C           Unused (reserved)
   

   

Description:

Notes:

Examples:

    -- Example 1 --
   
 // Load a file group from the dictionary and edit it //
   
 DC_FILEEDIT()
   

   
 -- Example 2 --
   
 // Edit file group "CUSTOMER"
   
 DC_FILEEDIT("CUSTOMER")
   

   
 -- Example 3 --
   
 // Edit a file group array //
   
 aFileGroup := DC_FilePik()
   
 aFileGroup := DC_FILEEDIT( aFileGroup )
   

   

   

Source/Library:

dc_fileimp()

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.
   

   

Returns:

    A logical .TRUE. if the file group was imported successfully.
   

   

   

   

Description:

Notes:

Source/Library:

See Also:

dc_filelist()

Return an array of files chosen by operator

Syntax:

Arguments:

    (aWildCard) is an array of character strings.  Each character
   
 string defines the wildcard for files to include in the
   
 directory pick-list.  Ex: { '*.IDX','*.CDX' }
   

   
 (cPath) is the start directory to display in the directory
   
 pick-list.
   

   
 (cTitle) is the title to display in the file "get-input" box.
   

   

Returns:

    An array of character strings.
   

   

Description:

Examples:

    aFiles := DC_FILELIST( {'*.COM','*.EXE'} )
   

   

Source/Library:

See Also:

dc_fileload()

Load a file group array from the file (work area) dictionary

Syntax:

Arguments:

    (cFileGroup) is the name of the file group in DCFILES.DBF
   
 to load.  If no parameter is passed, a pick-list of all
   
 File Groups in the DCFILES.DBF dictionary will be displayed.
   

   
 (lCache) if .TRUE. (default) will save the group to
   
 a static array so the next time it is requested it will
   
 be reloaded from the static array (cache) for faster speed.
   
 If .FALSE. then it will not be save to the cache.
   

   
 (lWorkFile) if .TRUE. will restore the file group from the
   
 currently open database rather than the DCFILES.DBF data
   
 dictionary.  The currently open database must have the same
   
 structure as DCFILES.DBF or any *.DCW work file.  If .FALSE.
   
 (default) then the file group is restored from the
   
 DCFILES.DBF dictionary.
   

   

Returns:

    A field group array that conforms to the specifications in
   
 the RETURNS section of the function DC_FIELDEDIT().
   

   

   

Description:

Examples:

    -- Example 1 --
   
 /* Restore work areas from a work file */
   
 USE customer.dcw
   
 DC_FILELOAD( nil,.t.,.t. )
   

   
 -- Example 2 --
   
 /* Restore Work areas from file dictionary */
   
 DC_FILELOAD( 'CUSTOMER' )
   

   
 -- Example 3 --
   
 /* Restore and Edit a file group array //
   
 cFileGroup := DC_FilePik()
   
 aFileGroup := DC_FILELOAD( cFileGroup )
   
 aFileGroup := DC_FileEdit( aFileGroup )
   

   

Source/Library:

See Also:

dc_filepick()

A Pick-List to choose a file

Syntax:

Arguments:

    (nStrow), (nStCol), (nEnRow) are the screen coordinates.  If
   
 none are passed then the window will be centered in the screen.
   

   
 (aWildCard) is an array of file-spec character strings
   
 representing the files to display in the file pick-list.
   

   

Returns:

    The name of the file chosen.
   

   
 A null-string will be returned if the operation is cancelled.
   

   

Description:

Examples:

    DC_FILEPICK( ,,,{'*.COM','*.EXE'} )
   

   

   

Source/Library:

See Also:

dc_filepik()

Pick a file (work-area) group from the file dictionary

Syntax:

Arguments:

    (cTitle) is the title to display on the pick-list box.
   

   

Returns:

    A character string.
   

   

   

Description:

Examples:

    cFileGroup := DC_FILEPIK()
   
 IF !Empty(cFileGroup)
   
   aFileGroup := DC_FileEdit( cFileGroup )
   
 ENDIF
   

   

   

   

   

   

Source/Library:

See Also:

dc_filesave()

Save Work area definition array to dictionary

Syntax:

Arguments:

    (aFileGroup) is a file group array that conforms to the
   
 specification of the array returned by DC_FILEEDIT().
   

   
 (lWorkFile) if .TRUE. will save the file group to the
   
 currently open database rather than the DCFILES.DBF data
   
 dictionary.  The currently open database must be empty
   
 and have the same structure as DCFILES.DBF or any *.DCW
   
 work file.  If .FALSE. (default) then the file group is
   
 saved to the DCFILES.DBF dictionary and will overwrite
   
 any file group with the same name.
   

   
 (lWorkAreas) if .TRUE. will save the information about
   
 currently open workareas rather than a passed array.
   
 The (aFileGroup) parameter is not needed and will be
   
 ignored if (lWorkAreas) is .TRUE.  The default is .FALSE.
   

   
 (cFileGroup) is needed only if (lWorkAreas) is .TRUE. This
   
 is the name of the file group (up to 8 characters) to assign
   
 to the file group.
   

   

Returns:

    A 2-dimension array consisting of 2 sub-arrays:
   

   
 Sub-array #1 contains general information about this file
   
 group.
   

   
 * - Maximum Length allowed, Minimum Length is 0
   

   
 Element         Type   Len   Description
   
 -------------   ----   --- -------------------------------
   
    1             C      8*  File Group Name
   
    2             C     50*  File Group Description
   

   

   
 Sub-array #2 contains one sub-array for each file, index
   
 or relation definition.
   

   
 See DCWORK.CH for the definitions of the array elements.
   

   
 Element         Type   Len   Description
   
 -------------   ----   ---   --------------------------------
   
 DCWORK_TYPE      C       1   Item Type
   
                              E - Open Database exclusive
   
                              S - Open Database shared
   
                              I - Open Index
   
                              R - Set a relation
   
 DCWORK_NAME      C     150*  File Name
   
 DCWORK_DESC      C      50*  Description of File
   
 DCWORK_ALIAS     C      10*  Alias Name
   
 DCWORK_RELALIAS  C      10*  Relational Alias Name
   
 DCWORK_FIELD1    C      10*  Relational Field
   
 DCWORK_KEY       C     300*  Index Key Expression
   
 DCWORK_RECNO     N           Database record to select
   
 DCWORK_FILTER    C     500*  Database filter expression
   
 DCWORK_RDD       C      10*  Name of RDD (Data-Driver to use)
   
 DCWORK_SUPERRDD  C      10*  Name of SUPER RDD (Data-Driver)
   
 DCWORK_INDEXNO   N           Index Order to select
   
 DCWORK_TAGNAME   C      10*  Index Tag Name to select
   
 DCWORK_INDEXFOR  C     500*  Index Condition expression
   
 DCWORK_DESCEND   L           Descending Index - .T.
   
 DCWORK_UNIQUE    L           Unique Index - .T.
   
 DCWORK_ISCDX     L           Combined Index - .T.
   
 DCWORK_BROWSE    C      10*  Browse Configuration Name
   
 DCWORK_EDIT      C      10*  Edit (Data-Entry) Configuration
   
 DCWORK_IMPORT    C      10*  Import Configuration
   
 DCWORK_DICT      C           Unused (reserved)
   

   

Description:

Examples:

    -- Example 1 --
   
 /* Save all work areas to a work file */
   
 dbCreate( 'CUSTOMER.DCW', DC_WorkStru() )
   
 USE customer.dcw
   
 DC_FILESAVE( ,.t.,.t.,'CUSTOMER' )
   

   
 -- Example 2 --
   
 /* Save Work areas to file dictionary */
   
 DC_FILESAVE( ,.f.,.t.,'CUSTOMER' )
   

   
 -- Example 3 --
   
 /* Edit and Save a file group array //
   
 cFileGroup := DC_FilePik()
   
 aFileGroup := DC_FileEdit( cFileGroup )
   
 DC_FILESAVE( aFileGroup )
   

   

Source/Library:

See Also:

dc_filevalid()

A function to validate file names entered into GETS

Syntax:

Arguments:

    (cFileName) is the value in the input GET to validate.  If a
   
 NIL is passed then the oGet:VarGet() value will be used.
   
 If the value in the get is empty, a pick-list of available
   
 files will be displayed.
   

   
 (nStrow),(nStcol),(nEnrow),(nEncol) are the screen
   
 coordinates to display the pick-list.
   

   
 (cWildcard) is the type of files to include in the list.
   
 Example: "*.DBF"
   

   
 (aWildCard) is a single-dimensional array containing
   
 character strings with the type of files to contain in
   
 the list.  Example: { "*.PRG","*.TXT","*.DCB" }
   

   
 (cDirectory) is the DOS directory.  If no argument is
   
 given, then the current DOS directory will be used.  The
   
 user can choose a different directory from the pick-list.
   
 If the current DEFAULT directory is to be used, then
   
 pass the argument SET(_SET_DEFAULT).
   

   
 (lWide) if .TRUE. will display the file list in WIDE format
   
 using DC_CHOICE().  If .FALSE. (default) the file list will
   
 be displayed in a format that includes pick-lists for
   
 directories, drives, and files using DC_DIRPICK().
   

   
 (lEmptyOK) if .TRUE. will not pop-up a file pick list if
   
 the GET is left empty. .FALSE. is the default.
   

   
 (lNotFoundOK) if .TRUE. will return a logical .TRUE. even
   
 if the file was not found.  The default is .FALSE.  If
   
 this parameter is .TRUE., then the file pick-list will not
   
 be displayed unless the operator presses (CTRL-ENTER) or
   
 double-clicks the mouse.
   

   

   

   

Returns:

    A .TRUE. if the file name entered is a valid file and exists
   
 in the directory or if the operator chooses a file from the
   
 pick-list.
   

   
 A .FALSE. if the file name entered is not valid or the
   
 operator presses ESCape.
   

   
 The name of the file chosen in the variable @(cFileName).
   

   

Description:

Examples:

    @ 10,10 say 'Enter FileName ' GET cFileName VALID ;
   
 DC_FILEVALID( @cFileName,,,,,'*.DBF',SET(_SET_DEFAULT) )
   

   

Source/Library:

See Also:

dc_filock()

Lock the current data file

Syntax:

Arguments:

    (nWaitTime) is the number of seconds to wait for the system to
   
 return a lock before returning the status or the error message.
   
 (0 = wait forever).
   

   
 (lDisplayError) if .true. will display an operator error
   
 message if the file cannot be locked. (default) or if .false.
   
 will not display an error message to the operator.
   

   

Returns:

    A logical .TRUE. if the file is locked, .FALSE. otherwise.
   

   

Description:

Examples:

    use customer
   
 if DC_FILOCK( 5 )
   
   replace print_flag with .F. for print_flag
   
   dc_unlock()
   
 endif
   

   

Source/Library:

dc_find()

Find a record from a pick-list of available indexes

Syntax:

Arguments:

    (cFieldSel) is the name of a reference field to display in a
   
 pick-list in the event that DC_FIND() finds more than one
   
 record that matches the entered value.  If no argument is
   
 given, then the first field in the database will be used as the
   
 reference.
   

   

Description:

Examples:

    use customer index cust_nmbr, cust_name, cust_code
   
 DC_FIND()
   

   

Source/Library:

See Also:

dc_fldtype()

Return the type of a field from it's name

Syntax:

Arguments:

    (cFieldName) is the name of the database field.
   

   

Returns:

    A character value.
   

   

Description:

Examples:

    append blank
   
 ? type('memo'), DC_FLDTYPE('memo')
   
 B B
   

   
 repl memo with directory()
   
 ? type('memo'), DC_FLDTYPE('memo')
   
 A A
   

   
 repl memo with 'string'
   
 ? type('memo'), DC_FLDTYPE('memo')
   
 C M
   

   

   

Source/Library:

dc_fmapdelete()

Delete a Field Map in the Field Map Dictionary

Syntax:

Arguments:

    (cMapGroup) is the name of the field map group in DCMAPS.DBF
   
 to delete (up to 8 characters).  If no parameter is passed,
   
 a pick-list of all Map Groups in DCMAPS.DBF will be displayed.
   

   

Returns:

    A logical .TRUE. if the field map was successfully deleted,
   
 otherwise a logical .FALSE.
   

   

Description:

Examples:

    -- Example 1 --
   
 // Delete the "TESTING" field map
   
 DC_FMAPDELETE("TESTING")
   

   

Source/Library:

See Also:

dc_fmapedit()

A Field Map editor

Syntax:

Arguments:

    (cMapGroup) is the name of the field map group in DCMAPS.DBF
   
 to load and edit (up to 8 characters) or (aMapGroup) is a
   
 Map Group array.  See RETURNS for a specification of this
   
 array.  If no parameter is passed, a pick-list of all Map
   
 Groups in DCMAPS.DBF will be displayed.
   

   

Returns:

    A multi-dimensional array consisting of 1 sub-array for
   
 each mapped item:
   

   
 See _DCFMAP.CH for the definitions of the array elements.
   

   
 An asterisk (*) denotes the "maximum" allowable length.
   

   
 Element         Type   Len   Description
   
 -------------   ----   ---   --------------------------------
   
 cMAP_SUBGROUP    C     10*   Sub-Group.  Use this element for
   
                              "conditional-mapping" based on
   
                              a sub-group name passed to the
   
                              DC_FMapImport() function.  If
   
                              left empty then it will be used
   
                              unconditionally.
   

   
 cMAP_FROMFIELD   C     10*   The name of to field to extract
   
                              information FROM.
   

   
 cMAP_TOFIELD     C     10*   The name of the field to write
   
                              information TO.
   

   
 cMAP_FROMALIAS   C     10*   The ALIAS name of the database
   
                              work area to select before
   
                              capturing the FROM field info.
   

   
 cMAP_TOALIAS     C     10*   The ALIAS name of the database
   
                              work area to select before writing
   
                              the TO field info.
   

   
 cMAP_TRANSFORM   C     100*  An optional Tranformation equation
   
                              for converting the FROM data before
   
                              writing it to the TO field.  Ex:
   
                              DC_CAPFIRST((f)).  NOTE: The (f)
   
                              performs a field name replacement
   
                              with the name of the FROM field.
   
                              Any literal name of any field may
   
                              also be used in the equation.
   

   
 cMAP_REPLMODE    C     1     The mode for replacing data in the
   
                              target field:
   

   
                              R - Replace field ALWAYS (default)
   
                              A - Append to existing data
   
                              E - Replace field only if EMPTY
   

   
 nMAP_TAG         L     1     Reserved
   

   

Description:

Notes:

Examples:

    -- Example 1 --
   
 // Load a field map group from the dictionary and edit it //
   
 DC_FMAPEDIT()
   

   
 -- Example 2 --
   
 // Edit field map group "CUSTOMER"
   
 DC_FMAPEDIT("CUSTOMER")
   

   
 -- Example 3 --
   
 // Edit a field map group array //
   
 aFMapGroup := DC_FMapPick()
   
 aFMapGroup := DC_FMAPEDIT( aFMapGroup )
   

   

   

Source/Library:

See Also:

dc_fmapimport()

Import or Replace data fields based on a Field Map

Syntax:

Arguments:

    (aMapGroup) is a field map array that conforms to the
   
 specifications documented in RETURNS for the function
   
 DC_FMAPEDIT().
   

   
 (cSubGroup) is the name of the map sub-group to include in
   
 the mapping process for the purpose of "conditional mapping".
   
 For example, let's say you have created a field map that
   
 is to be used for filling in default information in a
   
 CONTACTS.DBF database every time a new record is added to
   
 the database.  The field map must map information from one
   
 of 5 different database sources into the CONTACTS.DBF
   
 depending on a the TYPE of contact being made.  The value
   
 in the TYPE field would be passed as (cSubGroup) to insure
   
 that the correct mapping sub-group would be used.  Items
   
 in the map array which have an empty sub-group will always
   
 be mapped regardless of the (cSubGroup) value passed.
   

   
 (lAppendAll) if .TRUE. will traverse the PARENT database
   
 (defined in the Field Map array) starting at the current
   
 record pointer and all the way to the End of the file.
   
 For each record in the PARENT file a new record will be
   
 added to the TARGET file before the mapping process is
   
 accomplished.  If (lAppendAll) is .FALSE. (default), then
   
 mapping and replacement is accomplished based only on the
   
 existing database pointers.  NOTE: DC_FMapImport() will use
   
 any existing filter or scope condition that has been set
   
 on the PARENT database.
   

   
 (lWorking) if .TRUE. will display a "Working þþþ" progress
   
 indicator which is updated every .3 seconds while records
   
 are being appended and mapped.  This parameter is ignored
   
 if (lAppendAll) is .FALSE.
   

   

Returns:

    A logical .TRUE. if all fields defined in the field map
   
 were replaced successfully, otherwise a logical .FALSE.
   

   

Description:

Examples:

    /* -- Open a group of related files -- */
   
 DC_WorkRestore("MYSYSTEM")
   

   
 /* -- Add a new "P" record to the CONTACTS database -- */
   
 APPEND BLANK
   
 REPLACE CONT_TYPE WITH "P"
   

   
 /* -- Load the "CONTACTS" field map array -- */
   
 aMapGroup := DC_FMapLoad("CONTACTS")
   

   
 /* -- Make all replacements defined by field map -- */
   
 DC_FMAPIMPORT(aMapGroup,"P")
   

   

Source/Library:

See Also:

dc_fmapload()

Load a Field Map array from the Field Map Dictionary

Syntax:

Arguments:

    (cMapGroup) is the name of the field map group in DCMAPS.DBF
   
 to load (up to 8 characters).
   

   
 (lCache) if .TRUE. (default) will save the group to a static
   
 (cache) array so the next time it is requested it will
   
 be reloaded from the cache for faster speed.  If .FALSE. then
   
 it will not be saved to the static array.
   

   
 (lImport) if .TRUE. will attempt to load the array from a
   
 an import file named DXMAPS.DBF.  If .FALSE. (default) then
   
 the array will be loaded from the standard DCMAPS.DBF
   
 dictionary.
   

   

Returns:

    A multi-dimensional array consisting of 1 sub-array for
   
 each mapped item.  See RETURNS in DC_FMAPEDIT() for a
   
 definition of this array.
   

   

Description:

Notes:

Examples:

    -- Example 1 --
   
 // Load a field map group from the dictionary and edit it //
   
 aFmapGroup := DC_FMAPLOAD()
   
 aFmapGroup := DC_FMapEdit(aFmapGroup)
   

   
 -- Example 2 --
   
 // Replace field data based on the "SX" subgroup in field
   
 // Field Map "CUSTOMER"
   
 aFmapGroup := DC_FMAPLOAD("CUSTOMER")
   
 DC_FMapImport(aFmapGroup,"SX")
   

   

Source/Library:

See Also:

dc_fmappick()

Choose a Field Map name from Field Map Dictionary PickList

Syntax:

Arguments:

    (cTitle) is the title to display at the top of the pick-list.
   
 If no parameter is given, then a default title will be
   
 displayed.
   

   
 (lImport) if .TRUE. will display a list of maps in the import
   
 file named DXMAPS.DBF.  If .FALSE. (default) then the list will
   
 be loaded from the standard DCMAPS.DBF dictionary.
   

   

Returns:

    A character string.
   

   

Description:

Notes:

Examples:

    cFmapGroup := DC_FMAPPICK()
   
 aFmapGroup := DC_FmapLoad(cFmapGroup)
   
 DC_FMapImport(aFmapGroup)
   

   

   

Source/Library:

dc_fmapsave()

Save a Field Map array to the Field Map Dictionary

Syntax:

Arguments:

    (aMapGroup) is a field map array that conforms to the
   
 specifications documented in RETURNS for the function
   
 DC_FMAPEDIT().
   

   
 (lExport) if .TRUE. will save the array to an export file
   
 named DXMAPS.DBF.  If .FALSE. (default) then the array will
   
 be saved to the standard DCMAPS.DBF dictionary.
   

   

Returns:

    A logical .TRUE. if the map was successfully saved,
   
 otherwise a logical .FALSE.
   

   

Description:

Notes:

Examples:

    -- Example 1 --
   
 // Load a field map group from the standard DCMAPS.DBF
   
 // dictionary, edit the map, then export it to the
   
 // DCXMAPS.DBF export dictionary.
   
 aFmapGroup := DC_FMapLoad()
   
 aFmapGroup := DC_FMapEdit(aFmapGroup)
   
 DC_FMapSave(aFmapGroup,.t.)
   

   

Source/Library:

See Also:

dc_fornext()

Evaluate list of expressions for specified range of numbers

Syntax:

Arguments:

    (nStart) is the starting value to be assigned to a variable
   
 which will be incremented for each iteration of a FOR...NEXT
   
 loop.
   

   
 (nEnd) is the ending value.
   

   
 The incremental value will be passed to the (bEval) code block
   
 for each iteration of the loop.
   

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

   
 (bEval) is a code block to evaluate for each iteration of the
   
 loop.
   

   
 (bWhile) is an code block which must evaluate to .true. to
   
 continue the loop, otherwise the loop will be terminated.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    bEval := { | x | qout(x, sqrt(x) ) }
   
 bWhile := { || inkey()#27 }
   
 DC_FORNEXT( 100, 1000, 5, bEval, bWhile )
   

   

Source/Library:

See Also:

dc_foxrdd()

Get the best RDD to use for FoxPro compatability

Syntax:

Arguments:

    None.
   

   

Returns:

    A character value.
   

   

Description:

Examples:

    USE MYFILE RDD (DC_FoxRdd())
   

   

   

Source/Library:

dc_freadline()

Read a line of text from a file

Syntax:

Arguments:

    (nHandle) is a file handle returned by FOPEN() or FCREATE().
   

   

Returns:

    A character string equivalent to the contents of the current text
   
 line in the open ascii file.
   

   

Description:

Examples:

    local aView := {}
   
 cls
   
 accept "Enter a file to view " to cFileName
   
 nHandle := fopen( cFileName )
   
 do while !dc_feof( nHandle )
   
   aadd( aView, DC_FREADLINE( nhandle ) + ' ' )
   
 enddo
   
 fclose( nHandle )
   
 achoice( 0,0,24,79, aView )
   

   

   

Source/Library:

dc_frmcolumns()

Edit report form columns from a report form array

Syntax:

Arguments:

    (aReportInfo) is a multi-dimensional array with the report form
   
 information.  See DC_FRMSTRU() for a description of this array.
   

   
 (cFileName) is an optional parameter.  This is the name of the
   
 report file which will be created to use as a reference on the
   
 editor screen.
   

   

Returns:

    A multi-dimensional array containing the modified contents of
   
 the original array.
   

   

Description:

Examples:

    aReport := dc_frmstru( 'CUSTOMER.FRM' ) // Create report array
   
 do while .t.
   
   @ 10,10 prompt 'Edit form layout'
   
   @ 11,10 prompt 'Edit form columns'
   
   @ 12,10 prompt 'Save report form'
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       dc_frmlayout( aReport, 'CUSTOMER.FRM' )  // edit layout
   
     case nChoice = 2
   
       DC_FRMCOLUMNS( aReport, 'CUSTOMER.FRM' ) // edit columns
   
     case nChoice = 3
   
       dc_frmcreate( 'CUSTOMER.FRM', aReport )  // save report
   
       exit
   
   endcase
   
 enddo
   

   

Source/Library:

dc_frmcreate()

Create a .FRM report file from a report form array

Syntax:

Arguments:

    (cFileName) is the name of the file to create.
   

   
 (aReportInfo) is a multi-dimensional array with information
   
 about the report form.  See DC_FRMSTRU() for a description of a
   
 report form array.
   

   

Returns:

    A logical .TRUE. if the form is created with no errors, .FALSE.
   
 otherwise.
   

   

Description:

Examples:

    aReport := dc_frmstru( 'CUSTOMER.FRM' ) // Create report array
   
 do while .t.
   
   @ 10,10 prompt 'Edit form layout'
   
   @ 11,10 prompt 'Edit form columns'
   
   @ 12,10 prompt 'Save report form'
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       dc_frmlayout( aReport, 'CUSTOMER.FRM' )  // edit layout
   
     case nChoice = 2
   
       dc_frmcolumns( aReport, 'CUSTOMER.FRM' ) // edit columns
   
     case nChoice = 3
   
       DC_FRMCREATE( 'CUSTOMER.FRM', aReport )  // save report
   
       exit
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_frmlayout()

Edit a report form layout from a report form array

Syntax:

Arguments:

    (aReportInfo) is a multi-dimensional array with the report form
   
 information.  See DC_FRMSTRU() for a description of this array.
   

   
 (cFileName) is an optional parameter.  This is the name of the
   
 report file which will be created to use as a reference on the
   
 editor screen.
   

   

Returns:

    A multi-dimensional array containing the modified contents of
   
 the original array.
   

   

Description:

Examples:

    aReport := dc_frmstru( 'CUSTOMER.FRM' ) // Create report array
   
 do while .t.
   
   @ 10,10 prompt 'Edit form layout'
   
   @ 11,10 prompt 'Edit form columns'
   
   @ 12,10 prompt 'Save report form'
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       DC_FRMLAYOUT( aReport, 'CUSTOMER.FRM' )  // edit layout
   
     case nChoice = 2
   
       dc_frmcolumns( aReport, 'CUSTOMER.FRM' ) // edit columns
   
     case nChoice = 3
   
       dc_frmcreate( 'CUSTOMER.FRM', aReport )  // save report
   
       exit
   
   endcase
   
 enddo
   

   

Source/Library:

dc_frmmodify()

Edit or Create a Report form file

Syntax:

Arguments:

    (cReportFile) is the name of the Report Form (.FRM) file to
   
 edit. If no argument is given, then the menu will provide a
   
 user-prompt for entering a file name.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    @ 12,10 prompt "Modify a Report Form"
   
 @ 13,10 prompt "Output a Report Form"
   
 menu to nChoice
   
 do case
   
   case nChoice = 1
   
     DC_FRMMODIFY()
   
   case nChoice = 2
   
     dc_frmout()
   
 endcase
   

   

Source/Library:

dc_frmout()

Output a report form to screen, printer or file

Syntax:

Arguments:

    (cFormFile) is the name of the report form file (.FRM) to
   
 output to the screen, file or printer.  If no argument is
   
 given, then the name of the last report form to be printed will
   
 appear in the display for the user to modify.
   

   

Description:

Examples:

    @ 12,10 prompt "Modify a Report Form"
   
 @ 13,10 prompt "Output a Report Form"
   
 menu to nChoice
   
 do case
   
   case nChoice = 1
   
     dc_frmmodify()
   
   case nChoice = 2
   
     DC_FRMOUT()
   
 endcase
   

   

Source/Library:

dc_frmreport()

Front-End to Clipper's report function - displays Odometer

Syntax:

Arguments:

    Arguments are the same as __ReportForm().  See STD.CH - REPORT
   
 FORM command.
   

   
 (cFormFile)  - Report form file name
   
 (lPrint)     - Output to Printer
   
 (cToFile)    - Output to a file (cToFile)
   
 (lNoConsole) - Don't display output on console
   
 (bFor)       - FOR condition code block
   
 (bWhile)     - WHILE condition code block
   
 (nNext)      - Number of records to print
   
 (nRec)       - A single record number to print
   
 (lRest)      - Print only from current record to the end
   
 (lNoEject)   - Don't eject the printer paper first
   
 (lSummery)   - Print a summary report
   

   

Description:

Examples:

    // Pre-process REPORT FORM command to call DC_FRMREPORT()
   
 #include "DCRFORM.CH"
   

   
 REPORT FORM CUSTOMER TO PRINT NOEJECT
   

   

Source/Library:

dc_frmstru()

Create a report form array from a .FRM form file

Syntax:

Arguments:

    (cReportFile) is the name of a report form (.FRM) file.
   

   

Returns:

    A multi-dimensional array of two sub-arrays:
   

   
 The first sub-array (1) defines general information about the
   
 entire report.
   

   
 Element  Type        Description
   
 -------  ---------- -----------------------------------
   
  [1,1]   Character  Report Heading
   
  [1,2]   Character  Group Expression
   
  [1,3]   Character  Sub-Group Expression
   
  [1,4]   Character  Group Heading
   
  [1,5]   Character  Sub-Group Heading
   
  [1,6]   Numeric    Page Width
   
  [1,7]   Numeric    Lines per Page
   
  [1,8]   Numeric    Left Margin
   
  [1,9]   Numeric    Right Margin
   
  [1,10]  Numeric    Number of Columns
   
  [1,11]  Character  Double-Spaced? (Y/N)
   
  [1,12]  Character  Summary Report? (Y/N)
   
  [1,13]  Character  Page Eject? (Y/N)
   
  [1,14]  Character  Page Eject Before? (Y/N)
   
  [1,15]  Character  Page Eject After? (Y/N)
   
  [1,16]  Character  Plain Page? (Y/N)
   

   
 The second sub-array (2) consists of a sub-array for each
   
 column (col).  A maximum of 24 columns are allowed.
   

   
 Element     Type       Description
   
 --------   ---------- ------------------------------
   
 [2,col,1]  Numeric    Column Width
   
 [2,col,2]  Character  Totals? (Y/N)
   
 [2,col,3]  Numeric    Decimals
   
 [2,col,4]  Character  Column expression
   
 [2,col,5]  Character  Column heading
   

   

Description:

Examples:

    aReport := DC_FRMSTRU( 'CUSTOMER.FRM' ) // Create report array
   
 aReport := dc_frmlayout( aReport )      // Edit report layout
   
 aReport := dc_frmcolumns( aReport )     // Edit report columns
   
 dc_frmcreate( 'CUSTOMER.FRM', aReport ) // Create report file
   

   

Source/Library:

See Also:

dc_gatemenu()

Pop-up a user-configurable menu to gateway to dos programs

Syntax:

Arguments:

    (cHeading) is the heading to display at the top of the menu.
   
 If no argument is given, then " Gateway Menu " is default.
   

   
 (cMenuSel) is a single character designating the program to
   
 run:  A,B,C,E,F,G,I,J,K,L,N,O,P,R,T,U,V,W,X,Y,Z,1,2 or 3
   

   
 If (cMenuSel) argument is not 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.
   

   
 cDirectory is the directory that you wish to create the
   
 .DBF file if it doesn't exist.  (Default is SET DEFAULT).
   

   
 cFileName (new)  - The name you want to assign to the .DBF
   
 if it doesn't exist.  (Default is DCGATE.DBF)
   

   

Description:

Notes:

Examples:

    DC_GATEMENU()       // display menu of pre-defined programs.
   
 DC_GATEMENU( 'C' )  // run program number C.
   

   

Source/Library:

See Also:

dc_gateway()

Call the dos shell or any other executable program

Syntax:

Arguments:

    (cCommand) is a string containing the NAME OF THE PROGRAM to
   
 run and it's parameters.  If it is an empty string, the
   
 function will shell out to dos and run COMMAND.COM.
   

   
 (nMemory) is the AMOUNT OF MEMORY in K that you want to free
   
 up.  Specify 0 or a number greater than available memory to free
   
 up all the memory possible.
   

   
 (cPrompt) is a string containing the DOS PROMPT you want
   
 displayed if you are shelling to dos.
   

   
 (cSwapDir) is a string containing one or two DOS path
   
 specifications (seperated by semi-colon) to tell DC_GATEWAY()
   
 where to place the temporary file(s) produced by DC_GATEWAY().
   

   
 (cEnvironment) is a set of environment strings (separated by
   
 CHR(0)s) to modify the parent environment.  This can be used to
   
 add, delete, or change any environment string in the parent
   
 environment.
   

   

Returns:

    A Logical .TRUE. if the function succeeded or .FALSE. if the
   
 function call produced an error.  See GATEWAY ERROR for possible
   
 error codes.
   

   

Description:

Source/Library:

See Also:

dc_getactive()

Return the currently active GET object

Syntax:

Arguments:

    NONE
   

   

Returns:

    DC_GETACTIVE() returns the current active Get object within the
   
 current READ by DC_READMODAL().  If there is no READ active when
   
 DC_GETACTIVE() is called, it returns NIL.
   

   

Description:

Notes:

Examples:

    // This code uses a WHEN clause to force control to branch to a
   
 // special reader function.  Within this function, DC_GETACTIVE()
   
 // retrieves the active Get object:
   

   
 GetList := {}
   
 @ 10, 10 GET x
   
 @ 11, 10 GET y WHEN MyReader()
   
 @ 12, 10 GET z
   
 dc_readmodal( GetList )
   

   
 // Called just before second get (above)
   
 // becomes current
   
 FUNCTION MyReader
   
 LOCAL objGet               // Active Get holder
   
 objGet := DC_GETACTIVE()      // Retrieve current
   
                               // active Get
   
 BarCodeRead( objGet )
   
 RETURN (.F.)               // Causes Get to be
   
                            // skipped in READ
   

   

   

   

   

Source/Library:

See Also:

dc_getclip()

Get the value of a Clipper Environment setting

Syntax:

Arguments:

    (cName) is any parameter that has been burned into the
   
 Clipper .EXEcutable or has been passed via the // option.
   

   

   

Returns:

    A numeric value.
   

   

Description:

Examples:

    // Assume that the application is MAIN.EXE
   

   
 MAIN  //X120;F99;MOUSE;RDD:2
   

   
 ? DC_GETCLIP("X")
   
 120
   

   
 ? DC_GETCLIP("F")
   
 99
   

   
 ? DC_GETCLIP("MOUSE")
   
 0
   

   
 ? DC_GETCLIP("RDD")
   
 2
   

   
 ? DC_GETCLIP("ROGER")  // not defined
   
 -1
   

Source/Library:

dc_getdevout()

A Replacement for DevPos()/DevOut() when writing @SAY..GETS

Syntax:

Arguments:

    (nRow) is the display row.
   

   
 (nCol) is the display column.
   

   
 (cExpr) is the string to display.
   

   
 (cColor) is the display color for the string.  If no argument
   
 is passed, the current system color will be used.
   

   

Returns:

    Nil
   

   

Description:

Notes:

Examples:

    #include "dcget.ch"
   

   
 LOCAL GetList := {}, aData, i
   

   
 use (cDataFile)
   
 aData := Array(Fcount())
   
 FOR i := 1 TO LEN( aData )
   
   aData[i] := FieldGet(i)
   
 NEXT
   
 DC_ReadWindow( { 10, 10, 20, 60 } )
   
 FOR i := 1 TO LEN(aData)
   
   DC_GETDEVOUT( i, 12, PadL(Field(i),10), )
   
   SetPos( Row(), Col()+1 )
   
   AAdd( GetList,_GET_(aData[i],"aData[i]",,,) )
   
   DC_GetDisplay( GetList )
   
   GetList := DC_AddCargo(GetList,-1*i)
   
   GetList := ;
   
      DC_AddCargo(GetList,{ 108, { i, 12, PadL(Field(i),10) }})
   
 NEXT
   
 DC_ReadModal( GetList,,aReadArea )
   
 RETURN nil
   

   

   

Source/Library:

See Also:

dc_getdisplay()

Display a GET on the screen if it falls in scroll region

Syntax:

Arguments:

    (GetList) is the GET array containing a set of GETS.
   

   

Returns:

    Nil
   

   

Description:

Notes:

Examples:

    #include "dcget.ch"
   

   
 LOCAL GetList := {}, aData, i
   

   
 use (cDataFile)
   
 aData := Array(Fcount())
   
 FOR i := 1 TO LEN( aData )
   
   aData[i] := FieldGet(i)
   
 NEXT
   
 DC_ReadWindow( { 10, 10, 20, 60 } )
   
 FOR i := 1 TO LEN(aData)
   
   DC_GetDevOut( i, 12, PadL(Field(i),10), )
   
   SetPos( Row(), Col()+1 )
   
   AAdd( GetList,_GET_(aData[i],"aData[i]",,,) )
   
   DC_GETDISPLAY( GetList )
   
   GetList := DC_AddCargo(GetList,-1*i)
   
   GetList := ;
   
      DC_AddCargo(GetList,{ 108, { i, 12, PadL(Field(i),10) }})
   
 NEXT
   
 DC_ReadModal( GetList,,aReadArea )
   
 RETURN nil
   

   

   

Source/Library:

See Also:

dc_getvalue()

Handy function for getting an input value from user

Syntax:

Arguments:

    (cType) is the type of value to prompt the operator for.
   

   
  "C" - Character
   
  "N" - Numeric
   
  "L" - Logical
   
  "D" - Date
   
  "M" - Memo
   

   
 (cPrompt) is the operator prompt.  If no argument is given then
   
 "Enter a Character, Number, Date, Yes or No, or Text" is
   
 default.
   

   

Returns:

    A Date value if (cType) is "D".
   
 A Character string if (cType) is "C" or "M".
   
 A Logical .T. or .F. if (cType) is "L".
   
 A Number if (cType) is "N".
   

   

Description:

Examples:

    -- Example 1 -
   

   
 The database browsing function, DC_BROWSEDB(), supports a
   
 feature called "replacement by macro" which allows the user to
   
 create a special macro for replacing data in the currently
   
 selected browse column.  DC_GETVALUE() is a handy function that
   
 can be imbedded in a macro code block for getting a value from
   
 the operator before completing the replacement.
   

   
 Macro Expression: EVAL( {||X := GETVALUE('D'), X + 30 } )
   

   
 In the above example pressing the macro key will prompt the
   
 user to enter a date, add 30 days to the date, then replace the
   
 current field with the final value.
   

   

Source/Library:

dc_gobottom()

Go to the bottom record of a "scoped" database

Syntax:

Arguments:

    (xBottom) is a value that matches the same type as the index
   
 key to set as the bottom of the database.
   

   

Returns:

    nil
   

   

Description:

Examples:

    use customer index custname
   
 DC_GOBOTTOM('L')
   
 ? cust_name
   
 Lionel Gooseberry
   

   

Source/Library:

dc_gotoget()

Go directly to a desired GET

Syntax:

Arguments:

    none.
   

   

Returns:

    NIL
   

   

Description:

Notes:

Examples:

    SetKey( -1, { || DC_GOTOGET() } )
   
 DC_ReadModal( GetList )
   

   

Source/Library:

See Also:

dc_gotop()

Go to the top record of a "scoped" database

Syntax:

Arguments:

    (xTop) is a value that matches the same type as the index
   
 key to set as the top of the database.
   

   

Returns:

    nil
   

   

Description:

Examples:

    use customer index custname
   
 DC_GOTOP('C')
   
 ? cust_name
   
 Charlie Weaver
   

   

Source/Library:

dc_handinit()

Initialize the file handle to name function

Syntax:

Arguments:

    (nMode) is a numeric value.  A value of 1 is used to
   
 initialize the handle function and set the DOS interrupt.
   
 A value of 0 will disable the handle function and unload
   
 the interrupt.  The interrupt is automatically unloaded when
   
 the application is quit to dos.
   

   

Returns:

    nil
   

   

Description:

Examples:

    // initialize the file name grabbing system
   
 DC_HANDINIT(1)
   

   
 set defa to \myapps
   
 use customer
   

   
 nHandle := dc_dbfhandle()
   
 ? dc_handname( nHandle )
   
 \MYAPPS\CUSTOMER.DBF
   

   

Source/Library:

See Also:

dc_handname()

Return a DOS file name from the file handle

Syntax:

Arguments:

    (nHandle) is a DOS handle that is returned by FOPEN(),
   
 FCREATE() or any other Clipper file-opening mechanism such as
   
 dbUseArea(), dbSetIndex(), etc.
   

   

Returns:

    A character string with the name of the file associated with the
   
 file handle.  If no file is open under the specified file handle
   
 a null "" string is returned.
   

   

Description:

Examples:

    // initialize the file name grabbing system
   
 dc_handinit()
   

   
 set defa to \myapps
   
 use customer
   

   
 nHandle := dc_dbfhandle()
   
 ? DC_HANDNAME( nHandle )
   
 \MYAPPS\CUSTOMER.DBF
   

   

Source/Library:

See Also:

dc_hasmemo()

Does the current database contain a memo field?

Syntax:

Arguments:

    (nArea) is the database work area.  If no argument is given,
   
 then the currently selected work area is used.
   

   

Description:

Examples:

    . use baseball
   
 . ? DC_HASMEMO()
   
 .F.
   
 . use dctutor
   
 . ? DC_HASMEMO()
   
 .T.
   

   

Source/Library:

dc_help()

A General help and context-specific help system

Syntax:

Arguments:

    (cCommand) is the name of the command or function to display.
   
 If no parameter is passed, then the help maintenance menu
   
 will be displayed, otherwise the COMMAND field in the help
   
 database is searched for the passed command and the help
   
 information for the first matching command or function will
   
 be displayed.
   

   
 (lMemoOnly) if .TRUE. will display only the concatenated
   
 contents of the memo fields.  If .FALSE. (default), then the
   
 SYNTAX will also be displayed.
   

   
 (lSyntax) if .TRUE. will display the "syntax builder" for
   
 the specified command or function which allows the user to
   
 fill-in the blanks for all the possible arguments used with
   
 the specified command.  After filling in the arguments, the
   
 complete function or command (and it's arguments) are
   
 returned.  If (lSyntax) is .FALSE., then a null string is
   
 returned.
   

   

Returns:

    A character string.
   

   

Description:

Notes:

Examples:

    // Display help database pick-list and menu
   
 DC_HELP()
   

   
 // Display help information about DC_DBCHOICE()
   
 DC_HELP( 'DC_DBCHOICE' )
   

   

Source/Library:

dc_helpblock()

Post a code block to establish the Help system to call with F1

Syntax:

Arguments:

    (bBlock) is a code block to evaluate.  The Procedure Name,
   
 Line Number, and Input Variable Name will be passed to the
   
 code block when F1 is pressed.
   

   

Returns:

    A Code Block.
   

   

Description:

Source/Library:

dc_helpcode()

Post a Help Code for the context-help F1 key

Syntax:

Arguments:

    (cHelpCode) is a character string of up to 15 characters.
   

   
 Pass a NIL value to disable the help code.
   

   

Returns:

    A character string containing the last HELP CODE value.
   

   

Description:

Examples:

    /* Display default BROWSE system help screen if F1 pressed */
   
 DC_HELPCODE( 'BROWSE' ) // display
   

   

Source/Library:

See Also:

dc_helpf1()

A context-specific help system

Syntax:

Arguments:

    (cProcName) is a character string of up to 15 characters
   
 which will be used to search for the help screen.
   

   
 (nLineNmbr) is a numeric parameter that is required for
   
 compatability with the standard SET KEY command.  This
   
 parameter is not used therefore it may be passed as any
   
 value type including a NIL.
   

   
 (cInputVar) is the name of the pending input variable. If
   
 this parameter is passed, then the concatenated values in
   
 (cProcName) + (cInputVar) will be used to search for the
   
 help screen, otherwise only the value in (cProcName) will
   
 be used.
   

   

   

   

Returns:

    Nil.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 /* Display default BROWSE system help screen if F1 pressed */
   
 DC_HELPCODE( 'BROWSE' ) // display
   

   

   
 -- Example 2 --
   

   
 DC_SetKeys( { K_F1, K_ALT_F1 }, {|p,l,v|DC_HELPF1(p,l,v)} )
   

   

Source/Library:

See Also:

dc_helpfile()

Establish the file and alias name for the Help Database

Syntax:

Arguments:

    (cHelpFile) is the name that defines the database file to
   
 be used as the Help System Database.  The default file name
   
 is DCHELP.DBF and the alias is DCHELP.  If the file doesn't
   
 exist it will be created.
   

   
 (cHelpAlias) is the alias name (up to 7 characters) to use.
   
 If this parameter is not passed, then the alias will be
   
 given the same name as (cHelpFile).  The help system creates
   
 four (4) index files with the names (cHelpAlias)1 thru
   
 (cHelpAlias)4, therefore (cHelpAlias) cannot be longer than
   
 7 characters.
   

   

   

   

Returns:

    Nil
   

Description:

Notes:

Examples:

    DC_HELPFILE( "C:\MYDATA\MYHELP.DBF" )
   
 DC_HELP()
   

   

   

Source/Library:

See Also:

dc_hunt()

Search all open index tags for a match to passed value

Syntax:

Arguments:

    (cValue) is the value to find.
   

   
 (cExpression) is an expression that produces a value to find.
   

   
 If no (cValue) | (cExpression) argument is passed, then the
   
 user will be prompted to enter a value.
   

   
 (lResume) if .TRUE. will resume "hunting" for an index starting
   
 from the last index searched.  If .FALSE. (default) then the
   
 "hunting" process starts at the first index in the order of
   
 index files or tags.
   

   
 (DispMsg) if .TRUE. will display a message if record not found
   
 (default).  IF .FALSe. will display no message - just leaves
   
 file at EOF.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    USE dchelp INDEX dchelp1, dchelp2, dchelp3
   
 DC_HUNT('dc_hunt')
   
 DC_HUNT('BROWSE TILE')
   

   

Source/Library:

See Also:

dc_ifelse()

Evaluate a list of expressions based on a condition

Syntax:

Arguments:

    (bIf) is a code block to be that is evaluated as the IF
   
 statement.
   

   
 (bDoIf) is a code block that is evaluated if (bIf) evaluates
   
 .TRUE.
   

   
 (bDoElse) is a code block that is evaluated if (bIf) evaluates
   
 .FALSE.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    local bIf := { || eof() }
   
 local bDoIf := { || x := dc_expl(10,10,12,20), ;
   
                  devpos(11,12),;
   
                  devout("End of File"),;
   
                  inkey(0),;
   
                  dc_impl(x) }
   
 local bElseIf := { || _FIELD-)print_flag := .t. }
   

   
 setkey( -1, { || DC_IFELSE( bIf, bDoIf, bElseIf ) } )
   

   

Source/Library:

dc_impeval()

Return a portion of a field based on passed parameters

Syntax:

Arguments:

    (cFieldName) is the name of the import field.
   

   
 (nStPos) is the character position in the import field to start
   
 extracting from if the (cStDelim) argument is not passed or is
   
 a null ("") argument.  If a (cStDelim) argument is passed then
   
 (nStPos) is the character position equal to the nth occurence
   
 of the (cStDelim) in the import field.
   

   
 (cStDelim) is the starting delimeter.
   

   
 (nEnPos) is the character position in the import field to stop
   
 extracting from if the (cEnDelim) argument is not passed or is
   
 a null ("") argument.  IF a (cEnDelim) argument is passed then
   
 (nEnPos) is the character position equal to the nth occurence
   
 of the (cEnDelim) in the import field.
   

   
 (cEnDelim) is the ending delimeter.
   

   
 (cInstr) is an optional string of characters to insert at the
   
 beginning of the replaced data.
   

   
 (cAppStr) is an optional string of characters to insert at the
   
 end of the replaced data.
   

   

Returns:

    A character string.
   

   

Description:

Examples:

    use customer
   
 ? name
   
 Bush, George
   

   
 cLastName := DC_IMPEVAL('customer-)name',1,,1,',')
   
 ? cLastName
   
 Bush
   

   
 cFirstName := DC_IMPEVAL('customer-)name,1,',',20)
   
 ? cFirstName
   
 George
   

   

Source/Library:

See Also:

dc_impextract()

Build DC_IMPEVAL() expression from a user-friendly menu

Syntax:

Arguments:

    (cFieldName) is the name of the import field to extract from.
   

   

Returns:

    An expression in a character string that is evaluated with the
   
 macro compiler to extract the information from the database field.
   

   

Description:

Examples:

    use customer
   
 ? phone_num
   
 (714)263-1011
   
 cEval := DC_IMPEXTRACT( 'phone_num' )
   
 ? cEval
   
 DC_IMPEVAL("CUSTOMER-)PHONE_NUM",1,"(",1,")","","")
   
 ? &(cEval)
   
 714
   

   

Source/Library:

See Also:

dc_impfields()

Create field mapping array from a pick-list of data fields

Syntax:

Arguments:

    (cTargetAlias) is the alias name of the target work area in
   
 which data will be imported TO.
   

   
 (cImpAlias) is the alias name of the work area in which data
   
 will be imported FROM.
   

   
 NOTE: (cTargetAlias) and (cImpAlias) may be the same work area
   
 if the information is simply being copied from one field to
   
 another in an a single work area.
   

   

Returns:

    A multi-dimensional array with 2 parallel sub-arrays.  Each
   
 element in sub-array 1 is a character type expression defining the
   
 "target" database field.  Each element in sub-array 2 is a character
   
 type expression defining the "import" database field.
   

   
 Example:
   

   
 Element     Contents
   
 --------   -----------
   
 [1][1]     CUSTOMER-)CONTACT
   
 [1][2]     CUSTOMER-)CONTACT
   
 [1][3]     CUSTOMER-)BILL_STRT
   
 [1][4]     CUSTOMER-)BILL_CITY
   
 [1][5]     CUSTOMER-)COMMENTS
   

   
 [2][1]     CUST_BOR-)FNAME
   
 [2][2]     CUST_BOR-)LNAME
   
 [2][3]     CUST_BOR-)ADDRESS1
   
 [2][4]     CUST_BOR-)ADDRESS2
   
 [2][5]     CUST_BOR-)OCCUPATION
   

   

Description:

Examples:

    aImportMap := DC_IMPFIELDS('customer','transact')
   
 do while .t.
   
   @ 10,10 prompt "Select a Customer File record"
   
   @ 11,10 prompt "Select a Transaction File record"
   
   @ 12,10 prompt "Replace Customer Data with Transaction Data"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       sele customer
   
       dc_dbpick(5,20,20,40,"Cust_name")
   
     case nChoice = 2
   
       sele transact
   
       dc_dbpick(5,10,20,60,"Tran_nmbr","tran_type","tran_date")
   
     case nChoice = 3
   
       dc_impreplace( aImportMap, "customer" )
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_impl()

Implode a window created by dc_expl()

Syntax:

Arguments:

    (cSaveScreen) is a composite string consisting of the screen
   
 contents, coordinates, colors, etc.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    cSaveScreen := dc_expl( 10,10,12,70, ' Enter a command ' )
   
 cCommand := SPACE(50)
   
 @ 11,12 get cCommand
   
 read
   
 DC_IMPL( cSaveScreen )
   

   

Source/Library:

See Also:

dc_implode()

Implode a window created by dc_explode()

Syntax:

Arguments:

    (cSaveScreen) is a composite string consisting of the screen
   
 contents, coordinates, colors, etc.
   

   

Description:

Examples:

    cSaveScrn := dc_explode(5,10,7,70,'B/W','N/W',.F.,;
   
              ' Enter a Command ',10)
   
 cCommand := space(50)
   
 @ 6,12 get cCommand
   
 read
   
 DC_IMPLODE( cSaveScrn )
   

   

Source/Library:

See Also:

dc_impmapcreate()

Create a field replacement map (.DCF) file

Syntax:

Arguments:

    (cMapFile) is the name of the Import Map file to create.  If no
   
 extension is included then .DCF is assumed.
   

   
 (cTargetAlias) is the ALIAS name of the target database that
   
 data will be imported TO.  If no argument is given, then the
   
 currently selected database is the default.
   

   
 (cImportAlias) is the ALIAS name of the import database that
   
 data will be imported FROM.  If no argument is given, then a
   
 user-prompt will appear to enter the name of the database or to
   
 choose an open database from a pick list.
   

   

Returns:

    A logical .TRUE. if the file is created, .FALSE. otherwise.
   

   

Description:

Examples:

    use customer via 'DBFNTX'
   
 sele 0
   
 use cust_bor via 'PDX'
   
 DC_IMPMAPCREATE( 'NEWCUST','CUSTOMER','CUST_BOR' )
   

   

Source/Library:

See Also:

dc_impmapload()

Load an array with a field replacement map

Syntax:

Arguments:

    (cMapFile) is the import map (.DCF) file to load.
   

   

Returns:

    A multi-dimensional array with 2 parallel sub-arrays.  Each
   
 element in sub-array 1 is a character type expression defining the
   
 "target" database field.  Each element in sub-array 2 is a character
   
 type expression defining the "import" database field.
   

   
 Example:
   

   
 Element     Contents
   
 --------   -----------
   
 [1][1]     CUSTOMER-)CONTACT
   
 [1][2]     CUSTOMER-)CONTACT
   
 [1][3]     CUSTOMER-)BILL_STRT
   
 [1][4]     CUSTOMER-)BILL_CITY
   
 [1][5]     CUSTOMER-)COMMENTS
   

   
 [2][1]     CUST_BOR-)FNAME
   
 [2][2]     CUST_BOR-)LNAME
   
 [2][3]     CUST_BOR-)ADDRESS1
   
 [2][4]     CUST_BOR-)ADDRESS2
   
 [2][5]     CUST_BOR-)OCCUPATION
   

   

Description:

Examples:

    aImportMap := DC_IMPMAPLOAD('TRANSACT')
   
 do while .t.
   
   @ 10,10 prompt "Select a Customer File record"
   
   @ 11,10 prompt "Select a Transaction File record"
   
   @ 12,10 prompt ;
   
          "Replace Customer Data with Transaction Data"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       sele customer
   
       dc_dbpick(5,20,20,40,"Cust_name")
   
     case nChoice = 2
   
       sele transact
   
       dc_dbpick( 5, 10, 20, 60, "Tran_nmbr", "tran_type", ;
   
                  "tran_date")
   
     case nChoice = 3
   
       dc_impreplace( aImportMap, "customer" )
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_impmapread()

Extract a field map array from the Static array

Syntax:

Arguments:

    (nArea) is the work area.  If no argument is given, then the
   
 currently selected work area is default.
   

   

Returns:

    A multi-dimensional array with 2 parallel subarrays containing
   
 the mapping information from one work area to another.
   

   
 Example:
   

   
  Target database fields sub-array:
   

   
  Element  Type Field
   

   
  [1][1]    C    DCUSER-)LAST
   
  [1][2]    C    DCUSER-)FIRST
   
  [1][3]    C    DCUSER-)PHONE
   

   
  Import database fields sub-array:
   

   
  Element  Type Field
   

   
  [1][1]    C    CUSTOMER-)LAST_NAME
   
  [1][2]    C    CUSTOMER-)FIRST_NAME
   
  [1][3]    C    CUSTOMER-)TELEPHONE
   

   

Description:

Examples:

    use dcusers
   
 use customer new
   
 select dcusers
   

   
 // store dcusers.dcf map to memory
   
 dc_impmapstore( dc_impmapload( 'DCUSERS.DCF' ) )
   

   
 // replace current dcusers.dbf record with current
   
 // customer.dbf record
   
 dc_impreplace( DC_IMPMAPREAD() )
   

   

Source/Library:

See Also:

dc_impmapstore()

Store a field map array to the Static array

Syntax:

Arguments:

    (aFieldMap) is a multi-dimensional array with 2 parallel
   
 subarrays containing the mapping information from one work
   
 area to another.
   

   
 Example:
   

   
    Target database fields sub-array:
   

   
    Element  Type   Field
   

   
    [1][1]    C    DCUSER-)LAST
   
    [1][2]    C    DCUSER-)FIRST
   
    [1][3]    C    DCUSER-)PHONE
   

   
    Import database fields sub-array:
   

   
    Element  Type   Field
   

   
    [1][1]    C    CUSTOMER-)LAST_NAME
   
    [1][2]    C    CUSTOMER-)FIRST_NAME
   
    [1][3]    C    CUSTOMER-)TELEPHONE
   

   
 (nArea) is the work area.  If no argument is given, then the
   
 currently selected work area is default.
   

   

   

Returns:

    A .TRUE. if a valid array is passed, .FALSE. otherwise.
   

   

Description:

Examples:

    use dcusers
   
 use customer new
   
 select dcusers
   

   
 // store dcusers.dcf map to memory
   
 DC_IMPMAPSTORE( dc_impmapload( 'DCUSERS.DCF' ) )
   

   
 // replace current dcusers.dbf record with current
   
 // customer.dbf record
   
 dc_impreplace( dc_impmapread() )
   

   

Source/Library:

See Also:

dc_import()

Import a data file of any structure by matching fields

Syntax:

Arguments:

    (cImpAlias) is the ALIAS name of the database to import FROM.
   
 If no argument is given, then the user will be prompted for the
   
 name of the database.
   

   
 (cFieldMap) is the name of the Import Map file (.DCF) to use.
   
 If no argument is given, then the user will be given a set of
   
 field pick lists to match fields from the import database to
   
 the target database.
   

   
 (bFor) is a code-block that defines the condition for the
   
 import file records to be appended.  If no argument is passed,
   
 then all records in the import database will be appended.
   

   
 (bWhile) is a code-block that is evaluated after each record
   
 and terminates the importing of records when it evaluates
   
 .FALSE.
   

   
 (nNext) is an optional number that defines how many records to
   
 process starting with the current record.
   

   
 (nRecord) is an optional record number to process.
   

   
 (lRest) is an optional logical value that determines whether
   
 the scope of the import is all records, or starting with the
   
 current record and proceeding to the end of the file.
   

   

Returns:

    A logical .TRUE. if data is successfully imported, .FALSE.
   
 otherwise.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 use customer
   
 DC_IMPORT() // user-prompt menu for importing to customer.dbf
   

   

   
 -- Example 2 --
   

   
 // import from TRANSACT.DBF using CUSTTRAN.DCF map file for
   
 // all records transacted today
   
 DC_IMPORT( 'transact','custtran.dcf',{||ship_date=date()} )
   

   

Source/Library:

See Also:

dc_impreplace()

Replace field data with data record of different type

Syntax:

Arguments:

    (aMap) is a multi-dimensional array with 2 parallel sub-arrays.
   
  Each element in sub-array 1 is a character type expression
   
 defining the "target" database field.  Each element in
   
 sub-array 2 is a character type expression defining the
   
 "import" database field.
   

   
 Example:
   

   
 Element     Contents
   
 --------   -----------
   
 [1][1]     CUSTOMER-)CONTACT
   
 [1][2]     CUSTOMER-)CONTACT
   
 [1][3]     CUSTOMER-)BILL_STRT
   
 [1][4]     CUSTOMER-)BILL_CITY
   
 [1][5]     CUSTOMER-)COMMENTS
   

   
 [2][1]     CUST_BOR-)FNAME
   
 [2][2]     CUST_BOR-)LNAME
   
 [2][3]     CUST_BOR-)ADDRESS1
   
 [2][4]     CUST_BOR-)ADDRESS2
   
 [2][5]     CUST_BOR-)OCCUPATION
   

   
 (cTargetAlias) is the alias name of the target database.  This
   
 argument is not needed if the Target database is selected
   
 first.
   

   
 (lAppend) if .TRUE. will APPEND the information in the import
   
 fields to the existing information in the target fields for
   
 target fields of type "C" or "M".  If .FALSE., the data in the
   
 target fields will be   REPLACED by the data in the import
   
 fields.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    aImportMap := dc_impmapload('TRANSACT')
   
 do while .t.
   
   @ 10,10 prompt "Select a Customer File record"
   
   @ 11,10 prompt "Select a Transaction File record"
   
   @ 12,10 prompt "Replace Customer Data with Transaction Data"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       sele customer
   
       dbpick(5,20,20,40,"Cust_name")
   
     case nChoice = 2
   
       sele transact
   
       dbpick(5,10,20,60,"Tran_nmbr","tran_type","tran_date")
   
     case nChoice = 3
   
       DC_IMPREPLACE( aImportMap, "customer" )
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_index()

A pop-up expression builder for creating index keys

Syntax:

Arguments:

    (cOldKey) is the value of the current index key.  Pass the old
   
 key value if you wish to add to the key.  Pass no arguments if
   
 you wish to create a new key.
   

   

Description:

Examples:

    cls
   
 setkey( -1, {||x:=DC_INDEX(),__keyboard(x)} )
   
 cKey := space(40)
   
 @ 10,10 say 'Press key F2 for Index builder'
   
 @ 12,10 say 'Enter Index key' GET cKey
   
 read
   
 setkey( -1 )
   

   

Source/Library:

dc_indexcount()

Return the number of indexes open

Syntax:

Arguments:

    (nArea) is the work area.  If no argument is given then the
   
 current work area is used.
   

   

Description:

Examples:

    select 1
   
 use customer index custname, custnmbr
   
 select 2
   
 use invoice
   
 select 3
   
 use invitems index invitems
   
 ? DC_INDEXCOUNT(1)
   
 2
   
 ? DC_INDEXCOUNT(2)
   
 0
   
 ? DC_INDEXCOUNT(3)
   
 1
   

   

   

Source/Library:

See Also:

dc_indexfilt()

Return the Conditional Index Expression

Syntax:

Arguments:

    (nOrder) is the index order.  If no argument is given, then the
   
 currently selected order is used.
   

   

Returns:

    A character string.
   

   

Description:

Examples:

    . use sales via 'DBFNTX'  // Use Conditional Index driver
   
 . index on year for sales ) 100000
   
 . ? DC_INDEXFILT()
   
 sales ) 100000
   

   
 . select 2
   
 . use customer via 'DBFSIX'
   
 . index on cust_nmbr tag users of customer for cust_code = 'U'
   
 . ? DC_INDEXFILT()
   
 cust_code = 'U'
   

   

Source/Library:

See Also:

dc_indexkey()

Return the current index key expression

Syntax:

Arguments:

    None
   

   

Returns:

    A Character string containing the current index key value.
   
 If no index is in use or a data driver is being used that
   
 does not support indexes, then a null "" string is returned.
   

   

Description:

Examples:

    use sales
   
 index on year+month to sales
   
 ? DC_INDEXKEY()
   
 year+month
   

   

Source/Library:

dc_indexlist()

Return an array of indexes that match open database

Syntax:

Arguments:

    None
   

   

Returns:

    A multidimensional array. Element 1 of each subarray contains
   
 the file name.  Element 2 of each subarray contains the index
   
 key.
   

   

   

Description:

Examples:

    // open all indexes that match dchelp.dbf
   
 use dchelp
   
 aIndex := DC_INDEXLIST()
   
 dbClearIndex
   
 for i := 1 to len(aIndex)
   
   dbSetIndex( aIndex[i,1] )
   
 next
   

   

   

Source/Library:

dc_indexname()

Return the full file name of the current index

Syntax:

Arguments:

    (nArea) is the work area.  If no argument is given, then the
   
 current selected work area is default.
   

   
 (nOrder) is the order number of the index file.  If no argument
   
 is given, then the currently selected index is default.
   

   

Returns:

    A character string.
   

   

Description:

Examples:

    . set rdd to DBFNTX
   
 . select 2
   
 . use C:\DCLIP3\DCPRINT index C:\DCLIP3\DCPRINT
   
 . select 4
   
 . set rdd to DBFSIX
   
 . use F:\CUST\INVOICE index F:\CUST\INV1, F:\CUST\INV2.CDX
   
 . ? DC_INDEXNAME(2)
   
 C:\DCLIP3\DCPRINT.NTX
   
 . ? DC_INDEXNAME(4,1)
   
 F:\CUST\INV1.CDX
   
 . ? DC_INDEXNAME(4,2)
   
 F:\CUST\INV2.IDX
   

   

Source/Library:

See Also:

dc_indexrestore()

Restore all index files from array created by dc_indexsave()

Syntax:

Arguments:

    (aIndexNames) is an array of index file names that was returned
   
 by DC_INDEXSAVE().
   

   

Description:

Notes:

Examples:

    use customer index custname, custnmbr, custcode
   
 aIndex := dc_indexsave()
   
 set index to
   
 index on balance to balance
   
 dc_browsedb()
   
 dbclearindex()
   
 DC_INDEXRESTORE( aIndex )
   

   

Source/Library:

See Also:

dc_indexsave()

Save the name(s) and order of all open indexes

Syntax:

Arguments:

    NONE
   

   

Returns:

    An array with the file names of each open index.
   

   

Description:

Examples:

    use customer index custname, custnmbr, custcode
   
 aIndex := DC_INDEXSAVE()
   
 set index to
   
 index on balance to balance
   
 dc_browsedb()
   
 dc_indexrestore( aIndex )
   

   

Source/Library:

See Also:

dc_indexsel()

Select an index order or tag by key value

Syntax:

Arguments:

    (cKey) is a character string containing any portion of the key
   
 desired.
   

   

Returns:

    A logical .TRUE. if the index is found and selected, .FALSE.
   
 otherwise.
   

   

Description:

Examples:

    use customer
   
 index on CUST_NMBR to custnmbr
   
 index on UPPER(CUST_NAME) to custname
   
 index on CUST_CODE to custcode
   
 set index to custnmbr, custname, custcode
   
 ? DC_INDEXSEL( 'CUST_CODE' )
   
 .T.
   
 ? DC_INDEXSEL( 'CUST_NAME' )
   
 .T.
   
 ? DC_INDEXSEL( 'CUST_NMBR' )
   
 .T.
   
 ? DC_INDEXSEL( 'NAME' )
   
 .F.
   

   

Source/Library:

dc_iniload()

Load an array from a *.INI (initialization) file

Syntax:

Arguments:

    (cIniFile) is the name of the *.INI file to load.  If the full
   
 path is not included in the file name, then it is assumed that
   
 the file must exist in the same directory as the .EXEcutable
   
 program or in the directory established by the SET DCLIP=(path)
   
 command in your AUTOEXEC.BAT file.
   

   
 (cGroup) is the Group Name you wish to load.
   

   
 (aArray) is the array to populate from the contents of the
   
 intialization group.  This array must already exist and must
   
 contain default values for each item.  Values may be the
   
 following types: (C)haracter, (N)umeric, (D)ate, (L)ogical.
   

   
 (aReference) is a parallel array that contains the same number
   
 of elements as (aArray).  This array contains the name of each
   
 intialization item for each item in (aArray).
   

   

Returns:

    A logical .TRUE. if the file exists, if the (cGroup) can
   
 be found in the file and if at least one element of the
   
 array was updated from the file, .FALSE. otherwise.
   

   

   

   

   

Description:

Notes:

Examples:

   /* Sample *.INI file */
   

   
* MYCOLORS.INI
   

   
[COLORSET_1]
   
ColorSet=Standard Color Set
   
DotPrompt=W+/B
   
StatusLine=N/W
   
StatusData=N/W
   

   
[COLORSET_2]
   
ColorSet=Color Set #2
   
DotPrompt=GR+/GR
   
StatusLine=N*/N
   
StatusData=W+*/N
   

   

   
/* -- Example 1  (Loading an array from COLORSET_2 -- */
   

   
aRef := {'ColorSet','DotPrompt','StatusLine','StatusData'}
   

   
DC_INILOAD('MYCOLORS.INI','COLORSET_2',aColors[2],aRef)
   

   

Source/Library:

See Also:

dc_inisave()

Save an array to a *.INI (initialization) file

Syntax:

Arguments:

    (cIniFile) is the name of the *.INI file to save.  If the full
   
 path is not included in the file name, then it is assumed that
   
 the file must exist in the same directory as the .EXEcutable
   
 program or in the directory established by the SET DCLIP=(path)
   
 command in your AUTOEXEC.BAT file.  If the file does not exist
   
 it will be created.  If it already exists, then only the GROUP
   
 in the file that matches (cGroup) will be updated.
   

   
 (cGroup) is the Group Name you wish to save.
   

   
 (aArray) is the array to write to the initialization group.
   
 This array may contain values of the following types:
   
 (C)haracter, (N)umeric, (D)ate, (L)ogical.
   

   
 (aReference) is a parallel array that contains the same number
   
 of elements as (aArray).  This array contains the name of each
   
 intialization item for each item in (aArray).
   

   

Returns:

    A logical .TRUE. if the initialization group was properly
   
 saved, FALSE otherwise.
   

   

Description:

Examples:

   /* Sample *.INI file */
   

   
* MYCOLORS.INI
   

   
[COLORSET_1]
   
ColorSet=Standard Color Set
   
DotPrompt=W+/B
   
StatusLine=N/W
   
StatusData=N/W
   

   
[COLORSET_2]
   
ColorSet=Color Set #2
   
DotPrompt=GR+/GR
   
StatusLine=N*/N
   
StatusData=W+*/N
   

   

   
/* -- Example 1  (Saving an array to COLORSET_2 -- */
   

   
aRef := {'ColorSet','DotPrompt','StatusLine','StatusData'}
   

   
DC_INISAVE('MYCOLORS.INI','COLORSET_2',aColors[2],aRef)
   

   

   

Source/Library:

See Also:

dc_init()

Initialize the dCLIP IDE Environment

Syntax:

Arguments:

    (lRunTime) if .TRUE. will prevent the dCLIP startup screen and
   
 copyright message from being displayed.
   

   

   

Returns:

    NIL
   

   

Description:

Notes:

Source/Library:

dc_inkey()

Moused replacement for INKEY()

Syntax:

Arguments:

    (nSeconds) is the number of seconds to wait for a key press or
   
 mouse click.  If 0 (default) then DC_INKEY() will wait forever.
   

   
 (@nMouRow) and (@nMouCol) are memory variables passed by
   
 reference to store the current row and column location of the
   
 mouse if a mouse button is pressed.
   

   
 (lWaitRele) if .TRUE. will wait until the mouse button is
   
 released before processing any more mouse actions.  If this
   
 parameter is not passed, then the last call to DC_INKEYRELE()
   
 will establish the default mode.
   

   
 (lWinMode) if .TRUE. will cause DC_INKEY() to behave more like
   
 Windows programs. Normally, the right-button must be pressed
   
 or the left-button double-clicked for DC_INKEY() to return a
   
 -104 value.  If DC_INKEYWIN(.t.) is called in your setup
   
 program and the (lWinMode) parameter is passed to DC_INKEY(),
   
 then simply releasing the left button will return the -104 value
   
 to invoke the menu selection.
   

   
 (lGetReader) is reserved.
   

   
 (lNoDblClick) if .TRUE. will disable mouse double-click from
   
 returning a -104 but instead will return a -101 (same as single
   
 click).  The default is .FALSE.
   

   
 (lDragMode) if .TRUE. will return a value of 13 (K_ENTER) if
   
 the left mouse button is pressed.  The default is .FALSE.
   

   
 (cHelpCode) is a code of up to 22 characters to pass to the
   
 DC_HELPF1() function in the event that the F1 or ALT-F1 keys
   
 are pressed.
   

   
 (aMouseHelp) is an array of information to display on the
   
 screen if the mouse is moved over specified areas (icons) on
   
 the screen.  This optional array allows for displaying of help
   
 information when the mouse is placed over a screen area.  This
   
 is a 2-dimensional array that consists of a sub-array of screen
   
 coordinates for displaying the message and another sub-array
   
 consisting of a sub-sub-array for each mouse icon area.
   

   
 (aMouseHelp[1]) is defined as follows:
   

   
  Element   Type    Description
   
  -------   ---- -------------------------------------
   
    [1]      N      Start Message display row
   
    [2]      N      Start Message display column
   
    [3]      N      End Message display row
   
    [4]      N      End Message display column
   

   
 (aMouseHelp[2]) contains one array for each icon and is defined
   
 as follows:
   

   
  Element   Type    Description
   
  -------   ---- -------------------------------------
   
    [1]      N      Start Icon display row
   
    [2]      N      Start Icon display column
   
    [3]      N      End Icon display row (if element is a NIL
   
                    then element [1] is the default)
   
    [4]      N      End Icon display column (if element is a NIL
   
                    then element [2] is the default)
   
    [5]      C      Message to display when mouse is placed
   
                    over element 1-4 screen coordinates
   
    [6]      B      Optional code-block to disable the message
   
                    for this item.  Must return a logical .T.
   
                    to enable message or .F. to disable message.
   
                    The default is .TRUE.
   

   

Returns:

    0 if no key is pressed before timeout.
   

   
 The numeric value of the key pressed (same as INKEY() )
   

   
 -101 if the left mouse button is pressed
   
 -102 if the right mouse button is pressed
   
 -104 if the right mouse button is released, the left
   
      mouse button is double-clicked, or the left mouse
   
      button in released when in "Windows" compatible
   
      mode.
   

   

Description:

Examples:

    local nRow, nCol
   

   
 set key -1 to myfunc1
   
 set key -2 to myfunc2
   

   
 // Call HELP("MYFUNC") if F1 is pressed
   
 // Call MYFUNC1() if F2 is pressed
   
 // Call MYFUNC2() if F3 is pressed
   
 nInkey := DC_INKEY( 'MYFUNC', 0, @nRow, @nCol )
   

   

Source/Library:

See Also:

dc_inkeyeval()

Post a code block for evaluation by DC_INKEY()

Syntax:

Arguments:

    (bBlock) is a code block to evaluate.
   

   

Returns:

    The last posted DC_INKEYEVAL() code block.
   

   

Description:

Examples:

    LOCAL nRow, nCol
   
 DC_INKEYEVAL( {||DevPos(0,0),DevOut(Time())} )
   
 nInkey := DC_INKEY( 'MYFUNC', 0, @nRow, @nCol )
   

   

Source/Library:

See Also:

dc_inkeyrelease()

Require mouse to be released or positioned in specified area

Syntax:

Arguments:

    If (nSeconds) is 0, then DC_INKEY() will return a value only
   
 if the mouse button is released or the mouse is within the
   
 passed coordinates.
   

   
 If (nSeconds) is greater than 0 then DC_INKEY() will return
   
 a value only after the specified amount of time .AND. if the
   
 mouse is in the specified coordinates.  If coordinates are not
   
 passed, then DC_INKEY() will return a value regardless of the
   
 mouse position.
   

   

Returns:

    nil
   

Description:

Source/Library:

See Also:

dc_inkeywin()

Make DC_INKEY() behave like Windows

Syntax:

Arguments:

    If (lWinMode) is .TRUE.
   

   

   

Returns:

    0 if no key is pressed before timeout.
   

   
 The numeric value of the key pressed (same as INKEY() )
   

   
 -101 if the left mouse button is pressed
   
 -102 if the right mouse button is pressed
   
 -104 if the right mouse button is released, the left
   
      mouse button is double-clicked, or the left mouse
   
      button in released when in "Windows" compatible
   
      mode.
   

   

Description:

Examples:

    local nRow, nCol
   
 DC_INKEYWIN(.t.)  // set Windows compatible mode
   
 nInkey := DC_INKEY( 'MYFUNC', 0, @nRow, @nCol,,.t.)
   

   

Source/Library:

See Also:

dc_insert()

Insert a specified number of records

Syntax:

Arguments:

    (nInsertNo) is the number of records to insert.  If this
   
 argument is not passed, then the user will be prompted to enter
   
 a number.
   

   
 The second argument may be a Logical value or an array.  If it
   
 is a logical argument ((lVirtual)), then a value of .TRUE. will
   
 insert virtual records using the .DCV file (if it exists) that
   
 corresponds to the associated ALIAS.  If (lVirtual) is false,
   
 then BLANK records will be inserted.
   

   
 If the second argument is an array (aVirtual), then the contents
   
 of the array is used as the virtual record.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 use customer
   
 // create an array from CUSTOMER.DCV
   
 aVirtual := dc_virtrestore()
   
 if valtype( aVirtual ) # 'A'
   
   break
   
 endif
   
 go 25
   
 // insert 10 virtual records starting at record 25
   
 DC_INSERT( 10, aVirtual )
   

   

   
 -- Example 2 --
   

   
 use customer
   
 // insert 5 blank records at the top of the file.
   
 DC_INSERT( 5 )
   

   

Source/Library:

See Also:

dc_interpret()

Interpret a command string

Syntax:

Arguments:

    The first parameter may be passed as a string containing a
   
 single command or an array containing a procedure.  If passed
   
 as a string then (cCommand) is the command line with arguments.
   
 The command line may include any command that can be used at
   
 the dCLIP dot prompt and any command that is included in .CH
   
 files which are loaded with the INCLUDE command or
   
 DC_PREINCLUDE() function.  If the first parameter is an array,
   
 then it must conform to the specifications of the array returned
   
 by DC_PROGLOAD().
   

   
 (aParams) is a single-dimensional array 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.
   

   

   

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

   
 dc_preinclude('MYSTUFF.CH')
   
 aCommands := { 'USE INVOICE',;
   
    'USE INVITEMS NEW',;
   
    'SET RELATION TO INV_NMBR INTO INVOICE',;
   
    'BROWSE TILE',;
   
    'BACKUP',;
   
    'DONE' }
   
 for i := 1 to len(aCommands)
   
   ? aCommands[i]
   
   DC_INTERPRET( aCommands[i] )
   
 next
   

   

   
 -- Example 2 --
   

   
 /* 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
   
 */
   

   
 aProgram := DC_ProgLoad('TEST')
   
 nMoneyDue := DC_INTERPRET( aProgram, { 3, 5, 6, 9 } )
   
 ? nMoneyDue
   
 wait
   

   

   

Source/Library:

See Also:

dc_isanum()

Is a character Alphanumeric?

Syntax:

Arguments:

    (cCharacter) is a character string with a length of 1.
   

   

Description:

Examples:

    ? DC_IsAnum('Z')
   
 .T.
   

   
 ? DC_IsAnum('j')
   
 .T.
   

   
 ? DC_IsAnum('4')
   
 .T.
   

   
 ? DC_IsAnum('$')
   
 .F.
   

   

   

   

Source/Library:

dc_isblank()

Are all the fields in the current record empty?

Syntax:

Arguments:

    NONE
   

   

Returns:

    .TRUE. if all fields are empty, .FALSE. if any field contains
   
 data.
   

   

Description:

Examples:

    . use sales
   
 . go 10
   
 . ? DC_ISBLANK()
   
.F.
   
 . dc_blank() // blank out all fields
   
 . ? DC_ISBLANK()
   
.T.
   

   

Source/Library:

See Also:

dc_isdbfmdx()

Is the current work area using a DBFMDX Driver?

Syntax:

Arguments:

    (nArea) is the work area be queried.  If no argument is given,
   
 then the current work area is default.
   

   

Description:

Examples:

    . close all
   
 . use customer via 'DBFMDX'
   
 . ? DC_ISDBFMDX()
   
 .T.
   
 . ? DC_ISDBFMDX( 2 )
   
 .F.
   

   

Source/Library:

dc_isdbfndx()

Is the current work area using a DBFNDX Driver?

Syntax:

Arguments:

    (nArea) is the work area be queried.  If no argument is given,
   
 then the current work area is default.
   

   

Description:

Examples:

    . close all
   
 . use customer via 'DBFNDX'
   
 . ? DC_ISDBFNDX()
   
 .T.
   
 . ? DC_ISDBFNDX( 2 )
   
 .F.
   

   

Source/Library:

dc_isdbfsix()

Is the current work area using a DBFSIX Driver?

Syntax:

Arguments:

    (nArea) is the work area be queried.  If no argument is given,
   
 then the current work area is default.
   

   

Returns:

    .TRUE. if the DBFSIX driver is being used with an open database in
   
 (nArea).
   

   

Description:

Examples:

    . close all
   
 . use customer via 'DBFSIX'
   
 . ? DC_ISDBFSIX()
   
 .T.
   
 . ? DC_ISDBFSIX( 2 )
   
 .F.
   

   

Source/Library:

dc_isdescend()

Is the current index key Descending?

Syntax:

Arguments:

    (nOrder) is the order number of the controlling index. If
   
 no parameter is passed then the current controlling index
   
 will be used.
   

   

Returns:

    A logical value.
   

   

Description:

Examples:

    use customer
   
 index on cust_name to custname
   
 ? DC_ISDESCEND()
   
 .F.
   
 index on cust_name to custname descending
   
 ? DC_ISDESCEND()
   
 .T.
   
 index on DESCEND(cust_name) to custname
   
 ? DC_ISDESCEND()
   
 .F.
   

   

Source/Library:

dc_isfield()

Is a character string a field in the current work area?

Syntax:

Arguments:

    (cFieldName) is the name of the field to test.
   

   
 @(nPosition) is the position of the field in the database
   
 structure.  If the field does not exist, then a 0 will be
   
 return in this variable, otherwise the field position will
   
 be returned.
   

   

Returns:

    A logical value.
   

   

Description:

Examples:

    LOCAL cFieldName, nPosition
   

   
 use customer
   

   
 ? DC_ISFIELD('CUST_NMBR',@nPosition)
   
 .T.
   
 ? nPosition
   
 12
   

   
 ? DC_ISFIELD('CUST_NMBR+CUST_NAME',@nPosition)
   
 .F.
   
 ? nPosition
   
 0
   

   

   

Source/Library:

dc_isflock()

Is the current data File locked?

Syntax:

Arguments:

    (nArea) is the work area be queried.  If no argument is given,
   
 then the current work area is default.
   

   

Returns:

    A logical .TRUE. if the file is locked, .FALSE. otherwise.
   

   

Description:

Examples:

    lFileLocked := DC_ISFLOCK()
   
 do something
   
 if lFileLocked
   
   dc_filock()
   
 endif
   

   

Source/Library:

dc_isntxcond()

Is the current work area a DBFNTX Conditional Index driver?

Syntax:

Arguments:

    (nArea) is the work area be queried.  If no argument is given,
   
 then the current work area is default.
   

   

Description:

Examples:

    . close all
   
 // DBFNTX Conditional index is linked into application
   
 . use customer via 'DBFNTX'
   
 . ? DC_ISNTXCOND()
   
 .T.
   
 . ? DC_ISNTXCOND( 2 )
   
 .F.
   

   

Source/Library:

dc_ispath()

Is a directory in a path string?

Syntax:

Arguments:

    (cPath) is a path string with drive/directories separated
   
 by semicolons.
   

   
 (cDirectory) is the directory to test.
   

   

   

Returns:

    A logical .TRUE. if the directory exists in the path string,
   
 .FALSE. otherwise.
   

   

Description:

Examples:

    ? DC_ISPATH( GETE('PATH'),'C:\DOS' )
   
 .T.
   

   
 SET(_SET_PATH,'C:\MYDATA;D:\HISDATA;D:\HERDATA')
   
 ? DC_ISPATH( SET(_SET_PATH), 'C:\HISDATA' )
   
 .T.
   
 ? DC_ISPATH( SET(_SET_PATH), '\WINDOWS' )
   
 .F.
   

   

Source/Library:

See Also:

dc_ispdx()

Is the current work area a PARADOX (PDX) driver?

Syntax:

Arguments:

    (nArea) is the work area be queried.  If no argument is given,
   
 then the current work area is default.
   

   

Description:

Examples:

    . close all
   
 . use cust_borr via 'PDX'
   
 . ? DC_ISPDX()
   
 .T.
   
 . ? DC_ISPDX( 2 )
   
 .F.
   

   

Source/Library:

dc_isprotmode()

Is the application running in Protected Mode?

Syntax:

Arguments:

    NONE
   

   

Returns:

    A logicl .TRUE. if the application is running in protected
   
 mode.
   

   
 A logical .FALSE. if the application is running in real mode.
   

   

Description:

Examples:

    IF DC_ProtMode()
   
   IF Memory(0)(2000
   
     ? 'Memory warning.  May not have sufficient memory to run.'
   
     ? 'Make sure the operating system allocates at least 2000k'
   
     ? 'of VCPI or DPMI memory (Extended Memory)'
   
     wait
   
   ENDIF
   
 ELSE
   
   IF Memory(0)(120
   
     ? 'Memory warning.  May not have sufficient memory to run.'
   
     ? 'Make sure the operating system allocates at least 500k'
   
     ? 'of conventional memory and 1500k of EMS (Paged) memory.'
   
     wait
   
 ENDIF
   

   

   

   

Source/Library:

See Also:

dc_isrdd()

Determine if a specified RDD is available

Syntax:

Arguments:

    (cRddName) is the name of the Replaceable Data Driver.
   

   

Description:

Examples:

    accept "enter a file name to open" to cFileName
   
 accept "enter a Data Driver" to cRdd
   
 if DC_ISRDD( cRdd )
   
   use &cFileName via cRdd
   
 else
   
   ? 'Data driver ' + cRdd is not available
   
 endif
   

   

Source/Library:

See Also:

dc_isrlock()

Is the current Record locked?

Syntax:

Arguments:

    (nArea) is the work area be queried.  If no argument is given,
   
 then the current work area is default.
   

   

Returns:

    A logical .TRUE. if the file is locked, .FALSE. otherwise.
   

   

Description:

Examples:

    lRecLocked := DC_ISRLOCK()
   
 nRecSave := recno()
   
 do something
   
 goto nRecSave
   
 if lRecLocked
   
   dc_reclock()
   
 endif
   

   

Source/Library:

dc_isshared()

Is the current workarea file opened in Shared mode?

Syntax:

Arguments:

    (nArea) is the work area be queried.  If no argument is given,
   
 then the current work area is default.
   

   

Returns:

    A logical .TRUE. if the database was opened in SHARED mode,
   
 .FALSE. if it was opened in EXCLUSIVE mode.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 use customer shared
   
 ? DC_ISSHARED()
   
 .T.
   

   

   
 -- Example 2 --
   

   
 FUNCTION pack
   

   
 if DC_ISHARED()
   
   ? 'Exclusive USE is required to pack a file'
   
 else
   
   pack
   
 endif
   

   

Source/Library:

dc_isstru()

Verify the structure of the current database

Syntax:

Arguments:

    (aStructure) is a multi-dimensional array with one sub-array
   
 for each database field.
   

   
 Element  Type   Description
   
 ------   ----   ------------------------
   
   [1]     C     Field Name
   
   [2]     C     Field Type
   
   [3]     N     Field Length
   
   [4]     N     Field Decimals
   
   [5]    Any    Default Data (optional)
   

   

Returns:

    A logical .TRUE. if (aStructure) matches the structure
   
 of the current workarea, .FALSE. otherwise.
   

   

Description:

Examples:

    aStru := { ;
   
   { 'CUST_NAME','C',25,0 },;
   
   { 'CUST_NMBR','C',10,0 },;
   
   { 'LAST_DATE','D',8,0  } }
   

   
 use customer
   
 if .not. DC_ISTRU( aStru )
   
   dc_struupdate( aStru )
   
 endif
   

   

Source/Library:

See Also:

dc_isunique()

Is the current index a Unique index?

Syntax:

Arguments:

    (nArea) is the work area.  If no argument is passed then the
   
 current work area will be reported.
   

   

Description:

Examples:

    use customer
   
 index on cust_name to custname
   
 ? DC_ISUNIQUE()
   
 .F.
   
 index on cust_name to custname unique
   
 ? DC_ISUNIQUE()
   
 .T.
   

   

Source/Library:

dc_join()

Pop-up a user-prompt menu for joining databases

Syntax:

Description:

Examples:

    use cust1
   
 use cust2
   
 DC_JOIN()
   

   

Source/Library:

dc_keybuffer()

Save and Clear the Keyboard Buffer

Syntax:

Arguments:

    None.
   

   

Returns:

    An array of numeric values equal to the INKEY() values of
   
 each key in the keyboard buffer.
   

   

Description:

Examples:

    LOCAL aKeys := DC_KEYBUFFER()
   
 DO something
   
 DC_PutKey( aKeys )
   

   

Source/Library:

See Also:

dc_keyclear()

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.
   

   
 If an array (aKeyGroup) is passed in lieu of a character
   
 string, then the array must conform to the specification of
   
 the array that is returned by the function DC_KEYGET().
   

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

   

Returns:

    A logical .TRUE. if the keys were successfully cleared, .FALSE.
   
 otherwise.
   

Description:

Examples:

    -- Example 1 --
   

   
 IF DC_KeyLoad( "MYKEYS" )
   
   DO SOMETHING
   
   DC_KEYCLEAR()        // Clear all keys
   
 ENDIF
   

   

   
 -- Example 2 --
   

   
 aKeyGroup1 := DC_KeyGet( "F1THRUF10" ) // Get F1 thru F10
   
 IF DC_KeyLoad( aKeyGroup1 )
   
   DO PROGRAM1
   
   aKeyGroup2 := DC_KeyGet( "DEBUG" )   // Get Debug keys
   
   IF DC_KeyLoad( aKeyGroup2 )
   
     DO PROGRAM2
   
     DC_KEYCLEAR( aKeyGroup2 )          // Clear Debug keys
   
   ENDIF
   
   DO PROGRAM3
   
   DC_KEYCLEAR( aKeyGroup1 )            // Clear Func Keys
   
 ENDIF
   

   

Source/Library:

See Also:

dc_keycount()

Return the number of "active" records

Syntax:

Arguments:

    (xTop) is a value that matches the same type as the index
   
 key to set as the top of the database.
   

   
 (xBottom) is a value that matches the same type as the
   
 index key to set as the bottom of the database.
   

   
 (nTimeOut) is the amount of time (in seconds) to allow
   
 DC_KEYCOUNT() to calculate the number of records.  If the
   
 database is too large or the computer is too slow, this
   
 calculation may take too much time to be practical.  If the
   
 calculation takes longer than (nTimeOut) then -1 will be
   
 returned.
   

   

Returns:

    1. If there is no controlling index and no filter set then
   
    the total number of records in the database will be
   
    returned.
   

   
 2. If there is a controlling index and it is not a conditional
   
    index then the total number of records in the database will
   
    be returned.
   

   
 3. If there is a controlling index and it is also a
   
    conditional index then the number of keys in the index will
   
    be returned.
   

   
 4. -1 if the calculation times out.
   

   
 5. If values are passed for xTop and/or xBottom and there is a
   
    controlling index, then the number of records between the
   
    xTop and xBottom values will be returned.
   

   

Description:

Examples:

    // calculate the number of customers between C and L.
   

   
 use customer index custname
   
 ? DC_KEYCOUNT( 'C','L', 5 )
   

   

Source/Library:

See Also:

dc_keydelete()

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.
   

   

Returns:

    A logical .TRUE. if the keys were successfully deleted, .FALSE.
   
 otherwise.
   

Description:

Examples:

    DC_KEYDELETE( "MYKEYS" )
   

   

Source/Library:

See Also:

dc_keydisp()

Display the contents of Function Keys

Syntax:

Arguments:

    NONE
   

   

Description:

Examples:

    dc_keyload()       // load the keys
   
 DC_KEYDISP()       // display the keys
   

   

Source/Library:

See Also:

dc_keyedit()

Edit a Key Group Definition in the Key Dictionary

Syntax:

Arguments:

    (cKeyGroup) is an 8-character name that defines the key group
   
 to load into the editor 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 for editing.
   

   
 If neither an array file exists or the key group does not
   
 exist in the Dictionary file, then a pick-list of Key Groups
   
 (in the Key Dictionary) will be displayed.  If an array
   
 (aKeyGroup) is passed in lieu of a character string, then the
   
 array must conform to the specification of the array that is
   
 returned by the function DC_KEYGET().
   

   

Returns:

    An array that conforms to the specification defined in
   
 the function DC_KEYGET().
   

   

Description:

Notes:

Examples:

    -- Example 1 --
   

   
 aKeyGroup := DC_KeyGet( "MYKEYS" )    // Load array
   
 aKeyGroup := DC_KEYEDIT( aKeyGroup )  // Edit array
   
 DC_KeyLoad( aKeyGroup )               // Load keys
   

   

   
 -- Example 2 --
   

   
 DC_KEYEDIT( "TEMPLATE" )
   

   

Source/Library:

See Also: