dc_random()

Return a random number

Syntax:

Arguments:

    (nMax) is a value of the maximum number size to return.
   
 If no parameter is passed then the maximum size will
   
 be 255.  If a number greater than 255 is passed then
   
 the maximum size will still be 255.
   

   

Returns:

    A numeric value from 0 to 255
   

   

Description:

Examples:

    ? DC_RANDOM()
   
 137
   
 ? DC_RANDOM(10)
   
 6
   

   

Source/Library:

dc_rddsel()

Select a default data-driver (RDD)

Syntax:

Arguments:

    (cRdd) is the Driver to highlight in the select window.  If no
   
 argument is given, then the first linked in Rdd will be
   
 selected.
   

   
 (lSelect) if .TRUE. will set the Rdd selected.
   

   

Returns:

    A character string with the name of the Rdd selected by the user.
   

   

Description:

Source/Library:

See Also:

dc_readalt()

Establish alternate usage of Ctrl-END in table of Gets

Syntax:

Arguments:

    (lMode) if .TRUE. will Set the alternate mode.  The default
   
 is .FALSE.
   

   

Returns:

    The current mode.
   

   

Description:

Source/Library:

See Also:

dc_readapick()

Pops up array pick-list if GET not valid or double-clicked

Syntax:

Arguments:

    (xGetValue) is the current value in the GET variable.
   

   
 (aPickList) is an array of valid values for (getvar).
   
 If this is a single-dimensional array, then the array
   
 items will be displayed in the pick-list.  If it's a
   
 multi-dimensional array, then the first element of each
   
 item will be used for the validation, the second element
   
 of each item will be displayed in the pick-list, and the
   
 third (optional) element is a HELP CODE (character string)
   
 which will be passed on to the DC_HelpF1() function to
   
 display context-specific help if the F1 key is pressed on
   
 a selected item in the picklist.  (aPickList) may also be
   
 passed as a code-block that returns an array when evaluated.
   
 (aPickList) may be passed as an array of arrays with a
   
 pointer to which sub-array to use as the pick-list via
   
 (nSubList).  See below.
   

   
 (nStRow), (nStCol), (nEnRow), (nEnCol) are the screen
   
 coordinates to display the picklist.  If no coordinates
   
 are passed, then the pick-list will be displayed just
   
 to the right of the current GET location.
   

   
 (lAccept) if .TRUE. will exit the GET if the operator
   
 selects an item from the pick-list.  If .FALSE. (default),
   
 then the value will be returned into the GET and the cursor
   
 will remain in the GET.
   

   
 (lScanExact) if .TRUE. (default) will scan the (aValues)
   
 array for an "exact" match to the passed value.  IF .FALSE.,
   
 then the standard string-match method will be used.
   

   
 (lStringList) if .TRUE. will assume that the value in the
   
 GET is a list of characters, and the (aValues) array
   
 contains a single character for each item.  This method is
   
 used to pick one or more items from the the list and add
   
 the item to the value in the GET.  If .FALSE. (default)
   
 then the value of the GET will be replaced by the selected
   
 item.
   

   
 (nSubList) is used to choose a sub-array from (aValues) if
   
 (aValues) is an array of arrays rather than a single-
   
 dimensional array.  If (nSubList) is a 0 or is not passed
   
 then it is assumed that (aValues) is a single-dimensional
   
 array.
   

   
 (lAddToGet) if .TRUE. will append the selected value to the
   
 current value(s) in the GET.  If .FALSE. (default), then
   
 the GET contents will be replaced by the selected value.
   

   

Returns:

    A .TRUE. if the value entered for (getvar) is valid,
   
 .FALSE. otherwise.
   

   

Description:

Notes:

Examples:

    -- Example 1 --
   

   
 // Let's say that the only valid entries in the field
   
 // "nTimeIncr" are 5, 10, 15, 30, and 60.  You would use
   
 // DC_READAPICK() as follows:
   

   
 GetList := {}
   
 @ 10,10 SAY 'Enter Time Increment ' GET nTimeIncr VALID ;
   
    DC_READAPICK( nTimeIncr, { 5,10,15,30,60 } ) PICKLIST
   
 dc_ReadModal( GetList )
   

   

   
 -- Example 2 --
   

   
 // Let's say that the only valid entries in the field
   
 // "nWeek" are 1,2 or 3.  You would use DC_READAPICK() as
   
 // follows:
   

   
 GetList := {}
   
 @ 10,10 SAY 'Enter Week ' GET nWeek VALID ;
   
    DC_READAPICK( nWeek, ;
   
    { { 1,'First' },{ 2,'Second' },{ 3,'Third' } } ) ;
   
    PICKLIST
   
 dc_ReadModal( GetList )
   

   

   
 -- Example 3 --
   

   
 // You want to choose from a list of single-character
   
 // options and add each selected option to the GET.
   

   
 GetList := {}
   
 @ 10,10 SAY 'Enter Option List ' GET cList VALID ;
   
   DC_READAPICK( cList, ;
   
   { { 'P','Protect' }, {'L','Log'},{'S','Save'} }, ;
   
   10,40,20,75,,,.t. )
   

   

Source/Library:

See Also:

dc_readbox()

Create a modal dialog box and Mouse Buttons for DC_ReadModal()

Syntax:

Arguments:

    (nStrow), (nStcol), (nEnrow), (nEncol) are the active
   
 coordinates of the modal dialogue box.
   

   
 (cTitle) is the title of the box.
   

   
 @(aActiveArea) is the name of the variable to store the array
   
 created by DC_READBOX() which will later be passed to
   
 DC_ReadModal().
   

   
 (aHotKeys) is a multi-dimensional array of hotkeys.  The
   
 information in this array will be used to paint mouse buttons
   
 on the perimeter of the box to pass-on a portion of this
   
 information to DC_ReadModal().  If no array is passed then the
   
 following default array will be created:
   

   
 (aHotKeys[1]) :
   

   
  { {'[þ]',K_ESC,(nStCol)+2 } }
   

   
 (aHotKeys[2]) :
   

   
  { {'[F10:Save]',K_F10,(nStCol)+2} ;
   
    {'[ESC:Cancel]',K_ESC,(nStCol)+15},;
   
    {'[F1:Help]',K_F1,(nStCol)+30}  }
   

   
 (aHotKeys[1]) is an array of buttons to place on the top of
   
 the dialogue box.
   

   
 (aHotKeys[2]) is an array of buttons to place on the bottom of
   
 the dialogue box.
   

   

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:

Examples:

   LOCAL GetList := {}, aReadArea, cSaveScreen
   

   
cSaveScreen := DC_READBOX( 10, 10, 19, 70,, @aReadArea )
   
@ 12,15 say 'Customer Number ' GET cust_nmbr
   
@ 13,15 say '  Customer Name ' GET cust_name
   
@ 14,15 say '         Street ' GET street
   
@ 15,15 say '           City ' GET city
   
@ 16,15 say '          State ' GET state
   
@ 17,15 say '            Zip ' GET zip
   
DC_ReadModal( GetList, 2, aReadArea )
   

   

   

Source/Library:

See Also:

dc_readcapfirst()

Capitalize all first letters of all words in all GETs

Syntax:

Arguments:

    (lMode) if .TRUE. will set the "CapFirst" flag.  From then
   
 on all GETs read by DC_READMODAL() will automatically
   
 capitalize the first letter of each new word when typed
   
 into a GET.  If .FALSE. will reset the "CapFirst" flag.
   

   

Returns:

    A logical value whic is the last setting of the "CapFirst"
   
 flag.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 local cCustName, cAddress, GetList:={}
   
 store cust_name to cCustName
   
 store address to cAddress
   
 DC_READCAPFIRST(.t.)
   
 @ 10,10 say 'Customer Name ' get cCustName
   
 @ 11,10 say 'Street Address ' get cAddress
   
 dc_readmodal( GetList )
   
 DC_READCAPFIRST(.f.)
   

   

   
 -- Example 2 --
   

   
 local cCustName, cAddress, GetList:={}
   
 store cust_name to cCustName
   
 store address to cAddress
   
 @ 01,10 say 'Customer Name ' get cCustName CAPFIRST
   
 @ 11,10 say 'Street Address ' get cAddress
   
 dc_readmodal( GetList )
   

   

Source/Library:

See Also:

dc_readclick()

Evaluate code-block if mouse is double-clicked in a GET

Syntax:

Arguments:

    (xValue) is the value of the GET memory variable. If this
   
 is passed as a NIL, then the oGET:VarGet() value will be
   
 used.
   

   
 (bEval) is the code block to evaluate if the mouse is
   
 double-clicked.
   

   
 (lEnter) if .TRUE. will evaluate the code-block if the
   
 ENTER key is hit or the mouse is double-clicked.  If
   
 .FALSE. (default) then only a double-click will invoke
   
 the evaluation.
   

   
 (lNoEmpty) if .TRUE. will evaluate the code-block if
   
 the (xValue) is empty even if the mouse in not double-
   
 clicked.  The default is .FALSE.
   

   

Returns:

    If the mouse is double-clicked the returns the value
   
 returned by the evaluated code-block, otherwise returns
   
 .TRUE.
   

   

Description:

Notes:

Examples:

    // In this example, the calculator will pop-up and return
   
 // the accumulator in the (nTax) variable if the mouse
   
 // is double-clicked on the (nTax) get or the calendar
   
 // will pop-up and return the selected date if the mouse
   
 // is double-clicked on the (dDate) get.
   

   
 @ 12,10 say 'Sales Tax' get nTax ;
   
   VALID DC_READCLICK( nTax, { |n| dc_popcalc(n)} )
   
 @ 13,10 say '     Date' get dDate ;
   
   VALID DC_READCLICK( dDate, { |d| dc_popdate(d)} )
   

   

Source/Library:

See Also:

dc_readcolor()

A function for validating color strings in a GET

Syntax:

Arguments:

    (cColor) is the name of the GET variable.
   

   
 (nDisplayRow) is the start display row to display the color
   
 pick-list.
   

   
 (lEmptyOK) if .TRUE. will allow (cColor) to be empty.  If
   
 .FALSE. (default) then if (cColor) is empty the color
   
 pick-list will be automatically displayed.
   

   

   

Returns:

    A logical .TRUE. if the color string entered is valid or
   
 the operator picked a color from the pick-list.
   

   

Description:

Notes:

Examples:

     @ 7,12 SAY 'Enter a color string' GET cColor ;
   
    VALID DC_ReadColor( @cColor, 15 ) PICKLIST
   

   

Source/Library:

See Also:

dc_readcua()

Set CUA-Compliance for Navigating Gets

Syntax:

Arguments:

    (lNewCUAMode) if .TRUE. will set the CUA-compliant mode ON,
   
 if .FALSE. will set the CUA-compliant mode OFF, and if not
   
 passed will not affect the current setting.
   

   

   

Returns:

    A logical value equivalent to the previous setting.
   

   

Description:

Examples:

    /* -- Set CUA-compliance ON -- */
   
 DC_READCUA(.t.)
   

   

Source/Library:

See Also:

dc_readcut()

Establish the keys to use for cutting and pasting Gets

Syntax:

Arguments:

    (aKeys) is an array of 2 elements.
   

   
 Element  Type   Description  Default
   
 -------  ----    -----------  -----------
   
    1      N     Cut key      290 (Alt-G)
   
    2      N     Paste key  275 (Alt-R)
   

   

Returns:

    A 2-element array containing the current keys.
   

   

   

   

Description:

Source/Library:

See Also:

dc_readdpick()

Pops up database or array pick-list in a GET

Syntax:

Arguments:

    (xValue) is the name of the GET memory variable.
   

   
 (cAlias) is the alias of the work area to select for the
   
 pick list. This parameter is not needed if (aData) is passed.
   

   
 (aOptions) is an array of options about the picklist box.
   
 This array must conform to the same requirements as the
   
 (aOptions) array for DC_DBCHCREATE().
   

   
 (aColumns) is an array of columns to display in the picklist
   
 box.  This array must conform to the same requirements as the
   
 (aColumns) array for DC_DBCHCREATE().
   

   
 (bFieldBlock) is a code-block to evaluate after the user
   
 chooses the record from the pick-list.  The evaluated output
   
 will be stored in (xValue).
   

   
 (aData) is the name of a multi-dimensional array containing
   
 the pick-list data.  If this parameter is not passed, then the
   
 pick-list data will come from the database selected by (cAlias).
   

   
 (bPreBlock) is a code block to evaluate before popping up the
   
 pick-list.  (xValue) is passed as a parameter to the code
   
 block.  The code block may return a numeric value to control
   
 the continuing behavior of the function.  If the code block
   
 returns a numerical 1, then the picklist will not be displayed
   
 and DC_ReadDPick() will return a logical .FALSE.  If the code
   
 block returns a numerical 2, then the picklist will not be
   
 displayed and DC_ReadDPick() will return a logical .TRUE.  If
   
 the codeblock returns any other value, the picklist will be
   
 displayed.
   

   
 (bPostBlock) is a code block to evaluate after the pick-list
   
 has been displayed and the user selects a record or presses
   
 ESCAPE.  (xValue) is passed as a parameter to the code
   
 block.  The code block may return a numeric value to control
   
 the return value of the function.  If the code block returns a
   
 numerical 1, then DC_ReadDPick() will return a logical .FALSE.
   
 If the code block returns a numerical 2, then DC_ReadDPick()
   
 will return a logical .TRUE.  If the codeblock returns a logical
   
 value then the logical value will be returned.  If the codeblock
   
 returns any other value, a logical .TRUE. will be returned.
   

   
 (bPreBlock) and (bPostBlock) are optional parameters and may
   
 be used for such functions as opening and closing the database,
   
 setting filters and or indexes, etc. in the event that the
   
 database is not already open or the database conditions are
   
 unknown.
   

   
 (lSeek) if .TRUE. (default) will seek to the value passed as
   
 (xSeekValue) if not empty, otherwise will seek to the value
   
 passed as (xValue).  A .TRUE. will be returned if found,
   
 otherwise a database pick-list will be displayed.
   

   
 (lEmptyOK) if .TRUE. will return a .TRUE. if (xValue) is empty
   
 and (lSeek) is .FALSE.  The pick-list will not be displayed.
   

   
 (cFilter) is a filter string to impose upon the database before
   
 seeking or displaying records.  Any old filter will be restored
   
 before returning.
   

   
 (nSeekIndex) is the number (numeric) or tag-name (character) of
   
 the index to select before seeking the record when (lSeek) is
   
 .TRUE.  If this parameter is not passed, then the currently
   
 selected index will be used.   The currently selected index will
   
 be restored upon return.
   

   
 (xSeekValue) if not empty, will be used to perform the seek when
   
 (lSeek) is .TRUE., otherwise (xValue) will be used.
   

   

Returns:

    A logical .TRUE. if the operator clicks on a different GET
   
 or if the operator chooses and item from the pick-list.  A
   
 logical .FALSE. if the operator presses the ESCAPE key.
   

   

Description:

Notes:

Examples:

    -- Example 1 --
   

   
 // In this example a GET table asks the operator for a Customer
   
 // Number.  If the operator double-clicks on the GET, the
   
 // CUSTOMER database will be selected, a pick-list will pop-up
   
 // displaying the CUSTOMER NUMBER and CUSTOMER NAME.  The
   
 // CUSTOMER NUMBER of the selected record will be returned into
   
 // the GET variable.
   

   
 local cCustomer := SPACE(10), GetList := {}
   
 @ 10,10 say 'Enter Customer Number ' GET cCustNmbr ;
   
 VALID DC_READDPICK( cCustNmbr, 'CUSTOMER',  { 5,20,20,75 },;
   
                    { {{||cust_nmbr},'Number' },;
   
                      {{||cust_name},'Customer Name' } },;
   
                    {||PAD(cust_nmbr,10)} )
   
 dc_readmodal(GetList)
   

   

   
 -- Example 2 --
   

   
 // In this example a GET table asks the operator for a File
   
 // Name.  If the operator double-clicks on the GET, the
   
 // Directory() function will be used to create an array of
   
 // file names which will be displayed in the pick-list.  The
   
 // selected file will be returned into the GET variable.
   

   
 local cFileName := space(50), GetList := {}
   
 @ 10,10 say 'Enter File Name' get cFileName ;
   
  VALID DC_READDPICK( cFileName,,  { 5,20,20,75 },;
   
  { { 1,'File Name',15 }, { 2,'Size',8 }, { 3, 'Date',8 }},;
   
  {|a,n|a:=Directory(),n:=dc_arrayrec(),PAD(a[n,1],50)},;
   
   Directory() )
   
 dc_readmodal(GetList)
   

   

   

Source/Library:

See Also:

dc_readempty()

Validate that a GET is not empty or display message

Syntax:

Arguments:

    (xMemVar) is the memvar to validate.
   

   
 (cLine1) thru (cLineN) is an array of character strings.  This is
   
 the message to display if the field is empty.
   

   

   

Returns:

    Returns .TRUE. if (xMemVar) is not empty, otherwise will
   
 display message, wait for a key hit or mouse-click, then return
   
 .FALSE.
   

   

   

Description:

Examples:

    @ 10,10 say 'Enter Customer Name ' GET cCustName ;
   
    VALID DC_READEMPTY( cCustName ,;
   
      { "Must enter a Customer Name" } )
   

   

   

   

   

   

Source/Library:

See Also:

dc_reader()

A Replacement for GetReader() that works with mouse

Syntax:

Arguments:

    (oGet) is the Get object that is currently in focus.
   

   
 (aGetList) is the Get List array.
   

   

   

Returns:

    nil
   

   

Description:

Notes:

Examples:

   LOCAL GetList := {}
   

   
@ 13,15 say '  Customer Name ' GET cust_name
   
@ 14,15 say '         Street ' GET street
   
@ 15,15 say '           City ' GET city
   
@ 16,15 say '          State ' GET state
   
@ 17,15 say '            Zip ' GET zip
   
oGet := GetList[5]
   
oGet:reader := {|oGet| MyReader( oGet, GetList )}
   
dc_readmodal( GetList )
   
Return nil
   

   
// ----------------- //
   

   
STATIC FUNCTION MyReader ( oGet, GetList )
   

   
@ 24,0 SAY 'Enter a Valid Zip Code'
   
DC_READER( oGet, GetList )
   
@ 24,0 clear
   
Return nil
   

   

   

   

   

Source/Library:

See Also:

dc_readhelp()

Post a code-block for F1 help when using DC_ReadModal()

Syntax:

Arguments:

    (bHelp) is a code block that is used to call a HELP procedure
   
 when F1 is pressed or the mouse is clicked on HELP.
   

   

Returns:

    The last posted code block.
   

   

Description:

Examples:

    LOCAL bHelp, bSaveHelp, aReadArea, GetList := {}
   
 LOCAL cFileName := SPACE(40), cText := SPACE(30)
   
 bHelp := { |p,l,v| MyF1Help(p,l,v) }
   
 bSaveHelp := DC_READHELP( bHelp )
   
 DC_ReadBox( 11,10,17,70,,@aReadArea)
   
 @ 13,12 SAY ' File Name' GET cFileName
   
 @ 15,12 SAY 'Enter Text' GET cText
   
 DC_ReadModal( GetList,,aReadArea )
   
 DC_READHELP( bSaveHelp )
   

   

   

Source/Library:

See Also:

dc_readhelp()

