A-Shell XCALL Reference General Information Using This Document CHM Files A-Shell Doc Overview Available Docs Organization File Types Updates Locations Feedback Updates Introduction Limits and Capacities Creating Routines Configurable Routines Routines by Name Routines by Type Detailed Descriptions ABOX ACCEPT, ACCEPN ACCESS AMOS ANYCN ASCEBC, EBCASC ASFLAG Read Only Synchronized Write Memory Mapping No IDX Lock Local Copy Force Control-C to Parent AUI Control Parameters opcode ctlid ctext cstate Dialog Positioning Tip ctype MBF_DLGNOCREEP Alternate Dialog Coordinate System cmd Windows Command Line Keyboard Commands Shell execute Subroutine (SBX) Accelerator func cstatus srow, scol, erow, ecol Millirows Millicolumns fgc, bgc fontattr fontscale fontface tooltip parentid winclass winstyle winstylex ctype2 Control Methods (Opcodes) Query Control Add Control Change Control Delete Control Clear Control Query Checkbox Save/Restore Controls Batch Operations Get Control ID Set Current Tab Pane Control Types Static Text Control Lines, Rectangles and Frames Button Control Groupbox Control Groupbox + MBF_ALTPOS Checkbox Control Checkbox Alignment, Justification Radio button Control Animated Graphics Control Icon Control Static Icon Control Icon Library Button Icon Control Icons: Static vs. Button Bitmap Control Edit Control (INFLD) Up/Down Control (INFLD) Multi-line Edit Control (INFLD) Combo Box Control (INFLD) Text Mode Compatibility Coded Lists Self Service Combo Box Date Picker Control (INFLD) Time Picker Control (INFLD) Month Calendar Control position winstyle Operations Modal Dialog Box Control Modeless Dialog Progress Bar Control Tab Control Tab Control Example Image Control Static Image Control Button Image Control Other Control Topics ATE Optimization XP Themes Control names Scaling Logic Height of Controls Control Alignment Eventwait Parameter List parentid ctlid exitcode opflags EVW_NOWRAP EVW_NUMERIC EVW_DESCEND EVW_SIBLINGS EVW_SQUELCH EVW_ACCEL EVW_RAW EVW_EXCDFOCUS EVW_EXCDINOUT Comments Environment Menu Traditional Method Opcode MNUOP_RST Menuid Mnutxt Mstate Mtype Cmd Func Mstatus Dlgid Itemid Simplified Method Sample.mdf Context Menus Menu Icons Checked and Radio Button Menu Items AUI_MENU Enhancements Display Images Flag MBF_MENUID Internal Menu Items Reference Image Window HTMLHelp B64ENC BASORT BITOPS BLOCKS CCON, CCOFF CGIUTL CGI Status Retrieve stdin Retrieve single parameter Copy disk file to stdout Write string to stdout Retrieve envvar into envdef General custom file from template Retrieve multiple parameters CHKONE CMDR COMIO COMMON CONDEV CRC16 DATES DELCHR DEVCHK DSKCOM DSKPPN DSTOI ECHO EFS EMAILP ERRMSG EZSPL Old Format New Format EZ-SPOOL Processing EZTYP F2HOST FIFO FILNAM FLOCK FORCE FTPDLX Environmental Notes Debugging FTPDLX Error Codes wodFTPDLX.DLL Error Codes FTP Protocol return codes Certificate Errors Winsock Errors GDIPRT GET Inputting from a serial device GETADR GETBYT GETDEV GETJOB GETJTB GETMAC GETPPN GETPRG GETUSN GETVER GETX GRECNV GTLANG HOST2F HOSTEX Command Modifiers Launching A-Shell with HOSTEX HTMLP HTTP IDTIM IMAGE Load Close Display Open and Display Retrieve Information Remove from Display Acquire Select Data Source Get TWAIN Error Status Codes INCOM INFLD Parameters row col xmax type Character Type Acceptance Control character input Currency field Date input Date input, today Yes/NO field Phone number or zip code input Time input format European date YES/No field setdef qualifier Numeric Formatting Codes Allow decimal point Allow minus sign Thousands separator Right justify field Value range checking Zero fill Date/Time Formatting Codes Convert date format Allow date shortcuts HexaDecade dates (1) HexaDecade dates (2) Julian date format Time field Timer-related Codes GUI-related Codes Active Versus Inactive Behavior Convert Y/N field to checkbox Force fixed-pitch font Force modified fixed-pitch font Activate GUI enhancements Right Justify Checkbox Text Select data entry convention Create a radio button Field Markers Auto-Complete Auto-Complete Illustrations Auto-Complete Examples Auto-Complete Comments and Limitations Miscellaneous Codes Force destructive enter Disable bright and dim Enable protected fields Start cursor at end Clear bottom line Disable character blanking Disallow blanks Abort allowed Fast input Form Field Return updated field contents Use invisible field markers Disable the INFLD.DEF option Return null Disallow record abort key Prehistoric Compatibility Mode Do not redisplay field Read only Program Control-X Convert to upper case (1) Convert to upper case (2) Exit Key Enabling Codes Type Codes Summary entry inxctl parentid opcode exitcode timer cmdflg INFCF_CMDFIL INFCF_DROPDOWN INFCF_EXISTING INFCF_DISABLE defpt maxpt funmap setdef List of Complete Inputs Dummy List of Inputs List of Paired Inputs Date or Value Range Checking Character Acceptance List Invalid Input Message infclr hlpidx Tool tips Mouse Click Strings Help Keys Context Menu Handling maxchrs External Parameters INFLD Definition File Miscellaneous Topics Screen snapshots Pop-up Utilities Telnet Keepalive Update Notes INMEMO Update Notes ISMBLD ISMROK ITC JOBCMD JOBDAT JOBNUM JOBTRM JULCVT LOKOUT LOG LSTLIN MATCH MIAMEX MIAMEX Functions by Number MIAMEX Functions by Symbol MIAMEX Routines by Type MIAMEX 1: Set/get command file status MIAMEX 2: Exit A-Shell MIAMEX 3: Perform FSPEC on AMOS string MIAMEX 4: Get Control-C status MIAMEX 5: Get echo status MIAMEX 6: Set command prompt MIAMEX 7: Get hex output status MIAMEX 8: Set/reset hex mode MIAMEX 9: Output hex or octal number MIAMEX 10: Check for PPN MIAMEX 11: Get ersatz information MIAMEX 12: Get A-Shell version MIAMEX 13: Get/set Tracker flags MIAMEX 14: Call into VUE editor MIAMEX 15: Call into BASIC compiler MIAMEX 16: Call into PREBAS pre-compiler MIAMEX 17: Synchronize directories MIAMEX 18: Get next line of command file MIAMEX 19: Get device definition MIAMEX 20: Get first matching file MIAMEX 21: Find next matching file MIAMEX 22: Get directory separator char MIAMEX 23: End directory search MIAMEX 24: Get command prompt MIAMEX 25: Get file hash total MIAMEX 26: Format last file spec MIAMEX 27: Copy file MIAMEX 28: Output error message MIAMEX 29: Output rename error message MIAMEX 30: Get queue block contents MIAMEX 31: Get environment variable MIAMEX 32: Set default file extension MIAMEX 34: Get ISAM version and serial MIAMEX 36: Get AMOS hash mode status MIAMEX 37: Set/reset AMOS hash mode MIAMEX 38: Create path MIAMEX 39: Delete path MIAMEX 41: Zap jobtbl and queue blocks MIAMEX 50: Get LOKSER status MIAMEX 51: Set LOKSER status MIAMEX 52: Get CMD file input status MIAMEX 53: Set CMD file input status MIAMEX 54: Get signal received status MIAMEX 55: Clear signal received status MIAMEX 56: Define environmental variable MIAMEX 57: Send signal to another process MIAMEX 59: Get OPTIONS flags MIAMEX 60: Set OPTIONS flags MIAMEX 61: Get TRACE flags MIAMEX 62: Set TRACE flags MIAMEX 63: Load PFK file MIAMEX 64: Display loaded PFK filename MIAMEX 65: Manage screen picture MIAMEX 66: Rebuild queue MIAMEX 67: Lock queue MIAMEX 68: Unlock queue MIAMEX 69: Get UMASK MIAMEX 70: Set UMASK MIAMEX 72: Print msg from msg file MIAMEX 73: Read job control block MIAMEX 74: Write job control block MIAMEX 75: Get system time MIAMEX 76: Start telnet server MIAMEX 77: Show window MIAMEX 78: Get global DO params MIAMEX 79: Set global DO params MIAMEX 80: Get XCALL param info MIAMEX 81: Get/set params in SBX MIAMEX 82: Exit SBX MIAMEX 83: Get FKEYWAIT time MIAMEX 84: Set FKEYWAIT time MIAMEX 85: Get or set window title MIAMEX 86: Get error message MIAMEX 87: Disable stream buffering MIAMEX 88: Flush stream buffer MIAMEX 89: Clone file channel MIAMEX 90: Get/set beveling options MIAMEX 91: Get/set background color MIAMEX 92: Enable/disable PolyShell keys MIAMEX 93: Get ABOUT info MIAMEX 94: Get cursor position MIAMEX 95: Display open file dialog MIAMEX 96: Shell execute MIAMEX 97: Make directory MIAMEX 99: Get registry string MIAMEX 100: Play sound MIAMEX 101: Get swap wait time MIAMEX 102: Set swap wait time MIAMEX 103: Get/set cmd line flags MIAMEX 104: Get process ID MIAMEX 105: Get/set clipboard text MIAMEX 106: Get OS Information MIAMEX 107: Scan user memory MIAMEX 108: Load module into memory MIAMEX 109: Delete module from memory MIAMEX 110: Save memory module MIAMEX 111: Read/write memory module MIAMEX 112: Set AutoMouse translations MIAMEX 113: Change memory partition MIAMEX 115: Indirect XCALL MIAMEX 116: Process color ini file MIAMEX 117: Send MAPI mail MIAMEX 118: Get/set stream position MIAMEX 120: Prompt for Windows printer MIAMEX 121: Set/get chain-to on priv error MIAMEX 123: Get/set SBR= flags MIAMEX 124: Output to ashlog.log MIAMEX 125: Get last MCRS click info MIAMEX 126: Sink/unsink field MIAMEX 127: Get/set rounding factor MIAMEX 128: Get IP address MIAMEX 130: Get startup command MIAMEX 131: Get file stats MIAMEX 132: Format file time MIAMEX 133: Expand/reduce file in place MIAMEX 138: Registry operations Open Create Set Read Enumerate keys Enumerate values Close Delete Key Delete Value Replace Null Delimiters MIAMEX 141: Set Parent Control MIAMEX 143: Get/set INFLD Default TYPE Codes MIAMEX 144: Get/set DEBUG Control Variable MIAMEX 146: Get Last Line Number MIAMEX 147: Count Lines in File MIAMEX 148: Calculate String Length or Height Open Choose font Calculate rectangular text metrics Calculate string length Calculate rectangular XTEXT metrics MIAMEX 149: Get/set A-Shell GUI Settings MIAMEX 153: Set/release Keyboard Hold MIAMEX 154: Set 3D TAB Attributes MIAMEX 156: Return Instance Number MIAMEX 157: Find Window MIAMEX 163: Change Memory Module Flags MIAMEX 164: Display Color Selection Dialog MIAMEX 165: Display Font Selection Dialog MIAMEX 167: Verify File Information MIAMEX 169: Set/Overrride User Name MIAMEX 170: Select Windows Folder MIAMEX 171: Retrieve Directory Path MIAMEX 172: Password Encryption MIAMEX 173: Create Shortcut MIAMEX 174: String Compare MIAMEX 176: Check PC Network State MIAMEX 177: Wrap ATE Command MIAMEX 178: Establish File Hooks Hook SBX Specification MSBOXX MSGBOX MSGLOG NFIND NOECHO NUMCHK ODTIM PCKLST PLYJOB PRTCHK PUTBYT REGEX Pattern Complilation Errors Matching Errors Options Flags Background and General Information License Notes RENAME RSPCHK RXTERM SBXINP Label SCRSTS Using XTREE with SCRSTS SEND SERCH SETJTB SIZE SQL SORTIT STRIP STRTOK Almost Comma Delimited Large Packets, Multiple Delimiters SUBMIT SWPSBR TCPX Backwards Compatibility Advanced Server Connection Options Asynchronous Client Connections Closing Opcodes Flags1 Setting The SO_LINGER Option TLS/SSL STARTTLS Flags2 Status TCPCLI TCPSRV TIMES TINKEY TRIM TRMCHR UNIQUE USRCNT VUESCR WAKNO WINFLG XDEFLT XFOLD XFRMMO XLOCK XPAINT XPPN XTEXT Text Editing Overview Parameters opcode flags TXF_MODELESS TXF_STATUS TXF_TOOLBAR TXF_POSCUR TXF_DISABLE TXF_NOCLICKOUT src dst srow, scol, erow, ecol exitcode txtctl txc'ctlno txc'kbdstr txc'wrapwidth txc'docfmt'src txc'docfmt'dst txc'outbytes txc'outlines txc'saveoffset txc'fontface txc'fontsize txc'srchkey txc'sflags txc'flagmask txc'flags1 txc'flags2 txc'flags3 txc'flags4 txc'flags5 txc'flags6 txc'flags7 txc'flags8 txc'fmapctl txc'fmapapp txc'toolbarmask txc'fcolor txc'fprotclr txc'protrows txc'idname txc'maxbytes fmtdef Other XTEXT Topics Modeless Operation Multiple XTEXT Controls Controls in Container Windows Editing in a Standalone Window Search / Replace Page Breaks Trapping Toolbar Commands XTEXT as a Report Viewer Copy and Paste Printing ATE Issues Non-FTP Channel Text Return Spell Checking Keyboard Commands Updates XTREE Inputs and Outputs Parameters srow, scol, erow, ecol answer Examples array addcnt coldef cpos, cwidth ctitle cformat Preserve foreground color List hierarchy Numeric data Literal backslash Background cell color Background row color Row color Row color option Combo Box Standard Date Format Column contains editable text Font definition column Hidden column Image column Allow embedded CRLFs Editable radio button Editable checkbox Non-editable checkbox Application-editable only Read-only editable Conditional validation Unconditional validation Advanced Coldef Options ClickExit Dspwid ExitChars Font Format HdrClickExit HdrFont ImgSiz ImgCount ImgDir InfDef List Mask NegFgBg PopupMenu RGBbg RGBfg RGBfgSel and RGBbgSel Headers and Totals Colors ScrollMode CellList ListX and CellListX SelChgExit Advanced Syntax Example Traditional Syntax Simple Multi-Column Syntax File Mode Coldef Extensions exitcode flags XTF_ENTESC XTF_MODELESS XTF_FCOLDEF XTF_XYXY XTF_SORT XTF_MSEL XTF_DISABLE XTF_FILANS XTF_DRAGDROP XTF_SPLIT XTF_NOZEROEX flags2 XTF2_HOME_CTRL and XTF2_END_CTRL XTF2_NAVCOL XTF2_AUTOEXPCOL XTF2_CSV file mmoclr xtrctl xtr'opcode XTROP_CREATE XTROP_REPLACE XTROP_APPEND XTROP_DELETE XTROP_RESELECT XTROP_DELSEL XTROP_PRINT xtr'ctlno xtr'itemlines xtr'selectarea xtr'kbdstr xtr'skey xtr'topindex xtr'delctlid xtr'expandlevel xtr'colorder xtr'timeout xtr'leftpanecols xtr'leftpanewidth xtr'closedended xtr'xvalidate xtr'target... xtr'searchmode xtr'miscflags xtr'nfselstyle xtr'headerstyle xtr'rowhdrstyle xtr'showrowhdr filidx XTREE Techniques Initial View Position Mouse and keyboard techniques Sorting Multi-level lists Modeless operation Appending Editable tree controls Re-entry After Cell Validation Editable Image Cells Multiple tree controls Controls in container windows Destroying pick lists Typical Cell Editing Scenarios Saving User Adjustments Sample programs XTREE Update Notes Appendix CSIDL_xxx identifiers Virtual Key Symbolic Names Hex-Decimal Values Compatibility Table Glossary