home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / vdocs.zip / VC10H < prev    next >
Text File  |  1993-12-16  |  10KB  |  329 lines
  1. .TOPIC:                                             
  2. Programmer's Reference Guide
  3.  
  4.                                              VBBS 6.12 Documentation -- 10-H-1
  5.  
  6.  
  7.          ╔════════════════════════════════════════════════════════════════╗
  8.          ║  CHAPTER TEN ANNEX H     PROGRAMMER'S REFERENCE GUIDE          ║
  9.          ╚════════════════════════════════════════════════════════════════╝
  10.  
  11.                 This guide is a collection of the command formats for all
  12.          the commands contained in the Virtual Script Language.  If you
  13.          need more detail on a command all you need to do is look in the
  14.          corresponding sectoin of the documentation.  All the commands are
  15.          listed in the exact same format in both places so you may also
  16.          do a text search for the command line.  Make sure that you read
  17.          sections 1.4 and 1.5 for a listing of the format definitions and
  18.          the list of restricted variables.
  19.  
  20.          ═════════════════════════════════════════════════════════════════
  21.  
  22.          NUMERIC OPERATORS
  23.          ═════════════════
  24.  
  25.                +   -   *   /   ^
  26.  
  27.  
  28.          NUMERIC FUNCTIONS
  29.          ═════════════════
  30.  
  31.                  INT 0 ->  <variable1> = <value2> INT 0
  32.                  SQR 0 ->  <variable1> = <value2> SQR 0
  33.                    RND ->  <variable1> = <value1> RND <value2>
  34.  
  35.  
  36.          STRING OPERATORS
  37.          ════════════════
  38.  
  39.                      & ->  <variable1> = <token3> & <token5> & <token7>
  40.  
  41.  
  42.          STRING FUNCTIONS
  43.          ════════════════
  44.  
  45.                  ASC 0 ->  <variable1> = <string2> ASC 0
  46.                  CHR 0 ->  <variable1> = <value2> CHR 0
  47.                  LEN 0 ->  <variable1> = <string2> LEN 0
  48.                UPPER 0 ->  <variable1> = <string2> UPPER 0
  49.                  INSTR ->  <variable1> = <string2> INSTR <string3>
  50.                    MID ->  <variable1> = <string2> MID <value3>
  51.                   LEFT ->  <variable1> = <string2> LEFT <value3>
  52.  
  53.  
  54.          STRING ALTERATIONS
  55.          ══════════════════
  56.  
  57.                     JC ->  JC <variable1> <value2>
  58.                     JL ->  JL <variable1> <value2>
  59.                     JR ->  JR <variable1> <value2>
  60.  
  61.  
  62.                                              VBBS 6.12 Documentation -- 10-H-2
  63.  
  64.  
  65.          READING INPUT
  66.          ═════════════
  67.  
  68.                  GETYN ->  GETYN <variable1> <prompt>
  69.                  GETNY ->  GETNY <variable1> <prompt>
  70.                     RS ->  RS <variable1> <prompt>
  71.                     RX ->  RX <variable1> <prompt>
  72.                     RW ->  RW <variable1> <prompt>
  73.                     RN ->  RN <variable1> <prompt>
  74.                     RC ->  RC <variable1> <prompt>
  75.                     RR ->  RR <variable1> <string2> <prompt>
  76.                     RL ->  RL <variable1> <string2> <value3> <prompt>
  77.                     RF ->  RF <variable1> <prompt>
  78.                     RI ->  RI <variable1> <prompt>
  79.  
  80.  
  81.          SHOWING LINE OUTPUT
  82.          ═══════════════════
  83.  
  84.                     TR ->  TR <token2> <token3> <token4> ... <token7>
  85.                     TS ->  TS <token2> <token3> <token4> ... <token7>
  86.                     %s ->  %s<number1> <variable2>
  87.                     %i ->  %i<number1> <variable2>
  88.                     %d ->  %d<number1>.<number2> <value3>
  89.  
  90.  
  91.          COLORIZATION
  92.          ════════════
  93.  
  94.                  ANSIC ->  ANSIC <color code>
  95.               $<color> ->  $RED, $BLUE, $GREEN, $YELLOW, $MAGENTA,
  96.                            $CYAN, $WHITE, $NORM, $BLACK
  97.                 Hearts ->  See description in main section.
  98.  
  99.  
  100.          OTHER DISPLAY COMMANDS
  101.          ══════════════════════
  102.  
  103.                         EF ->  EF <pathfile1>
  104.                DRAWWAITBAR ->  DRAWWAITBAR <value1>
  105.                        LOC ->  LOC <value1> <value2>
  106.                       MENU ->  MENU <filename1>
  107.                    NEWPAGE <---
  108.           SUSPENDPAGEBREAK <---
  109.            RESUMEPAGEBREAK <---
  110.                      PAUSE ->  PAUSE <prompt>
  111.  
  112.  
  113.          DATABASE SELECTION
  114.          ══════════════════
  115.  
  116.                DBGROUP ->  DBGROUP <group identifier>
  117.                     DB ->  DB <database number>
  118.  
  119.  
  120.                                              VBBS 6.12 Documentation -- 10-H-3
  121.  
  122.  
  123.          LOAD RELATED COMMANDS
  124.          ═════════════════════
  125.  
  126.                   LOAD ->  LOAD <value1> <option>
  127.             DISPLAYMSG <---
  128.            DISPLAYTEXT <---
  129.  
  130.  
  131.          EDITING COMMANDS
  132.          ════════════════
  133.  
  134.              ADDCOUNT ->  ADDCOUNT <value1>
  135.               CLEANUP <---
  136.                DBFLAG ->  DBFLAG <value1> <switch>
  137.                   DEL ->  DEL <value1>
  138.                  PACK <---
  139.                    QS ->  QS <value1>
  140.                  SAVE ->  See description in main section.
  141.                 SEARCH ->  SEARCH <value1> <number2> <string3>
  142.  
  143.  
  144.          VIEWING AND WRITING
  145.          ═══════════════════
  146.  
  147.            CHOOSETOPIC <---
  148.              LISTBASES <---
  149.               NEXTBASE <---
  150.               PREVBASE <---
  151.                   POST <---
  152.             READSEQMSG <---
  153.             READNEWMSG <---
  154.                SCANMSG <---
  155.             SELECTBASE <---
  156.           SETQUICKSCAN <---
  157.  
  158.  
  159.          E-MAIL FUNCTIONS
  160.          ════════════════
  161.  
  162.                SETEMAIL <---
  163.                FEEDBACK <---
  164.               QUICKMAIL <---
  165.            READALLEMAIL <---
  166.           READEMAILFROM <---
  167.             READEMAILTO <---
  168.               SENDEMAIL <---
  169.  
  170.  
  171.          BUFFER COMMANDS
  172.          ═══════════════
  173.  
  174.           BUFFER APPEND ->  BUFFER APPEND <string1>
  175.            BUFFER CLEAR <---
  176.             BUFFER EDIT <---
  177.             BUFFER LIST <---
  178.  
  179.  
  180.                                              VBBS 6.12 Documentation -- 10-H-4
  181.  
  182.  
  183.          INFORMATION COMMANDS
  184.          ════════════════════
  185.  
  186.                CHECKFILE ->  CHECKFILE <variable1> <pathfile2>
  187.                FINDFIRST ->  FINDFIRST <variable1> <pathfile2>
  188.                 FINDNEXT ->  FINDNEXT <variable1>
  189.                FINDFILES <---
  190.                LISTFILES <---
  191.                 NEWFILES <---
  192.                    RATIO <---
  193.               REVIEWFILE <---
  194.            REVIEWUPLOADS <---
  195.          SETNEWFILESSCAN ->  SETNEWFILESSCAN <value1>
  196.                SEARCHALL <---
  197.             TOPDOWNLOADS <---
  198.                 XFERTIME ->  XFERTIME <variable1> <pathfile2>
  199.  
  200.  
  201.          TRANSFER COMMANDS
  202.          ═════════════════
  203.  
  204.                BATCHDL <---
  205.           DLMASTERLIST <---
  206.               DOWNLOAD ->  DOWNLOAD <pathfile1>
  207.           DOWNLOADFILE <---
  208.           REMOTEUPLOAD <---
  209.            SYSOPUPLOAD <---
  210.                 UPLOAD ->  UPLOAD <pathfile1>
  211.  
  212.  
  213.          FILE EDITING
  214.          ════════════
  215.  
  216.               EDITFILE <---
  217.                  CLOSE <---
  218.                   KILL ->  KILL <pathfile1>
  219.                   OPEN ->  OPEN <pathfile1> <option>
  220.                            <option> = INPUT, OUTPUT, APPEND
  221.                   READ ->  READ <variable1>
  222.                  WRITE ->  WRITE <token2> <token3> <token4> ... <token7>
  223.  
  224.  
  225.  
  226.  
  227.          GENERAL REDIRECTION
  228.          ═══════════════════
  229.  
  230.                      # ->  # <label>
  231.                   CALL ->  CALL <label>
  232.                     GO ->  GO <label>
  233.                    RET <---
  234.  
  235.  
  236.                                              VBBS 6.12 Documentation -- 10-H-5
  237.  
  238.  
  239.          LOOPS AND COMPARISONS
  240.          ═════════════════════
  241.  
  242.            DO LOOPS
  243.            ────────
  244.  
  245.              ->  DO <variable1> = <value2> <value3>
  246.                     [body of the loop]
  247.                  LOOP
  248.  
  249.              ->  DO WHILE <variable1>   {must store a numeric!}
  250.                     [body of the loop]
  251.                  LOOP
  252.  
  253.            IF/IFVAL STRUCTURES
  254.            ───────────────────
  255.  
  256.              ->  IF <variable1> <relation> <variable2> THEN
  257.                     [then-code]
  258.                  ENDIF
  259.  
  260.              ->  IF <variable1> <relation> <variable2> THEN
  261.                     [then-code]
  262.                  ELSE
  263.                     [else-code]
  264.                  ENDIF
  265.  
  266.  
  267.          TEST/TESTVAL COMMANDS
  268.          ═════════════════════
  269.  
  270.          ->  TEST <variable1> <relation> <variable2> <label>
  271.          ->  TESTVAL <variable1> <relation> <variable2> <label>
  272.  
  273.  
  274.          PASSING CONTROL
  275.          ═══════════════
  276.  
  277.                   LINK ->  LINK <filename>
  278.                   EXIT ->  EXIT <filename>
  279.                  SHELL ->  SHELL <pathfile or DOS command line>
  280.                   DOOR ->  DOOR <pathfile or DOS command line>
  281.               RETURNFB -> RETURNFB <function block name>
  282.           RETURNSCRIPT -> RETURNSCRIPT <script name>
  283.  
  284.  
  285.                                              VBBS 6.12 Documentation -- 10-H-6
  286.  
  287.  
  288.          VISUAL/INTERACTIVE
  289.          ══════════════════
  290.  
  291.               AUTOPOST <---
  292.            LISTCALLERS ->  LISTCALLERS <value1>
  293.                 LOGOFF <---
  294.               LOGOFFYN <---
  295.              PAGESYSOP <---
  296.                 RANDOM <---
  297.                  STACK ->  STACK <variable1>
  298.                SYSINFO <---
  299.               VALIDATE <---
  300.                    WHO <---
  301.  
  302.  
  303.          USER MODIFIERS
  304.          ══════════════
  305.  
  306.                ACCOUNT <---
  307.                 ACTION ->  ACTION <string1>
  308.             ADDCREDITS ->  ADDCREDITS <value1>
  309.                ADDTIME ->  ADDTIME <value1>
  310.             SETACCFLAG ->  SETACCFLAG <value1> <option>
  311.                            <option> = ON, OFF
  312.               SETEXTRA ->  SETEXTRA <value1> <string2>
  313.               SETFLAGS ->  SETFLAGS <variable1> <option>
  314.                            <option> = ON, OFF
  315.                  SETSL ->  SETSL <value1>
  316.           SETTIMELIMIT ->  SETTIMELIMIT <value1>
  317.               USEREDIT <---
  318.  
  319.  
  320.          REAL MISCELLANY
  321.          ═══════════════
  322.  
  323.                      ! ->  ! <put your comments here>
  324.                      & ->  & <filename>
  325.                   BEEP <---
  326.                  DELAY ->  DELAY <value1>
  327.                    LOG ->  LOG <token2> <token3> <token4> ... <token7>
  328.  
  329.