Toggle the "F1=HELP" message on dCLIP dialog screens.

Syntax:

Arguments:

    (lMode) if .TRUE. will Set the alternate mode.  The default
   
 is .FALSE.
   

   

Returns:

    The current mode.
   

   

Description:

Source/Library:

See Also:

dc_readincr()

A "VALID" function for incrementing a GET value with the mous

Syntax:

Arguments:

    @(getvar) is the name of the GET variable.
   

   
 (aValues) is an array of valid values for (getvar).
   

   

   

   

Returns:

    .TRUE.
   

   

Description:

Notes:

Examples:

    // Let's say that the only valid entries in the field
   
 // "nTimeIncr" are 5, 10, 15, 30, and 60.  You would use
   
 // DC_READINCR() as follows:
   

   
 GetList := {}
   
 @ 10,10 SAY 'Enter Time Increment ' GET nTimeIncr VALID ;
   
    DC_READINCR( @nTimeIncr, { 5,10,15,30,60 } ) .AND. ;
   
    ' '+STR(nTimeIncr,2)+' ' $ '  5 10 15 30 60 ' PICKLIST
   
 dc_readmodal( Getlist )
   

   
 // If the current value of nTimeIncr is 15, then double-
   
 // clicking on the get will change it to 30.
   

   

Source/Library:

See Also:

dc_readkill()

Return, and/or set, whether current READ should be exited

Syntax:

Arguments:

    (lReadKill) sets the DC_READKILL() flag.  A value of true (.T.)
   
 indicates that the current read should be terminated, and a value
   
 of false (.F.) indicates that it should not.
   

   

Returns:

    NIL
   

   

Description:

Notes:

Source/Library:

See Also:

dc_readmemo()

Insert a memo editor into a table of GETS

Syntax:

Arguments:

    @(cMemo) is the memo field to edit or view.  If this argument
   
 is a NIL, then (cMemVar) must contain the name of a PRIVATE or
   
 PUBLIC memvar with the contents of the memo.
   

   
 (nStrow), (nStcol), (nEnrow), (nEnCol) are the screen
   
 coordinates.
   

   
 (cTitle) is the title to put on the memo box.
   

   
 (lEnter) if .TRUE. will display the memo only if the ENTER key
   
 was pressed in the GET or the mouse was double-clicked,
   
 otherwise the memo will be displayed when (1) entering the get
   
 if using the WHEN clause or (2) leaving the get if using the
   
 VALID clause.
   

   
 (lEdit) if .TRUE. will enter "edit" mode, otherwise "view"
   
 mode will be active and "edit" will be an option on the memo
   
 menu.
   

   
 (lProtect) will allow the user to view or print the memo only.
   

   
 (nExitState) is a number (from GETEXIT.CH) to determine where
   
 to navigate in the get list after exiting the memo editor.
   
 GE_NOEXIT is default.
   

   

Returns:

    .TRUE.
   

   

Description:

Notes:

Examples:

    cApptMemo := tcappt-)cal_memo
   
 cApptAgenda := tcappt-)agen_memo
   
 cGetMemo := 'MEMO'
   
 cGetAgenda := 'MEMO'
   
 @ 10,10 SAY '  Appointment Memo' GET cGetMemo VALID ;
   
   DC_READMEMO( @cApptMemo, 12, 10, 23, 70, 'Appointment Memo',;
   
                .t., .f., .f. )
   
 @ 11,10 SAY 'Appointment Agenda' GET cGetAgenda VALID ;
   
   DC_READMEMO( @cApptAgenda, 12, 10, 23, 70, 'Agenda Memo',;
   
                .t., .f., .f. )
   
 dc_readmodal( GetList )
   

   

   

   

Source/Library:

See Also:

dc_readmodal()

A moused replacement for ReadModal()

Syntax:

Arguments:

    (aGetList) is an array containing a list of Get objects to
   
 edit.
   

   
 (nPos) is the number of the GET to place into focus.
   
 If no parameter is passed then GET #1 will be in focus.
   

   
 (aActiveArea) is an array of 4 elements:
   

   
  Element   Type  Description
   
  -------   ----  -----------------------------------------
   
   [1]       N    Start Row
   
   [2]       N    Start Column
   
   [3]       N    End Row
   
   [4]       N    End Column
   
   [5]       A    Mouse buttons
   
                  (See DC_MOUSEKEY() for specification)
   

   
 If no array is passed, then if the mouse is clicked outside
   
 any active GETs, it will do nothing.  If an array is passed,
   
 an the mouse is clicked outside the array coordinates, the
   
 READ will be terminated exactly the same as hitting the
   
 CTRL-W key.
   

   
 (lConfirm) if .TRUE. will display a confirmation picklist, if
   
 .FALSE. (default) will exit normally.
   

   
 (nConfRow)  - If a value is passed the confirmation box
   
 will start at the row number of the passed value, otherwise
   
 it will be centered on the screen.
   

   
 (lNoUpdateEsc) - If .TRUE., the mouse is clicked outside the
   
 active area, and no gets were updated, then  Lastkey() will
   
 return K_ESC.  If .FALSE. (default), the confirmation box will
   
 be displayed.
   

   
 (lProtect) - If .TRUE. the user will be allowed to navigate
   
 thru the GET table, but will not be allowed to change any
   
 data in the active gets.  If .FALSE. (default), then the Get
   
 list will behave normally.
   

   
 (aMsg) - This is an optional array of 5 parameters
   
 defining the location of the screen to place messages defined
   
 by the MESSAGE command line parameter in the @SAY..GET command.
   
 Elements 1-4 are the screen coordinates ( nStRow, nStCol,
   
 nEnRow, nEnCol respectively ).  Element 5 is a string defining
   
 the color of the message window.
   

   
 (bCustomKey) - This is a code block which will be evaluated
   
 in the "Apply Key" sub-function of DC_ReadModal(). This routine
   
 checks which key has been pressed and sets the EXITSTATE based
   
 on the key pressed.  The default action for keys is the same as
   
 the standard Clipper GET system.  You can modify the action for
   
 specified keys by adding your own CASE statements in a function
   
 placed into the (bCustomKey) code block.  Three parameters are
   
 passed to your custom function:
   

   
   1. The Inkey() value of the key pressed.
   
   2. The Get Object that is in focus.
   
   3. The GetList Object.
   

   
 The (bCustomKey) code-block must return a LOGICAL .TRUE. if the
   
 custom action was accomplished, .FALSE. otherwise.
   

   
 (aCustomKey) is an array of INKEY values and code blocks.  If
   
 any key is pressed that matches an INKEY value in the array,
   
 the associated code-block will be evaluated.
   

   
  Element  Type   Description
   
  -------  ----   ------------------------
   
    [1]   N     INKEY value
   
    [2]     B     Code block to evaluate when (INKEY) is pressed.
   

   
 (lViewEdit) if .TRUE. will place DC_ReadModal() in the VIEW/EDIT
   
 toggle mode.  In this mode, the GETS start out in VIEW mode.  In
   
 VIEW mode the GETS may be navigated in the normal method, but
   
 there will be no cursor displayed and pressing data entry keys
   
 will not cause the GETS to be updated.  When the (ENTER) key is
   
 pressed the EDIT mode is enabled at the currently selected GET
   
 and the cursor is displayed.  Pressing (ESCAPE) will exit EDIT
   
 mode and reestablish VIEW mode.  If this parameter is not passed
   
 or is passed as a .FALSE, then normal editing will be enabled.
   

   
 (lMouXWrite) if .TRUE. is equivalent to pressing the (CTRL-END)
   
 or (F10) key to save the GETS whenever the mouse is clicked
   
 outside the area established by the (aActiveArea) array.  If
   
 this parameter is not passed or is passed as a .FALSE., then
   
 clicking the mouse outside the (aActiveArea) region is
   
 equivalent to pressing the (ESCAPE) key.
   

   
 (lMouRele) if .TRUE. (default) will require that the mouse
   
 button be released and pressed again before it will navigate
   
 to the clicked-on GET.  If .FALSE. and the mouse button is
   
 pressed on a GET, the clicked-on GET will immediately be
   
 placed into focus.
   

   
 (lNoHelp) if .TRUE. will disable the code block that calls
   
 DC_HELPF1() when the F1 key is pressed.  The default is .FALSE.
   
 Use this parameter if the F1 key has already been set to a
   
 different procedure.
   

   

   
 DC_READMODAL() also supports additional command line parameters
   
 which may be added to the end of your @ SAY...GET command line.
   

   
 (These options require #include 'DCGET.CH' in your source code):
   

   
 FORCEVALID
   

   
  This option will require that the VALID statement in the
   
  GET be evaluated before the Get List can be exited, even if
   
  the GET is never entered by the operator. For example, if you
   
  have a GET that is not allowed to be empty, use this parameter
   
  in conjuction with DC_READEMPTY().
   

   
 PICKLIST
   

   
  This option is used to paint a "down arrow" mouse button at
   
  the end of the GET variable on the screen which informs the
   
  operator that an additional picklist will pop-up if the
   
  operator single-clicks on the arrow or double-clicks within
   
  the GET area or if the operator presses the CTRL-J or
   
  CTRL-ENTER key while in the GET area.
   

   
 DOUBLEPICK
   

   
  This option is used to paint a "down arrow" and "up arrow"
   
  mouse button at the end of the GET variable on the screen
   
  which informs the operator that clicking on the down arrow
   
  will decrease the value in the GET by the increment value
   
  and clicking on the up arrow will increase the value in the
   
  GET by the increment value.   This option was intended to be
   
  used with the DC_ReadIncr() function in the VALID statement.
   

   
 PREEVAL (block)
   

   
  This option functions similar to the WHEN clause except it
   
  doesn't return a value and the block is evaluated before the
   
  WHEN block.
   

   
 POSTEVAL (block)
   

   
  This option functions similar to the VALID clause except
   
  it doesn't return a value and the block is evaluated before
   
  the VALID block.
   

   
 MESSAGE (aMessage)
   

   
  This option is used to display a message on the screen
   
  while the get is in focus.   (aMessage) may be a character
   
  string or an array of character strings.  The message will be
   
  displayed in the coordinates defined by the DC_READMSG()
   
  function, the SET READ MESSAGE TO (parameters) command, or
   
  the (aMessage) parameter passed to DC_ReadModal().
   

   
 PROTECT
   

   
  This option will allow the user to enter the GET but not
   
  make any changes.  Any attempt to modify the data will cause
   
  a beep.
   

   
 HIDE
   

   
  This option will hide all user input in the GET and display
   
  only an empty GET with the exception of an asterisk * at the
   
  cursor position.
   

   
 CAPFIRST
   

   
  This parameter will automatically capitalize the first letter
   
  of each word typed into the GET.
   

   
 APOINTER
   

   
  Editing an array of GETS that are displayed in a FOR..NEXT or
   
  DO..WHILE loop using an "incremented" or "decremented" pointer
   
  to each array element is not possible unless the value of the
   
  pointer is stored in CARGO.  This can be accomplished very
   
  easily by using the APOINTER (nVar) parameter at the end of
   
  your GET statement.  See Example 2.
   

   
 CHECKBOX [MEMVAR] (xMemVar) [DELIMS (cDelims)]
   

   
  This option is used to define a GET as a "CHECK BOX".  A
   
  check box GET is used to toggle a logical variable whenever
   
  the mouse is clicked in the GET or when the cursor is moved
   
  to the GET and the ENTER key is pressed.  The (cDelims)
   
  parameter is a character string of 3 characters defining
   
  the delimeter characters to use to frame the check mark and
   
  the character to use to display the check mark when the
   
  check box is toggled to .TRUE.  If the DELIMS suboptions is
   
  not used then the default delimeters is "(*)".  (xMemVar) is
   
  the logical memory variable that will be toggled when the check
   
  box is toggled.
   

   
 RADIOGROUP (nGroup) MEMVAR (xMemVar) [DELIMS (cDelims)] ;
   
            VALUE (xValue)
   

   
  This option is used to define a set of GETs as a "RADIO GROUP".
   
  A Radio Group GET is used to set a variable to a specified
   
  value whenever the mouse is clicked in the GET or when the
   
  cursor is moved to the GET and the ENTER key is pressed.
   
  (nGroup) is the number of the radio group that binds the
   
  separate GET items to a group.  The (cDelims) parameter is a
   
  character string of 3 characters defining the delimeter
   
  characters to use to frame the check mark and the character to
   
  use to display the check mark when the radio group item is
   
  selected.  If the DELIMS suboptions is not used then the
   
  default delimeters is "(*)".  (xMemVar) is the memory variable
   
  that will be updated when the radio group item is selected.
   
  (xValue) is the value that will be stored into (xMemVar) when
   
  the radio group item is selected.
   

   
 HELPCODE (helpcode)
   

   
  This option is used to establish which help screen to display.
   
  If F1 or Alt-F1 is pressed while in the GET, the Help Code will be
   
  passed to the Help System.  This will override the INPUT VAR,
   
  PROC NAME, and any DC_HELPCODE() and force the dCLIP Help system to
   
  use the code in the GetList.
   

   

   

   

   

Returns:

    .TRUE. if any gets were updated, .FALSE. otherwise.
   

   

Description:

Notes:

Examples:

    -- Example 1 --
   

   
 /* This example shows how DC_READMODAL() can be used
   
    to support pick-lists a memos */
   

   
 #include "dcget.ch"
   

   
 LOCAL GetList := {}, aReadArea, cSaveScreen,;
   
       cMemoGet := 'MEMO'
   

   
 cSaveScreen := DC_ReadBox( 9, 10, 19, 70,, @aReadArea )
   
 @ 11,15 say 'Enter Memo' GET cMemoGet ;
   
   valid dc_readmemo( @cMemo ) PICKLIST PROTECT
   
 @ 12,15 say 'Customer Number ' GET cust_nmbr ;
   
   valid dc_readempty(cust_nmbr) FORCEVALID
   
 @ 13,15 say '  Customer Name ' GET cust_name
   
 @ 14,15 say '         Street ' GET street
   
 @ 15,15 say '           City ' GET city
   
 @ 16,15 say '          State ' GET state ;
   
   valid dc_readclick( @state, {|d|d:=statelist()} ) ;
   
   PICKLIST
   
 @ 17,15 say '            Zip ' GET zip MESSAGE ;
   
   "Must be at least 5 digits"
   

   
 DC_READMODAL( GetList,, aReadArea,,,,,,;
   
              {|a,b|CustomKey(a,b)} )
   
 Return nil
   

   
 /* ----------------- */
   

   
 STATIC FUNCTION CustomKey ( nInkey, oGet )
   

   
 DO CASE
   
   /* Change PgDn key default action */
   
   CASE nInkey = K_PGDN
   
     oGet:ExitState := GE_BOTTOM
   
   /* Change PgUp key default action */
   
   CASE nInkey = K_PGUP
   
     oGet:ExitState := GE_TOP
   
   OTHERWISE
   
     RETURN .f.
   
 ENDCASE
   
 RETURN .t.
   

   

   
 -- Example 2 --
   

   
 /* This example demonstrates how DC_READMODAL() can be
   
    used to edit and scroll thru an Array of Field Data */
   

   
 #include "dcget.ch"
   

   
 LOCAL GetList := {}, aReadArea, cSaveScrn, aData, i
   

   
 USE DCPRINT
   
 aData := Array(Fcount())
   
 FOR i := 1 TO LEN( aData )
   
   aData[i] := FieldGet(i)
   
 NEXT
   
 cSaveScrn := DC_ReadBox( 10, 10, 20, 60,, @aReadArea )
   
 FOR i := 1 TO LEN(aData)
   
   @ i,12 SAY PADL(Field(i),10) GET aData[i] APOINTER i
   
 NEXT
   
 DC_READMODAL( GetList,,aReadArea )
   
 DC_Impl( cSaveScrn )
   
 RETURN nil
   

   

   
 -- Example 3 --
   

   
 /* This example demonstrates how DC_READMODAL() can be
   
    used to create CHECK BOXES and RADIO GROUPS */
   

   
 #include 'dcget.ch'
   

   
 FUNCTION junk
   

   
 LOCAL GetList := {}, aCheck := {' ','û',' '}, nLength,;
   
       aRadio := {'*',' ',' ','*',' ',' '}, ;
   
       lAscii := .f., lBackup := .t., lPrinter := .f., ;
   
       aReadArea, cComPort, ;
   
       cSaveScrn := DC_ReadBox( 3,5,21,70,,@aReadArea )
   

   
 /* -- Paint Check Boxes -- */
   
 @ 5,10 TO 11,35
   
 @ 5,12 SAY ' Check options below '
   
 @ 7,12 SAY 'Convert to ASCII ' GET aCheck[1] CHECKBOX ;
   
                  MEMVAR lAscii DELIMS '(û)'
   
 @ 8,12 SAY 'Keep Backup File ' GET aCheck[2] CHECKBOX ;
   
                  MEMVAR lBackup DELIMS '(û)'
   
 @ 9,12 SAY ' Copy to Printer ' GET aCheck[3] CHECKBOX ;
   
                  MEMVAR lPrinter DELIMS '(û)'
   

   
 /* -- Paint Radio Group 1 -- */
   
 @ 13,10 TO 19,35
   
 @ 13,12 SAY ' Select Page Length '
   
 @ 15,12 SAY ' 40 Lines  ' GET aRadio[1] RADIOGROUP 1 ;
   
             MEMVAR nLength DELIMS '(*)' VALUE 40
   
 @ 16,12 SAY ' 55 Lines  ' GET aRadio[2] RADIOGROUP 1 ;
   
             MEMVAR nLength DELIMS '(*)' VALUE 55
   
 @ 17,12 SAY ' 66 Lines  ' GET aRadio[3] RADIOGROUP 1 ;
   
             MEMVAR nLength DELIMS '(*)' VALUE 66
   

   
 /* -- Paint Radio Group 2 -- */
   
 @ 13,40 TO 19,65
   
 @ 13,42 SAY ' Select Com Port '
   
 @ 15,42 SAY ' Com 1  ' GET aRadio[4] RADIOGROUP 2 ;
   
             MEMVAR cComPort DELIMS '(*)' VALUE 'COM1'
   
 @ 16,42 SAY ' Com 2  ' GET aRadio[5] RADIOGROUP 2 ;
   
             MEMVAR cComPort DELIMS '(*)' VALUE 'COM2'
   
 @ 17,42 SAY ' Com 3  ' GET aRadio[6] RADIOGROUP 2 ;
   
             MEMVAR cComPort DELIMS '(*)' VALUE 'COM3'
   

   
 DC_READMODAL( GetList,,aReadArea )
   
 DC_Impl( cSaveScrn )
   
 RETURN { lAscii, lBackup, lPrinter, nLength, cComport }
   

   

   

Source/Library:

See Also:

dc_readnav()

Enable an alternative navigation method for GETS

Syntax:

Arguments:

    (lMode) if .TRUE. will set the alternate navigation
   
 method.  The default is .FALSE.
   

   

Returns:

    The current setting.
   

   

Description:

Source/Library:

See Also:

dc_readonly()

Report if current workarea is Read Only

Syntax:

Arguments:

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

   

Description:

Examples:

    if DC_READONLY()
   
   ? 'This database cannot be modified'
   
 else
   
   replace ship_date with date()
   
 endif
   

   

Source/Library:

dc_readvar()

Update a check box or Radio Button GET

Syntax:

Arguments:

    @(xMemVar) is the value of the memvar to update.  If this
   
 parameter is not passed then the name of a PRIVATE or
   
 PUBLIC memvar must be passed as (cMemVar).
   

   
 (nElement) is used only if (xMemVar) is an array.  The
   
 value of this parameter determines which array element to
   
 update.
   

   
 (xValue) is used only if (xMemVar) or (cMemVar) is a
   
 Radio Button and not a Check Box.  This is the value to
   
 stuff into (xMemVar) or &(xMemVar).
   

   
 (lCheck) if .TRUE. establishes (xMemVar) as a logical Check
   
 box memvar, otherwise it is a Radio Button memvar of any
   
 type.
   

   

   

   

   

Returns:

    NIL
   

   

Description:

Notes:

Examples:

    See DCGET.CH
   

   

Source/Library:

See Also:

dc_readwindow()

Establish scroll-region for DC_ReadModal() GETS

Syntax:

Arguments:

    (aCoord) is an array containing the screen coordinates.
   

   
  Element   Type  Description
   
  -------   ----  -----------------------------------------
   
   [1]       N    Start Row
   
   [2]       N    Start Column
   
   [3]       N    End Row
   
   [4]       N    End Column
   

   

Returns:

    An array containing the previously established screen
   
 coordinates.
   

   

Description:

Notes:

Examples:

    #include "dcget.ch"
   

   
 LOCAL GetList := {}, aData, i
   

   
 USE DCPRINT
   
 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)
   
   @ i,12 SAY PADL(Field(i),10) GET aData[i] APOINTER i
   
 NEXT
   
 DC_ReadModal( GetList,,aReadArea )
   
 RETURN nil
   

   

   

