_UPDATE2.ZIP.x/DOCS/MCI.REF

10.8 KB 6357a912cb33075b…
`07
                  Telegard Bulletin Board Software, v3.10
                            REFERENCE: MCI Codes

                      Copyright (C) 1998 by Tim Strike
                            All Rights Reserved.


  The MCI codes can be globally used (except where noted).  The MCI codes
  are available for menu prompts, strings, and all display files.  Telegard
  will process the MCI codes and replace the codes with their correct
  values wherever it encounters the codes.  MCI codes are *not* active in
  message areas for specific reasons (and this will not change).

  Variable Options
  &1     variable MCI codes which depend on the strings being passed
  -&9       values are listed in default language file before values they
            affect
  &K     Returns YES/NO keys - default in upperase, other in lowercase
  &Y     Returns YES/NO default answer
  &D     Description overflow (file records only)

  OS/2 MCI Commands - ONLY AVAILABLE IN TELEGARD/2
  2P     OS/2 Communication Handle     ~2P 

  Archive Commands - ONLY ACTIVE WITH ARCHIVE/VIRUS SCANNER
  AF     filename to process
  AI     include filespec

  Current Connection
  CA     Baudrate                      ~CA
            if locked = locked rate
            if local  = 0
            else = baudrate (~ CB)
  CB     Baudrate (Local = 0)          ~CB
  CC     Group 1 Description           ~CC`07
  CD     Description of Modem          ~CD`07
  CE     Time Left (seconds)           ~CE
  CF     Node phone number             ~CF
         (if single node, returns ''
          else returns setting of node
          phone for the current node)
         ** This MCI can be used in **
         ** origin lines **
  CG     Group 1 Tag                   ~CG
  CH     Group 2 Description           ~CH`07
  CI     COM port IRQ                  ~CI
  CJ     COM port BASE I/O ADDRESS     ~CJ
  CK     Group 2 Tag                   ~CK
  CL     Locked Speed                  ~CL
  CM     Time Left (minutes)           ~CM
  CN     Node Number                   ~CN
         ** This MCI can be used in **
         ** origin lines **
  CO     Time Online/Active (hh:mm:ss) ~CO
  CP     COM port (Local = 0)          ~CP
  CQ     Chat reason                   ~CQ`07
  CR     Chat requests (#)             ~CR
  CS     Verbose connection speed      ~CS
  CT     Time Left (hh:mm:ss)          ~CT
  CU     ACS-Event start time          ~CU
  CV     ACS-Event left time           ~CV
  CW     Chat event start time         ~CW
  CX     Chat event left time          ~CX
  CY     Time Online/Active (minutes)  ~CY
  CZ     Filename of current menu      ~CZ

  Display Files (*.ANS/*.MSG/*.RIP/*.AVT)
  DA     Disable aborts
  DD     Disable screen pause
  DP     Enable screen pause
  DM     Enable More Y/N/C pause

  Extended Processing Commands - Affect next valid MCI code
  EC<n>      Center & Justify, expand to n characters
  ED         Convert YYYY date to YY date in date string
             (this will not be useful until YYYY dates are active)
  EE<n>      Create fill pattern of spaces to length <n>
  EFc<n>     Create fill pattern of character <c> to length <n>
  EI<n>{..}  Iterate string .. <n> times (curly brackets can't exist in string!)
  EL<n>      Flush-Left, expand to n characters
  EM         Convert to mixed case
  EN         Strip all spaces
  EPck       Will replace character c with character k in next string
  ER<n>      Flush-right, expand to n characters
  ES         Strip colour codes
  ET         Convert 24-hour time to 12-hour time ~ET~ST
  EU         Convert to uppercase
  EW         Convert to lowercase

  File Bases
  FB     File base name                ~FB`07
  FD     File base drive space (free)  ~FD
  FF     File base filename            ~FF
  FI     File base infofile name       ~FI
  FL     File base current CD-label    ~FL
            (CD-ROM areas only)
  FM     File base defined CD-label    ~FM
            (defined in base setup)
  FN     File base number              ~FN
  FP     File transfer protocol        ~FP`07
            (Note: only stored after transfer selected)
  FQ     # of tagged downloads         ~FQ
  FS     File pointer date             ~FS
  FT     Total # files in filebase     ~FT
  FU     Total # bytes in filebase     ~FU

  Caller ID - Current Call
  ID     Caller ID number              ~ID
         (for users last verified number, see VO)
  VO     Previous caller ID number     ~VO
  IN     Caller ID name                ~IN

  Message Bases
  MA     Message base address          ~MA
  MB     Message base name             ~MB`07
  MF     Message base filename         ~MF
  MH     Message - highest msg#        ~MH
  MI     Message base infofile name    ~MI
  ML     Message - lowest msg#         ~ML
  MN     Message base number           ~MN
  MO     Message - current msg#        ~MO
  MR     Message - lastread msg #      ~MR

  Offline mail (QWK) user settings
  OA     QWK archive setting           ~OA
  OB     bundle from user              ~OB
  OC     create BW *.XTI file          ~OC
  OD     include news file             ~OD
  OE     include welcome file          ~OE
  OF     include goodbye file          ~OF
  OG     include new files listing     ~OG
  OH     include qwk session listing   ~OH
  OI     include qwk pointer           ~OI
  ON     QWK packet name               ~ON

  Protocols - ONLY ACTIVE WITH PROTOCOLS
  PF     filename to send/receive
  PT     temporary path
  PL     temporary log filename

  Quoting MCI codes - ACTIVE ONLY IN QUOTE STRING
  QA     message from address
  QB     message board
  QD     message date
  QF     message from name
  QM     message date (month only - long)
  QS     message subject
  QT     message to name

  Restrictions
  RA     timebank account maximum      ~RA
  RB     kbytes dl/1k upload           ~RB
  RC     calls per day                 ~RC
  RD     downloads/1 uploads           ~RD
  RF     # files per day               ~RF
  RK     kbytes per day                ~RK
  RM     time/1 post (PTR)             ~RM
  RP     timebank deposit per day      ~RD
  RR     calls/1 post (PCR)            ~RR
  RT     time per day                  ~RT
  RW     timebank withdrawl per day    ~RW

  System Information/Commands
  SA     System Name (from config)     ~SA`07
  SB     System Location (from config) ~SB`07
  SC     Clear Screen
  SD     System Date (date format)     ~SD
  SE     Event Time                    ~SE
  SF     System Phone # (from config)  ~SF
  SG     Beep                          ~SG
  SH     Backspace
  SI     Backspace + Space + Backspace
  SJ     System Date (MM/DD/YY)        ~SJ
  SK     Reset line-count to 0
  SL     Command List                  ~SL
  SM     <CR> + Linefeed
  SN     Total number of callers       ~SN
  SO     Caller number                 ~SO
  SP     Pause screen                  ~SP
  SQ     Morning, afternoon, evening   ~SQ
  SR     <CR>
  SS     SysOp Name (from config)      ~SS`07
  ST     System Time                   ~ST
  SU     Environment & Version         ~SU
  SV     Telegard Version              ~SV
  SW     Wait/Delay 750ms              ~SW
  SX     Event Minutes                 ~SX
  SY     Wait/Delay 250ms              ~SY
  SZ     Telegard Version (/2, etc.)   ~SZ
  S!     Long system date & time       ~S!

  User Totals
  TA     Total public posts            ~TA
  TB     Total private posts           ~TB
  TC     Total netmail posts           ~TC
  TD     Post/Call Ratio (1:##)        ~TD
  TE     Total netmail credit          ~TE
  TF     Total netmail debit           ~TF
  TG     Available netmail credit      ~TG
  TH     Total Uploads (k)             ~TH
  TI     Total Uploads (#)             ~TI
  TJ     Total Downloads (k)           ~TJ
  TK     Total Downloads (#)           ~TK
  TL     Today Downloads (k)           ~TL
  TM     Today Downloads (#)           ~TM
  TN     Total File Points             ~TN
  TO     Total Time                    ~TO
  TP     Total Calls                   ~TP
  TQ     Total Calls Today             ~TQ
  TR     Total Illegal Logons          ~TR
  TS     Timebank today (+=dep,-=wd)   ~TS
  TT     Total Timebank                ~TT
  TU     Upload/Download Ratio (1:##)  ~TU
  TV     Ul/Dl KB Ratio (1:##)         ~TV
  TW     Post/Time Ratio (1:##)        ~TW

  User Information
  UA     Location                      ~UA`07
  UB     Street Name                   ~UB`07
  UC     Postal Code                   ~UC`07
  UD     Voice Phone                   ~UD
  UE     Data Phone                    ~UE
  UF     First Name                    ~UF`07
  UG     Gender                        ~UG
  UH     Handle                        ~UH`07
  UI     Laston Date                   ~UI
  UJ     Laston Time                   ~UJ
  UK     Firston Date                  ~UK
  UL     Last Name                     ~UL`07
  UM     Mailbox Status                ~UM
  UN     User Record #                 ~UN
  UO     Birthdate                     ~UO
  UP     User Age                      ~UP
  UR     Realname (full)               ~UR`07
  US     Security Level                ~US
  UT     Graphics Terminal Type        ~UT
  UU     User-ID                       ~UU
  UV     Graphics Terminal Fallback    ~UV
  UW     Graphics Terminal Type (num)  ~UW
  UX     Subscription Expiry Days      ~UX
  UY     Subscription Expiry Date      ~UY
  UZ     Subscription Level Desc       ~UZ`07

  User Settings
  VA     Hidden from caller logs       ~VA
  VB     Hidden from user list         ~VB
  VC     Clear Screen w/Msgs (On/Off)  ~VC
  VD     Date Format                   ~VD
  VE     Full Screen Editor            ~VE
  VF     Full Line Input (On/Off)      ~VF
  VG     Geographic Region             ~VG
            (note: VG is only really useful for (a)newusers and (b)prompts
            after geography region has been determined; otherwise it will
            default to United States)
  VH     Menu Hotkeys (On/Off)         ~VH
  VI     User Definable Note 1         ~VI`07
  VJ     User Definable Note 2         ~VJ`07
  VK     User Definable Note 3         ~VK`07
  VL     Language                      ~VL`07
  VM     Language (filename)           ~VM
  VN     Mailbox status (raw)          ~VN
            (note: Useful for parsing in scripts)
  VO     Previous caller ID number     ~VO
            (see ID/IN for current session information)
  VP     Screen Pause (On/Off)         ~VP
  VQ     Previous caller ID date       ~VQ
  VR     Previous caller ID time       ~VR
  VS     Screen Length                 ~VS
  VT     Transfer Protocol             ~VT
  VU     SysOp Comment                 ~VU`07
  VW     Screen Width                  ~VW
  VX     Expert Mode (On/Off)          ~VX
  VY     Lightbar menus                ~VY