.TOPIC:                                             
Programmer's Reference Guide

                                             VBBS 6.12 Documentation -- 10-H-1


         ͻ
           CHAPTER TEN ANNEX H     PROGRAMMER'S REFERENCE GUIDE          
         ͼ

                This guide is a collection of the command formats for all
         the commands contained in the Virtual Script Language.  If you
         need more detail on a command all you need to do is look in the
         corresponding sectoin of the documentation.  All the commands are
         listed in the exact same format in both places so you may also
         do a text search for the command line.  Make sure that you read
         sections 1.4 and 1.5 for a listing of the format definitions and
         the list of restricted variables.

         

         NUMERIC OPERATORS
         

               +   -   *   /   ^


         NUMERIC FUNCTIONS
         

                 INT 0 ->  <variable1> = <value2> INT 0
                 SQR 0 ->  <variable1> = <value2> SQR 0
                   RND ->  <variable1> = <value1> RND <value2>


         STRING OPERATORS
         

                     & ->  <variable1> = <token3> & <token5> & <token7>


         STRING FUNCTIONS
         

                 ASC 0 ->  <variable1> = <string2> ASC 0
                 CHR 0 ->  <variable1> = <value2> CHR 0
                 LEN 0 ->  <variable1> = <string2> LEN 0
               UPPER 0 ->  <variable1> = <string2> UPPER 0
                 INSTR ->  <variable1> = <string2> INSTR <string3>
                   MID ->  <variable1> = <string2> MID <value3>
                  LEFT ->  <variable1> = <string2> LEFT <value3>


         STRING ALTERATIONS
         

                    JC ->  JC <variable1> <value2>
                    JL ->  JL <variable1> <value2>
                    JR ->  JR <variable1> <value2>


                                             VBBS 6.12 Documentation -- 10-H-2


         READING INPUT
         

                 GETYN ->  GETYN <variable1> <prompt>
                 GETNY ->  GETNY <variable1> <prompt>
                    RS ->  RS <variable1> <prompt>
                    RX ->  RX <variable1> <prompt>
                    RW ->  RW <variable1> <prompt>
                    RN ->  RN <variable1> <prompt>
                    RC ->  RC <variable1> <prompt>
                    RR ->  RR <variable1> <string2> <prompt>
                    RL ->  RL <variable1> <string2> <value3> <prompt>
                    RF ->  RF <variable1> <prompt>
                    RI ->  RI <variable1> <prompt>


         SHOWING LINE OUTPUT
         

                    TR ->  TR <token2> <token3> <token4> ... <token7>
                    TS ->  TS <token2> <token3> <token4> ... <token7>
                    %s ->  %s<number1> <variable2>
                    %i ->  %i<number1> <variable2>
                    %d ->  %d<number1>.<number2> <value3>


         COLORIZATION
         

                 ANSIC ->  ANSIC <color code>
              $<color> ->  $RED, $BLUE, $GREEN, $YELLOW, $MAGENTA,
                           $CYAN, $WHITE, $NORM, $BLACK
                Hearts ->  See description in main section.


         OTHER DISPLAY COMMANDS
         

                        EF ->  EF <pathfile1>
               DRAWWAITBAR ->  DRAWWAITBAR <value1>
                       LOC ->  LOC <value1> <value2>
                      MENU ->  MENU <filename1>
                   NEWPAGE <---
          SUSPENDPAGEBREAK <---
           RESUMEPAGEBREAK <---
                     PAUSE ->  PAUSE <prompt>


         DATABASE SELECTION
         

               DBGROUP ->  DBGROUP <group identifier>
                    DB ->  DB <database number>


                                             VBBS 6.12 Documentation -- 10-H-3


         LOAD RELATED COMMANDS
         

                  LOAD ->  LOAD <value1> <option>
            DISPLAYMSG <---
           DISPLAYTEXT <---


         EDITING COMMANDS
         

             ADDCOUNT ->  ADDCOUNT <value1>
              CLEANUP <---
               DBFLAG ->  DBFLAG <value1> <switch>
                  DEL ->  DEL <value1>
                 PACK <---
                   QS ->  QS <value1>
                 SAVE ->  See description in main section.
                SEARCH ->  SEARCH <value1> <number2> <string3>


         VIEWING AND WRITING
         

           CHOOSETOPIC <---
             LISTBASES <---
              NEXTBASE <---
              PREVBASE <---
                  POST <---
            READSEQMSG <---
            READNEWMSG <---
               SCANMSG <---
            SELECTBASE <---
          SETQUICKSCAN <---


         E-MAIL FUNCTIONS
         

               SETEMAIL <---
               FEEDBACK <---
              QUICKMAIL <---
           READALLEMAIL <---
          READEMAILFROM <---
            READEMAILTO <---
              SENDEMAIL <---


         BUFFER COMMANDS
         

          BUFFER APPEND ->  BUFFER APPEND <string1>
           BUFFER CLEAR <---
            BUFFER EDIT <---
            BUFFER LIST <---


                                             VBBS 6.12 Documentation -- 10-H-4


         INFORMATION COMMANDS
         

               CHECKFILE ->  CHECKFILE <variable1> <pathfile2>
               FINDFIRST ->  FINDFIRST <variable1> <pathfile2>
                FINDNEXT ->  FINDNEXT <variable1>
               FINDFILES <---
               LISTFILES <---
                NEWFILES <---
                   RATIO <---
              REVIEWFILE <---
           REVIEWUPLOADS <---
         SETNEWFILESSCAN ->  SETNEWFILESSCAN <value1>
               SEARCHALL <---
            TOPDOWNLOADS <---
                XFERTIME ->  XFERTIME <variable1> <pathfile2>


         TRANSFER COMMANDS
         

               BATCHDL <---
          DLMASTERLIST <---
              DOWNLOAD ->  DOWNLOAD <pathfile1>
          DOWNLOADFILE <---
          REMOTEUPLOAD <---
           SYSOPUPLOAD <---
                UPLOAD ->  UPLOAD <pathfile1>


         FILE EDITING
         

              EDITFILE <---
                 CLOSE <---
                  KILL ->  KILL <pathfile1>
                  OPEN ->  OPEN <pathfile1> <option>
                           <option> = INPUT, OUTPUT, APPEND
                  READ ->  READ <variable1>
                 WRITE ->  WRITE <token2> <token3> <token4> ... <token7>




         GENERAL REDIRECTION
         

                     # ->  # <label>
                  CALL ->  CALL <label>
                    GO ->  GO <label>
                   RET <---


                                             VBBS 6.12 Documentation -- 10-H-5


         LOOPS AND COMPARISONS
         

           DO LOOPS
           

             ->  DO <variable1> = <value2> <value3>
                    [body of the loop]
                 LOOP

             ->  DO WHILE <variable1>   {must store a numeric!}
                    [body of the loop]
                 LOOP

           IF/IFVAL STRUCTURES
           

             ->  IF <variable1> <relation> <variable2> THEN
                    [then-code]
                 ENDIF

             ->  IF <variable1> <relation> <variable2> THEN
                    [then-code]
                 ELSE
                    [else-code]
                 ENDIF


         TEST/TESTVAL COMMANDS
         

         ->  TEST <variable1> <relation> <variable2> <label>
         ->  TESTVAL <variable1> <relation> <variable2> <label>


         PASSING CONTROL
         

                  LINK ->  LINK <filename>
                  EXIT ->  EXIT <filename>
                 SHELL ->  SHELL <pathfile or DOS command line>
                  DOOR ->  DOOR <pathfile or DOS command line>
              RETURNFB -> RETURNFB <function block name>
          RETURNSCRIPT -> RETURNSCRIPT <script name>


                                             VBBS 6.12 Documentation -- 10-H-6


         VISUAL/INTERACTIVE
         

              AUTOPOST <---
           LISTCALLERS ->  LISTCALLERS <value1>
                LOGOFF <---
              LOGOFFYN <---
             PAGESYSOP <---
                RANDOM <---
                 STACK ->  STACK <variable1>
               SYSINFO <---
              VALIDATE <---
                   WHO <---


         USER MODIFIERS
         

               ACCOUNT <---
                ACTION ->  ACTION <string1>
            ADDCREDITS ->  ADDCREDITS <value1>
               ADDTIME ->  ADDTIME <value1>
            SETACCFLAG ->  SETACCFLAG <value1> <option>
                           <option> = ON, OFF
              SETEXTRA ->  SETEXTRA <value1> <string2>
              SETFLAGS ->  SETFLAGS <variable1> <option>
                           <option> = ON, OFF
                 SETSL ->  SETSL <value1>
          SETTIMELIMIT ->  SETTIMELIMIT <value1>
              USEREDIT <---


         REAL MISCELLANY
         

                     ! ->  ! <put your comments here>
                     & ->  & <filename>
                  BEEP <---
                 DELAY ->  DELAY <value1>
                   LOG ->  LOG <token2> <token3> <token4> ... <token7>