Source/Library:

See Also:

dc_readwrap()

Enable wrapping mode in a table of GETS

Syntax:

Arguments:

    (lWrap) if .TRUE. will enable Read Wrap mode.  The default is
   
 .FALSE.
   

   

Returns:

    .TRUE.
   

   

Description:

Notes:

Examples:

    // Set Read Wrap mode ON
   
 DC_READWRAP(.t.)
   

   

   

   

Source/Library:

See Also:

dc_recall()

Pop-up user-prompt menu to recall deleted database records

Syntax:

Arguments:

    NONE
   

   

Returns:

    A logical .TRUE. if the recall process is successfully completed.
   

   

Description:

Examples:

    . use invoice
   
 . use invitems new
   
 . set relation to inv_nmbr into invoice
   
 . DC_RECALL()
   

   

Source/Library:

See Also:

dc_reclock()

Lock the current record regardless of Rdd (data-driver)

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 record cannot be locked. (default) or if .false.
   
 will not display an error message to the operator.
   

   

Returns:

    A logical .TRUE. if the record is successfully locked.
   

   

Description:

Examples:

    if DC_RECLOCK( 5 )
   
   replace cust_nmbr with cCustNmbr
   
 else
   
   break
   
 endif
   

   

Source/Library:

See Also:

dc_rectag()

Build or add to a tag array

Syntax:

Arguments:

    (lClear) will remove record numbers from the tag array that
   
 meet the specified conditions, otherwise records will be
   
 added.
   

   
 (aTags) is an existing array of record numbers which will
   
 display the TAG marker in the browse display.  If no
   
 argument is given then the public DCTAGS array will be
   
 used.
   

   
 See the Clipper DBEVAL() function on how to use the (bFor),
   
 (bWhile), (nNext), (nRec), (lRest) parameters.
   

   

Returns:

    A pointer to an array of tagged numbers.
   

   

Description:

Examples:

    use customer
   
 dc_rectagclear()
   
 aTags := {}
   

   
 // tag all records with a balance greater than 0
   
 aTags := DC_RECTAG(.f., aTags, {||balance)0} )
   

   
 // untag all records in Los Angeles
   
 aTags := DC_RECTAG(.t., aTags, {||zip='90'.or.zip='91'} )
   

   
 list cust_name for dc_tagged(aTags)
   

   

Source/Library:

See Also:

dc_rectagbrowse()

Pop-up a pick-list of record for tagging and untagging

Syntax:

Arguments:

    (afields) is an array of field names to browse.  If no
   
 argument is given then all fields will be used.
   

   
 (aTags) is an existing array of record numbers which will
   
 display the TAG marker in the browse display.  If no
   
 argument is given then the public DCTAGS array will be
   
 used.
   

   
 (aHeadings) is an array of column headings.  Array must
   
 have same number of elements as aFields.  If not passed
   
 then column headings will be the same as field names.
   

   
 (aWidths) is an array of column widths - NUMERIC.  Array
   
 must have the same number of elements as aFields.  If not
   
 passed then column widths will default to length of each
   
 field.
   

   
 (cTitle) is the title to appear at top of picklist.
   

   

Returns:

    A pointer to an array of tagged numbers.
   

   

Description:

Examples:

    use customer
   
 dc_rectagclear()
   
 aTags := {}
   
 aTags := DC_RECTAGBROWSE({'CUST_NMBR','CUST_NAME'}, aTags )
   
 list cust_name for dc_tagged(aTags)
   

   

Source/Library:

See Also:

dc_rectagclear()

Clear all the tags from the tag array

Syntax:

Arguments:

    (aTags) is an array of tags.  If no array is passed then
   
 the currently selected work area portion of the public
   
 DCTAGS array will be cleared.
   

   

   

   

Returns:

    nil
   

   

Description:

Examples:

     use customer
   
  dc_rectag(,,{||balance)0})
   
  count to x for dc_tagged()
   
  ? x
   
 123
   
  DC_RECTAGCLEAR()
   
  count to x for dc_tagged()
   
  ? x
   
 0
   

   

Source/Library:

See Also:

dc_rectagtoggle()

Toggle the current record between Tagged/UnTagged

Syntax:

Arguments:

    (aTags) is an existing array of record numbers which will
   
 display the TAG marker in the browse display.  If no
   
 argument is given then the public DCTAGS array will be
   
 used.
   

   

Returns:

    A logical .T. if the record was added to the array, .F. if
   
 the record was removed from the array.
   

   

Description:

Examples:

    use customer
   
 aTags := {}
   
 go 10
   
 ? DC_RECTAGTOGGLE( aTags )
   
 .T.
   
 ? DC_RECTAGTOGGLE( aTags )
   
 .F.
   

   

Source/Library:

See Also:

dc_relarray()

Get an array of child relational info

Syntax:

Arguments:

    NONE.
   

   

Returns:

    A multi-dimensional array containing one sub-array for each
   
 child relation:
   

   
 Element   Type   Description
   
 ------      ----   ---------------------------------
   
   1        C     Alias of child workarea
   
   2        N     Number of child workarea
   

   

   

Description:

Source/Library:

dc_rename()

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

Syntax:

Arguments:

    NONE
   

   

Returns:

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

   

Description:

Examples:

    @ 12,10 prompt "Copy a File"
   
 @ 13,10 prompt "Erase a File"
   
 @ 14,10 prompt "Rename a File"
   
 menu to nChoice
   
 do case
   
   case nChoice = 1
   
     dc_copyfile()
   
   case nChoice = 2
   
     dc_erase()
   
   case nChoice = 3
   
     DC_RENAME()
   
 endcase
   

   

Source/Library:

See Also:

dc_replace()

Pop-up a user-prompt menu for replacing database fields

Syntax:

Arguments:

    NONE
   

   

Returns:

    A logical .TRUE. if data was replaced, .FALSE. otherwise.
   

   

Description:

Examples:

    @ 11,10 prompt "Delete Records"
   
 @ 12,10 prompt "Recall Records"
   
 @ 13,10 prompt "Replace Data by condition"
   
 menu to nChoice
   
 do case
   
   case nChoice = 1
   
     dc_append()
   
   case nChoice = 2
   
     dc_delete()
   
   case nChoice = 3
   
     DC_REPLACE()
   
 endcase
   

   

Source/Library:

See Also:

dc_report()

A Report and Label Form manager

Syntax:

Arguments:

    (lProtect) if .TRUE. will protect the reports from being
   
 modified by the operator.  .FALSE. is the default.
   

   

Returns:

    NIL
   

   

Description:

Source/Library:

See Also:

dc_restset()

Restore all Clipper SETs from an array

Syntax:

Arguments:

    (aSets) is an array created by DC_SAVESET().
   

   

Returns:

    nil
   

   

Description:

Examples:

    aSaveSet := dc_saveset()
   
 set default to \customer\data
   
 set path to \myreport
   
 set printfile to print.txt
   
 use customer
   
 report form custlist
   
 DC_RESTSET( aSetSave )
   

   

Source/Library:

See Also:

dc_saveset()

Save all Clipper SETs to an array

Syntax:

Arguments:

    None
   

   

Returns:

    An array that contains the contents of the SET environment.
   

   

Description:

Examples:

    aSaveSet := DC_SAVESET()
   
 set default to \customer\data
   
 set path to \myreport
   
 set printfile to print.txt
   
 use customer
   
 report form custlist
   
 dc_restset( aSetSave )
   

   

Source/Library:

See Also:

dc_say()

Perform @..SAYs relative to coordinates in dc_expl() window

Syntax:

Arguments:

    (cSaveScreen) is the composite screen data returned by
   
 DC_EXPL().
   

   
 (nRow) is the relative row position within the window.
   

   
 (nCol) is the relative column position within the window.
   

   
 (cText) is the text to display.
   

   

   

Returns:

    NIL
   

   

Description:

Examples:

    aText := { "Enter a name to search.",;
   
           "The name must start with",;
   
           "an alphabet character" }
   
 disp_msg( 10,10,15,40,aText )
   
 return
   

   
 FUNC disp_msg ( nSrow, nScol, nErow, nEcol, aText )
   

   
 cScreen := dc_expl( nSrow, nScol, nErow, nEcol )
   
 for i := 1 to len(aText)
   
   DC_SAY( i+1, 2, aText[i] )
   
 next
   

   

Source/Library:

See Also:

dc_saycenter()

Write a string in the center of an area of the screen

Syntax:

Arguments:

    (nRow) is the row position of the screen.
   

   
 (nStCol) is the start column.
   

   
 (nEnCol) is the end column.
   

   

   

Returns:

    NIL
   

   

Description:

Examples:

    dc_expl( 12, 20, 14, 50 )
   
 DC_SAYCENTER( 13, 20, 50, 'Center this' )
   

   

Source/Library:

dc_scope()

Pop-up a menu for creating database scoping conditions

Syntax:

Arguments:

    (cMessage) is a title which will appear at the top of the box
   
 that is used to enter the scoping conditions.
   

   

Returns:

    An array of 9 elements:
   

   
 Element    Type             Description
   
 --------  ------------      ---------------------------------
   
   [1]     Code Block        FOR condition Code Block
   
   [2]     Code Block        WHILE condition Code Block
   
   [3]     Numeric           Number of Records, NIL if ALL
   
   [4]     Numeric           Record Number, NIL if ALL
   
   [5]     Logical           .t. if REST, .f. if ALL
   
   [6]     Variable          Scope TOP Value
   
   [7]     Variable          Scope BOTTOM Value
   
   [8]     Character         FOR condition Expression
   
   [9]     Character         WHILE condition Expression
   

   

   

Description:

Notes:

Examples:

    -- Example 1 --
   

   
 accept "enter database to copy records to" to cToFile
   
 aScope := DC_SCOPE( 'Copying Records' )
   
 __dbCopy( cToFile, , aScope[1], aScope[2], aScope[3],;
   
                      aScope[4], aScope[5] )
   

   

   
 -- Example 2 --
   

   
 nSelect := sele()
   
 accept "enter database to append records from" to cFromFile
   
 use (cFromFile)
   
 aScope := DC_SCOPE( 'Appending Records' )
   
 use
   
 sele ( nSelect )
   
 if dc_filock()
   
   __dbApp( cFromFile, , aScope[1],                ;
   
     dc_odblock( aScope[2], aScope[1], aScope[3],, ;
   
     "Appended",, nRecords ),                   ;
   
     aScope[3], aScope[4], aScope[5] )
   
   unlock
   
 endif
   

   

Source/Library:

See Also:

dc_scoperec()

Get the top/bottom record numbers 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.
   

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

   
 @(nTopRec) is the memvar to place the number of the top
   
 record.
   

   
 @(nBottomRec) is the memvar to place the number of the
   
 bottom record.
   

   

Returns:

    The current record number if it falls within the scoped
   
 area, otherwise returns the top record.
   

   

Description:

Examples:

    LOCAL nTop, nBottom
   

   
 use customer index custname
   
 DC_SCOPEREC( 'C','L', @nTop, @nBottom )
   

   
 go nTop
   
 ? cust_name
   
 Charlie Weaver
   

   
 go nBottom
   
 ? cust_name
   
 Lionel Gooseberry
   

   

Source/Library:

See Also:

dc_scrldata()

Display a database vertical scroll bar

Syntax:

Arguments:

    (nStartRow) is the start display row.
   

   
 (nEndRow) is the end display row.
   

   
 (nColumn) is the display column.
   

   
 (lDispBar) if .TRUE. (default) will display the bar,
   
 otherwise only the row pointer will be returned.
   

   
 (xScopeTop) and (xScopeBottom) are optional values to
   
 determine the number of active records for calculating the
   
 position of the scroll bar.  This will work only if an index
   
 is selected and the scope values match the current index.
   

   

Returns:

    The row position of the scroll-bar.
   

   

Description:

Notes:

Examples:

    use customers index custname
   

   
 // display relative position of current record pointer
   
 // for all customers starting with "H" and ending with "R"
   
 DC_SCRLDATA( 0, 24, 79, .t., "H", "R" )
   

   

Source/Library:

See Also:

dc_scrldmou()

Return a record pointer from database scroll-bar mouse-click

Syntax:

Arguments:

    (nStartRow) is the start display row.
   

   
 (nEndRow) is the end display row.
   

   
 (nMouseRow) is clicked row of the mouse.
   

   
 (xScopeTop) and (xScopeBottom) are optional values to
   
 determine the number of active records for calculating the
   
 position of the scroll bar.  This will work only if an index
   
 is selected and the scope values match the index key.
   

   
 (lPageMode) if .TRUE. (default ) will return a value that
   
 is one page higher than (nCurrVal) if the mouse is clicked
   
 below the current pointer or a value that is one page
   
 lower than the (nCurrVal) if the mouse is clicked above
   
 the current pointer.  If (lPageMode) is .FALSE. then the
   
 value returned is a number proportional to the mouse-click
   
 position within the scroll-bar region.
   

   

Returns:

    A record number to GO TO.
   

   

Description:

Examples:

    use customers index custname
   

   
 // return record pointer based on scroll-bar mouse-click
   
 // for all customers starting with "H" and ending with "R"
   
 dc_mougetpos( @nMouseRow, @nMouseCol )
   
 nRecNo := DC_SCRLDMOU( 0, 24, nMouseRow, "H", "R" )
   

   

Source/Library:

See Also:

dc_scrldthumb()

Enable display of database vertical scroll bar thumb

Syntax:

Arguments:

    (lEnable) if .TRUE. will enable the thumb, otherwise it will
   
 be disabled.
   

   

Returns:

    A logical value equal to the current setting.
   

   

Description:

Examples:

    use customers index custname
   
 DC_SCRLDTHUMB( .f. ) // speed up browsing
   
 dc_browsedb()
   
 use testdata index testdata
   
 DC_SCRLDTHUMB( .t. ) // show relative position
   
 dc_browsedb()
   

   

Source/Library:

See Also:

dc_scrlhbar()

Display a horizontal scroll bar

Syntax:

Arguments:

    (nStartCol) is the start display column.
   

   
 (nEndCol) is the end display column.
   

   
 (nRow) is the display row.
   

   
 (nCurVal) is the current value.  This could be an array
   
 element.
   

   
 (nMinVal) is the minimum value.  If an array, then this
   
 should be 1 or the minimum selectable value.
   

   
 (nMaxVal) is the maximum value.  If an array, then this
   
 should be the number of items in the array or the maximum
   
 selectable value.
   

   

Returns:

    The column position of the scroll bar.
   

   

Description:

Examples:

    aFields := array(fcount())
   
 aFields( aFields )      // create an array of field names
   
 nPointer := 10
   
 // display scroll bar showing relative position
   
 DC_SCRLHBAR( 0, 79, 24, nPointer, 1, LEN(aFields )
   

   

   

Source/Library:

See Also:

dc_scrlhmou()

Return an array pointer from horizontal scroll-bar mouse-click

Syntax:

Arguments:

    (nStartCol) is the start display column.
   

   
 (nEndCol) is the end display column.
   

   
 (nMouseCol) is the clicked mouse column.
   

   
 (nMinVal) is the minimum value.  If an array, then this
   
 should be 1 or the minimum selectable value.
   

   
 (nMaxVal) is the maximum value.  If an array, then this
   
 should be the number of items in the array or the maximum
   
 selectable value.
   

   
 (nCurrVal) is the current value.  This is needed to
   
 determine the relative position of the mouse with respect
   
 to the current position.
   

   
 (lIncrMode) if .TRUE. (default )will return a value that is
   
 one number higher than (nCurrVal) if the mouse is clicked
   
 to the right of the current pointer or a value that is one
   
 number lower than the (nCurrVal) if the mouse is clicked
   
 to the left of the current pointer.  If (lIncrMode) is
   
 .FALSE. then the value returned is a number proportional
   
 to the mouse-click position within the scroll-bar region.
   

   

Returns:

    A pointer to an array element.
   

   

Description:

Examples:

    aFields := array(fcount())
   
 aFields( aFields ) // create an array of field names
   

   
 // get an array element based on mouse position
   
 dc_mougetpos( @nMouseRow, @nMouseCol )
   
 nPointer := ;
   
    DC_SCRLHMOU( 0, 79, 24, nMouseCol, 1, LEN(aFields )
   

   
 ? aFields[nPointer]
   

   

Source/Library:

See Also:

dc_scrlvbar()

Display a vertical scroll bar

Syntax:

Arguments:

    (nStartRow) is the start display row.
   

   
 (nEndRow) is the end display row.
   

   
 (nColumn) is the display column.
   

   
 (nCurVal) is the current value.  This could be an array
   
 element.
   

   
 (nMinVal) is the minimum value.  If an array, then this
   
 should be 1 or the minimum selectable value.
   

   
 (nMaxVal) is the maximum value.  If an array, then this
   
 should be the number of items in the array or the maximum
   
 selectable value.
   

   

Returns:

    The row position of the scroll-bar.
   

   

Description:

Examples:

    aFields := array(fcount())
   
 aFields( aFields )     // create an array of field names
   
 nPointer := 10
   
 // display scroll bar showing relative position
   
 DC_SCRLVBAR( 0, 24, 79, nPointer, 1, LEN(aFields )
   

   

Source/Library:

See Also:

dc_scrlvmou()

Return an array pointer from vertical scroll-bar mouse-click

Syntax:

Arguments:

    (nStartRow) is the start display row.
   

   
 (nEndRow) is the end display row.
   

   
 (nMouseRow) is the clicked mouse row.
   

   
 (nMinVal) is the minimum value.  If an array, then this
   
 should be 1 or the minimum selectable value.
   

   
 (nMaxVal) is the maximum value.  If an array, then this
   
 should be the number of items in the array or the maximum
   
 selectable value.
   

   
 (nCurrVal) is the current value.  This is needed to
   
 determine the relative position of the mouse with respect
   
 to the current position.
   

   
 (lPageMode) if .TRUE. (default) will return a value that
   
 is one page higher than (nCurrVal) if the mouse is clicked
   
 below the current pointer or a value that is one page
   
 lower than the (nCurrVal) if the mouse is clicked above
   
 the current pointer.  If (lPageMode) is .FALSE. then the
   
 value returned is a number proportional to the mouse-click
   
 position within the scroll-bar region.
   

   

Returns:

    A pointer to an array element.
   

   

Description:

Examples:

    aFields := array(fcount())
   
 aFields( aFields ) // create an array of field names
   

   
 // get an array element based on mouse position
   
 dc_mougetpos( @nMouseRow, @nMouseCol )
   
 nPointer := ;
   
    DC_SCRLVMOU( 0, 24, 79, nMouseRow, 1, LEN(aFields )
   

   
 ? aFields[nPointer]
   

   

Source/Library:

See Also:

dc_scrnedit()

A Screen Designer/Editor

Syntax:

Arguments:

    (cScrnGroup) is the name of the screen group in DCSCRN.DBF
   
 to load and edit (up to 8 characters) or (aScrnGroup) is a
   
 Screen Group array.  See RETURNS for a specification of this
   
 array.  If no parameter is passed, a pick-list of all Screen
   
 Groups in the DCSCRN.DBF will be displayed.
   

   
 (cCurrScrn) is the image of the current screen area.  If
   
 this parameter is not passed, the existing screen will be
   
 captured.
   

   
 (aScrnCoord) is an optional array of screen coordinates to
   
 establish the working area of the screen.  If no array is
   
 passed then the full screen is the default.
   

   
  Element   Type   Description
   
  -------   ----   --------------------------------------
   
    [1]      N      Start Row
   
    [2]      N      Start Column
   
    [3]      N      End Row
   
    [4]      N      End Column
   
    [5]      N      Row Offset
   
    [6]      N      Column Offset
   

   
 The first four elements determine the active area of the
   
 screen.  The last two elements are used to determine how
   
 much offset to use for displaying the screen objects.  The
   
 objects will be displayed relative to the starting screen
   
 coordinates and will be truncated at the ending screen
   
 coordinates.
   

   

   

Returns:

    A 2-dimensional array of two sub-arrays.
   

   
 The first array contains general information about the
   
 screen group.
   

   
  Element  Type   Description
   
  -------  ----  --------------------------------------
   
    [1]     C    Screen Group Name (up to 8 characters)
   
    [2]     C    Screen Group Description
   

   
 The second array contains one sub-array for each screen
   
 object.
   

   
  Element  Type   Description
   
  -------  ----  ---------------------------------------
   
    [1]     C    Reserved
   
    [2]     C    Screen object description
   
    [3]     C    Screen object type (1 character)
   
                 F - Fill screen area
   
                 B - Draw a box
   
                 T - Display text
   
                 G - Display a normal input GET
   
                 C - Check Box GET
   
                 R - Radio Button GET
   
                 P - Push Button
   
                 M - Memo GET
   
                 S - Screen Image
   
                 E - Explode a Dialog Window
   
    [4]     N    Page number (1-99)
   
    [5]     N    Start Row
   
    [6]     N    Start Column
   
    [7]     N    End Row
   
    [8]     N    End Column
   
    [9]     C    Text (see TYPE above)
   
                 F - 1 char for fill screen
   
                 B - 8 characters for a box plus 1 fill char
   
                 T - Up to 8000 characters for text
   
                 S - Screen Image
   
                 G/C/M/R - Prompt for GET
   
    [10]    C    Color String
   
    [11]    C    Get Variable Name
   
    [12]    C    Get Option characters
   
    [13]    N    Radio Group (1-9)
   
    [14]    C    Get Picture Clause
   
    [15]    C    Get Valid Clause (expression)
   
    [16]    C    Get When Clause (expression)
   
    [17]    C    Get Default Value (expression)
   
    [18]    L    Is Get Memvar a PUBLIC Memvar?
   
    [19]    C    Radio Group Memvar Value (expression)
   
    [20]    L    Screen tag
   

   

Description:

Notes:

Examples:

    -- Example 1 --
   
 // Load a screen group from the dictionary and edit it //
   
 DC_SCRNEDIT()
   

   
 -- Example 2 --
   
 // Edit screen group "MAIN"
   
 DC_SCRNEDIT("MAIN")
   

   
 -- Example 3 --
   
 // Edit a screen group array and paint the screen //
   
 aScrnGroup := DC_ScrnPick()
   
 aScrnGroup := DC_SCRNEDIT( aScrnGroup )
   
 DC_ScrnPaint( aScrnGroup )
   

   

   

   

   

Source/Library:

See Also:

dc_scrnload()

Load a Screen Group in the Screen Dictionary to an array

Syntax:

Arguments:

    (cScrnGroup) is the name of the screen group in DCSCRN.DBF
   
 to load (up to 8 characters).  If no parameter is passed, a
   
 pick-list of all Screen Groups in the DCSCRN.DBF dictionary
   
 will be displayed.
   

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

   

Returns:

    An 2-dimensional array that conforms to the specification of
   
 the array defined in DC_SCRNEDIT().
   

   

Description:

Examples:

    aScrnGroup := DC_SCRNLOAD('MYSCREEN')
   
 DC_ScrnPaint( aScrnGroup )
   

   

   

   

Source/Library:

See Also:

dc_scrnpaint()

Paint all screen objects from a screen array

Syntax:

Arguments:

    (cScrnGroup) is a screen group array that conforms to the
   
 specifications of the array returned by DC_SCRNEDIT().
   

   
 (cCurrScrn) is the image of the current screen area.  If
   
 this parameter is not passed, the existing screen will be
   
 captured.
   

   
 (aScrnCoord) is an optional array of screen coordinates to
   
 establish the working area of the screen.  If no array is
   
 passed then the full screen is the default.
   

   
  Element   Type   Description
   
  -------   ----   --------------------------------------
   
    [1]      N      Start Row
   
    [2]      N      Start Column
   
    [3]      N      End Row
   
    [4]      N      End Column
   
    [5]      N      Row Offset
   
    [6]      N      Column Offset
   

   
 The first four elements determine the active area of the
   
 screen.  The last two elements are used to determine how
   
 much offset to use for displaying the screen objects.  The
   
 objects will be displayed relative to the starting screen
   
 coordinates and will be truncated at the ending screen
   
 coordinates.
   

   
 (nScrnPage) is the number of the screen page to display (0-99).
   
 If -1 (default), then all objects in all pages will be displayed.
   
 Screens that have been assigned Page 0 will be displayed along
   
 with the requested screen.
   

   
 (nElement) is the element number of the screen object to
   
 display.  If 0 (default), then all objects will be displayed.
   

   
 (lScrnImpl) if .TRUE. (default) will implode any screen
   
 window created by a type "E" object after the GETs are
   
 activated and completed with DC_READMODAL().
   

   

   

   

   

   

Returns:

    nil
   

   

Description:

Examples:

    -- Example 1 --
   
 // Paint the main screen area //
   
 aScrnGroup := DC_ScrnLoad('MAIN')
   
 DC_SCRNPAINT( aScrnGroup )
   

   
 -- Example 2 --
   
 // Paint page 2 of the Editing screen in a window area //
   
 aScrnGroup := DC_ScrnLoad('EDIT')
   
 DC_SCRNPAINT( aScrnGroup, , { 5,10,20,60,-5,-5} )
   

   
 -- Example 3 --
   

   
 See the _DCEDIT.PRG source code for an example of how the
   
 dCLIP database editor uses the screen painter.
   

   

   

   

   

Source/Library:

See Also:

dc_scrnsave()

A "Night-Sky" or Blank-screen screen Saver

Syntax:

Arguments:

    [nTimeOut] is the time (in Seconds) to wait for no keyboard
   
 or mouse activity.  If no parameter is passed then the screen
   
 save will start immediately.  Note: this time-out is checked
   
 only if you are using dCLIP functions or DC_INKEY() to get a
   
 key.  Default is 120 seconds.
   

   
 DC_SCRNSAVE(-1) will return the current time-out setting
   
 without changing it.  DC_SCRNSAVE(0) will disable the screen-
   
 saver.
   

   
 [nStyle] is the style of screen.
   

   
  0 - Night sky with blinking stars (default)
   
  1 - Blank screen.  Uses INKEY(0) to prevent background
   
      processing in multi-tasking environments.
   

   

Returns:

    The current screen-saver time-out setting.
   

   

Description:

Examples:

    -- Example 1 --
   
 // Set DC_INKEY() time-out to 10 seconds
   
 DC_SCRNSAVE( 10 )
   

   
 -- Example 2 --
   
 // Invoke the screen saver
   
 DC_SCRNSAVE()
   

   

Source/Library:

See Also:

dc_scrnstore()

Save a Screen Group array to the Screen Dictionary file

Syntax:

Arguments:

    (aScrnGroup) is an array of screen group objects.  This array
   
 must conform to the specifications described in DC_SCRNEDIT().
   

   

Returns:

    An logical .TRUE. if the array was saved successfully, .FALSE.
   
 otherwise.
   

   

Description:

Examples:

    aScrnGroup := DC_SCRNEDIT('MYSCREEN')
   
 DC_SCRNSTORE( aScrnGroup )
   

   

   

   

Source/Library:

See Also:

dc_search()

Search all fields of a database for a value

Syntax:

Arguments:

    (cFileName) is the name of the database to search.  If no path
   
 is given then the current SET DEFAULT directory is assumed.  If
   
 (cFileName) is "ALL", then all databases that match the
   
 currently selected RDD will be searched.
   

   
 (cText) is the text to search for.  This is a case
   
 non-sensitive search and the first occurrence of the text in
   
 each field will be listed.
   

   
 (cOutPut) is the name of the output device.  If no argument is
   
 given or (cOutPut) is a null "" string then the output will go
   
 to the screen. If (cOutPut) = 'PRN' then the output will go to
   
 the printer, otherwise the output will go to a file named
   
 (cOutPut).  If no extension is included then .PRN is assumed.
   
 The file will be created in the SET DEFAULT directory.
   

   

Returns:

    nil
   

   

Description:

Examples:

    // search CUSTOMER.DBF for occurrences of "O'BRIEN"
   
 // and display results on screen
   
 set rdd to 'DBFSIX'
   
 DC_SEARCH( 'CUSTOMER', "O'BRIEN" )
   

   
 // search CUSTOMER.DB for occurrences of "O'BRIEN"
   
 // and copy results to file OBRIEN.TXT
   
 set rdd to 'PDX'
   
 DC_SEARCH( 'CUSTOMER', "O'BRIEN", "OBRIEN" )
   

   
 // search all .DBF's for occurences of "CLIPPER"
   
 set rdd to 'DBFNTX'
   
 DC_SEARCH( 'ALL', 'CLIPPER' )
   

   

Source/Library:

See Also:

dc_select()

Pop-up a pick-list of open workarea aliases

Syntax:

Arguments:

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

   

Returns:

    A numeric value which is the work area of the database selected.
   

   

Description:

Source/Library:

See Also:

dc_setarray()

Returns an array with complete SET environment information

Syntax:

Arguments:

    NONE
   

   

Returns:

    A 2-dimensional parallel array with subarray 1 containing the
   
 mnenomic identifier and subarray 2 containing the value of the
   
 environment variable.  The first 38 elements are the Clipper
   
 environment and the remaining elements are the dCLIP environment.
   

   
 For example element [1,1] will return 'EXACT' and [2,1] will
   
 return the logical value for SET EXACT.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 aSet := DC_SETARRAY()
   
 ? aSet[1,1]
   
 EXACT
   
 ? aSet[2,1]
   
 .F.
   
 ? aSet[1,39]
   
 RDD
   
 ? aSet[2,39]
   
 DBFNTX
   

   
 -- Example 2 --
   

   
 // write the contents of the environment to a file
   
 nHandle := fcreate( 'ENVIR.SET' )
   
 aSet := DC_SETARRAY()
   
 for i := 1 to len( aSet[1] )
   
   fwrite( nHandle, pad(aSet[1,i],15) + transform( aSet[2,i], '@' ) )
   
 next
   
 fclose( nHandle )
   

   

Source/Library:

See Also:

dc_setdclip()

Set the directory to use for dCLIP data-dictionary files

Syntax:

Arguments:

    (cPathSpec) is any valid directory which may also include a
   
 drive letter.  If no parameter is passed, then the value will
   
 not be changed.
   

   

Returns:

    A character string.
   

   

Description:

Source/Library:

See Also:

dc_setdefault()

Set the DEFAULT directory the right way

Syntax:

Arguments:

    (cPath) is the name of the directory.
   

   

Returns:

    The new DEFAULT setting.
   

   

Description:

Examples:

    #include 'set.ch'
   
 DC_DEFAULT('\DCLIP3\DATA')
   
 ? SET(_SET_DEFAULT)
   
 \DCLIP3\DATA\
   

   

Source/Library:

See Also:

dc_setedit()

Edit the SET environment from a pick-list menu

Syntax:

Arguments:

    (cSetName) is the SET environment variable you want to display
   
 as the initial item in the display.  If this argument is not
   
 passed, then the start of the display will be the first
   
 variable.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    -- Example 1 --
   

   
 DC_SETEDIT( "DEFAULT" )
   

   
 -- Example 2 --
   

   
 DC_SETEDIT()
   

   

Source/Library:

See Also:

dc_setfilter()

Set a filter from a Query-by-example-style condition builder

Syntax:

Arguments:

    (cFilter) is a string containing the existing filter condition
   
 to build upon.  If a null ("") string or no argument is passed
   
 then the query builder will start with a blank slate.
   

   

   

Returns:

    A Logical .TRUE. if the filter was set, .FALSE. otherwise.
   

   

Description:

Examples:

    use baseball
   
 set filt to league='NL'
   
 DC_SETFILTER( DbFilter() )
   

   

Source/Library:

See Also:

dc_setindex()

Pop up picklist of available indexes if index file not found

Syntax:

Arguments:

    (cFileName) is the name or wildcard of the index file to open.
   
 If a full file name is passed, then DC_SETINDEX() will attempt
   
 to open (cFileName).  If the file cannot be found, then the
   
 pick-list will appear.  If no argument is passed then a pick-
   
 list of all index files that match the designated RDD will
   
 appear. If a wildcard argument is passed, then all files that
   
 match the wildcard will appear in the pick-list.
   

   

   
 (lOpenFile) if .TRUE. (default) will open the index, otherwise
   
 the index will not be opened but the filename will be returned
   
 if the index exists.
   

   

   

Returns:

    A character string containing the name of the file used.
   

   

Description:

Examples:

    cFileName := space(50)
   
 @ 10,10 say ;
   
   "enter an index to open (leave empty for pick-list)" ;
   
   get cFileName
   
 read
   
 DC_SETINDEX( cFileName )
   

   

   

Source/Library:

See Also:

dc_setkeyrestore()

Restore a "group" of keys that were save with DC_SETKEYSAVE()

Syntax:

Arguments:

    (aKeyNumbers) is an array of INKEY() numbers for the keys
   
 to set.
   

   
 (bBlock) is the code block to evaluate when any of the
   
 keys are pressed.  The array of keys will be reset if this
   
 is a NIL.
   

   

   

Returns:

    Nil
   

Description:

Examples:

    local aKeys := { -2, -3, -4, -5, -6, -7 }
   
 local aSaveKeys := dc_setkeysave( aKeys, {||myProc()} )
   
 * Do something
   
 DC_SETKEYRESTORE( aSaveKeys )
   
 return
   

   

   

Source/Library:

See Also:

dc_setkeysave()

Set a "group" of keys to call the same function/procedure

Syntax:

Arguments:

    (aKeyNumbers) is an array of INKEY() numbers for the keys
   
 to set.
   

   
 (bBlock) is the code block to evaluate when any of the
   
 keys are pressed.  The array of keys will be reset if this
   
 is a NIL.
   

   

   

Returns:

    An array of keys that is used by DC_SETKEYRESTORE() to restore
   
 the keys to their original value.
   

   

   

Description:

Examples:

    local aKeys := { -2, -3, -4, -5, -6, -7 }
   
 local aSaveKeys := DC_SETKEYSAVE( aKeys, {||myProc()} )
   
 * Do something
   
 dc_setkeyrestore( aSaveKeys )
   
 return
   

   

   

Source/Library:

See Also:

dc_setoptions()

Set indexing options before building a .IDX/.CDX index

Syntax:

Arguments:

    (lIsCDX)      = .T. if index is a .CDX, .F. if not
   
 (cCDXName)    = Name of the .CDX to create or add to
   
 (cCondition)  = String containing filter expression
   
 (lDescend)    = .T. if index is descending, .F. if not
   
 (bOption)     = Code block to execute as OPTION
   
 (nStep)       = Number of records to process before each call
   
                 to OPTION block
   
 (lUseCurrent) = .T. if index is to be based on current index,
   
                 .F. if not.
   
 (lEmpty)      = .T. if empty index is to be created.
   

   

Returns:

    A logical .T.
   

   

Description:

Source/Library:

See Also:

dc_setp()

Send a code sequence to the printer from a pseudo-code

Syntax:

Arguments:

    (cPtrCode)   = A string of characters which include the
   
                list of code sequences to send to the
   
                printer.  See table below.
   

   
 (lSetPath)   = .t. - Set printer path to path designated
   
                      in tagged printer record. (default).
   
                .f. - Do not change printer path.
   

   
 (lCloseFile) = .t. - Close DCPRINT.DBF datafile after
   
                      sending codes. (default).
   
                .f. - Leave file open after sending codes.
   

   
 (lPrintOff)  = .f. - Issue SET PRINT ON before sending
   
                      codes and SET PRINT OFF after sending
   
                      codes. (default)
   
                .t. - Don't change print environment.
   

   
 (lReturnCodes) = .f. - Send codes to printer.
   
                  .t. - Return codes as a string.
   

   
 (cPtrCode) options:
   

   
 Code   Description
   
 -----  ------------------------------------------------
   
   F    FORM FEED - Page eject.
   
   P    PICA.  10 Characters per inch.
   
   E    ELITE.  12 Characters per inch.
   
   C    COMPRESSED.  17 Characters per inch.
   
   Q    QUALITY.  Letter Quality mode
   
   N    NORMAL.  Data Processing Character Mode
   
   D    DOUBLE WIDE ON - Elongated characters
   
   S    SET DOUBLE WIDE OFF - Elongated characters off
   
   M    MARGINS ON - Set left and right margins
   
   O    OFF MARGINS - Turn off left and right margins
   
   A    Set UNDERLINE ON
   
   B    Set UNDERLINE OFF
   
   G    Set BOLD ON
   
   H    Set BOLD OFF
   
   U    6 Lines Per Inch
   
   V    8 Lines Per Inch
   
   X    Set ITALICIZED ON
   
   Y    Set ITALICIZED OFF
   
   I    INITIALIZE - Printer initialization code sequence
   
   R    RESET - Printer reset to default settings sequence
   
   J    Send START SPOOL COMMAND to DOS
   
   K    Send END SPOOL COMMAND to DOS
   

   
  0-9   User-defined psuedo-codes
   

   

Returns:

    A character string.
   

   

Description:

Notes:

Examples:

    // select a printer driver
   
 nPrinter := dc_printsel()
   
 // Send the escape sequence for Compressed/8 lines per inch
   
 DC_SETP( 'CU', , , , .F. )
   
 report form customer to print
   

   

Source/Library:

See Also:

dc_setrdd()

Return the RDD name of an open data file

Syntax:

Arguments:

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

   

Returns:

    A character string with the name of the RDD being used.  If no
   
 database in opened in the specified work area, then the current
   
 system RDD is returned.
   

   

Description:

Examples:

    select 1
   
 use customer via 'DBFNTX'
   
 ? DC_SETRDD()
   
 DBFNTX
   
 select 2
   
 use sales via 'DBFSIX'
   
 ? DC_SETRDD()
   
 DBFSIX
   
 select 3
   
 use cust_bor via 'PDX'
   
 ? DC_SETRDD()
   
 PDX
   
 select 0
   
 ? DC_SETRDD()
   
 DBFNTX
   

   

Source/Library:

See Also:

dc_setrestore()

Restore all Clipper/dCLIP SETs from a file or array

Syntax:

Arguments:

    The SET environment can be restored either from an array or
   
 file depending on the type of argument passed.
   

   
 (cFileName) is the name of a SET file that was saved by
   
 DC_SETSAVE( (cFileName ).  If no extension is included, then
   
 .DCA is assumed.
   

   
 (aSets) is an array that was created by DC_SETSAVE().
   

   

Returns:

    A logical .TRUE. if the SET environment was properly restored.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 aSaveSet := dc_setsave()
   
 set default to \customer\data
   
 set path to \myreport
   
 set printfile to print.txt
   
 use customer
   
 report form custlist
   
 DC_SETRESTORE( aSetSave )
   

   
 -- Example 2 --
   

   
 dc_setsave( 'MYSET' )
   
 set odir to \myapps\obj
   
 set pdir to \myapps\prg
   
 dc_turbedit()
   
 DC_SETRESTORE( 'MYSET' )
   

   

   

Source/Library:

dc_setsave()

Save all Clipper/dCLIP SETs to a file or array

Syntax:

Arguments:

    (cFileName) is the name of the file to save the SET to.  If no
   
 extension is included, then .DCA is assumed.
   

   

Returns:

    An array that contains the contents of the SET environment.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 aSaveSet := DC_SETSAVE()
   
 set default to \customer\data
   
 set path to \myreport
   
 set printfile to print.txt
   
 use customer
   
 report form custlist
   
 dc_setrestore( aSetSave )
   

   
 -- Example 2 --
   

   
 DC_SETSAVE( 'MYSET' )
   
 set odir to \myapps\obj
   
 set pdir to \myapps\prg
   
 dc_turbedit()
   
 dc_setrestore( 'MYSET' )
   

   

   

Source/Library:

See Also:

dc_setscope()

Set a scoping value for the current work area

Syntax:

Arguments:

    (nWhich) is a number 0 if setting the SCOPE TOP value or a
   
 number 1 if setting the SCOPE BOTTOM value.
   

   
 (xValue) is the value to set.  This should be a value that
   
 matches the current index key.  If (xValue) is a NIL then
   
 the current setting will be returned.
   

   

Returns:

    The current SCOPE value.
   

   

Description:

Notes:

Examples:

    use customer
   
 set index to custname
   
 DC_SETSCOPE(0,"HARRIS")
   
 DC_SETSCOPE(1,"HYBRID")
   
 dc_browsedb()
   

   

Source/Library:

See Also:

dc_setstep()

Start or stop source-level debugging mode

Syntax:

Arguments:

    (lStepMode) if .TRUE. will start displaying source code on the
   
 first line of code (compiled with debug information) that is
   
 executed. If .FALSE., then step mode will be terminated.
   

   

Returns:

   A logical value equivalent to the current setting of step mode.
   

   

Description:

Examples:

    do while .t.
   
   DC_SETSTEP(.t.)  // step through MAINMENU()
   
   code := mainmenu()
   
   DC_SETSTEP(.f.)  // set step mode off
   
   do case
   
     case code = 'A'
   
      menu_a()
   
     case code = 'B'
   
       menu_b()
   
     case code = 'C'
   
       menu_c()
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_sett()

Set or Read an environment variable via an identifier

Syntax:

Arguments:

    (cSetName) is the identifier code for the SET environment
   
 variable.  See the table below.
   

   
 (xValue) is the value to assign to the designated variable.
   

   
 (nSetNmbr) is an optional parameter to designate the desired
   
 variable by numeric representation rather than mnemonic
   
 character representation.  If this argument is passed, then
   
 (cSetName) is ignored and is not required.
   

   
 Clipper Environment Variables
   
 (cSetNmbr)   (cSetName)
   
 ----------  -------------
   
     1        EXACT
   
     2        FIXED
   
     3        DECIMALS
   
     4        DATEFORMAT
   
     5        EPOCH
   
     6        PATH
   
     7        DEFAULT
   
     8        EXCLUSIVE
   
     9        SOFTSEEK
   
    10        UNIQUE
   
    11        DELETED
   
    12        CANCEL
   
    13        DEBUG
   
    14        TYPEAHEAD
   
    15        COLOR
   
    16        CURSOR
   
    17        CONSOLE
   
    18        ALTERNATE
   
    19        ALTFILE
   
    20        DEVICE
   
    21        EXTRA
   
    22        EXTRAFILE
   
    23        PRINTER
   
    24        PRINTFILE
   
    25        MARGIN
   
    26        BELL
   
    27        CONFIRM
   
    28        ESCAPE
   
    29        INSERT
   
    30        EXIT
   
    31        INTENSITY
   
    32        SCOREBOARD
   
    33        DELIMITERS
   
    34        DELIMCHARS
   
    35        WRAP
   
    36        MESSAGE
   
    37        MCENTER
   
    38        SCROLLBREAK
   

   
 dCLIP Environment Variables
   
 (cSetNmbr)   (cSetName)
   
 ----------  -------------
   
    39        RDD
   
    40        ODIR
   
    41        PDIR
   
    42        STEP
   
    43        PROFILE
   
    44        TRACE
   
    45        PROMPT
   
    46        PROMPTTYPE
   
    47        SWAP
   
    48        CLIPOPT
   
    49        CLIPPATH
   
    50        CLOAK
   
    51        PEXT
   
    52        TALK
   
    53        STATUS
   
    54        CANCEL
   
    55        RESET
   
    56        REEDIT
   
    57        MAXROWS
   
    58        FLDKEY
   
    59        CHRKEY
   
    60        QUERYKEY
   
    61        INDEXKEY
   
    62        STEPKEY
   
    63        SPLIT
   
    64        FLUSH
   
    65        ECHO
   
    66        PUBLIC
   
    67        AUTOLOCK
   
    68        SLASH
   

   

Returns:

    The value of the designated environment variable.
   

   

Description:

Examples:

    ? DC_SETT( 'PDIR' )
   
 F:\DCLIP3\PRG
   

   
 ? DC_SETT( 'DEVICE' )
   
 .F.
   

   
 ? DC_SETT( 'DEFAULT' )
   
 \CUSTOMER\DATA\
   

   

Source/Library:

See Also:

dc_sort()

Pop-up a user-promt menu for creating a database sort

Syntax:

Arguments:

    NONE
   

   

Returns:

    A logical .TRUE. if the sort process is completed without any
   
 errors or user abort.
   

   

Description:

Examples:

    @ 11,10 prompt "Delete Records"
   
 @ 12,10 prompt "Recall Records"
   
 @ 13,10 prompt "Sort Records"
   
 menu to nChoice
   
 do case
   
   case nChoice = 1
   
     dc_append()
   
   case nChoice = 2
   
     dc_delete()
   
   case nChoice = 3
   
     DC_SORT()
   
 endcase
   

   

Source/Library:

See Also:

dc_startscrn()

Save the startup screen

Syntax:

Arguments:

    (lRestore) if .TRUE. will restore the startup screen.
   
 If .FALSE. (default) then the current screen will
   
 be saved.
   

   

   

Returns:

    Nil
   

   

Description:

Examples:

    DC_STARTSCRN()    // save the screen at start-up.
   
 DC_STARTSCRN(.t.) // Restore the screen before Quitting.
   

   

Source/Library:

See Also:

dc_statline()

Display a 3-bar status line of work area information

Syntax:

Arguments:

    (nStrow) is the start display row of the 3-line status line.
   

   
 (nMode) - 0 will leave the status on the screen, 1 will display
   
 the status and an operator prompt to "press any key".  After a
   
 key is pressed, the screen will be restored.
   

   

   

Description:

Examples:

    do while .t.
   
   cls
   
   DC_STATLINE(0,0)
   
   @ 11,10 prompt "Open a database"
   
   @ 12,10 prompt "Open an index"
   
   @ 13,10 prompt "Database Utilities"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       dc_dbfopen()
   
     case nChoice = 2
   
       dc_ntxopen()
   
     case nChoice = 3
   
       dc_util()
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_status()

Display or print status of all work areas and environment

Syntax:

Arguments:

    (cFileName) is an optional name of a file to write the status.
   

   
 (lAppend) if .TRUE. will append the status to end of
   
 (cFileName) otherwise the file will be overwritten.
   

   
 (lWindow) if .TRUE. (default) will display the status in a
   
 window and the user can scroll up or down through the window to
   
 observe any portion of the status.  The display will be
   
 restored upon exiting the windoe.  If .FALSE. the status will
   
 scroll up   the display and the user will be prompted to press
   
 a key for each new screen.
   

   
 (lWorkAreas) if .TRUE. will display only the status of the work
   
 areas.  If .FALSE. (default) the status of the 38 Clipper SET
   
 environment variables and 30 dCLIP environment variables will
   
 also be displayed.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    do while .t.
   
   cls
   
   @ 11,10 prompt "Open a database"
   
   @ 12,10 prompt "Open an index"
   
   @ 13,10 prompt "Database Utilities"
   
   @ 14,10 prompt "Display Status"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       dc_dbfopen()
   
     case nChoice = 2
   
       dc_ntxopen()
   
     case nChoice = 3
   
       dc_util()
   
     case nChoice = 4
   
       DC_STATUS()
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_statwin()

Display a user-configurable window of work area information

Syntax:

Arguments:

    (aStat) is a 2 - dimensional array which is used to configure
   
 the status box.    Subarray 1 consists of 4 numeric elements
   
 which are the screen coordinates to display the window.
   
 Subarray 2 is simply an array of numbers defining the
   
 information and order you wish to display the status in the
   
 window based on the following table:
   

   
   1         Work area
   
   2         Alias
   
   3         Data Driver
   
   4         Database file name
   
   5         Record Pointer
   
   6         Database filter expression
   
   7         Index File name
   
   8         Currently selected tag
   
   9         Current index key
   
  10         Index filter expression
   
  11         Index Key number
   
  12         *Deleted*
   
  13         *Exclusive*/*Shared*
   
  14         *ReadOnly*/*Read/Write*
   
  15         *Relation*
   
  16         *Unique*
   
  17         *Descending*
   

   
 For example if you wish to display only the Database file
   
 name, Index file name, and Index filter expression, then sub-
   
 array 2 would look like this:
   

   
  { 4, 7, 10 }
   

   
 (nMode) = 0 - will display and leave the status on the screen
   
           1 - will display the status and an operator prompt
   
               to "press any key".  After a key is pressed,
   
               the screen will be restored.
   
           2 - will store the (aStat) parameters to a STATIC
   
               array so DC_STATWIN() can be recalled with no
   
               parameters and display the same configuration
   
               each time.
   

   

Description:

Examples:

    // load STATIC array with configuration
   
 DC_STATWIN( { {10,20,16,50}, {2,3,4,5,6} }, 2 )
   
 // Assign key F2 to display status
   
 setkey( -1, {||DC_STATWIN()} )
   

   

Source/Library:

See Also:

dc_step()

Load or clear an expression / procedure into the Step table

Syntax:

Arguments:

    (cExpression) is an expression or procedure/function name in a
   
 character string.  If an expression is passed, then the
   
 expression will be evaluated after each line of code (compiled
   
 with /b switch) is executed. If the expression evaluates .TRUE.
   
 then the program execution will stop and the source code will
   
 be displayed on the current line. If (cExpression) is a
   
 procedure or function name ( no parenthesis ), then the program
   
 execution will stop when line (nNumber) of procedure
   
 (cExpression) is executed.
   

   
 (nNumber) can refer to either the line number of a specified
   
 procedure to start step mode, or the position of an expression
   
 in the step table to clear (remove) when using the (lClear)
   
 option.
   

   
 (lClear) if .TRUE. will clear (remove) a specified expression
   
 from the step table.  If (nNumber) is 0, then ALL step
   
 expressions will be cleared.
   

   
 (lStepOnly) if .TRUE. will step ONLY the procedure specified in
   
 (cExpression) and bypass all other procedures.
   

   
 (lStepAnd) if .TRUE. will start step mode only when ALL
   
 expressions in the step table evaluate .TRUE., otherwise only
   
 one of the expressions must evaluate .TRUE. to start step mode.
   

   

Returns:

    nil
   

   

Description:

Examples:

    // - start step mode if CUSTOMER.DBF is opened or key F2 is
   
 // - pressed
   
 // - this example adds 2 expressions to the step table
   
 DC_STEP( 'ALIAS() = "CUSTOMER"' )
   
 DC_STEP( 'LASTKEY() = -1' )
   

   
 // - start step mode on first line of function MYFUNC()
   
 DC_STEP( 'MYFUNC' )
   

   
 // - start step mode on line 123 of MYPROC()
   
 DC_STEP( 'MYPROC', 123 )
   

   
 // - clear step expression 2 from step table
   
 DC_STEP( , 2, .t. )
   

   
 // - clear all expressions from step table
   
 DC_STEP( , 0, .t. )
   

   
 // - step only through procedure GRAPH()
   
 DC_STEP( 'GRAPH', , , .t. )
   

   
 // - start step mode only if all expressions in table evaluate
   
 // - .True.
   
 DC_STEP( , , , , .t. )
   

   
 // - start step mode if any expression in table evaluates
   
 // - .True.
   
 DC_STEP( , , , , .f. )
   

   

   

Source/Library:

See Also:

dc_str2ar()

Convert a character string array to a multidimensional array

Syntax:

Arguments:

    (cArray) is any character string containing the contents of
   
 a multidimensional array saved with DC_AR2STR().
   

   

Returns:

    A character string.
   

   

Description:

Examples:

    aDir := Directory()
   
 USE dirs
   
 REPLACE directory WITH DC_ar2str( aDir )
   
 aDir := DC_STR2AR( directory )
   

   

   

   

   

   

Source/Library:

See Also:

dc_strudbf()

Copy structure of a file to a dCLIP Structure extended file

Syntax:

Arguments:

    (cFileName) is the name of the structure extended database to
   
 create.  If no argument is given then NEW_STRU.DBF is default.
   

   

Returns:

    NIL
   

   

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:

See Also:

dc_struupdate()

Update the structure of the current database

Syntax:

Arguments:

    (aStructure) is a multi-dimensional array with one sub-array
   
 for each database field.  This may be a standard Clipper
   
 structure array or an enhanced array with information about
   
 previous field type(s) and field name(s).
   

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

   
 (cNewFileName) is the name of the new file to create.  If
   
 parameter is not passed, then the new file will be given the
   
 same name as the old file.
   

   
 (lChangedType) if .TRUE. will use a "slower" method of update
   
 to insure that data is properly restored.  Pass this flag if
   
 the type of one or more fields has changed and the array
   
 does not contain the old information (element 5).
   

   
 (lChangedName) if .TRUE. will use a "slower" method of update
   
 to insure that data is properly restored.  Pass this flag if
   
 the name of one or more fields has changed and the array
   
 does not contain the old information (element 6).
   

   
 (lPrompt) if .TRUE. (default) will prompt the user with the
   
 option of erasing the backup file(s) after the structure
   
 update.  If .FALSE. the backup files will not be erased and
   
 the user will not be prompted.
   

   

   

   

   

Returns:

    A logical .TRUE. if structure is updated. .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_isstru( aStru )
   
   DC_STRUUPDATE( aStru )
   
 endif
   

   

Source/Library:

See Also:

dc_strwrap()

Convert a string to a text array and specify line length

Syntax:

Arguments:

    (cString) is a character string.
   

   
 (nLength) is the length of each line in the output array.
   

   

Returns:

    An array of strings that contains the original (cString)
   
 information formatted to the length of (nLength).
   

   

Description:

Examples:

    . cString := 'The quick red fox jumped over the lazy dog.'
   
 aText := DC_STRWRAP( cString, 10 )
   
 for i := 1 to len(aText)
   
  ? aText[i]
   
 next
   

   
 The quick
   
 red fox
   
 jumped
   
 over the
   
 lazy dog.
   

   

Source/Library:

dc_sum()

Pop-up a user-prompt menu for summing selected fields

Syntax:

Arguments:

    NONE
   

   

Returns:

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

   

Description:

Examples:

    . use invoice
   
 . use invitems new
   
 . set relation to inv_nmbr into invoice
   
 . DC_SUM()
   

   

Source/Library:

See Also:

dc_superrdd()

Return and/or set the SUPER RDD name

Syntax:

Arguments:

    (cRddName) is the name of the RDD to use as the SUPER RDD.
   

   

Returns:

    The name of the currently selected Super Rdd.
   

   

Description:

Examples:

    // set the Super Rdd to COMIX
   
 DC_SUPERRDD( 'DBFCMX' )
   

   
 USE sales VIA FLEXFILE
   

   

Source/Library:

See Also:

dc_tablename()

Return the Database file name of a Work Area

Syntax:

Arguments:

    (nArea) is the work area.  If no parameter is passed
   
 then the currently selected work area will be used.
   

   
 (cFileName) is the file name to store into the
   
 table array.  This parameter should not be passed if
   
 the table name for the work area is being queried.
   

   
 @(aTables) is the name of an array to store the names of
   
 all databases that have been opened via the DC_USEAREA()
   
 function.  Each element is a character string containing
   
 the following information:
   

   
   Chars 1-3 : Work Area
   
  Chars 5-14 : Alias
   
 Chars 16-up : Database name
   

   

   

Returns:

    A character string containing the name of the database
   
 opened in the selected workarea.
   

   

   

Description:

Examples:

    set defa to C:\MYAPPS\DATA
   
 select(10)
   
 DC_UseArea( .f., "DBFCDX", "CUSTOMER" )
   
 ? DC_TABLENAME()
   
 C:\MYAPPS\DATA\CUSTOMER.DBF
   

   

Source/Library:

See Also:

dc_tagallcreate()

Create index tags for all fields in database

Syntax:

Arguments:

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

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

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

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

   

Returns:

    A logical .TRUE. if the index is successfully created, .FALSE.
   
 otherwise.
   

   

Description:

Examples:

    use maillist via 'DBFMDX'
   
 DC_TAGALLCREATE('MAILLIST.MDX', ;
   
                 {"LAST", "COMPANY", "SOURCE"} )
   
 dc_hunt( 'SCOTT' )
   

   

Source/Library:

dc_tagcreate()

Create new index Tag and add to the open combined index file

Syntax:

Arguments:

    NONE
   

   

Returns:

    A logical .TRUE. if the index tag is successfully created,
   
 .FALSE. otherwise.
   

   

Description:

Examples:

    do while lastkey()#27
   
   cls
   
   @ 10,10 prompt "create a database"
   
   @ 11,10 prompt "create an index tag"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       dc_crdata()
   
     case nChoice = 2
   
       DC_TAGCREATE()
   
   endcase
   
 enddo
   

   

Source/Library:

dc_tagdelete()

Delete an index Tag from a pick-list of available tags

Syntax:

Arguments:

    NONE
   

   

Description:

Examples:

    do while lastkey()#27
   
   cls
   
   @ 10,10 prompt "create a database"
   
   @ 11,10 prompt "create an index tag"
   
   @ 12,10 prompt 'delete an index tag"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       dc_crdata()
   
     case nChoice = 2
   
       dc_tagcreate()
   
     case nChoice = 3
   
       DC_TAGDELETE()
   
   endcase
   
 enddo
   

   

Source/Library:

dc_tagged()

Determine whether or not the current record is tagged

Syntax:

Arguments:

    (aTags) is an existing array of record numbers which will
   
 display the TAG marker in the browse display.  If no
   
 argument is given then the public DCTAGS array will be
   
 used.
   

   

Returns:

    A pointer to an array of tagged numbers.
   

   

Description:

Examples:

     . select customer
   
  . dc_rectagclear()
   
  . go 113
   
  . ? DC_TAGGED()
   
 .F.
   
  . dc_rectag(.f.)
   
  . ? DC_TAGGED()
   
 .T.
   
  . dc_rectag(.t.)
   
  . ? DC_TAGGED()
   
 .F.
   
  . dc_rectag(.f.,,{||balance)0})
   
  . dc_rectag(.f.,,{||zip='92001'})
   
  . dc_rectag(.t.,,{||balance(1000})
   
  . count for DC_TAGGED()
   
  . label form customer for DC_TAGGED() to print
   

   

Source/Library:

See Also:

dc_taginfo()

Return an array of information about tags in a combined index

Syntax:

Arguments:

   NONE
   

   

Returns:

    A multi-dimensional array with 1 subarray for each index
   
 tag.  Each sub-array contains the following information:
   

   
 Element  Type   Description
   
 ------- ------ ---------------------
   
  [1]      C     Tag Name
   
  [2]      C     Index Key Expression
   
  [3]      C     Index Condition Expression
   
  [4]      L     Is it a Unique Index?
   
  [5]      L     Is it a Descending Index?
   
  [6]      L     Is it a Roll your own index?
   

   

Description:

Source/Library:

dc_tagname()

Return the name of an index tag from a controlling order

Syntax:

Arguments:

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

   

   

Returns:

    A character string.
   

   

Description:

Examples:

    // list all the tags in a combined index
   
 local i, cTag
   
 use sales via 'DBFSIX' index sales.cdx
   
 for i := 1 to 99
   
   cTag := DC_TAGNAME( i )
   
   if empty(cTag)
   
     exit
   
   endif
   
   ? cTag
   
 next
   

   

Source/Library:

dc_tagrestore()

Rebuild all Tags in a combined index from a Tag (.DCT) file

Syntax:

Arguments:

    (cFileName) is the name of the combined index to restore.  If
   
 no argument is given then it is assumed that the currently
   
 selected index is to be restored.  (cFileName) must be the same
   
 name as the index to restore except it will have the .DCT
   
 extension.
   

   

Returns:

    A numeric value.
   

   
 0 - Index tags were successfully created.
   
 1 - No index file name was passed.
   
 2 - The current database driver does not support combined
   
     indexes.
   
 3 - The .DCT tag information file could not be found or
   
     contains invalid information.
   

   

Description:

Examples:

    use customer via 'DBFSIX'
   
 index on cust_name tag custname of customer
   
 index on cust_nmbr tag custnmbr of customer
   
 index on recno() tag 714 of customer for area = '714'
   
 index on recno() tag 619 of customer for area = '619'
   
 dc_savetags()
   
 set index to
   
 erase customer.cdx
   
 DC_RESTORETAGS()
   

   

Source/Library:

See Also:

dc_tagsave()

Save information about all tags to a Tag (.DCT) file

Syntax:

Arguments:

    (cFileName) is the name of the file to create.  If no argument
   
 is given then the file name is the same as the selected index
   
 file information to be saved, except with the .DCT extension.
   

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

   

Description:

Examples:

    use customer via 'DBFSIX'
   
 index on cust_name tag custname of customer
   
 index on cust_nmbr tag custnmbr of customer
   
 index on recno() tag 714 of customer for area = '714'
   
 index on recno() tag 619 of customer for area = '619'
   
 DC_SAVETAGS()
   
 set index to
   
 erase customer.cdx
   
 dc_restoretags()
   

   

Source/Library:

See Also:

dc_tagsel()

Select an index Tag from a pick-list of available tags

Syntax:

Arguments:

    (nOrder) is the index order.  If no argument is given then the
   
 tags for the currently selected index will be displayed.
   

   

Description:

Examples:

    do while lastkey()#27
   
   cls
   
   @ 10,10 prompt "open a database"
   
   @ 11,10 prompt "open an index file"
   
   @ 12,10 prompt "select an index tag"
   
   @ 13,10 prompt "browse database"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       dc_dbfopen()
   
     case nChoice = 2
   
       dc_ntxopen()
   
     case nChoice = 3
   
       DC_TAGSEL()
   
     case nChoice = 4
   
       dc_browsedb()
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_tbinkey()

A special version of INKEY() for adding mouse to Tbrowse system

Syntax:

Arguments:

    (oObject) is the name of the Tbrowse object to mouse.
   

   
 (nDelay) is the amount of seconds to wait for a key click or
   
 mouse click.  If zero, then wait forever.
   

   
 (aButtons) is an optional multi-dimensional array of mouse-
   
 buttons that must meet the criteria specified for the
   
 DC_MOUSEKEY() function.  If the mouse is clicked within a
   
 specified region the value returned by will be the key value
   
 passed in the array.
   

   
 (aNavigate) is an optional multi-dimensional array of mouse-
   
 button coordinates to be used for navigation.  There are a
   
 total of 10 sub-arrays required, each with 4 numeric elements
   
 designating the coordinates on the screen.  If the mouse is
   
 clicked within the specified coordinates, then the activity
   
 will be performed.
   

   
 Subarray  Description                         Default
   
 --------  -----------                         ------------
   
    1      Pan Left  (same as K_CTRL_LEFT)     o:nLeft-1
   
    2      Pan Right (same as K_CTRL_RIGHT)    o:nRight+1
   
    3      Move up one Row (same as K_UP)      o:nTop+1
   
    4      Move down one Row (same as K_DOWN)  o:nBottom-1
   
    5      Page Up (same as K_PGUP)            o:nTop
   
    6      Page Down (same as K_PGDN)          o:nBottom
   
    7      Pan Home (same as K_CTRL_HOME)      Col 0
   
    8      Pan End (same as K_CTRL_END)        Col 79
   
    9      Top (same as K_CTRL_PGUP)           Row 0
   
   10      Bottom (same as K_CTRL_PGDN)        MaxRow()
   

   
 If no array is passed, then the coordinates for the above
   
 functions will be equivalent to the default values.
   

   
 Note:  Due to Tbrowse limitations, DC_TBINKEY() calculates
   
 the active area of the screen by scanning the columns in
   
 the object to determine the number of heading and footing
   
 rows.  This can slow down operation, therefore, to regain
   
 speed it is recommended that you pass two parameters:
   

   
 (nStartRow) - Starting data row (screen row)
   
 (nEndRow)   - Ending data row (screen row)
   

   

   

Returns:

    A numeric value equivalent to one of the following:
   

   
  a.  -101 if the mouse is clicked within the navigation region.
   

   
  b.  The INKEY value of any key pressed.
   

   
  c.  The value in (aButtons), element #5 if the mouse is
   
      clicked in an (aButtons) region.
   

   

Description:

Examples:

    // Start of Tbrowse Key Check routine
   
 do while lastkey()#27
   
   do while !b:stabilize()
   
   enddo
   
   k := DC_TBINKEY(b,0,,,5,22)
   
   do case
   
     case k=K_DOWN
   
       b:down()
   
     case k=K_UP
   
       b:up()
   
     case k=K_PGDN
   
       b:pagedown()
   
     case k=K_PGUP
   
       b:pageup()
   
     case k=K_CTRL_PGUP
   
       b:gotop()
   
     case k=K_CTRL_PGDN
   
       b:gobottom()
   
     case k=K_RIGHT
   
       b:right()
   
     case k=K_LEFT
   
       b:left()
   
     case k=K_HOME
   
       b:home()
   
     case k=K_END
   
       b:end()
   
     case k=K_CTRL_LEFT
   
       b:panleft()
   
     case k=K_CTRL_RIGHT
   
       b:panright()
   
     case k=K_CTRL_HOME
   
       b:panhome()
   
     case k=K_CTRL_END
   
       b:panend()
   
   endcase
   
 enddo
   

   

   

Source/Library:

See Also:

dc_textbrow()

Browse large text files

Syntax:

Arguments:

    (cFileName) is the text file to browse.
   

   

Returns:

    Nil.
   

   

Description:

Examples:

    DC_TEXTBROW('DCLIP.LOG')
   

Source/Library:

See Also:

dc_textmerge()

Merge text with data

Syntax:

Arguments:

    (cMemoText) is the text that is to be merged with the data.
   
 Data that is to be merged into the text is handled by a set
   
 of TAGS that are defined at the top of the text.  Each tag
   
 is a single letter defined as follows:
   

   
 ((A)) (expression)
   

   
 When a matching tag in the text is encountered, the area of
   
 the text defined by the tag is replaced by the contents of
   
 the expression previously defined for each tag.
   

   

   

Returns:

    A character string.
   

   

Description:

Examples:

    -- Example of LETTER.TXT --
   

   
 ((A)) DM011-)pvrname
   
 ((B)) DM011-)pvrfname
   
 ((C)) DM011-)pvrlname
   
 ((D)) DM011-)addr1
   
 ((E)) DM011-)city
   
 ((F)) DM011-)state
   
 ((G)) DM011-)zipcode
   
 ((H)) DM011-)wkac1
   
 ((I)) DM011-)wkphone1
   
 ((J)) DM011-)faxac
   
 ((K)) DM011-)faxphone
   

   
 ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ
   
                     SERVING PEOPLE, SERVING PEOPLE
   
 ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ
   

   
 You have been listed among 160,000 behaviorial health service providers
   
 on the world wide web.  Your name (and organization) is now available
   
 to purchasers of behavioral health services and organizations creating
   
 provider networks for centralized triage processes.
   

   
 The accuracy of your listing is very important.  Please take this
   
 opportunity to review the listing and report any error by return fax.
   

   
         Current Listing                  Change To  (please print)
   

   
 (AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA)  _________________________________
   
 (BBBBBBBBBBBBBBBB) (CCCCCCCCCCCCCCC)  _______________ _________________
   
 (DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD)  _________________________________
   
 (EEEEEEEEEEEEEEEEEE) (FF) (GGGGGGGG)  __________________ ___ __________
   
 Voice  ((H)) (IIIIIIIIIIIIIIIIIIII)   (   ) ___________________________
   
   Fax  ((J)) (KKKKKKKKKKKKKKKKKKKK)   (   ) ___________________________
   

   

   
 -- Example of Merging LETTER.TXT with Data --
   

   
 cText := MemoRead('LETTER.TXT')
   
 USE DM011
   
 DO WHILE !Eof()
   
   DC_FaxAdd( ;
   
     nil, ;
   
     DM011-)faxphone,;
   
     nil,;
   
     nil,;
   
     'OURLOGO.BMP',;
   
     DC_TEXTMERGE(cMemo) )
   
   SKIP
   
 ENDDO
   

   

   

