SP_COPYITOUT

 COPYITOUT()

  Short:
  ------
  COPYITOUT() Copies records to a new DBF

  Returns:
  --------
  nothing

  Syntax:
  -------
  COPYITOUT()

  Description:
  ------------
  Copies records to a new DBF, with query and tagging
  options.

  Examples:
  ---------
   Use (dbf_file)

   COPYITOUT()

  Notes:
  -------
  For more control, see COPYFIELDS(). If field
  selection is not needed, use COPYITOUT(), which is smaller and
  faster.

  Source:
  -------
  S_COPY.PRG

 

SP_COPYFIELDS

COPYFIELDS()

  Short:
  ------
  COPYFIELDS() Copies selected fields of selected records to new dbf

  Returns:
  --------
  None

  Syntax:
  -------
  COPYFIELDS([aFields,[aDescript]])

  Description:
  ------------
  This metafunction allows selection of fields, and
  selection of record criteria (filter) to be copied to a new DBF.

  [aFields]  is an array of valid field names. Default
  is all fields. Fields not of the current area are not allowed.

  [aDescript] is an array of field descriptions, which
  can only be passed if [aFields]  is passed, and which must
  reflect the fields in [aFields]

  Examples:
  ---------
   use (cDbfName)

   COPYFIELDS()  // its a metafunction...

  Source:
  -------
  S_COPYF.PRG

 

SP_COLPIK

COLPIK()

  Short:
  ------
  COLPIK() Allows selection of colors from a list

  Returns:
  --------
  Nothing

  Syntax:
  -------
  COLPIK()

  Description:
  ------------
  Gives the user a choice of 12 pre-defined color
  combinations to choose from

  Examples:
  ---------
   COLPIK()

  Notes:
  -------
  Color combo is stored to COLORS.DBF (or whatever name
  is assigned - see SLSF_COLOR()  ).

  See appendix for more info on colors usage by the
  library.

  Source:
  -------
  S_COLPIK.PRG

 

SP_CLS

CLS()

  Short:
  ------
  CLS() Clear the screen with optional color,character

  Returns:
  --------
  Nothing

  Syntax:
  -------
  CLS([nAttribute],[cChar])

  Description:
  ------------
  Clear the screen.

  Optional color [nAttribute] and character [cChar].

  Examples:
  ---------
   CLS()   // clears screen with current color

   CLS(48) // clears screen with black on cyan

   CLS(8,chr(177))  // clears screen grey on black
                    // with character 177

  Notes:
  -------
  Of course in Clipper 5.01 you can also do:
  dispbox(0,0,24,79,repl(chr(177),9),"+N/N") and get the same
  result.

  Source:
  -------
  S_CLS.PRG

 

SP_CLABEL

CLABEL()

  Short:
  ------
  CLABEL() Menu driven module for label management

  Returns:
  --------
  Nothing

  Syntax:
  -------
  CLABEL([aInFieldNames,aInFieldDesc,aInFieldTypes],[lUseBuildex],[lRelease])

  Description:
  ------------
  This function requires no parameters and is entirely
  menu driven. Clipper compatible LBL files can be imported from.
  Definitions are stored in a DBF format. Labels may be printed by
  Query matches, by Tagging, or all records.

  Three arrays may be passed - <aInFieldNames> is an
  array of allowable field names. <aInFieldDesc>  is an array of
  field descriptions. <aInFieldTypes> is an array of field types.
  All three must be passed, or none. All fields are used as
  default, with field names being the default field descriptions.

  [lUseBuildex] if True, allows calling BUILDEX() to
  build complex expressions.

  [lRelease] if this is TRUE, CLABEL() will release the printer every
  50 labels. If on a network, this will allow the queue to empty out.
  If you are printing a bunch of labels, this can be important. Default
  is False.

  Examples:
  ---------
   use CUSTOMER

   CLABEL()

       or

   USE CUSTOMER
   aFlds := {"FNAME","LNAME","MI"}
   aFdes := {"First","Last","Middle"}
   aType := {"C","C","C"}
   CLABEL(aFlds,aFdes,aType,.t.)

  Notes:
  -------
  Requires datafile to be open.

  Reads Clipper compatible LBL files. Writes to a DBF.
  Does not call LABEL FORM. instead, uses its own label printing
  routine. Label printing routine optionally compresses blank
  lines (i.e. a 2nd address), as well as removing all but single
  space in a line (i.e. FIRSTNAME+ LASTNAME) See SLSF_LABEL() for
  notes on the storage DBF.

  Source:
  -------
  S_CLAB.PRG

 

SP_CENTR

CENTR()

  Short:
  ------
  CENTR() Centers a string in x spaces

  Returns:
  --------
  <cCentered> => String centered

  Syntax:
  -------
  CENTR(cInString,[nSpaces])

  Description:
  ------------
  Centers <cInString> in [nSpaces] spaces

  [nSpaces] spaces is optional. Default is current
  string length

  Examples:
  ---------

   cString := "Superfunction "

   cString := CENTR(cString,20)     //   => "  Superfunction  "

  Notes:
  -------
  In Clipper 5.01, use PADC(), which does the same
  thing and faster. Here for compatibility.

  Source:
  -------
  S_CENTR.PRG

 

