Daily Archives: November 23, 2013

SP_SFREADLINE

Posted on by vivaclipper 
()

  Short:
  ------
  SFREADLINE() Reads in text up to the next CRLF in a text file

  Returns:
  --------
  <cLine> => line read in

  Syntax:
  -------
  SFREADLINE(nHandle)

  Description:
  ------------
  Reads in text up to the next CRLF in a text file. The
  pointer is moved back to the starting position when done. To move to a
  new line, use  FMOVE2PRIOR() or FMOVE2NEXT().

  Examples:
  ---------
   nHandle := fopen("Report.doc")

   ?sfreadline(handle)
   while fmove2next(handle)
     ?sfreadline(handle)
   end

  Source:
  -------
  S_FREADL.PRG

 

SP_SFIL_LOCK

Posted on by vivaclipper 
SFIL_LOCK()

  Short:
  ------
  SFIL_LOCK() Attempts to lock a file

  Returns:
  --------
  <lSuccess> success

  Syntax:
  -------
  SFIL_LOCK(nTries,lInteract,[cMoreMessage])

  Description:
  ------------
  Attempts to lock entire DBF file. Tries <nTries>
  times and then allows user to retry or not <lInteract> by giving
  message [cMoreMessage] and asking YES/NO.

  Examples:
  ---------
   IF SFIL_LOCK(5,.F.)
       count for "S"$LNAME
       UNLOCK
   ELSE
       LOOP
   ENDIF

  Source:
  -------
  S_SFILOK.PRG

 

SP_SEXPORT

Posted on by vivaclipper 
SEXPORT()

  Short:
  ------
  SEXPORT() Export DBF to delimited or SDF files

  Returns:
  --------
  Nothing

  Syntax:
  -------
  SEXPORT([<aFields>,<aDesc>,<aTypes>,<aLens>,<aDeci>])

  Description:
  ------------
  This metafunction allows the user to select certain
  fields and, based on a condition or not, export them to a
  delimited or SDF file.

  [<aFields>,<aDesc>,<aTypes>,<aLens>,<aDeci>]

  Pass all or none. Array of field names, descriptions,
  types, lengths and decimals.

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

   SEXPORT()

  Source:
  -------
  S_EXPORT.PRG

 

SP_SET_DATE

Posted on by vivaclipper 
SET_DATE()

  Short:
  ------
  SET_DATE() Sets and restores date format

  Returns:
  --------
  <nFormat> => previous SET DATE format 1-5

  Syntax:
  -------
  SET_DATE([nFormatNew])

  Description:
  ------------
  Return current SET DATE setting <nFormat> and
  optionally set to new format [nFormatNew]

  [nFormatNew] =    1  American
                    2  British/French
                    3  German
                    4  ANSI
                    5  Italian

  Examples:
  ---------
   nOldformat := SET_DATE(5)

   ** SET TO ITALIAN

   * code

   * more code

   SET_DATE(nOldformat)   // restore to prior setting

  Source:
  -------
  S_SETDAT.PRG

 

SP_SETEXACT

Posted on by vivaclipper 
SETEXACT()

  Short:
  ------
  SETEXACT() Determines if exact is on/off

  Returns:
  --------
  <lExact> => Exact is on/off

  Syntax:
  -------
  SETEXACT([lNew])

  Description:
  ------------
  Returns current SET EXACT setting and optionally sets
  exact on/off with [lNew]  .t. = ON .f. = OFF

  Examples:
  ---------
   nOldexact = SETEXACT(.f.) // SET EXACT OFF

   * code

   SETEXACT(nOldexact)

  Source:
  -------
  S_SETEX.PRG

 

SP_SETCOLORS