Source/Library:

See Also:

dc_token()

Extract a token from a string

Syntax:

Arguments:

    (cString) is a character string containing tokens.
   

   
 (cDelims) is a character string containing the delimeter(s)
   
 to use between tokens.  If no parameter is passed then the
   
 following default set of delimeters will be used:
   

   
  (SPACE)
   
   Š�,.;:!?/()#&%+-*
   
  (CHR(0))
   
  (CHR(9))
   
  (CHR(10))
   
  (CHR(13))
   
  (CHR(26))
   

   
 (nOccurence) is the number of the token to extract.
   

   

   

   

   

   

Returns:

    A character string.
   

   

Description:

Examples:

    cString := 'This is a test'
   
 ? DC_TOKEN( cString,,2 )
   
 is
   

   
 cString := 'AB|CD|EF|GHI|JKLM|NOP|QR|STUVW|XYZ'
   
 ? DC_TOKEN( cString,'|',5 )
   
 JKLM
   

   

   

Source/Library:

See Also:

dc_tokenarray()

Parse all tokens in a string to an Array

Syntax:

Arguments:

    (cString) is a character string containing tokens.
   

   
 (cDelims) is a character string containing the delimeter(s)
   
 to use between tokens.  If no parameter is passed then the
   
 following default set of delimeters will be used:
   

   
  (SPACE)
   
   Š�,.;:!?/()#&%+-*
   
  (CHR(0))
   
  (CHR(9))
   
  (CHR(10))
   
  (CHR(13))
   
  (CHR(26))
   

   

   

   

   

   

