home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #6 / amigamamagazinepolishissue1998.iso / coders / tooltypes / tooltypes.autodoc < prev    next >
Text File  |  1996-07-15  |  3KB  |  99 lines
  1. GetToolInt*                                                       GetToolInt*
  2.  
  3.    NAME
  4.       GetToolInt - to get integer ToolTypes
  5.  
  6.    SYNOPSIS
  7.       GetToolInt*(Pattern:ARRAY OF CHAR;Default:LONGINT):LONGINT
  8.  
  9.    FUNCTION
  10.       Searches for the ToolType in the Icon (or the commandline,
  11.       if CLI-startet) and, if there not found, for an env: Variable
  12.       with the name of the ToolType or an entry in the Configfile
  13.       and converts the String to an INTEGER-value.
  14.       If not found, uses the given default.
  15.  
  16.    INPUTS
  17.       Pattern: an ARRAY OF CHAR with the searched ToolType in it
  18.       Default: the default-value if tooltype not found
  19.  
  20.    RESULT
  21.       The value after tooltype (or default, if not found or not convertable)
  22.  
  23.    EXAMPLE
  24.  
  25.    NOTES
  26.  
  27.    BUGS
  28.  
  29.    SEE ALSO
  30.  
  31. GetToolRawStr*                                                 GetToolRawStr*
  32.  
  33.    NAME
  34.       GetToolRawStr - to get the String after a Congiguration Keyword without
  35.  
  36.                       any change
  37.    SYNOPSIS
  38.       GetToolRawStr* (Pattern:ARRAY OF CHAR;VAR in: Exec.STRING):BOOLEAN;
  39.  
  40.    FUNCTION
  41.       Searches for the ToolType in the Icon (or the commandline,
  42.       if CLI-startet) and, if there not found, for an env: Variable
  43.       with the name of the ToolType. If not there, it searches for
  44.       the Keyword in the Configuration-file (named Progname.cfg or
  45.       like the String in the "CONFIG" Keyword.
  46.       The entry in the configfile must start with an "#" at the first
  47.       column, like #TOOLTYPE=...
  48.  
  49.    INPUTS
  50.       Pattern: an ARRAY OF CHAR with the searched ToolType in it
  51.  
  52.    RESULT
  53.       in: an Exec.STRING with the raw String after the ToolType
  54.       FuncResult: FALSE if tooltype was not found
  55.  
  56.    EXAMPLE
  57.  
  58.    NOTES
  59.  
  60.    BUGS
  61.  
  62.    SEE ALSO
  63.  
  64. GetToolStr*                                                       GetToolStr*
  65.  
  66.    NAME
  67.       GetToolStr - to get the String after the tooltype without the "" or ''
  68.  
  69.    SYNOPSIS
  70.       GetToolStr* (Pattern:ARRAY OF CHAR;VAR in: ARRAY OF CHAR):BOOLEAN;
  71.  
  72.    FUNCTION
  73.       Searches for the ToolType in the Icon (or the commandline,
  74.       if CLI-startet) and, if there not found, for an env: Variable
  75.       with the name of the ToolType.
  76.       If not found, the Configfile (named ProgName.cfg) is used and
  77.       scanned for an parameter like #TOOLTYPE = ...
  78.     THIS IS NEEDET IN FIRST COLUMN--^
  79.       The name of the configfile may be changed by using the CONFIG=
  80.       ToolType
  81.  
  82.    INPUTS
  83.       Pattern: an ARRAY OF CHAR with the searched ToolType in it
  84.  
  85.    RESULT
  86.       in: an ARRAY OF CHAR with the String after the ToolType without "" or '
  87. '
  88.       FuncResult: FALSE if tooltype was not found
  89.  
  90.    EXAMPLE
  91.  
  92.    NOTES
  93.  
  94.    BUGS
  95.  
  96.    SEE ALSO
  97.  
  98.  
  99.