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