Returns:

    A array of character strings.
   

   

Description:

Examples:

    cString := 'AB|CD|EF|GHI|JKLM|NOP|QR|STUVW|XYZ'
   
 aTokens := DC_TOKENARRAY( cString,'|' )
   
 display array aTokens
   

   
 [1] C AB
   
 [2] C CD
   
 [3] C EF
   
 [4] C GHI
   
 [5] C JKLM
   
 [6] C NOP
   
 [7] C QR
   
 [8] C STUVW
   
 [9] C XYZ
   

   

Source/Library:

See Also:

dc_tokenjustify()

Perform text-justfication of tokens in a string

Syntax:

Arguments:

    (cString) is a character string containing tokens.
   

   
 (cDelims) is a character string containing the delimeter(s)
   
 to use between tokens.  If no parameter is passed then the
   
 following default set of delimeters will be used:
   

   
  (SPACE)
   
   Š�,.;:!?/()#&%+-*
   
  (CHR(0))
   
  (CHR(9))
   
  (CHR(10))
   
  (CHR(13))
   
  (CHR(26))
   

   
 (nWidth) is the final width of the resultant character
   
 string.
   

   
 (nType) is used to denote the type of justification to
   
 perform:
   

   
   0 - Center Justify to fit (nWidth) characters
   
   1 - Pad Right until (nWidth) characters
   
   2 - Left Justify. Pad right to (nWidth) characters
   
   3 - Pad Left until (nWidth) characters
   
   4 - Right Justify. Pad left to (nWidth) characters
   

   

   

   

   

Returns:

    A character string.
   

   

Description:

Examples:

    cString := 'This is a test'
   
 ? DC_TOKENJUSTIFY( cString,,50,0 )
   
 This            is             a            test
   

   

Source/Library:

See Also:

dc_tokennum()

Determine the number of tokens in a string

Syntax:

Arguments:

    (cString) is a character string containing tokens.
   

   
 (cDelims) is a character string containing the delimeter(s)
   
 to use between tokens.  If no parameter is passed then the
   
 following default set of delimeters will be used:
   

   
  (SPACE)
   
   Š�,.;:!?/()#&%+-*
   
  (CHR(0))
   
  (CHR(9))
   
  (CHR(10))
   
  (CHR(13))
   
  (CHR(26))
   

   

   

   

   

   

Returns:

    A numeric value.
   

   

Description:

Examples:

    cString := 'This is a test'
   
 ? DC_Token( cString,,2 )
   
 is
   
 ? DC_NUMTOKEN( cString )
   
 4
   

   
 cString := 'AB|CD|EF|GHI|JKLM|NOP|QR|STUVW|XYZ'
   
 ? DC_Token( cString,'|',5 )
   
 JKLM
   
 ? DC_NUMTOKEN( cString )
   
 9
   

   

   

   

Source/Library:

See Also:

dc_tone()

A front-end to Tone() that doesn't lock computer

Syntax:

Arguments:

    See Clipper 5.x Guides - TONE()
   

   

   

Returns:

    NIL
   

   

Description:

Source/Library:

dc_trace()

Activate trace mode to profile an application

Syntax:

Arguments:

    (lTraceOn) if .TRUE. will START tracing when (cTraceProc)
   
 evaluates .true.  (lTraceOn) if .FALSE. will STOP tracing when
   
 (cTraceProc) evaluates .true.
   

   
 (cTraceProc) is an expression or procedure name.  If
   
 (cTraceProc) is a procedure name, then tracing will start/stop
   
 when (nLineNmbr) of procedure (cTraceProc) is executed.  If
   
 (cTraceProc) is an expression, then tracing will start/stop
   
 when (cTraceProc) evaluates .true.
   

   
 (lTraceOnly) if .TRUE. will enable trace mode only when
   
 executing procedure (cTraceProc).  Tracing will be temporarily
   
 terminated when any procedure other than (cTraceProc) is
   
 executing.
   

   
 (lClear) will clear trace mode expessions.
   

   
 (nLineNmbr) is used only with (cTraceProc).  See description
   
 above.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    // start tracing at the next line of code
   
 DC_TRACE(.t.)
   
 // stop tracing at the next line of code
   
 DC_TRACE(.f.)
   

   
 // start tracing when F2 pressed
   
 DC_TRACE(.t.,'LASTKEY()=-1')
   
 // stop tracing when ESCape pressed
   
 DC_TRACE(.f.,'LASTKEY()=27')
   

   
 // start tracing at procedure GRAPH line 123
   
 DC_TRACE(.t.,'GRAPH',,,,123)
   
 // stop tracing at procedure BROWSE line 540
   
 DC_TRACE(.f.,'BROWSE',,,,540)
   

   
 // clear all trace expressions
   
 DC_TRACE(,,,,.t.)
   

   
 // trace only when executing procedure MYEDITOR
   
 DC_TRACE(,'MYEDITOR',.t.)
   

   

Source/Library:

dc_tracesize()

Set Maximum size of Trace File

Syntax:

Arguments:

    (nSize) is the maximum size of the Trace File (in Bytes).
   
 The default is 100000.
   

   

Returns:

    The previous trace file size setting.
   

   

Description:

Examples:

    DC_TRACESIZE(500000)
   

   

Source/Library:

See Also:

dc_tranarray()

Convert a function sequence from a string to an array

Syntax:

Arguments:

    (cFunction) is a character string of expressions separated by
   
 semicolons or carriage-return/line feed.
   

   

Returns:

    An array of character string expressions.
   

   

Description:

Examples:

    -- Example 1 -
   

   
 aFunctions := ;
   
    DC_TRANARRAY( 'CLS; CLOSE ALL; DISPLAY STATUS' )
   

   
 dc_disparray( aFunctions )
   

   
 [1] C  Scroll()
   
 [2] C  SetPos(0,0)
   
 [3] C  dbCloseAll()
   
 [4] C  select(1)
   
 [5] C  __SetFormat(NIL)
   
 [6] C  DC_STATUS(,.f.,.t.)
   

   
 -- Example 2 --
   

   
 // this example allows the user to enter a series of commands
   
 // in a memo and then translate and execute the commands.
   
 aCommands := hardcr(memoedit())
   
 aFunctions := DC_TRANARRAY( aCommands )
   
 for i := 1 to len(aFunctions)
   
   cMacro := aFunctions[i]
   
   xDummy := &cMacro
   
 next
   

   

   