SP_CALENDWHEN

CALENDWHEN()

  Short:
  ------
  CALENDWHEN() Uses GETDATE() function as a GET WHEN clause

  Returns:
  --------
  <lWhen> => when condition

  Syntax:
  -------
  CALENDWHEN([lShowonUp],[lReturn])

  Description:
  ------------
  This sets up the popup GETDATE() function for use in
  a GET WHEN clause. (the pre validation block). If a date is
  selected, it is assigned to the get. The Calendar function will
  pop up upon entry into a GET field.

  [lShowOnUp] Normally you wouldn't want this WHEN to
  occur if the user is using the up arrow, and if <lShowOnUp> is
  .f. (the default) it does not occur (the GET is just skipped)

  [lReturn] If set to False (the default) the GET is
  never actually edited, as the WHEN will always return .f., but
  it is assigned the value returned by GETDATE(). By setting it to
  True, the Calendar will pop up, and then the GET will also be
  put through the normal get editor.

  Examples:
  ---------

   proc test

   v1 := date()
   v2 := date()+1
   v3 := date()+1
   v4 := date()+1

   @10,10 get v1
   @11,10 get v2 when calendwhen(.f.) // calendar pops up  when the
                                   // get is entered. No  direct
                                   // editing.
   @12,10 get v3 valid calendvalid( {||v3>date()} )
   @13,10 get v4

   read

  Notes:
  -------
  You might want to look at CALENDVALID() and
  CALENDKSET() for other options.

  Source:
  -------
  S_DATVW.PRG

 

SP_CALENDVALID

 CALENDVALID()

  Short:
  ------
  CALENDVALID() Uses GETDATE() popup calendar function as a GET
  VALID clause

  Returns:
  --------
  <lValid> => valid condition

  Syntax:
  -------
  CALENDVALID([bValid])

  Description:
  ------------
  This sets up the popup GETDATE() calendar for use in
  a GET VALID clause. (the post validation block). If a value is
  selected, it is assigned to the get. (if ESCAPE is pressed, it
  is not) The Calendar function will pop up upon exit from a GET
  field.

  [bValid] If you pass a validation codeblock, it will
  be checked first. If the GET is already valid, according to the
  codeblock, the calculator will not be popped up. The codeblock
  must return a logical value.

  Examples:
  ---------

   proc test

   v1 := date()
   v2 := date()
   v3 := date()
   v4 := date()

   @10,10 get v1
   @11,10 get v2 when calendwhen(.f.)
   @12,10 get v3 valid calendvalid( {||v3>date()}  )
                      // note the validation block
                      // IF V3 > date(), the calendar
                      // will not be called
   @13,10 get v4

   read

  Notes:
  -------
  You might want to look at CALENDWHEN() and
  CALENDKSET() for other options.

  Source:
  -------
  S_CALCVW.PRG

 

SP_CALENDKSET

CALENDKSET()

  Short:
  ------
  CALENDKSET() Allows use of GETDATE() calendar in GETS

  Returns:
  --------
  Nil

  Syntax:
  -------
  CALENDKSET(nKey,cProc,cVar,lAssign)

  Description:
  ------------
  Sets up a call to GETDATE() when key <nKey> is
  pressed while in proc or function <cProc> at variable <cVar>.

  If <lAssign> is True, the value returned from
  GETDATE() is assigned to the current get. Use CALENDKCLR() when
  done.

  Examples:
  ---------

  // this will pop up a the calendar when F2 is pressed while
  // on the get V2. The value will be assigned to V2.

  proc test
  local v1 := DATE(),  v2 := DATE()+1
  @10,10 get v1
  @11,10 get v2
  CALENDKSET(K_F2,"TEST","V2",.t.)
  read

  CALENDKCLR()  // clear it out

  Source:
  -------
  S_DATEK.PRG

 

SP_CALENDKCLR

CALENDKCLR()

  Short:
  ------
  CALENDKCLR() Clears hot keys set up by CALENDKSET()

  Returns:
  --------
  Nil

  Syntax:
  -------
  CALENDKCLR()

  Description:
  ------------
  Clears hot keys set up by CALENDKSET(). Always use
  this after using CALENDKSET()

  Examples:
  ---------
   // this will pop up a the calendar when F2 is pressed while
   // on the get V2. The value will be assigned to V2.

   proc test
   local v1 := DATE(), v2 := DATE()+1
   @10,10 get v1
   @11,10 get v2

   CALENDKSET(K_F2,"TEST","V2",.t.)

   read

   CALENDKCLR()  // clear it out

  Source:
  -------
  S_DATEK.PRG