Posted on by vivaclipper 
SETCOLORS()

  Short:
  ------
  SETCOLORS() Interactive color setting interface

  Returns:
  --------
  Nothing

  Syntax:
  -------
  SETCOLORS()

  Description:
  ------------
  This is a development tool for finding nice
  combinations of colors for the global superfunction colors. I would
  not give this to an end user, as it is just TOO MANY CHOICES! I
  normally select 10-15 nice combinations of the colors and give
  the user a selection of those, giving them such names as
  'Hawaiian Blue' or 'Royal Red'. In fact, see COLPIK() for just
  such a function.

  If SETBLINK() is set to False (.f.), the high
  intensity colors will be available - if your monitor supports them.

  Examples:
  ---------
   SETCOLORS()

  Notes:
  -------
  First, a word on the Superfunction color scheme:

  This is not the perfect color scheme. It is the one
  on which this library runs. (hey - I hadda pick something) I
  also realize full well that color selection is more art than it
  is technical, and it is difficult to get two people to agree on
  a color scheme.

  Several global color settings are used, and they are
  recorded and accessed via the functions:

     sls_normcol([cNew])    -  For normal input/output
     sls_normmenu([cNew])   -  For normal 'menu to' operations
     sls_popcol([cNew])     -  For popup box colors
     sls_popmenu([cNew])    -  For popup box menus
     sls_frame([cNew])      -  Frame string
     sls_shadatt([nNew])    -  Shadow color attribute
                              (numeric)
     sls_shadpos([nNew])    -  Shadow position (0,1,3,7,9)
     sls_xplode([lNew])     -  Logical - explode windows?

     (All of the colors are of the format "f/b,f/b,,,f/b"
      where f=foreground b=background)

  SETCOLORS() allows interactive setting of these
  colors. The settings can stored as color sets in COLORS.DBF -
  which is created if needed by SETCOLORS().

  If COLORS.DBF is not present, SuperLib will use a
  default set of colors.

  See the SATT*() functons, and the SLS_*() functions
  for more info.

  See the appendix for more general colors info.

  See the upgrade notes for more info on upgrading from
  older SuperLibs, which used a public variable scheme.

  Source:
  -------
  S_SETCOL.PRG

 

SP_SETCENT

Posted on by vivaclipper 
SETCENT()

  Short:
  ------
  SETCENT() Determines if century is on/off

  Returns:
  --------
  <lCentury> => Century is on/off

  Syntax:
  -------
  SETCENT([lCentury])

  Description:
  ------------
  Returns current SET CENTURY setting and optionally
  sets century on/off

  [lCentury]  True = ON False = OFF

  Examples:
  ---------
   lOldcentury := SETCENT(.f.)   //  SET CENTURY OFF

   // code

   SETCENT(lOldcentury)

  Source:
  -------
  S_SETCEN.PRG

 

SP_SEARCHMRS

Posted on by vivaclipper 
SEARCHMRS()

  Short:
  ------
  SEARCHMRS() Resets all SEARCHME() settings

  Returns:
  --------
  NIL

  Syntax:
  -------
  SEARCHMRS([)

  Description:
  ------------
  Resets all SEARCHME() static variables
    - sets found() flag to FALSE
    - sets locate block to nil
    - sets continue flag to .f.
    - sets ALIAS to nil

  For instance, if you change datafiles - you need to reset
  SEARCHME() with SEARMRS()

  Examples:
  ---------
  SEARCHMRS()

  Source:
  -------
  S_SEARCH.PRG

 

SP_SEARCHMFND

Posted on by vivaclipper 
SEARCHMFND()

  Short:
  ------
  SEARCHMFND() Set/return last found() status from SEARCHME()

  Returns:
  --------
  <lFound> -> Last searchme found() status

  Syntax:
  -------
  SEARCHMFND([lSet])

  Description:
  ------------
  Sets/retrieves the last found() setting for SEARCHME()
  [lSet] optionally sets the found() flag.

  For instance, to find out what the last result of SEARCHME() was
  so you can take an action or not based on something being found,
  use SEARCHMFND() to retrieve the last result.

  Examples:
  ---------
  SEARCHMFND(.f.)

  Source:
  -------
  S_SEARCH.PRG

 

SP_SEARCHME

Posted on by vivaclipper 
SEARCHME()

  Short:
  ------
  SEARCHME() Search a DBF with user-specified criteria

  Returns:
  --------
  <bSearch> -> The code block used to do the search

  Syntax:
  -------
  SEARCHME([aField,aFieldTypes,aFieldLengths],[aFieldDesc])

  Description:
  ------------
  Searches the current dbf with criteria given

  by the user.

       for :    Field Contents Match
                Query match  --->> calls QUERY()
                End of file
                Beginning of File
                Deleted Records
                Memo contents

  On subsequent calls, if the previous search resulted
  in a FOUND(), a box asking "Continue..", "New Search" will pop up.
  If CONTINUE is selected, a continuation of the last search is
  done.

  Three arrays may be passed for FIELDS [aFields],
  FIELD TYPES [aFieldTypes], and FIELD LENGTHS [aFieldLengths].

  An additional (optional) array of field descriptions may be passed

  Default is all fields, field names as descriptions.

  Searchme() actually returns the code block used to do the
  search. Normally you would want to ignore this. I use it in
  TAGIT() - if the code block is not NIL, then I can 'tag all
  matching' with it.

  Examples:
  ---------
  SEARCHME()

  Source:
  -------
  S_SEARCH.PRG