Source/Library:

dc_trandefault()

Load Default Clipper .CH set(s)

Syntax:

Arguments:

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

   

Returns:

    A logical .TRUE. if the command set was successfully loaded,
   
 .FALSE. otherwise.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 . ? K_ESC
   
 Variable does not exist  Base[1003]
   

   
 . DC_TRANDEFAULT( "INKEY" )
   
 . ? K_ESC
   
 27
   

   

Source/Library:

See Also:

dc_translate()

Translate a command line to an array of functions

Syntax:

Arguments:

    (cCommandLine) is any command string that contains Clipper
   
 commands, dCLIP commands or commands from pre-processor files
   
 loaded with the INCLUDE command or DC_INCLUDE() function.
   

   

Returns:

    An array of character strings.  Each string is an expression.
   
 If the translation is unsuccessful, then the array will be empty.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 dc_predefadd( "K_ESC  27" )
   
 dc_predefadd( "ABORTED  INKEY()=K_ESC" )
   
 dc_pretradd( ;
   
  "BACKUP (dir) [WHILE (w)] =) mybackup(((dir)),({w})); DONE" )
   
 dc_pretradd( "DONE =) __quit()" )
   
 aFunctions := ;
   
   DC_TRANSLATE( "BACKUP \CUSTOMER WHILE !ABORTED" )
   
 dc_disparr(aFunctions)
   

   
 [1] mybackup("\CUSTOMER",{||!INKEY()=27})
   
 [2] __quit()
   

   

   
 -- Example 2 --
   

   
 accept "enter a command" to cCommand
   
 aFunctions := DC_TRANSLATE( cCommand )
   
 for i := 1 to len(aFunctions)
   
   cMacro := aFunctions[i]
   
   xDummy := &cMacro
   
 next
   

   

Source/Library:

See Also:

dc_trconv()

Convert a Trace file

Syntax:

Arguments:

    (cFileName) is the name of the file to create from the DCTRACE
   
 file and your source code files or the name of the printer
   
 device to send the output.
   

   
 If no parameter is given, then a file named DCTRACE.TXT is
   
 assumed.
   

   
 DC_TRCONV() will overwrite any file you specify.
   

   

Returns:

    NIL
   

   

Description:

Notes:

Examples:

    dc_trace(.t.)  // start tracing to DCTRACE file
   
 dc_trace(.f.)  // stop tracing
   
 DC_TRCONV()    // convert DCTRACE file to DCTRACE.TXT file
   

   

Source/Library:

See Also:

dc_tstcond()

Test if a condition is valid

Syntax:

Arguments:

    (cCondition) is any expression.
   

   
 (lDisplayError) if .TRUE. (default) will display an "Invalid
   
 Condition" error if the condition is not valid.
   

   

Returns:

    A logical .TRUE. if the condition is valid, .FALSE. otherwise.
   

   

Description:

Examples:

    use customer
   
 accept "enter a condition for output" to cCondition
   
 if DC_TSTCOND( cCondition )
   
   report form custlist for &cCondition
   
 endif
   

   

Source/Library:

dc_tstfile()

Test for existence or ability to create a file.

Syntax:

