home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / GENUTIL / FKFOS102.ZIP / VARIABLE.REF < prev   
Text File  |  1994-12-27  |  21KB  |  354 lines
  1.  
  2.                            _______________________
  3.  
  4.                            VARIABLES AND CONSTANTS
  5.                            _______________________
  6.  
  7.              The following guide is a quick reference chart to all variables
  8.         and constants the FKFOSSIL provides.  This reference file is a
  9.         trimmed copy of the information found in the FKFOSSIL.DOC file.
  10.  
  11.         CONSTANTS
  12.         --------------------------------------------------------------------
  13.         fk_StandardInput = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUV'
  14.                           +'WXYZ1234567890~!@#$%^&*()-+\[]{};:`''".,/<> =_?|'
  15.         fk_highBitInput  = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUV'
  16.                           +'WXYZ1234567890~!@#$%^&*()-+\[]{};:`''".,/<> =_?|'
  17.                           +'ÇüéâäàåçêëèïîìÄÅÉæÆôöòûùÿÖÜ¢£¥₧ƒáíóúñѪº¿⌐¬½¼¡«'
  18.                           +'»░▒▓│┤╡╢║╕╣║╗╝╜╛┐└┴┬├─┼╞╟╚╔╩╦╠═╬╧╨╤╥╙╘╒╓╫╪┘┌█▄▌▐'
  19.                           +'▀αßΓπΣσµτΦΘΩδ∞φε∩≡±≥≤⌠⌡÷≈°∙·√ⁿ²■';
  20.         fk_FilenameInput = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUV'
  21.                           +'WXYZ1234567890~!@#$%^&()-_{}.';
  22.         fk_FilespecInput = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUV'
  23.                           +'WXYZ1234567890~!@#$%^&()-_{}.?*';
  24.         fk_FilepathInput = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUV'
  25.                           +'WXYZ1234567890~!@#$%^&()-_{}.?*:\';
  26.         fk_NumberInput   = '123456790.-+';
  27.  
  28.         fk_DriverVersion = '1.02';
  29.         fk_DriverName    = 'Forbidden Knights Fossil Driver Unit';
  30.         fk_DriverAuthor  = 'Tim Strike';
  31.         On               = True;
  32.         Off              = False;
  33.  
  34.  
  35.         FOSSIL INFORMATION
  36.         ---------------------------------------------------------------------
  37.         The Fossil Information Variables contain information on the fossil
  38.         driver version and the connection information.  Do *NOT* set any of
  39.         these variables yourself unless you know what you are doing.
  40.  
  41.         fk_Fossil.Started      Boolean  True if fk_InitFossil has been
  42.                                         called. If false, the other fossil
  43.                                         dependant routines will not run.
  44.  
  45.         fk_Fossil.Port         Longint  Current port
  46.         fk_Fossil.Baud         Longint  Current connection BPS rate
  47.         fk_Fossil.Locked       Longint  Current locked BPS rate
  48.         fk_Fossil.Carrier      Boolean  True if there is a modem carrier
  49.  
  50.         fk_Fossil.Driver       Str(80)  Fossil Driver Name
  51.         fk_Fossil.Version      Byte     Fossil Driver Major Version No.
  52.         fk_Fossil.Revision     Byte     Fossil Driver Minor Revision No.
  53.  
  54.  
  55.         PROGRAM INFORMATION
  56.         ---------------------------------------------------------------------
  57.         fk_ProgramInfo.Title   Str(25)  Your Program Title
  58.         fk_ProgramInfo.Version Str(8)   Program Version
  59.         fk_ProgramInfo.Author  Str(20)  Author Information
  60.         fk_ProgramInfo.Other   Str(20)  Other Information
  61.  
  62.  
  63.         TASK INFORMATION
  64.         ---------------------------------------------------------------------
  65.         The Task Information variables contain all the information on the
  66.         current task type.  These variables are automatically tested for when
  67.         your program is run, and should *NOT* be changed at all.
  68.  
  69.         fk_Task.System         Str(15)  Contains name and version of OS;
  70.                                         Supports DOS, Windows, DESQview and
  71.                                         OS/2.  All OS's compatible with DOS
  72.                                         will be listed as "DOS".
  73.  
  74.         fk_Task.Tasktype       Byte     Contains the task type;  0  DOS
  75.                                                                  1  DESQview
  76.                                                                  2  OS/2
  77.                                                                  3  Windows
  78.  
  79.         fk_Task.Window         Integer  Active window number (DESQview Only)
  80.         fk_Task.Share          Boolean  If SHARE is active (use for file
  81.                                         sharing test -- see the section on
  82.                                         FILE SHARING)
  83.  
  84.  
  85.         CLIENT INFORMATION
  86.         ---------------------------------------------------------------------
  87.         DS   indicates this variable can be retrieved via DOOR.SYS.
  88.         DI   indicates this variable can be retrieved via DORINFO#.DEF.
  89.         MI   indicates this is required information and is set through the
  90.              fk_InitFossil routine if the doorfiles aren't read.
  91.  
  92.         fk_Client.BBSName      Str(35)  BBS System Name             DI
  93.         fk_Client.Calls        Longint  # of Calls                  DS
  94.         fk_Client.Citystate    Str(30)  User's City/State           DS,DI
  95.         fk_Client.Downloads    Longint  # of Downloads              DS
  96.         fk_Client.Firstdate    Str(8)   First Calling Date
  97.         fk_Client.Handle       Str(35)  User's Handle               MI,DS,DI
  98.         fk_Client.HomePhone    Str(15)  Home/Voice Phone Number     DS
  99.         fk_Client.Lastdate     Str(8)   Last Calling Date           DS
  100.         fk_Client.Lasttime     Str(5)   Last Calling Time
  101.         fk_Client.Name         Str(35)  User's Real Name            MI,DS,DI
  102.         fk_Client.Pagelength   Byte     Pagelength                  DS
  103.         fk_Client.Password     Str(30)  User's Password             DS
  104.         fk_Client.RecordPos    Longint  Record Position (file)      DS
  105.         fk_Client.Screentype   Byte     Screen Mode;  0  TTY        MI,DS,DI
  106.                                                       1  ANSI
  107.                                                       2  AVATAR
  108.         fk_Client.Security     Longint  Security Level              DS,DI
  109.         fk_Client.SysOpName    Str(35)  BBS SysOp Name              DI
  110.         fk_Client.Timeleft     Longint  Time Remaining (seconds)    MI,DS,DI
  111.         fk_Client.Uploads      Longint  # of Uploads                DS
  112.         fk_Client.WorkPhone    Str(15)  Work/Data Phone             DS
  113.  
  114.         If the information isn't gathered, default (empty/nul) values will be
  115.         given for each of the fields.
  116.  
  117.  
  118.         MUSIC INFORMATION
  119.         ---------------------------------------------------------------------
  120.         fk_Music.Musictype     Byte     Current Music Type;  6  Staccato
  121.                                                              7  Normal
  122.                                                              8  Legato
  123.  
  124.         fk_Music.Notelength    Byte     Note Length (default  = 4, Quarter)
  125.         fk_Music.Octave        Byte     Current Octave (default = 4)
  126.         fk_Music.Tempo         Byte     Current Tempo (default = 120)
  127.  
  128.  
  129.         HOST INFORMATION
  130.         ---------------------------------------------------------------------
  131.         fk_Host.AnsiTimer      Word     Countdown for Ansi Detection.  If
  132.                                         this count down reaches 0 before the
  133.                                         codes are received, the fk_AnsiDetect
  134.                                         routine will return false.
  135.                                         (default = 2500)
  136.  
  137.         fk_Host.Blink          Boolean  Blinking Attribute.  Used by the
  138.                                         colour routines; it is not suggested
  139.                                         that you reset the value of this
  140.                                         variable.
  141.  
  142.  
  143.         fk_Host.Clock          Boolean  Decrease Time and Increase Lastkey.
  144.                                         If FALSE, then time will not be
  145.                                         counted (could be used for intensive
  146.                                         procedures -- or during chat or
  147.                                         something similar).  It is a lot
  148.                                         better to use fk_Clock to turn the
  149.                                         time on and off, since the fk_Clock
  150.                                         routine will take care of all the
  151.                                         variables that fk_Host.Clock affects.
  152.                                         (default = TRUE)
  153.  
  154.         fk_Host.CurrentInput   Str(80)  The default output for fk_Readln.
  155.                                         Sets up the string for fk_Readln with
  156.                                         this value -- this value is NOT
  157.                                         written to the screen (you should do
  158.                                         this) but will be used as if the user
  159.                                         had already typed this in.
  160.  
  161.         fk_Host.Error          Byte     Contains information on the last
  162.                                         run procedure;
  163.  
  164.                                         0   No Errors
  165.                                         1   Fossil Driver Not Initialized
  166.                                         2   Error Initializing Fossil Driver
  167.                                         9   File Not Found
  168.                                         10  Function Not Compatible with
  169.                                                Users Screen Mode
  170.                                         11  Invalid Call to Function
  171.  
  172.         fk_Host.ExitCode       Byte     Contains exit code that
  173.                                         fk_DeInitFossil will exit with.  If
  174.                                         your program encounters an error (and
  175.                                         you wish to exit with a different
  176.                                         errorlevel) set this variable and
  177.                                         then call fk_DeInitFossil.
  178.                                         (default = 0)
  179.  
  180.         fk_Host.High           Boolean  High-Bit (bright foreground).  Used
  181.                                         by the colour routines; it is not
  182.                                         suggested that you reset the value of
  183.                                         this variable.
  184.  
  185.         fk_Host.HostScreen     Boolean  Send information to local screen -
  186.                                         If FALSE, no information from any of
  187.                                         the fk_Write[ln] functions will be
  188.                                         sent to the local screen (although
  189.                                         the status bar will still be active)
  190.                                         (default = TRUE)
  191.  
  192.         fk_Host.Hostkey        Boolean  Get information from local keyboard -
  193.                                         If FALSE, no keys pressed on the
  194.                                         local side will be processed during
  195.                                         any of the fk_Read[ln] functions.
  196.                                         (default = TRUE)
  197.  
  198.         fk_Host.Inactivity     Word     Count down in seconds for user
  199.                                         Inactivity.  If the user does not hit
  200.                                         a key for this number of seconds,
  201.                                         the program will automatically end.
  202.                                         (default = 180 seconds, 3 minutes)
  203.  
  204.         fk_Host.Lastbg         Byte     Last background attribute
  205.         fk_Host.Lastfg         Byte     Last foreground attribute
  206.         fk_Host.Mono           Boolean  Monochrome Monitor (local)
  207.  
  208.                                         ** All three variables are used by
  209.                                         the colour/write routines.  It is not
  210.                                         suggested that they be changed and
  211.                                         should be used for reference only
  212.                                         (otherwise you create the risk of
  213.                                         messing up your program).
  214.  
  215.         fk_Host.Multinode      Boolean  Stores whether the system is running
  216.                                         in a multinode environment.  If TRUE,
  217.                                         the value of fk_Host.Node will be
  218.                                         displayed on the status line.
  219.  
  220.         fk_Host.Node           Byte     Stores the node number value.  This
  221.                                         will be used when reading/writing door
  222.                                         drop files, and also displayed on the
  223.                                         status line if the fk_Host.Multinode
  224.                                         is TRUE.
  225.                                         (default = 1)
  226.  
  227.  
  228.         fk_Host.OutputChar     Char     Send this character in the fk_Readln
  229.                                         function.  Since the fk_Readln reads
  230.                                         in characters and displays them, this
  231.                                         function can be used to override the
  232.                                         character returned.  If it's set to
  233.                                         CHR(0) then whatever the user types
  234.                                         will be returned.  However, if it's
  235.                                         set to say, CHR(178) then the ▓
  236.                                         character will be sent, regardless of
  237.                                         what the user typed.  This is a good
  238.                                         function for password input or other
  239.                                         sensitive items.  ALWAYS MAKE SURE
  240.                                         THAT YOU RESET THE VALUE TO CHR(0)!
  241.  
  242.         fk_Host.Outputlines    Word     The number of output lines sent to
  243.                                         the user.  This is handy if you want
  244.                                         to have screen pauses -- Just check
  245.                                         this value, if it's greater then the
  246.                                         screen length, pause for a key and
  247.                                         reset this variable.  In some areas,
  248.                                         after you clear a screen or any other
  249.                                         sort of "pause", you may wish to
  250.                                         reset the value.
  251.  
  252.         fk_Host.RemoteScreen   Boolean  Send information to remote screen -
  253.                                         If FALSE, no information from any of
  254.                                         the fk_Write[ln] functions will be
  255.                                         sent to the remote screen (although
  256.                                         the status bar will still be active)
  257.                                         (default = TRUE)
  258.  
  259.         fk_Host.Remotekey      Boolean  Get information from remote buffer -
  260.                                         If FALSE, no keys pressed on the
  261.                                         remote side will be processed during
  262.                                         any of the fk_Read[ln] functions.
  263.                                         (default = TRUE)
  264.  
  265.         fk_Host.Sound          Boolean  Local Sound Toggle - if in Local mode
  266.                                         the default is TRUE, otherwise the
  267.                                         default is FALSE.  To hear any Ansi
  268.                                         Music or CHR(7) Beeps locally, this
  269.                                         variable needs to be TRUE.
  270.  
  271.         fk_Host.StatuslineBuf  Byte     The number of blank lines setup
  272.                                         before the actual status line.
  273.                                         (default = 1)
  274.  
  275.         fk_Host.StatuslinePos  Byte     The position of the status line.
  276.                                         (default = 25)
  277.  
  278.                                         0     will disable the status line
  279.  
  280.                                         1-10  will place the active window
  281.                                               below the status line position.
  282.  
  283.                                         11-25 will place the active window
  284.                                               above the status line position.
  285.  
  286.         fk_Host.StrictColour   Boolean  If TRUE, then if the user is in TTY
  287.                                         mode any colour changes will be
  288.                                         ignored.  If FALSE and the user is in
  289.                                         TTY mode, all changes of colour will
  290.                                         be displayed as normal locally.
  291.                                         (default = TRUE)
  292.  
  293.         fk_Host.Timeslice      Boolean  If TRUE, FKFOSSIL will attempt to
  294.                                         give up unused timeslices to the
  295.                                         OS/Multitasker. (default = TRUE)
  296.  
  297.         fk_Host.Titleline      Boolean  If TRUE and the status line position
  298.                                         is 25, then a second title line will
  299.                                         be added at line 24.  On this line,
  300.                                         the information in the fk_ProgramInfo
  301.                                         variables will be displayed.
  302.                                         (default = FALSE)
  303.  
  304.         fk_Host.ValidInput     String   Determines the allowable characters
  305.                                         for the fk_Readln function.  If you
  306.                                         set this string to 'ABC' then the
  307.                                         fk_Readln function will only accept
  308.                                         an A, B or C.  Several constants have
  309.                                         been provided so that you don't need
  310.                                         to type in all the characters all the
  311.                                         time. (default = fk_StandardInput)
  312.  
  313.         fk_Host.WaitforChar    Boolean  If TRUE, the fk_Read function will
  314.                                         wait for a character, otherwise it
  315.                                         won't.  The MUCH better alternative
  316.                                         to this variable is the function
  317.                                         fk_NoWaitRead since you won't need to
  318.                                         remember to reset the variable.
  319.                                         (default = TRUE)
  320.  
  321.         fk_Host.WarningBell    Boolean  TRUE if warning bell (inactivity
  322.                                         timeout) has been sent to the user.
  323.         fk_Host.WarningTime    Boolean  TRUE if timeleft warning has been
  324.                                         sent to the user.
  325.  
  326.                                         ** It is not suggested that the
  327.                                         warning variables be reset, unless
  328.                                         there is a specific need.  FKFOSSIL
  329.                                         will automatically handle the warning
  330.                                         variables itself.
  331.  
  332.  
  333.         COLOUR INFORMATION
  334.         ---------------------------------------------------------------------
  335.         fk_Host.Colour.Baud             Baud Rate         (default =  9,1)
  336.         fk_Host.Colour.Handle           Handle            (default = 11,1)
  337.         fk_Host.Colour.InfoDesc         Descriptors       (default =  9,1)
  338.         fk_Host.Colour.Lastkey          Lastkey Timer     (default = 11,1)
  339.         fk_Host.Colour.Multitasker      Multitasker Type  (default =  9,1)
  340.         fk_Host.Colour.Name             Real Name         (default = 14,1)
  341.         fk_Host.Colour.Node             Node Marker       (default =  9,1)
  342.         fk_Host.Colour.NoTimeleft       No User Time Left (default = 12,1)
  343.         fk_Host.Colour.Screentype       Emulation Mode    (default =  9,1)
  344.         fk_Host.Colour.Statusline       Empty Space       (default =  1,1)
  345.         fk_Host.Colour.Timeleft         User Time Left    (default = 11,1)
  346.         fk_Host.Colour.Titleline        Program Info      (default = 11,1)
  347.         fk_Host.Colour.Warning          Warning Sent      (default = 12,1,B)
  348.  
  349.         For monochrome monitors the attributes are all set to black on white
  350.         (reverse video) and should easily be seen.  Let me know, I don't have
  351.         a mono monitor. ;)  For colour monitors, the default is listed in the
  352.         righthand column (foreground, background, blink).
  353.  
  354.