Arguments:

    (cFileName) = filename including optional drive and directory.
   
 If no drive/and directory are included then the SET DEFAULT
   
 directory or DOS directory is assumed (depending on the value
   
 of (lDosDir).
   

   

   
 (lExist) = .t. - Return .t. if file exists.
   
                  Return .f. if file does not exist
   
            .f. - Return .t. if file does not exist
   
                  Return .t. if file exists and OK to overwrite.
   
                  Return .f. if file exists and no overwrite.
   

   
 (lPrompt) = .t. - Will prompt operator if error
   
             .f. - Will not prompt operator
   

   
 (lCreateNew) if .TRUE. will prompt the operator if the
   
 file cannot be created as a new file. .FALSE. is the default.
   

   
 (lDosDir) if .TRUE. will test the currently selected DOS
   
 directory, otherwise the currently selected SET DEFAULT
   
 directory will be assumed.
   

   

   

   

Returns:

    A logical value.
   

   

Description:

Examples:

    -- Example 1 --
   

   
 accept "enter file name to open" to cFileName
   
 if DC_TSTFILE( cFileName, .t., .t. )
   
   nHandle := fopen( cFileName )
   
 else
   
   break
   
 endif
   

   

   
 -- Example 2 --
   

   
 accept "enter file name to create" to cFileName
   
 if DC_TSTFILE( cFileName, .f., .t. )
   
   nHandle := fcreate( cFileName )
   
 else
   
   break
   
 endif
   

   

Source/Library:

dc_turbconfig()

Define the system turbo 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 / command or DC_TURBEDIT() function.
   

   
  [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 upon 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_TURBCONFIG( { 'Q2.BAT','200','C:\;D:\','L' } )
   
 dc_turbedit()
   

   

Source/Library:

See Also:

dc_turbedit()

Invoke a Turbo Edit-Compile-Do sequence

Syntax:

Arguments:

    (cCommand) is a set of commands to compile and run (separated
   
 by semi-colons).
   

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

   

Description:

Notes:

Examples:

    dc_turbconfig( { 'Q2.BAT','300','C:\;D:\','L' } )
   
 DC_TURBEDIT()
   

   

Source/Library:

See Also:

dc_turbo()

A "turbo-style" integrated development environment (IDE)

Syntax:

Arguments:

    NONE
   

   

Description:

See Also:

dc_tutor()

A tutoring system for Clipper/dCLIP command ands functions

Syntax:

Arguments:

    (idCommand) | (idFunction) is the name of the command or
   
 function to jump to in the DCTUTOR database.
   

   
 If no argument is given, then DC_TUTOR() will return to the
   
 screen that was last accessed during the previous tutoring
   
 session.
   

   

Description:

Source/Library:

See Also:

dc_txtclose()

Close text file

Syntax:

Arguments:

    (nHandle) is the numeric file handle returned by DC_TXTOPEN().
   
 Caution: This is NOT the dos file handle.
   

   

Returns:

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

   

Description:

Examples:

    nHandle := dc_txtopen( 'dclip.sys' )
   
 do while !dc_txteof( nHandle )
   
   ? dc_txtline( nHandle )
   
   dc_txtskip( nHandle, 1 )
   
 enddo
   
 DC_TXTCLOSE( nHandle )
   

   

   

Source/Library:

See Also:

dc_txtcount()

Return the number of lines in an open text file

Syntax:

Arguments:

    (nHandle) is the numeric file handle returned by DC_TXTOPEN().
   
 Caution: This is NOT the dos file handle.
   

   

Returns:

    A number value equal to the number of lines in the text file.
   

   

Description:

Examples:

    nHandle := dc_txtopen( 'dclip.sys' )
   
 if DC_TXTCOUNT( nHandle ) ( 100
   
   do while !dc_txteof( nHandle )
   
     ? dc_txtline( nHandle )
   
     dc_txtskip( nHandle, 1 )
   
   enddo
   
   dc_txtclose( nHandle )
   
 endif
   

   

   

Source/Library:

See Also:

dc_txteof()

Is file pointer at end of text file?

Syntax:

Arguments:

    (nHandle) is the numeric file handle returned by DC_TXTOPEN().
   
 Caution: This is NOT the dos file handle.
   

   

Returns:

    A logical .TRUE. if the file pointer is at the end of the text
   
 file, .FALSE. otherwise.
   

   

Description:

Examples:

    nHandle := dc_txtopen( 'dclip.sys' )
   
 do while !DC_TXTEOF( nHandle )
   
   ? dc_txtline( nHandle )
   
   dc_txtskip( nHandle, 1 )
   
 enddo
   
 dc_txtclose( nHandle )
   

   

   

Source/Library:

See Also:

dc_txtgoto()

Goto a specified line in a text file

Syntax:

Arguments:

    (nHandle) is the numeric file handle returned by DC_TXTOPEN().
   
 Caution: This is NOT the dos file handle.
   

   
 (nLineNumber) is the line in the text file to go to.
   

   

Returns:

    A logical .TRUE. if the file pointer was successfully moved to
   
 the specified line, .FALSE. otherwise.
   

   

Description:

Examples:

    // This example will open the source code file and extract the
   
 // line of code that caused a runtime error.
   
 proc myerror
   

   
 cPrgName := dc_objfind( procname(1) )
   
 nLineNo := procline(1)
   
 nHandle := dc_txtopen( cPrgName )
   
 DC_TXTGOTO( nHandle, nLineNo )
   
 ? "This is the line of code that caused the error:"
   
 ? dc_txtline( nHandle )
   
 dc_txtclose( nHandle )
   

   

Source/Library:

See Also:

dc_txtline()

Read the current line of a text file

Syntax:

Arguments:

    (nHandle) is the numeric file handle returned by DC_TXTOPEN().
   
 Caution: This is NOT the dos file handle.
   

   

Returns:

    A string containing the contents of the current text line.
   

   

Description:

Examples:

    nHandle := dc_txtopen( 'dclip.sys' )
   
 do while !dc_txteof( nHandle )
   
   ? DC_TXTLINE( nHandle )
   
   dc_txtskip( nHandle, 1 )
   
 enddo
   
 dc_txtclose( nHandle )
   

   

   

Source/Library:

See Also:

dc_txtlno()

Report the current line pointer of an open text file

Syntax:

Arguments:

    (nHandle) is the numeric file handle returned by DC_TXTOPEN().
   
 Caution: This is NOT the dos file handle.
   

   

Returns:

    The current line number pointer of the text file.
   

   

Description:

Examples:

    nHandle := dc_txtopen( 'dclip.sys' )
   
 ? DC_TXTLNO( nHandle )
   
 1
   
 dc_txtskip( nHandle, 2 )
   
 ? DC_TXTLNO( nHandle )
   
 3
   

   

Source/Library:

See Also:

dc_txtopen()

Open a text file for use with Text file functions

Syntax:

Arguments:

    (cFileName) is the name of the text file to open.
   

   

Returns:

    A numeric file handle to be used by the other DC_TXT*()
   
 functions.
   

   

Description:

Examples:

    nHandle := DC_TXTOPEN( 'dclip.sys' )
   
 do while !dc_txteof( nHandle )
   
   ? dc_txtline( nHandle )
   
   dc_txtskip( nHandle, 1 )
   
 enddo
   
 dc_txtclose( nHandle )
   

   

   

Source/Library:

See Also:

dc_txtsize()

Return the size in bytes of an open text file

Syntax:

Arguments:

    (nHandle) is the numeric file handle returned by DC_TXTOPEN().
   
 Caution: This is NOT the dos file handle.
   

   

Returns:

    The size of the text file in bytes.
   

   

Description:

Examples:

    nHandle := dc_txtopen( 'DCLIP.SYS' )
   
 ? DC_TXTSIZE( nHandle )
   
 672
   

   

Source/Library:

See Also:

dc_txtskip()

Skip a specified number of lines in a text file

Syntax:

Arguments:

    (nHandle) is the numeric file handle returned by DC_TXTOPEN().
   
 Caution: This is NOT the dos file handle.
   

   
 (nLines) is the number of text lines to skip.
   

   

Description:

Examples:

    nHandle := dc_txtopen( 'dclip.sys' )
   
 do while !dc_txteof( nHandle )
   
   ? dc_txtline( nHandle )
   
   DC_TXTSKIP( nHandle, 1 )
   
 enddo
   
 dc_txtclose( nHandle )
   

   

   

Source/Library:

See Also:

dc_txtword()

Return value of a word in a String by specifying position

Syntax:

Arguments:

    (cString) is the string to search.
   

   
 (nPosition) is the numerical position of the word.
   

   
 (cWhiteSpace) is the character to be used as the "white
   
 space" character. (The default is SPACE " ").
   

   

Returns:

    The word corresponding to (nPosition).  If (nPosition) is
   
 greater than the number of words in (cString) then a null
   
 will be returned.
   

   

Description:

Examples:

    ? DC_TXTWORD( 'This is a test', 2)
   
 is
   

   

Source/Library:

See Also:

dc_updated()

Determine whether a GET changed during a READ

Syntax:

Arguments:

    (lUpdated) if .TRUE. will set the "updated" flag.  If no
   
 parameter is passed, then only the current status will be
   
 returned.
   

   

   

Returns:

    .TRUE. if any GETS were updated during the read, .FALSE.
   
 otherwise.
   

   

Description:

Notes:

Examples:

    local cCustName, cPhoneNmbr
   
 store customer-)cust_name to cCustName
   
 store customer-)phone_nmbr to cPhoneNmbr
   
 @ 10,10 say 'Customer Name ' get cCustName
   
 @ 11,10 say 'Phone Number  ' get cPhoneNmbr
   
 dc_readmodal( GetList )
   
 IF DC_UPDATED() .and. dc_reclock()
   
   replace cust_name with cCustName
   
   replace phone_nmbr with cPhoneNmbr
   
   unlock
   
 ENDIF
   

   

Source/Library:

See Also:

dc_use()

Pop up pick-list of available data files if file not found

Syntax:

Arguments:

    (cFileName) is the name or wildcard of the database
   
 file to open.   If a full file name is passed, then DC_USE()
   
 will attempt to open (cFileName).  If the file cannot be found,
   
 then the pick-list will appear.  If no argument is passed then
   
 a pick-list of all files that match the designated RDD will
   
 appear. If a wildcard argument is passed, then all files that
   
 match the wildcard will appear in the pick-list.
   

   
 (lExclusive) if .TRUE. will open the file in EXCLUSIVE mode, if
   
 .FALSE. (default) will open the file in SHARED mode.
   

   
 (cRdd) is the name of the Replaceable data driver to use.  If
   
 no argument is given, then the currently selected default RDD
   
 will be used.
   

   
 (cAlias) is an optional alias to assign to the file.
   

   
 (lNew) if .TRUE. will open the database in the first unused
   
 work area, if .FALSE. (default) the file will be opened in the
   
 current work area.
   

   
 (lOpenFile) if .TRUE. (default) will open the database, otherwise
   
 the database will not be opened but the filename will be returned
   
 if the database exists.
   

   

   

Returns:

    A character string containing the name of the file used.
   

   

Description:

Examples:

    cFileName := space(50)
   
 @ 10,10 say ;
   
   "enter a database to open (leave empty for pick-list)" ;
   
   get cFileName
   
 read
   
 DC_USE( cFileName )
   

   

Source/Library:

See Also:

dc_useaindex()

Automatically open index files

Syntax:

Arguments:

    (lAutoIndex) when .TRUE. will automatically open indexes,
   
 when .FALSE. will disable the automatic index-open feature.
   

   

Returns:

   A logical value equivalent to the previous settting.
   

   

Description:

Examples:

   Let's say the following files exist in the Default directory:
   

   
DM004.DBF
   
DM0041.NTX
   
DM0042.NTX
   
DM0043.NTX
   

   
They will all be opened with the following commands:
   

   
DC_UseAIndex(.t.)
   
USE DM004
   

   
 or
   

   
SET AUTOINDEX ON
   
USE DM004
   

   
 or
   

   
USE DM004 AUTOINDEX
   

   

Source/Library:

See Also:

dc_useall()

Opens all data files matching a specified wildcard

Syntax:

Arguments:

    (cWildCard) is a wild-card argument for the database files to
   
 open.  If no argument is given, then "*" is default.
   

   
 (cRdd) is the Rdd to use.  If no argument is passed, then the
   
 current Rdd will be used.
   

   
 (lShared) if .TRUE. will open the databases in SHARED mode, if
   
 .FALSE. will open the database in EXCLUSIVE mode.  If no
   
 argument is passed, then the system SET EXCLUSIVE value will be
   
 used.
   

   
 (lReadOnly) if .TRUE. will open the databases for Read
   
 operations only, if .FALSE. (default) will open the database
   
 for Read/Write operations.
   

   

Returns:

    A logical .TRUE. if any databases were opened, a .FALSE.
   
 if no databases were opened.
   

   

Description:

Examples:

    set rdd to "DBFNTX"
   
 DC_USEALL("CUST*")
   
 set default to \mytools\data
   
 set rdd to "DBFSIX"
   
 DC_USEALL()
   

   

Source/Library:

See Also:

dc_usearea()

A front-end to dbUseArea() that tests RDD to prevent errors

Syntax:

Arguments:

    (lNew) if .TRUE. will open the database in a new work area. If
   
 .FALSE. (default), the current work area will be used.
   

   
 (cRdd) is the Rdd to use.  If no argument is passed, then the
   
 (cAltRdd) will be used followed by the current Rdd.
   

   
 (cDatabase) is the name of the file to open.  If no drive and
   
 directory is included then the file must exist in the SET
   
 DEFAULT directory or SET PATH directory.
   

   
 (lShared) if .TRUE. will open the database in SHARED mode, if
   
 .FALSE. will open the database in EXCLUSIVE mode.  If no
   
 argument is passed, then the system SET EXCLUSIVE value will be
   
 used.
   

   
 (lReadOnly) if .TRUE. will open the database for Read
   
 operations only, if .FALSE. (default) will open the database
   
 for Read/Write operations.
   

   
 (cAlias) is the ALIAS to assign to the work area.  If no
   
 argument is passed then the prefix of the database name will
   
 be used as the alias.
   

   
 (lDisplayError) if .TRUE. (default) will display an error window
   
 if the file could not be opened.
   

   
 (lBreak) if .TRUE. will BREAK after an error rather than RETURN.
   
 The default is .FALSE.
   

   
 @(lError) is a logical parameter, passed by reference.  If an
   
 error occurs this variable will be set to .TRUE., otherwise it
   
 will be set to .FALSE.
   

   
 (lCMXAutoOpen) is used to override the "auto-open" feature of the
   
 "COMIX" and "FORTRESS" data drivers.  Passing a .FALSE. (default
   
 is .TRUE) will force the COMIX/FORTRESS driver to NOT open any
   
 associated *.CDX index file.
   

   
 (cAltRdd) is an alternate RDD to use if the database cannot be
   
 opened by the primary (cRdd) driver.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    DC_USEAREA ( .t., 'DBFMDX', 'CUSTOMER',, .t., .f. )
   

   

Source/Library:

See Also:

dc_useraccess()

Determine if Logged-On user has access to a lock

Syntax:

Arguments:

    (cLockCode) is a 3-character "Lock" code.
   

   
 (cErrorMsg) is the message to display if the user does not
   
 have posession of the key to the specified lock or a master
   
 key.  If this parameter is not passed, then a default message
   
 will be displayed.
   

   

   

   

Returns:

    A logical .TRUE. if the user possesses a key to the specified
   
 lock, .FALSE. otherwise.
   

   

Description:

Examples:

    #include 'dcuser.ch'
   
 DC_UserLogon( 'CURLY' )
   

   
 -- Example 1 --
   

   
 IF !DC_USERACCESS( '511', "Sorry.  You can't use this menu!" )
   
   RETURN
   
 ENDIF
   
 DC_MenuRun('MENU511')
   

   

   

Source/Library:

dc_userfree()

Free the lock on the the User file to allow user access

Syntax:

Arguments:

    None
   

   

   

   

Returns:

    Nil
   

   

Description:

Examples:

    DC_USERFREE()
   

   

Source/Library:

See Also:

dc_userinfo()

Get or Set information about Logged-On User

Syntax:

Arguments:

    (nElement) is the array item to return.  If the (nElement)
   
 argument is not passed then the entire array will be returned.
   

   
 (xValue) is the value to store in aUserInfo[(nElement)].
   

   

   

Returns:

    An array if (nElement) is not passed or a value dependent on
   
 the value of (nElement).
   

   
 The array consists of 15 elements (See DCUSER.CH) for
   
 array definitions:
   

   
 Element   Type   Description
   
 -------  ----   -------------------------------------------
   
   [1]      C     USER_ID - User ID code
   
   [2]      C     USER_NAME - User Name
   
   [3]      C     USER_KEYS - User Keys (separated by commas)
   
   [4]      C     USER_MASTERPASS - Master Password
   
   [5]      L     USER_PROGRAMMER - "Programmer" flag
   
   [6]      C     USER_PASSWORD - Logged On User Password
   
   [7]      C     USER_MENU - User Start Menu Name
   
   [8]      C     USER_WPNAME - User Word Processor
   
   [9]      C     USER_WPPARAM - User Word Processor parameters
   
   [10]     C     USER_WPPATH - User Word Processor directory
   
   [11]     C     USER_GROUP - User Group
   
   [12]     L     USER_MAILFLAG - Mail Flag
   
   [13]     L     USER_PHONEFLAG - Phone message Flag
   
   [14]     L     USER_COLOR - Set Color ON Flag
   
   [15]     C     USER_PRINTER - User Printer Name
   

   

Description:

Examples:

    #include 'dcuser.ch'
   
 DC_UserLogon( 'LARRY' )
   

   
 -- Example 1 --
   

   
 ? DC_USERINFO( USER_ID )
   

   
 LARRY
   

   

   
 -- Example 2 --
   

   
 /* -- Give user temporary access to all menus -- */
   
 DC_USERINFO( USER_KEYS, '' )
   

   

   
 -- Example 3 --
   

   
 ? DC_USERINFO()[ USER_KEYS ]
   
 1**,2**,31*,320,321,4**
   

   

   

Source/Library:

See Also:

dc_userlock()

Lock or attempt to lock all users out of the system

Syntax:

Arguments:

    (aErrorMsg) is an array of character strings to display as
   
 the message in the event that the DCUSER.DBF database cannot
   
 be locked.  If this argument is not passed, then a default
   
 message will be displayed.
   

   

   

Returns:

    A logical .TRUE. if the file was locked successfully, .FALSE.
   
 otherwise.
   

   

Description:

Examples:

    ? DC_USERLOCK()
   
 .f.
   

   

Source/Library:

See Also:

dc_userlogin()

Log On to system to establish user rights

Syntax:

Arguments:

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

   

   

Returns:

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

   

Description:

Examples:

    #include 'dcuser.ch'
   

   
 DC_USERLOGON( 'LARRY' )
   

   

   

Source/Library:

See Also:

dc_usermaint()

Maintain the DCUSER.DBF User database

Syntax:

Arguments:

    If the (cUserID) argument is passed, then the record that
   
 contains the USR_ID matching (cUserID) will be edited,
   
 otherwise all records will be available for browsing and
   
 editing.
   

   

Returns:

    A logical .TRUE. if the user database was opened and accessed,
   
 .FALSE. otherwise.
   

   

Description:

Examples:

    #include 'dcuser.ch'
   

   
 -- Example 1 --
   

   
 DC_USERMAINT( 'LARRY' )
   

   

   
 -- Example 2 --
   

   
 DC_USERMAINT()
   

   

   

Source/Library:

dc_useropen()

Open the DCUSER.DBF User database

Syntax:

Arguments:

    (cTagName) is the Tag Name of the Index to select.
   
 If no parameter is passed then USR_ID is the default.
   

   

   
 Tag Name     Description
   
 --------       ------------------------------------------
   
 USR_ID       USR_ID
   
 DEPT         USR_DEPT + USR_ID
   
 JOB          USR_JOB + USR_DEPT + USR_ID
   

   

Returns:

    A logical .TRUE. if the user database was opened successfully,
   
 .FALSE. otherwise.
   

   

Description:

Source/Library:

dc_userset()

Establish the Logged-On user from the User Database

Syntax:

Arguments:

    (cUserID) is a valid user id that matches the value in the
   
 USR_ID field of the DCUSER.DBF database.
   

   

Returns:

    A logical .TRUE. if the User ID was found in the database,
   
 .FALSE. otherwise.
   

   

Description:

Examples:

    DC_USERSET( 'MOE' )
   

   

   

Source/Library:

See Also:

dc_util()

A menu-driven set of database utilities

Syntax:

Arguments:

    (cCode) is a single character designating the utility program
   
 to run.  If no argument is passed then a user-menu will be
   
 displayed.
   

   
 cCode   Utility program
   
 -----  -------------------
   
   C     Create Database
   
   D     Display Structure
   
   O     mOdify Structure
   
   S     Copy Structure
   
   A     Append Records
   
   P     coPy Records
   
   M     iMport a Data File
   
   R     Replace Data
   
   Y     copY Fields
   
   E     dElete Records
   
   L     RecaLL Records
   
   T     SorT Database
   
   J     Join with Database
   
   N     CouNt Records
   
   U     sUm Data Fields
   
   V     aVerage Data Fields
   
   K     disK Directory
   
   I     Insert Blank Record(s)
   
   B     Pack DataBase
   
   Z     Zap Database
   
   X     Import/eXport Memos
   
   G     PurGe Duplicate Records
   

   

Returns:

    A character equivalent to the code letter for the utility
   
 program selected an run by the user.
   

   

Description:

Examples:

    do while lastkey()#27
   
   cls
   
   @ 10,10 prompt "open a database"
   
   @ 11,10 prompt "open an index file"
   
   @ 12,10 prompt "database utilities"
   
   @ 13,10 prompt "browse database"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       dc_dbfopen()
   
     case nChoice = 2
   
       dc_ntxopen()
   
     case nChoice = 3
   
       DC_UTIL()
   
     case nChoice = 4
   
       dc_browsedb()
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_valtype()

Validate input parameters and set default values

Syntax:

Arguments:

    (cMemVar) is the memory variable to validate.
   

   
 (xDefaultVal) is the value to initialize (cMemVar) if the
   
 (cMemVar) is not the same type as (xDefaultVal).
   

   

Returns:

    NIL
   

   

Description:

Notes:

Examples:

    function window ( nStRow, nStCol, nEnRow, nEnCol, cTitle )
   

   
 DC_VALTYPE( @nStRow, 0, @nStCol, 0, @nEnRow, MaxRow(), ;
   
     @nEnCol, MaxCol(), @cTitle, "" )
   

   
 return dc_expl( nStRow, nStCol, nEnRow, nEnCol, cTitle )
   

   

Source/Library:

dc_version()

Returns current dCLIP version

Syntax:

Arguments:

    NONE
   

   

Returns:

    A character string.
   

   

Description:

Examples:

    ? DC_VERSION()
   
 3.00
   

   

Source/Library:

dc_viewlib()

Browse status of loaded dynamic libraries and .obj files

Syntax:

Arguments:

    (lObjList) if .TRUE. will list only the .OBJ files currently
   
 "dynamic-linked" into memory.  If .FALSE. (default), then a
   
 browse-style menu will appear with information about .OBJ's and
   
 modules that are "dynamic-linked" and dynamic-libararies that
   
 are loaded.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    do while lastkey()#27
   
   cls
   
   @ 10,10 prompt "load a dynamic library"
   
   @ 11,10 prompt "run a program"
   
   @ 12,10 prompt "view dynamic link status"
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       accept "enter dynamic library to load" to cDlb
   
       dc_libload( cDlb )
   
     case nChoice = 2
   
       accept "enter program to run" to cProgram
   
       dc_do( cProgram )
   
     case nChoice = 3
   
       DC_VIEWLIB()
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_virtcapture()

Capture the current record to the Virtual record

Syntax:

Arguments:

    If (lFieldNames) is a logical .TRUE., then the field name data
   
 will be saved in the array returned.  DC_VIRTREPLACE() will
   
 automatically know if the field data information is in the array
   
 and will not cause an error if the structure of the target
   
 database is not the same as the structure of the primary database.
   

   
 IF (lFieldNames) is .FALSE., then the target database must
   
 exactly match the structure of the primary database.
   

   

Returns:

    If (lFieldNames) is .TRUE., returns single-dimensional array with
   
 a number of elements equal to the number of fields in the
   
 current database.
   

   
 If (lFieldNames) is .FALSE., returns a multi-dimensional array
   
 of two elements:  The first is an array of field names, the
   
 second is an array of data.
   

   

Description:

Examples:

    aVirtual := nil
   
 do while lastkey()#27
   
   cls
   
   @ 10,10 prompt "capture current record to virtual"
   
   @ 11,10 prompt "select a record"
   
   if valtype(aVirtual)='A'
   
     @ 12,10 prompt "replace current record with virtual"
   
   endif
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       aVirtual := DC_VIRTCAPTURE()
   
     case nChoice = 2
   
       dc_dbchoice()
   
     case nChoice = 3
   
       dc_virtreplace( aVirtual )
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_virtreplace()

Replace the current record with the Virtual record

Syntax:

Arguments:

    (aVirtualRecord) is a virtual record array saved by
   
 DC_VIRTSAVE().
   

   

Returns:

    A logical .TRUE. if the data replacement is successful, .FALSE.
   
 otherwise.
   

   

Description:

Examples:

    aVirtual := nil
   
 do while lastkey()#27
   
   cls
   
   @ 10,10 prompt "capture current record to virtual"
   
   @ 11,10 prompt "select a record"
   
   if valtype(aVirtual)='A'
   
     @ 12,10 prompt "replace current record with virtual"
   
   endif
   
   menu to nChoice
   
   do case
   
     case nChoice = 1
   
       aVirtual := dc_virtcapture()
   
     case nChoice = 2
   
       dc_dbchoice()
   
     case nChoice = 3
   
       DC_VIRTREPLACE( aVirtual )
   
   endcase
   
 enddo
   

   

Source/Library:

See Also:

dc_virtrestore()

Restore Virtual record from Virtual (.DCV) file

Syntax:

Arguments:

    NONE
   

   

   

Returns:

    An array with the contents of the .DCV file.
   

   

Description:

Examples:

    // this routine will append 5 records to the current database
   
 // that will be filled in with data from the virtual record.
   
 aVirtual := DC_VIRTRESTORE()
   
 if valtype(aVirtual) = 'A'
   
   for i := 1 to 5
   
     dc_addrec()
   
     dc_virtreplace( aVirtual )
   
   next
   
 endif
   

   

Source/Library:

See Also:

dc_virtsave()

Save Virtual record to Virtual (.DCV) file

Syntax:

Arguments:

    (aVirtualRecord) is a virtual record array saved by
   
 DC_VIRTSAVE(). If no argument is passed, then the contents of
   
 the current record in the current work area will be used as the
   
 virtual record.
   

   

Description:

Source/Library:

See Also:

dc_wait()

A mouseable wait-state that clears message line

Syntax:

Arguments:

    (cMessage) is the message to display.
   

   

Description:

Examples:

    nHandle := dc_txtopen( '\clipper5\include\std.ch' )
   
 nLine := 0
   
 do while !dc_feof( nHandle ) .and. lastkey()#27
   
   ? dc_txtline( nHandle )
   
   dc_txtskip( nHandle, 1 )
   
   nLine++
   
   if nLine ) maxrow()-3
   
     DC_WAIT( "Press any key to continue, Escape to Abort")
   
     nLine := 0
   
   endif
   
 enddo
   
 dc_txtclose( nHandle )
   

   

   

Source/Library:

dc_waiton()

Display a "Wait" Message in a window to restore later

Syntax:

Arguments:

    (cMessage) is the message to place in the window.  If this
   
 is passed as an array, then each element must be a character
   
 string representing each line of text in the window.  If no
   
 argument is passed then the following default message will
   
 be displayed: "Please wait..."
   

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

   
 (cColor1) is the color of the window frame.  If no argument
   
 is passed then the system color for "exploding box frame" will
   
 be used.
   

   
 (cColor2) is the color of the window contents.  If no
   
 argument is passed then the system color for "exploding box
   
 contents" will be used.
   

   
 (nTop) is the top display row of the message box.  If no
   
 argument is passed, then the box will be vertically positioned
   
 in the center of the screen.
   

   
 (nLeft) is the left display column of the message box.  If no
   
 argument is passed, then the box will be horizontally
   
 positioned in the center of the screen.
   

   

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:

    aMessage := { 'Now Printing Calendar',;
   
               '',;
   
               'Press ESCAPE to Abort' }
   

   
 cSaveScrn := DC_WAITON( aMessage )
   

   
 do while !eof() .and. inkey(.5)#K_ESC
   

   
   * Do some stuff
   

   
 enddo
   

   
 DC_Implode(cSaveScrn)
   

   

   

   

Source/Library:

See Also:

dc_watch()

Load / clear an expression to / from the Watch table

Syntax:

Arguments:

    (cExpression) is an expression to evaluate.  This expression
   
 may include database fields, private variables, and public
   
 variables. (cExpression) may also be the name of Local or
   
 Static variables provided that the Local or Static variable
   
 name is not included in a complex expression.
   

   
 (lClear) will clear a specified expression from the watch
   
 table.
   

   
 (nNumber) is the number of the watch expression to clear from
   
 the watch table.  The watch table is treated like a "stack" so
   
 after an expression is cleared, all other expressions will be
   
 pushed down the stack.  If nNumber is 0 and lClear is .TRUE.
   
 then ALL expressions will be cleared from the watch table.
   

   
 NOTE - If NO ARGUMENTS are passed, then DC_WATCH() will display
   
 the current status of the watch table.
   

   

Returns:

    NIL
   

   

Description:

Examples:

    -- Example 1 --  Adding expressions to the watch table
   

   
 DC_WATCH( 'RECNO()' )
   
 DC_WATCH( 'ALIAS()' )
   

   
 -- Example 2 --  Clearing an expression from the watch table
   

   
 DC_WATCH( , .t., 2 ) // Clear expression #2
   

   
 -- Example 3 --  Clearing the entire expression table
   

   
 DC_WATCH( , .t., 0 ) // Clear ALL
   

   
 -- Example 4 --  Displaying contents of watch table
   

   
 DC_WATCH()
   

   

Source/Library:

dc_watchdisp()

Evaluate Watch Table and display results

Syntax:

Arguments:

    (nStrow) is the start display row.
   
 (nStcol) is the start display column.
   
 (nEnrow) is the end display row.
   
 (nEncol) is the end display column.
   

   

Returns:

    nil
   

   

Description:

Examples:

    // load watch table with expressions to evaluate
   
 dc_watchtable( {'RECNO()','INDEXKEY(0)','ALIAS()','EOF()'} )
   
 DC_WATCHDISP( 10,5,15,75 )  // display expressions
   

   

Source/Library:

See Also:

dc_watchtable()

Return the watch table array

Syntax:

Arguments:

    (aWatchTable) is an array of character-string expressions to
   
 evaluate.
   

   

Returns:

    An array of character strings equivalent to the expressions that
   
 have been loaded into the watch table using the DC_WATCH()
   
 function or WATCH command.
   

   

Description:

Examples:

    // This example shows how the display of watch expressions
   
 // can be manipulated at the dot prompt.
   

   
 . aWatch := { 'TIME()','DATE()','ALIAS()','RECNO()' }
   
 . define WATCHON  DC_WATCHTABLE( aWatch )
   
 . define WATCHOFF DC_WATCHTABLE( {} )
   
 . WATCHON  // turn on watch window
   
 . WATCHOFF // turn off watch window
   

   

Source/Library:

See Also:

dc_word2num()

Convert a 2-byte word to a number

Syntax:

Arguments:

    (cByteString) is a 2-byte character string.
   

   

Returns:

    An integer number.
   

   

Description:

Examples:

    The following example shows how to use DC_NUM2WORD() and
   
 DC_WORD2NUM() to save numeric values to a file and restore
   
 them.
   

   
 FUNCTION savenumbers ( aNumbers )
   

   
 // aNumbers := { 10, 45, 134, 678, 3, 200 }
   
 nHandle := fcreate( 'numbers.bin' )
   
 for i := 1 to len(aNumbers)
   
   fwrite( nHandle, DC_NUM2WORD( aNumbers[i] )
   
 next
   
 fclose( nHandle )
   
 return
   

   

   
 FUNCTION restnumbers
   

   
 local nHandle := fopen( 'numbers.bin' )
   
 local aNumbers := {}
   
 aadd( aNumbers, DC_WORD2NUM( freadstr( nHandle, 2 ) ) )
   
 fclose( nHandle )
   
 return aNumbers
   

   

Source/Library:

See Also:

dc_work()

A work area file (*.DCW) manager

Syntax:

Arguments:

    NONE
   

   

Returns:

    nil
   

   

Description:

Examples:

    DC_WORK()
   

   

Source/Library:

See Also:

dc_workarray()

Capture all information about a work area to an array

Syntax:

Arguments:

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

   

Returns:

    A multi-dimensional array described as follows:
   

   
 Element Type        Description
   
 ------- ---------   ------------------------------------------
   
   1     Numeric     I dunno...a bunch of numbers of some sort
   
   2     Numeric     Number of fields
   
   3     Logical     At Beginning of file?
   
   4     Logical     At End of file?
   
   5     Logical     Did last SEEK find a match?
   
   6     Character   Search String for last LOCATE
   
   7     Character   Current filter condition
   
   8     Numeric     Number of Child Relations
   
   9     Numeric     Length of record
   
  10     Numeric     Number of records
   
  11     Numeric     Current record number
   
  12     Numeric     File handle of DBF
   
  13     Logical     Does this DBF have a DBT file?
   
  14     Numeric     File handle of DBT
   
  15     Logical     Was DBF opened in SHARED mode?
   
  16     Logical     Was DBF opened in READONLY mode?
   
  17     Logical     Is the DBF File locked?
   
  18     Logical     Is the current record locked?
   
  19     Numeric     Record number of locked record
   
  20     Numeric     Index order
   
  21     Numeric     Index count
   
  22     Array       Numeric - File handle of each Index file
   
  23     Array       Character - field Names
   
  24     Array       Character - field Type
   
  25     Array       Numeric - field Length
   
  26     Array       Numeric - field Decimal
   

   

Description:

Examples:

    set default to \customer\data
   
 use customer via 'DBFSIX' index custname, custnmbr
   
 aWorkData := DC_WORKARRAY()
   

   
 // display database name
   
 ? dc_hand2name( aWorkData[12] )
   
 \CUSTOMER\DATA\CUSTOMER.DBF
   

   
 // display memo name
   
 ? dc_hand2name( aWorkData[14] )
   
 \CUSTOMER\DATA\CUSTOMER.FPT
   

   
 // display index file name(s)
   
 ? dc_hand2name( aWorkData[22,1] )
   
 \CUSTOMER\DATA\CUSTNAME.IDX
   
 ? dc_hand2name( aWorkData[22,2] )
   
 \CUSTOMER\DATA\CUSTNMBR.IDX
   

   

Source/Library:

dc_workbrow()

Browse a Work Area (*.DCW) dictionary file

Syntax:

Arguments:

    (cWorkFile) is the name of the Work File to browse.  If no
   
 extension is given then .DCW is assumed.  If no argument is
   
 passed, then a window will appear to request the name of
   
 the .DCW file from the user.
   

   

Description: