Rocket wIntegrate Host Subroutines...

Rocket wIntegrate

Host Subroutines Reference

Version 6.3.7

April 2015WIN-637-HS-RM-01

2

NoticesEdition

Publication date: April 2015Book number: WIN-637-HS-RM-01Product version: Version 6.3.7

Copyright© Rocket Software, Inc. or its affiliates 1996-2015. All Rights Reserved.

Trademarks

Rocket is a registered trademark of Rocket Software, Inc. For a list of Rocket registered trademarks goto: www.rocketsoftware.com/about/legal. All other products or services mentioned in this documentmay be covered by the trademarks, service marks, or product names of their respective owners.

Examples

This information might contain examples of data and reports. The examples include the names ofindividuals, companies, brands, and products. All of these names are fictitious and any similarity tothe names and addresses used by an actual business enterprise is entirely coincidental.

License agreement

This software and the associated documentation are proprietary and confidential to Rocket Software,Inc. or its affiliates, are furnished under license, and may be used and copied only in accordance withthe terms of such license.

Note: This product may contain encryption technology. Many countries prohibit or restrict theuse, import, or export of encryption technologies, and current use, import, and export regulationsshould be followed when exporting this product.

http://www.rocketsoftware.com/about/legal

3

Corporate informationRocket Software, Inc. develops enterprise infrastructure products in four key areas: storage, networks,and compliance; database servers and tools; business information and analytics; and applicationdevelopment, integration, and modernization.

Website: www.rocketsoftware.com

Rocket Global Headquarters77 4th Avenue, Suite 100Waltham, MA 02451-1468USA

To contact Rocket Software by telephone for any reason, including obtaining pre-sales informationand technical support, use one of the following telephone numbers.

Country Toll-free telephone number

United States 1-855-577-4323Australia 1-800-823-405Belgium 0800-266-65Canada 1-855-577-4323China 800-720-1170France 0800-180-0882Germany 08-05-08-05-62Italy 800-878-295Japan 0800-170-5464Netherlands 0-800-022-2961New Zealand 0800-003210South Africa 0-800-980-818United Kingdom 0800-520-0439

Contacting Technical Support

The Rocket Customer Portal is the primary method of obtaining support. If you have currentsupport and maintenance agreements with Rocket Software, you can access the Rocket CustomerPortal and report a problem, download an update, or find answers to in the U2 Knowledgebase.To log in to the Rocket Customer Portal or to request a Rocket Customer Portal account, go towww.rocketsoftware.com/support.

In addition to using the Rocket Customer Portal to obtain support, you can send an email [email protected] or use one of the following telephone numbers.

Country Telephone number

North America +1 800 729 3553United Kingdom/France +44 (0) 800 773 771 or +44 (0) 20 8867 3691Europe/Africa +44 (0) 20 8867 3692Australia +1 800 707 703 or +61 (0) 29412 5450New Zealand +0800 505 515

http://www.rocketsoftware.com

http://www.rocketsoftware.com/support

mailto:[email protected]

4

Contents

Notices................................................................................................................................................................................... 2

Corporate information......................................................................................................................................................... 3

Chapter 1: wIntegrate overview........................................................................................................................................ 11wIntegrate features................................................................................................................................................ 11

Chapter 2: Host subroutines.............................................................................................................................................. 12WC............................................................................................................................................................................ 12WIN.ACTIVATE..........................................................................................................................................................13WIN.APP................................................................................................................................................................... 14WIN.APPDIR............................................................................................................................................................. 14WIN.ASCTOFT.......................................................................................................................................................... 15WIN.ASSIGN............................................................................................................................................................. 15WIN.BARSUB............................................................................................................................................................15WIN.BKIMAGE.......................................................................................................................................................... 16WIN.BOX...................................................................................................................................................................17WIN.CBREAD............................................................................................................................................................ 18WIN.CBWRITE.......................................................................................................................................................... 19WIN.CHECK.............................................................................................................................................................. 20WIN.CLINFO............................................................................................................................................................. 20WIN.COLOR.............................................................................................................................................................. 21WIN.COLOUR........................................................................................................................................................... 22WIN.COMLINE.......................................................................................................................................................... 23WIN.COMSUB...........................................................................................................................................................24WIN.CURSOR............................................................................................................................................................24WIN.DBANIM............................................................................................................................................................ 25WIN.DBATTACH....................................................................................................................................................... 26WIN.DBAXCTRL........................................................................................................................................................ 27WIN.DBBOX.............................................................................................................................................................. 28WIN.DBBUTTON.......................................................................................................................................................29WIN.DBCAPT............................................................................................................................................................ 30WIN.DBCHECK......................................................................................................................................................... 30WIN.DBCHILD...........................................................................................................................................................31WIN.DBCOMBO........................................................................................................................................................ 32WIN.DBCTRL............................................................................................................................................................ 33WIN.DBDEL...............................................................................................................................................................34WIN.DBDTTIME........................................................................................................................................................ 35WIN.DBEDGET..........................................................................................................................................................35WIN.DBEDGET2........................................................................................................................................................36WIN.DBEDIT............................................................................................................................................................. 37WIN.DBEDSET.......................................................................................................................................................... 38WIN.DBENABLE........................................................................................................................................................39WIN.DBENALL.......................................................................................................................................................... 39WIN.DBEND..............................................................................................................................................................40WIN.DBESTACK........................................................................................................................................................41WIN.DBEVENT.......................................................................................................................................................... 42WIN.DBEVENT2........................................................................................................................................................ 43WIN.DBEVENTR........................................................................................................................................................44WIN.DBEVENTS........................................................................................................................................................45WIN.DBFETCH..........................................................................................................................................................45WIN.DBFETCH2........................................................................................................................................................47WIN.DBFOCUS......................................................................................................................................................... 47WIN.DBGET.............................................................................................................................................................. 48

Contents

5

WIN.DBGET2............................................................................................................................................................ 49WIN.DBGETM........................................................................................................................................................... 50WIN.DBGETPRP....................................................................................................................................................... 51WIN.DBGETPRPL..................................................................................................................................................... 52WIN.DBGRID.............................................................................................................................................................53WIN.DBGROUP.........................................................................................................................................................53WIN.DBHEADER....................................................................................................................................................... 54WIN.DBHTML........................................................................................................................................................... 55WIN.DBIMAGE.......................................................................................................................................................... 56WIN.DBIMBUT.......................................................................................................................................................... 57WIN.DBINIPRP......................................................................................................................................................... 58WIN.DBINIT.............................................................................................................................................................. 58WIN.DBINPOK.......................................................................................................................................................... 59WIN.DBKEY...............................................................................................................................................................59WIN.DBLABEL.......................................................................................................................................................... 60WIN.DBLIST..............................................................................................................................................................62WIN.DBLISTVW.........................................................................................................................................................63WIN.DBLOAD............................................................................................................................................................64WIN.DBLOADF..........................................................................................................................................................64WIN.DBMETHOD...................................................................................................................................................... 65WIN.DBMNSIZE........................................................................................................................................................ 67WIN.DBMOVE........................................................................................................................................................... 67WIN.DBMSGBOX...................................................................................................................................................... 68WIN.DBMSGBOX2.................................................................................................................................................... 69WIN.DBMSIZE...........................................................................................................................................................70WIN.DBMVCTRL....................................................................................................................................................... 71WIN.DBNEVENT....................................................................................................................................................... 71WIN.DBNEW............................................................................................................................................................. 72WIN.DBOPTION........................................................................................................................................................74WIN.DBPANEL..........................................................................................................................................................76WIN.DBPOST............................................................................................................................................................77WIN.DBPOST2..........................................................................................................................................................78WIN.DBPRGRES....................................................................................................................................................... 78WIN.DBRADIO.......................................................................................................................................................... 79WIN.DBRECT............................................................................................................................................................ 80WIN.DBSCROLL........................................................................................................................................................81WIN.DBSELECT........................................................................................................................................................ 81WIN.DBSET...............................................................................................................................................................82WIN.DBSETCOL........................................................................................................................................................83WIN.DBSETFNT........................................................................................................................................................84WIN.DBSETMNU.......................................................................................................................................................84WIN.DBSETPRP........................................................................................................................................................85WIN.DBSETPRPL......................................................................................................................................................86WIN.DBSHOW.......................................................................................................................................................... 86WIN.DBSHOWPU......................................................................................................................................................87WIN.DBSTATUS........................................................................................................................................................88WIN.DBTAB.............................................................................................................................................................. 89WIN.DBTABS............................................................................................................................................................ 90WIN.DBTEXT.............................................................................................................................................................90WIN.DBTRACK..........................................................................................................................................................92WIN.DBTREEVW....................................................................................................................................................... 92WIN.DBTYPEAH........................................................................................................................................................93WIN.DBUNIT.............................................................................................................................................................94WIN.DBUPDOWN..................................................................................................................................................... 95WIN.DDECLOSE........................................................................................................................................................96WIN.DDEEXEC.......................................................................................................................................................... 97

Contents

6

WIN.DDEEXEC2........................................................................................................................................................ 97WIN.DDEOPEN......................................................................................................................................................... 99WIN.DDEPOKE....................................................................................................................................................... 100WIN.DDEREQ..........................................................................................................................................................101WIN.DDETIME.........................................................................................................................................................102WIN.DISPLAY..........................................................................................................................................................102WIN.DRARC............................................................................................................................................................ 103WIN.DRBRUSH....................................................................................................................................................... 104WIN.DRCHORD.......................................................................................................................................................105WIN.DRELL............................................................................................................................................................. 106WIN.DRERASE........................................................................................................................................................ 107WIN.DRFONT..........................................................................................................................................................109WIN.DRLINE........................................................................................................................................................... 110WIN.DRMOVE......................................................................................................................................................... 110WIN.DRPEN............................................................................................................................................................ 111WIN.DRPIE..............................................................................................................................................................112WIN.DRPOLY.......................................................................................................................................................... 113WIN.DRRECT.......................................................................................................................................................... 114WIN.DRTEXT...........................................................................................................................................................115WIN.EDDATA.......................................................................................................................................................... 116WIN.EDDICT........................................................................................................................................................... 117WIN.EDIT................................................................................................................................................................ 117WIN.EDPROG......................................................................................................................................................... 118WIN.EFFECT........................................................................................................................................................... 119WIN.EFILL...............................................................................................................................................................120WIN.EI.....................................................................................................................................................................121WIN.EI2...................................................................................................................................................................124WIN.EVAL................................................................................................................................................................125WIN.EXPORT.......................................................................................................................................................... 126WIN.FKEY................................................................................................................................................................127WIN.FSCRIPT..........................................................................................................................................................128WIN.FTPCLOSE...................................................................................................................................................... 128WIN.FTPCON..........................................................................................................................................................129WIN.FTPDEL...........................................................................................................................................................129WIN.FTPDIR............................................................................................................................................................130WIN.FTPDISC......................................................................................................................................................... 130WIN.FTPFILE.......................................................................................................................................................... 131WIN.FTPGET...........................................................................................................................................................131WIN.FTPGETDR......................................................................................................................................................132WIN.FTPINFO......................................................................................................................................................... 132WIN.FTPLIST.......................................................................................................................................................... 133WIN.FTPMKDIR...................................................................................................................................................... 133WIN.FTPOPEN........................................................................................................................................................134WIN.FTPPOS.......................................................................................................................................................... 135WIN.FTPPUT.......................................................................................................................................................... 135WIN.FTPREAD........................................................................................................................................................ 136WIN.FTPRMDIR...................................................................................................................................................... 137WIN.FTPSCR...........................................................................................................................................................137WIN.FTPSCRPT...................................................................................................................................................... 138WIN.FTPSETDR...................................................................................................................................................... 139WIN.FTPSETV......................................................................................................................................................... 139WIN.FTPWRITE.......................................................................................................................................................140WIN.FTTOASC........................................................................................................................................................ 141WIN.GET64.UD....................................................................................................................................................... 141WIN.GETDATA........................................................................................................................................................ 142WIN.GETLIST..........................................................................................................................................................143

Contents

7

WIN.GETLISTL........................................................................................................................................................143WIN.GETPARAM..................................................................................................................................................... 144WIN.GETVAL........................................................................................................................................................... 145WIN.GETVAR...........................................................................................................................................................145WIN.HGLASS.......................................................................................................................................................... 146WIN.HOSTVER........................................................................................................................................................147WIN.HOTSPOT....................................................................................................................................................... 147WIN.HOTSPOT2..................................................................................................................................................... 148WIN.HSCRIPT......................................................................................................................................................... 149WIN.HSCRIPTC.......................................................................................................................................................150WIN.ILADD..............................................................................................................................................................151WIN.ILCOUNT.........................................................................................................................................................151WIN.ILDELETE........................................................................................................................................................ 152WIN.ILICON............................................................................................................................................................ 152WIN.ILINFO.............................................................................................................................................................153WIN.ILISIZE............................................................................................................................................................ 153WIN.ILLOAD............................................................................................................................................................153WIN.ILNEW............................................................................................................................................................. 154WIN.ILREMOVE.......................................................................................................................................................155WIN.IMAGE............................................................................................................................................................. 155WIN.IMCHANGE......................................................................................................................................................156WIN.IMCLOSE.........................................................................................................................................................157WIN.IMOPEN.......................................................................................................................................................... 158WIN.IMPORT.......................................................................................................................................................... 159WIN.INFOBOX........................................................................................................................................................ 161WIN.INFOBOX2...................................................................................................................................................... 161WIN.INPBOX...........................................................................................................................................................162WIN.INVOKE........................................................................................................................................................... 163WIN.LI.....................................................................................................................................................................163WIN.LICINFO.......................................................................................................................................................... 164WIN.LOOKUP......................................................................................................................................................... 165WIN.LOOKUPM...................................................................................................................................................... 166WIN.MENUATT....................................................................................................................................................... 167WIN.MENUDEL....................................................................................................................................................... 168WIN.MENUDET....................................................................................................................................................... 169WIN.MENUIN.......................................................................................................................................................... 169WIN.MENULDF....................................................................................................................................................... 170WIN.MENULOAD.................................................................................................................................................... 171WIN.MLADDR..........................................................................................................................................................172WIN.MLAVAIL..........................................................................................................................................................173WIN.MLDELETE...................................................................................................................................................... 174WIN.MLFIND...........................................................................................................................................................175WIN.MLLOOKUP.................................................................................................................................................... 176WIN.MLNEXT.......................................................................................................................................................... 178WIN.MLREAD..........................................................................................................................................................179WIN.MLSEND..........................................................................................................................................................181WIN.MOUSE........................................................................................................................................................... 182WIN.MOUSEDEF.....................................................................................................................................................183WIN.MOUSEIN........................................................................................................................................................184WIN.MSGBOX......................................................................................................................................................... 185WIN.MSGBOX2....................................................................................................................................................... 186WIN.MSTATE.......................................................................................................................................................... 188WIN.OBEXIST......................................................................................................................................................... 188WIN.OBGET............................................................................................................................................................ 189WIN.OBGETPRP..................................................................................................................................................... 189WIN.OBMETHOD....................................................................................................................................................190

Contents

8

WIN.OBNEW........................................................................................................................................................... 191WIN.OBREL............................................................................................................................................................ 191WIN.OBSET............................................................................................................................................................ 192WIN.OBSETPRP..................................................................................................................................................... 192WIN.OBVTYPE........................................................................................................................................................ 193WIN.PCBROWSE.................................................................................................................................................... 193WIN.PCCLOSE........................................................................................................................................................ 195WIN.PCCOPY.......................................................................................................................................................... 195WIN.PCCREATE...................................................................................................................................................... 196WIN.PCDELETE...................................................................................................................................................... 197WIN.PCDIR............................................................................................................................................................. 197WIN.PCEDIT........................................................................................................................................................... 198WIN.PCEOF.............................................................................................................................................................199WIN.PCFILE............................................................................................................................................................ 199WIN.PCINFO........................................................................................................................................................... 200WIN.PCLIST............................................................................................................................................................ 201WIN.PCMKDIR........................................................................................................................................................ 202WIN.PCMOVE......................................................................................................................................................... 203WIN.PCOPEN..........................................................................................................................................................203WIN.PCPOS............................................................................................................................................................ 204WIN.PCPRINT.........................................................................................................................................................205WIN.PCREAD.......................................................................................................................................................... 205WIN.PCREADAL...................................................................................................................................................... 206WIN.PCREADLN......................................................................................................................................................207WIN.PCRMDIR........................................................................................................................................................ 208WIN.PCRUN............................................................................................................................................................208WIN.PCRUN2..........................................................................................................................................................209WIN.PCSCRIPT....................................................................................................................................................... 210WIN.PCWRITE........................................................................................................................................................ 211WIN.PIESUB........................................................................................................................................................... 212WIN.PLAYBACK...................................................................................................................................................... 213WIN.POPUPIN........................................................................................................................................................ 214WIN.PRINTOFF.......................................................................................................................................................215WIN.PRINTON........................................................................................................................................................ 216WIN.PRTPAUSE......................................................................................................................................................216WIN.RECOFF.......................................................................................................................................................... 217WIN.RECON............................................................................................................................................................218WIN.RECPAUSE......................................................................................................................................................219WIN.RSEXEC...........................................................................................................................................................220WIN.RSEXIST..........................................................................................................................................................220WIN.RSNAME..........................................................................................................................................................221WIN.RSSCRIPT....................................................................................................................................................... 222WIN.RSSTART........................................................................................................................................................ 223WIN.RWSUB........................................................................................................................................................... 224WIN.SCREEN.......................................................................................................................................................... 224WIN.SDUMP........................................................................................................................................................... 224WIN.SENDKEYS...................................................................................................................................................... 225WIN.SERIAL............................................................................................................................................................ 226WIN.SERVER...........................................................................................................................................................227WIN.SET64.UD....................................................................................................................................................... 227WIN.SETDATA........................................................................................................................................................ 228WIN.SETEFFCT....................................................................................................................................................... 229WIN.SETLIST.......................................................................................................................................................... 230WIN.SETLISTL........................................................................................................................................................ 230WIN.SETPARAM......................................................................................................................................................231WIN.SETVAL........................................................................................................................................................... 232

Contents

9

WIN.SETVAR...........................................................................................................................................................232WIN.SHARE............................................................................................................................................................ 233WIN.SHOW............................................................................................................................................................. 233WIN.SLOAD............................................................................................................................................................ 234WIN.SPULL............................................................................................................................................................. 234WIN.SPUSH............................................................................................................................................................ 235WIN.SREMOVE........................................................................................................................................................235WIN.SRESTORE......................................................................................................................................................236WIN.SSAVE............................................................................................................................................................. 237WIN.SSTATE........................................................................................................................................................... 238WIN.SSTORE.......................................................................................................................................................... 238WIN.STACK.............................................................................................................................................................239WIN.STACKOFF...................................................................................................................................................... 240WIN.STACKON........................................................................................................................................................240WIN.STATLINE........................................................................................................................................................240WIN.TADEMO......................................................................................................................................................... 241WIN.TASK............................................................................................................................................................... 241WIN.TCL................................................................................................................................................................. 242WIN.TITLE.............................................................................................................................................................. 243WIN.TRANSFER...................................................................................................................................................... 243WIN.TWCLOSE....................................................................................................................................................... 244WIN.TWFOOT......................................................................................................................................................... 245WIN.TWMSG........................................................................................................................................................... 246WIN.TWOPEN.........................................................................................................................................................246WIN.TWPULL..........................................................................................................................................................248WIN.TWPUSH.........................................................................................................................................................249WIN.TWUSE............................................................................................................................................................250WIN.USESTYLE.......................................................................................................................................................251WIN.VERSION.........................................................................................................................................................252WIN.XLADDWS....................................................................................................................................................... 252

Chapter 3: Using host subroutines..................................................................................................................................254WIN.DEMO options................................................................................................................................................255

Bar graphs................................................................................................................................................. 255Pie charts...................................................................................................................................................256Images....................................................................................................................................................... 257Drawings.................................................................................................................................................... 258Colors.........................................................................................................................................................262Text windows............................................................................................................................................ 263Hot spots................................................................................................................................................... 264DDE Demo................................................................................................................................................. 265Menus.........................................................................................................................................................267Dialog box lookup.....................................................................................................................................268Dialog boxes..............................................................................................................................................269Chiselled effects........................................................................................................................................274Background images.................................................................................................................................. 276FTP............................................................................................................................................................. 277Object (Automation) demo...................................................................................................................... 279Dialog boxes: common controls..............................................................................................................281

Appendix A: The service subroutine................................................................................................................................285Calling a service subroutine.................................................................................................................................285Using the service subroutine............................................................................................................................... 285Examples............................................................................................................................................................... 285

Action code details................................................................................................................................... 287Example subroutines............................................................................................................................................ 291

Appendix B: National Language Support (NLS)..............................................................................................................292

Contents

10

Appendix C: Reading the TCL command line input buffer in D3................................................................................... 293

Appendix D: Loading a dialog using the Basic subroutines...........................................................................................295WIN.DBLOAD..........................................................................................................................................................295WIN.DBSHOW........................................................................................................................................................ 297WIN.DBLOADSHOW............................................................................................................................................... 298

11

Chapter 1: wIntegrate overviewwIntegrate is a connectivity tool that integrates host-based applications with the desktop. Theinitial interface is a terminal emulator with data transfer features designed for the multi-valuedenvironments of UniVerse, UniData, D3, and mvBase. You can share data with popular Windowsapplications, including Microsoft Word and Excel.

For developers, a comprehensive programming language enables a range of options for integratinghost environments with the desktop. You can add GUI features incrementally or create full GUIapplications driven from the host.

A suite of host-based subroutines is supplied to control the PC. These subroutines are created formulti-valued environments, but the techniques used can be adapted to any host.

Developer tools include the Editor and a Tools menu with useful utilities. You can choose to displaythe Tools menu in Setup > Preferences. Select the Scripts tab and then use the Menu Bar Scriptdrop-down list.

wIntegrate featuresAll wIntegrate features are supported with Rocket’s UniVerse, UniData, D3, and mvBase databases.

With wIntegrate, you can do the following tasks:

▪ Run concurrent sessions▪ Customize a wIntegrate session▪ Control any aspect of the application using powerful scripting language▪ Optionally deploy a thin client on Windows or Java▪ Run scripts from supplied host-based subroutines▪ Define terminal emulations▪ Export files from your PC to a host computer▪ Import host computer files to your PC▪ Transfer files from one host computer to another host computer▪ Simplify deployment through optional thin client and browser interfaces

12

Chapter 2: Host subroutinesThis chapter details each of the subroutines and programs that are provided with wIntegrate. You canuse these subroutines to develop your application. The subroutines accept parameters and generatescript statements that are sent to the PC for execution. The scripts are documented in Client ScriptingReference.

If your site is running different versions of wIntegrate, it is recommended that you always install thehost subroutines for the latest version in use. This should not affect users because changes are notmade to existing subroutines that would introduce backward-compatibility issues.

If an enhancement is made to a subroutine that might affect existing users, a new version ofthe subroutine is created with the suffix of “2” instead of modifying the existing subroutine. It isrecommended that you use the subroutines ending in “2” where available.

Note that it is not possible to run host subroutines from a phantom process on Linux. A phantom is acompletely separate process to the one the user is running. It is not running the wIntegrate client, so itcannot communicate with the PC.

WCThis is the abbreviation for the WIN.COMLINE command. It gives you the ability to directly enterscript commands on the screen.

Syntax

WC

Examples

The following example uses WC to change the Normal attribute in the emulation screen to a light blueforeground (text) with a darker blue background, change the window title, and display a message box.

>WCEnter ? for helpwIntegrate Command >Set Effect_Normal RGB_LightCyan, RGB_BluewIntegrate Command >Set Title "Host: voyager - ~: @ - |"wIntegrate Command >MS "This is a MessageBox"

You can achieve the same effect by using the subroutines that generate script statements and sendthem to the desktop for execution:

CALL WIN.SETEFFCT("Normal", "LightCyan", "Blue", "", "")CALL WIN.SETPARAM("Title", "Host: voyager - ~: @ - |")CALL WIN.MSGBOX2("This is a MessageBox", "", "", "")

Alternatively, you can embed script statements and control codes in your own Basic program:

C1 = CHAR(1)ESC = CHAR(27)CR = CHAR(13)CRT ESC : C1 : "Set Effect_Normal RGB_LightCyan, RGB_Blue" : CR :CRT ESC : C1 : 'Set Title "Host: voyager - ~: @ - |"' : CR :CRT ESC : C1 : 'MS "This is a MessageBox"' : CR :

WIN.ACTIVATE

13

Here is an alternate Basic program that uses the subroutines:

CALL WIN.SETEFFCT("Normal", "LightCyan", "Blue", "", "")CALL WIN.SETPARAM("Title", "Host: voyager - ~: @ - |")CALL WIN.MSGBOX2("This is a MessageBox", "", "", "")

If you enabled Developer Additions during installation, the PC script WC.wis runs scripts in the sameway as the WC host program. WC.wis is located in Program Files\wIntegrate\Example\Script.

Related Subroutines

WIN.COMSUB, WIN.HSCRIPT, WIN.COMLINE

WIN.ACTIVATEThis subroutine activates a window on the Windows desktop. The window that you want to show mustbe a running application (accessed by pressing Alt + Tab to scroll through running applications). Thetask name must be the same as it displays in the Windows task list or the taskbar.

Syntax

WIN.ACTIVATE (TASKNAME)

Parameters

The following table describes the parameters of the WIN.ACTIVATE command:

Parameter Description

TASKNAME The name of the window as it is shown in the Windows task list. If thetaskname is null, the subroutine activates the wIntegrate window.

Examples

The following example prints out a message if the task is not running. Otherwise, it inserts the reportname on the first line.

* Verify the report "recrept.txt" is runningCALL WIN.TASK("Notepad - RECREPT.TXT", RUNNING)IF RUNNING THEN GOSUB 100END ELSE PRINT "recrept.txt is not running, open it and try again"ENDRETURN*100 * Change the active window from wIntegrate to NotepadCALL WIN.ACTIVATE("Notepad - RECREPT.TXT")* Send the report name to the Notepad reportCALL WIN.SENDKEYS("STUDENT REPORT", 1)RETURN*END

Chapter 2: Host subroutines

14

Related Subroutines

WIN.TASK

Related Script Commands

Activate

WIN.APPThis subroutine checks if an application is running.

Syntax

WIN.APP (FILENAME, RUNNING)

Parameters

The following table describes the parameters of the WIN.APP command:


FILENAME Specifies the name of the application to checkRUNNING Returns 0 if not running; returns 1 if running

Examples

The following example checks if the Windows Microsoft Word application is running.

CALL WIN.APP ("WINWORD.EXE", RUNNING)IF RUNNING THEN PRINT "Word for Windows is running"* When this program is run, it returns nothing if Word is not running,* and returns the following if Word is running:* Word for Windows is running

WIN.APPDIRThis subroutine returns the name of the directory of the current wIntegrate session.

Syntax

WIN.APPDIR (DIR)

Parameters

The following table describes the parameters of the WIN.APPDIR command:


DIR Variable to hold the returned directory

Examples

The following example finds wIntegrate’s running directory.

DIR = ""

WIN.ASCTOFT

15

CALL WIN.APPDIR(DIR)PRINT DIR* The output of this program is:* C:\Program Files\wIntegrate

WIN.ASCTOFTThis subroutine converts an ASCII format string to its File Transfer equivalent. The file transfer formatrepresents control codes and other special characters as one or two seven-bit values. The seven-bitdata can be sent across any communications line.

Syntax

WIN.ASCTOFT (VALUE)

Parameters

The following table describes the parameters of the WIN.ASCTOFT command:


VALUE The variable to convert to FT format

Related Subroutines

WIN.FTTOASC

WIN.ASSIGNThis subroutine assigns the given variable with the specified value.

Unlike WIN.SETVAR, this routine does not automatically create a global script variable.

Syntax

WIN.ASSIGN (VAR, VALUE)

Parameters

The following table describes the parameters of the WIN.ASSIGN command:


VAR The name of the variable to assignVALUE The value to assign to the variable

Related Subroutines

WIN.SETVAR

WIN.BARSUBThis subroutine uses the wIntegrate draw commands to create a bar chart.


16

Syntax

WIN.BARSUB (TITLE, LABELS, VALUES, OPTIONS)

Parameters

The following table describes the parameters of the WIN.BARSUB command:


TITLE Specifies the bar chart nameLABELS Labels the X-axis multivalue listVALUES Specifies values for each labelOPTIONS Options for the chart

Fields for OPTIONS:

Field Description

1 Specifies the style:1 - Normal2 - Several data sets

2 Screen position.3 Reserved4 Colors for the bars5 Y-axis labels:

5.1 - Minimum value

5.2 - Maximum value

5.3 - Step value

Examples

The following example is taken from the demo program WIN.BARDEMO.

LABELS = ''VALUES = ''LABELS<1> = 'Computers'; VALUES<1> =200LABELS<2> = 'Stationery'; VALUES<2> = 500LABELS<3> = 'Accessories'; VALUES<3> = 50*R.OPTS = ''R.OPTS<2,1> = 20R.OPTS<2,2> = 3R.OPTS<2,3> = 60R.OPTS<2,4> = 15*CALL WIN.BARSUB("Products sold", LABELS, VALUES, R.OPTS)

WIN.BKIMAGEThis subroutine specifies a background image for the session screen.

WIN.BOX

17

Syntax

WIN.BKIMAGE (IMAGE, DISPLAY, OPTS)

Parameters

The following table describes the parameters of the WIN.BKIMAGE command:


IMAGE The file name of the image file used. If only the leaf name of the file name isused, the image is assumed to be in wIntegrate's background folder.

DISPLAY Tile or Stretch the image. Use literal values “Tile” or “Stretch” respectively.OPTS Set to "". Reserved for future expansion.

Examples

The following example code is from the host program WIN.BKDEMO.

IF REDISP THEN IF DISP = "" THEN DISP = "Stretch" CALL WIN.BKIMAGE(IMAGE, DISP,"") CALL WIN.SETEFFCT("Normal",COL,0,"",0) PRINT CMSG:' CALL WIN.BKIMAGE("':IMAGE:'","':DISP:'","")':END

Version

4.0.3 Original version

WIN.BOXThis subroutine draws a box on the screen.

Syntax

WIN.BOX (LEFT, TOP, RIGHT, BOTTOM, STYLE)

Parameters

The following table describes the parameters of the WIN.BOX command:


LEFT Specifies the coordinate for the left side of the boxTOP Specifies the coordinate for the top of the boxRIGHT Specifies the coordinate for the right side of the boxBOTTOM Specifies the coordinate for the bottom of the boxSTYLE Style of the box

Values for STYLE

Enter the name in quotation marks or number for each style.


18

Value Description

0 "SPACES" No visible border1 "SINGLE" Single-line border2 "DOUBLE" Double-line border3 "MIX" Alternating dot and block border4 "BLOCK" Block border+512 "MERGE" Merges box lines with lines already on the screen+256 "NOFILL" Leaves the box empty

Examples

The following example draws a single line across line 1 on the screen.

CALL WIN.BOX(0,1,79,1,1)

The preceding example could also be written:

CALL WIN.BOX(0,1,79,1,"SINGLE")

The following example is taken from the WIN.DEMO demonstration program.

PRINT @(40,11):"12. Chiselled effects"CALL WIN.COLOR("Yellow","") ;* Set foreground colourCALL WIN.BOX(0,19,79,19,1) ;* Draw line across bottom

For a single line merged with the screen on line 11:

CALL WIN.BOX(5,11,75,11,"SINGLE,MERGE")

For a box with double lines on the top and bottom and single lines on the sides:

CALL WIN.BOX(20,10,60,15,"DOUBLE, SINGLE")


Display Box

WIN.CBREADThis subroutine reads text from the Windows clipboard. It converts CR/LF to a field mark and TAB to avalue mark.

Syntax

WIN.CBREAD (TEXT, RESP)

Parameters

The following table describes the parameters of the WIN.CBREAD command:


TEXT Variable to be set with the text from the clipboard

WIN.CBWRITE

19


RESP Error code; see the following table

Values for RESP

Value Description

1 Unable to connect to the clipboard.2 Unable to allocate memory to transfer data.3 Data on clipboard is not text.4 There is more than 30K of data on the clipboard.

Related Subroutines

WIN.CBWRITE


Clipboard Read

Version

4.1 Original version

WIN.CBWRITEThis subroutine writes text on to the Windows clipboard. It converts field marks to CR/LF pairs andvalue marks to TABS.

Syntax

WIN.CBWRITE (TEXT, RESP)

Parameters

The following table describes the parameters of the WIN.CBWRITE command:


TEXT The text to put on the clipboardRESP Error code; see the following Resp table

Values for RESP

Error codes returned in RESP:

Value Description

1 Unable to connect to the clipboard.2 Unable to allocate memory to transfer data.

Related Subroutines

WIN.CBREAD


20


Clipboard Write

Version


WIN.CHECKThis subroutine checks if wIntegrate is running.

WIN.CHECK itself is aimed at the generic machine type, while there is a WIN.CHECK.UD for UniDatahosts and WIN.CHECK.UV for UniVerse hosts.

This subroutine has a side effect of moving the cursor to the beginning of the current line and erasingthe first 10 characters (needed to erase the check sequence on non-wIntegrate terminals).

Syntax

WIN.CHECK (RUNNING)

Parameters

The following table describes the parameters of the WIN.CHECK command:


RUNNING Returns 0 if not running; returns 1 if running

Examples

The following example checks if wIntegrate is running on UniVerse.

RUNNING = 0CALL WIN.CHECK.UV(RUNNING)IF RUNNING THEN GOSUB 100;* Show GUI menuEND ELSE GOSUN 200;* Show character menuEND

Version

5.1.2 Original

WIN.CLINFOThis routine returns information about the client machine and user running this session.

Syntax

WIN.CLINFO (INFO)

WIN.COLOR

21

Parameters

The following table describes the parameters of the WIN.CLINFO command:


INFO Variable to be set with a dynamic array of the returned client information

Fields for INFO

Field Description

1 The user name that is used to log in to Windows2 The computer name

Version

4.2.1 Original

WIN.COLORThis subroutine sets the current color on the terminal. If you set FOREGROUND or BACKGROUNDto null, the component color does not change. To turn off colored text, set FOREGROUND to “Off”.FOREGROUND and BACKGROUND can be set to a color name (Black, Blue, LightCyan) or to a numberfrom 0 to 15.

Syntax

WIN.COLOR (FOREGROUND, BACKGROUND)

Parameters

The following table describes the parameters of the WIN.COLOR command:


FOREGROUND Specifies the foreground color (text)BACKGROUND Specifies the background color

Values for FOREGROUND

Color values/names. Also applies to the BACKGROUND parameter.

Value Description

0 Black1 Blue2 Green3 Cyan4 Red5 Magenta6 Brown7 LightGray or LightGrey8 Gray or Grey9 LightBlue


22

Value Description

10 LightGreen11 LightCyan12 LightRed13 LightMagenta14 Yellow15 White

Examples

The following example is part of the WIN.CEDEMO demonstration program.

* Set up box to display informationCALL WIN.COLOR("White","Blue")CALL WIN.TWOPEN("INFO","Information",1,18,78,22,"DOUBLE")CALL WIN.COLOR("Black","White")CALL WIN.TWFOOT("INFO","Press <CR> to continue","RCALL WIN.COLOR(TEXT.COL,"Blue")TEXT.LEN = 77*

Related Subroutines

WIN.COLOUR


Color

WIN.COLOURSets the current color on the terminal. If you set FOREGROUND or BACKGROUND to null, the componentcolor does not change. To turn off colored text, set FOREGROUND to "Off". FOREGROUND andBACKGROUND can be set to a color name (Black, Blue, LightCyan) or to a number from 0 to 15.

This routine is identical to the WIN.COLOR subroutine.

Syntax

WIN.COLOUR (FOREGROUND, BACKGROUND)

Parameters

The following table describes the parameters of the WIN.COLOUR command:


FOREGROUND Specifies the foreground color (text)BACKGROUND Specifies the background color

Values for FOREGROUND

Color values/names. Also applies to the BACKGROUND parameter.

WIN.COMLINE

23

Value Description

0 Black1 Blue2 Green3 Cyan4 Red5 Magenta6 Brown7 LightGray or LightGrey8 Gray or Grey9 LightBlue10 LightGreen11 LightCyan12 LightRed13 LightMagenta14 Yellow15 White

Related Subroutines

WIN.COLOR


Colour

WIN.COMLINEThis subroutine runs script commands and host script names from the host. In addition to using thissubroutine in your host routines, you can use it to test command lines before incorporating them intoyour application code. When you see the prompt for a wIntegrate command, you can enter a questionmark for help on how to use this subroutine.

Syntax

WIN.COMLINE

Examples

You can run any wIntegrate script command at the WIN.COMLINE prompt. The following exampleuses WIN.COMLINE to change the Normal attribute in the emulation screen to a light blueforeground (text), with a darker blue background.

WIN.COMLINEEnter ? for helpwIntegrate Command >wIntegrate Command >Set Effect_Normal RGB_LightCyan, RGB_Blue


24

Related Subroutines

WC, WIN.COMSUB, WIN.HSCRIPT

WIN.COMSUBThis subroutine executes a script on the PC.

Note: Every field in the dynamic array REC is executed as a separate script. To execute REC as asingle script, use the WIN.HSCRIPT subroutine.

Note: WIN.COMSUB appends each script instruction with CHAR(27):CHAR(1) and terminates itwith a Carriage Return. For example:

PRINT CHAR(27) : CHAR(1) : "Set Title = ’Test Account’" : CHAR(13) :

You can wrap script statements in your own Basic programs and avoid the use of WIN.COMSUB ifyou prefer.

Also try the host program WC which lets you enter script statements at a command line.

Syntax

WIN.COMSUB (REC)

Parameters

The following table describes the parameters of the WIN.COMSUB command:


REC The PC script to execute

Examples


* Have to temporarily put scrollregion back to whole screen*CALL WIN.COMSUB("Screen ScrollRegion")

Related Subroutines

WC, WIN.COMLINE, WIN.HSCRIPT

WIN.CURSORThis subroutine sets the shape of the cursor in the host emulation screen and turns it on and off.

Syntax

WIN.CURSOR (TYPE, TURN.ON)

WIN.DBANIM

25

Parameters

The following table describes the parameters of the WIN.CURSOR command:


TYPE Specifies the type of cursor you want to show.TURN.ON "ON" shows the cursor. "OFF" hides the cursor.

Values for TYPE

Use one of the following literal values:

Value Description

"LINE" Displays a line cursor"BLOCK" Displays a block cursor"" Displays a line cursor

Examples

The following example turns on the line cursor.

CALL WIN.CURSOR("LINE", "ON")

WIN.DBANIMThis subroutine adds an animation control to a dialog box. The animation control displays a simpleanimation on a dialog box.

Use WIN.DBEVENT to set up the events to be returned by the control. The initial properties of acontrol can be set with WIN.DBINIPRP. After the dialog box containing the control has been shown,properties can be set and retrieved using WIN.DBSETPRP and WIN.DBGETPRP. The methods of thecontrol can be run at this time using WIN.DBMETHOD.

For a full list of properties, methods, and events, see the Client Scripting Reference.

Syntax

WIN.DBANIM (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBANIM command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameX Column positionY Row positionW WidthD DepthSTYLE See Client Scripting Reference for details


26

Related Subroutines

WIN.DBINIPRP, WIN.DBEVENTS, WIN.DBSETPRP, WIN.DBGETPRP, WIN.DBMETHOD


DialogBox Animate

Version

4.0.1 Original

WIN.DBATTACHThis subroutine attaches a modal dialog box to an existing dialog box. When a dialog box is attached,the parent dialog box cannot receive input until the attached box is closed.

Syntax

WIN.DBATTACH (DLGNAME, PARENT, ERR)

Parameters

The following table describes the parameters of the WIN.DBATTACH command:


DLGNAME The name of the dialog box shownPARENT Specifies the main dialog boxERR The error codes returned:

0 - No error.

1 - The dialog definition is missing a name.

2 - The dialog box is shown.

3 - The dialog box is loaded.

4 - Unable to create the dialog box.

Examples

The following example prints an error message if there is an error attaching the dialog box.

CALL WIN.DBATTACH(DBSURE, DBXNAME, ERR)IF ERR THEN PRINT "CANT ATTACH SURE DIALOG ":ERR; RETURN

Related Subroutines

WIN.DBSHOW


DialogBox Show

WIN.DBAXCTRL

27

WIN.DBAXCTRLThis subroutine adds an ActiveX control to a dialog box.


Syntax

WIN.DBAXCTRL (DBX, NAME, PROGID, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBAXCTRL command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the namePROGID The PROGID or class ID enclosed in {} for the ActiveX controlX Column positionY Row positionW WidthD DepthSTYLE See the following Style table

Values for STYLE

Value Description

WS_DISABLED Disables the control.WS_GROUP Makes this control the first in a group. Up and down arrows move to the

previous or next control in the group.WS_TABSTOP Tab or back tab moves to the previous or next control with WS_TABSTOP

style.WS_VISIBLE The control is visible (the default).

Related Subroutines



DialogBox AxControl

Version

4.0.2 Original


28

WIN.DBBOXThis subroutine adds a 3D box or line to a dialog box. This is used as a visual way to enclose orseparate area of the dialog box.

Syntax

WIN.DBBOX (DBX, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBBOX command:


DBX The wIntegrate "handle" for a dialog boxX Column positionY Row positionW WidthD DepthSTYLE See the following Style table

Values for STYLE

Value Description

"SUNKEN" or "S" Sunken rectangle"RAISED" or "R" Raised rectangle"ETCHED" or "E" Etched rectangle"HORZ" or "H" Etched horizontal line"VERT" or "V" Etched vertical line"FRAME" or "F" Etched Frame (this is identical to "ETCHED")

Examples

The following example defines a dialog box that shows all the box styles.

* SINK.TEXT = "";SINK.TEXT<3> = 1; * Sunken text option for text and labels*CALL WIN.DBNEW(DBX, DLG.NAME, "Static control demo",8,8,252,106,"","")CALL WIN.DBLABEL(DBX, "This is a normal label",5,8,78,12,"")CALL WIN.DBLABEL(DBX, "This is a sunken label",141,8,78,12,SINK.TEXT)CALL WIN.DBTEXT(DBX, "Text1", 5,22,78,12,"")CALL WIN.DBINIPRP(DBX,"Text1","","This is normal text")CALL WIN.DBTEXT(DBX, "Text2", 141,22,78,12, SINK.TEXT)CALL WIN.DBINIPRP(DBX,"Text2","","This is sunken text")CALL WIN.DBLABEL(DBX, "Sunken box:",5,46,53,12,"")CALL WIN.DBBOX(DBX, 71,44,40,12,"SUNKEN")CALL WIN.DBLABEL(DBX, "Raised box:",5,66,40,12,"")CALL WIN.DBBOX(DBX, 71,65,40,12,"RAISED")CALL WIN.DBLABEL(DBX, "Etched box:",5,86,40,12,"")CALL WIN.DBBOX(DBX, 71,84,40,12,"ETCHED")CALL WIN.DBLABEL(DBX, "Horizontal line:",128,46,54,12,"")CALL WIN.DBBOX(DBX, 196,44,40,12,"HORZ")

WIN.DBBUTTON

29

CALL WIN.DBLABEL(DBX, "Vertical line:",128,66,40,12,"")CALL WIN.DBBOX(DBX,196,65,40,12, "VERT")CALL WIN.DBLABEL(DBX, "Etched Frame:",128,86,52,12,"")CALL WIN.DBBOX(DBX, 196,84,40,12, "FRAME")*CALL WIN.DBBUTTON(DBX,"Cancel","Close",111,120,40,12,1)*

Version

4.1.1 Original

WIN.DBBUTTONThis subroutine adds a raised rectangle push button to a dialog box. Use push buttons to initiate somekind of action in the dialog box.

The unit of measure for the parameters X, Y, W, and D is a dialog box unit. This is calculated as 1/4 ofthe average width and 1/8 of the average depth of the dialog box font.

Syntax

WIN.DBBUTTON (DBX, NAME, TEXT, X, Y, W, D, DEF)

Parameters

The following table describes the parameters of the WIN.DBBUTTON command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameTEXT Specifies the text for the captionX Column positionY Row positionW Width; default width is 40D Depth; default depth is 14DEF Specifies that this push button is the default button. An "OK" button is usually

the default in a dialog box.

0 - Not the default button

1 - Default button

Examples

The following example is part of the WIN.DBDEMO demonstration program.

CALL WIN.DBBUTTON(DBX,"OK","OK",158,4,'','',1)CALL WIN.DBBUTTON(DBX,"Cancel","Cancel",158,20,'','',0)* The two lines listed above produce the "OK" and "Cancel" buttons* in the larger dialog box. The "OK" button is the default, displayed* as a box with a defined border.


30

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBCAPT, WIN.DBEVENT


DialogBox Pushbutton, DialogBox DefPushButton

WIN.DBCAPTThis subroutine changes the caption of an existing window or button.

Syntax

WIN.DBCAPT (DLGNAME, NAME, TEXT)

Parameters

The following table describes the parameters of the WIN.DBCAPT command:


DLGNAME The name of the dialog box shownNAME Specifies the name of a button; use "" to change the window titleTEXT Specifies the text for the caption

Examples

The following example changes the “Cancel” button text to “Close.”

* Change the Cancel button name to CloseCALL WIN.DBCAPT("DEMODLG", "CANCEL", "Close")

WIN.DBCHECKThis subroutine adds a square check box to a dialog box. A check box can be turned on or off. When acheck box is turned on, it displays an "x"; when it is turned off, it is empty.

Note: When you want the user to be able to select more than one of several options, use radiobuttons in a group box.

Syntax

WIN.DBCHECK (DBX, NAME, TEXT, X, Y, W, D)

Parameters

The following table describes the parameters of the WIN.DBCHECK command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameTEXT Specifies the text for the caption

WIN.DBCHILD

31


X Column positionY Row positionW Width; default width is 40D Depth; default depth is 14

Examples


Run this program from your database prompt.

CALL WIN.DBNEW(DBX, DLG.NAME, "Demonstration of Dialog boxes", 10,10,200,160, '','')*CALL WIN.DBLABEL(DBX,"Label 1",4,4,'','','')CALL WIN.DBEDIT(DBX,"E1",40,4,40,'','')CALL WIN.DBTEXT(DBX,"T1",4,24,80,'','C')CALL WIN.DBCHECK(DBX,"C1","Check one",4,36,60,'')*

Related Subroutines



DialogBox CheckBox, DialogBox ControlCommand

WIN.DBCHILDThis subroutine attaches a modeless dialog box to an existing dialog box.

The child dialog box should be given the WS_CHILD style when it is created.

Syntax

WIN.DBCHILD (DLGNAME, PARENT, ERR)

Parameters

The following table describes the parameters of the WIN.DBCHILD command:


DLGNAME The name of the dialog box to be attachedPARENT The name of the dialog box to be attached toERR Set to 0 if OK, otherwise an error number; see the following Err table

Values for ERR

Error Numbers returned:

Value Description

0 No error.


32

Value Description

1 Dialog box name is invalid.2 Dialog box is already displayed.3 Dialog box with this name has not been created.4 Unable to display dialog box.

Related Subroutines

WIN.DBSHOW


DialogBox Window

Version

4.0.1

WIN.DBCOMBOThis subroutine adds a combo box to a dialog box. A combo box is a text field or edit field combinedwith a list box.

The list box can be displayed at all times (CBS_SIMPLE), pulled down by the user (CBS_DROPDOWNor CBS_DROPDOWNLIST), or automatically shown for auto completion (CBS_AUTOCOMPLETE).

Populate the box with data using WIN.DBSET, and select a default option with WIN.DBSELECT.

See the ComboBox control in Client Script Reference for more details.

Syntax

WIN.DBCOMBO (DBX, NAME, X, Y, W, D, OPTS)

Parameters

The following table describes the parameters of the WIN.DBCOMBO command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameX Column positionY Row positionW Width; default width is 40D Depth; default depth is 14OPTS Available options; see the following Opts table

Fields for OPTS

This is a dynamic array with two fields:

WIN.DBCTRL

33

Field Description

1 Style - Combo box style flags. See the information about script controls in theClient Scripting Reference.

2 Maximum field length.

Examples


Notice that WIN.DBCOMBO creates the box, and later in the program, WIN.DBSET sets the data forthe box. WIN.DBSELECT selects one of the data options as the default.

CALL WIN.DBLIST(DBX, "L1", 68,52,50,52, "WS_BORDER | WS_TABSTOP | LBS_NOTIFY")CALL WIN.DBCOMBO(DBX,"CB1",122,52,50,52,'')CALL WIN.DBSCROLL(DBX,"S1", 4,116,60,'','WS_TABSTOP','','')CALL WIN.DBIMAGE(DBX,"I1", "image\computer.wmf",68,116,100,40)...*IF ERR = 0 THEN CALL WIN.DBSET(DLG.NAME,"T1","Centered Text") CALL WIN.DBSET(DLG.NAME,"R1",1) R.LIST = "Option 1" R.LIST<-1>="Option 2" R.LIST<-1>="Option 3" CALL WIN.DBSET(DLG.NAME,"L1", R.LIST) CALL WIN.DBSELECT(DLG.NAME,"L1", "Option 2") CALL WIN.DBSET(DLG.NAME,"CB1",R.LIST) CALL WIN.DBSELECT(DLG.NAME,"CB1", "Option 3")END

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBSET, WIN.DBSELECT, WIN.DBEVENT


DialogBox ComboBox, DialogBox Validate

WIN.DBCTRLThis subroutine adds a control of the specified class to the dialog box.

It is an advanced routine that is used when a special set of styles is required for a control that is notavailable using the standard control routines (such as WIN.DBTEXT).

Syntax

WIN.DBCTRL (DBX, NAME, CLASS, TEXT, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBCTRL command:


34


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameCLASS The class name of the controlTEXT The text for the control if this specific control class requires textX Column positionY Row positionW WidthD DepthSTYLE Styles appropriate to the control

Examples

The following example adds some etched lines to the dialog box.

CALL WIN.DBCTRL(DBX, "None", "static" , "", 140, 70,6, 12, "SS_ETCHEDVERT|WS_VISIBLE")CALL WIN.DBCTRL(DBX, "HL", "static", "", 140, 70, 41, 12,"SS_ETCHEDHORZ|WS_VISIBLE")CALL WIN.DBCTRL(DBX, "VL", "static", "", 100, 58, 6, 14,"SS_ETCHEDVERT|WS_VISIBLE")


DialogBox Control

Version

4.1 Original

WIN.DBDELThis subroutine deletes a dialog box that was loaded using WIN.DBLOAD.

You must use this command to delete the dialog box from memory, or the next time you try to run itwithin the same session, you will get an error message that the dialog box is already shown. Use theWIN.DBEND command to close the dialog box, then WIN.DBDEL to delete it from memory.

Syntax

WIN.DBDEL (DLGNAME)

Parameters

The following table describes the parameters of the WIN.DBDEL command:


DLGNAME The name of the dialog box to delete

Examples

The following example is a part of the WIN.PRODMD2 demonstration program.

*CALL WIN.DBEND(DBXNAME,0)

WIN.DBDTTIME

35

CALL WIN.DBDEL(DBXNAME)

WIN.DBDTTIMEThis subroutine adds a date/time control to a dialog box. The date/time control displays a control intowhich provides entry of a date, a time, or both.



Syntax

WIN.DBDTTIME (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBDTTIME command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameX Column positionY Row positionW WidthD DepthSTYLE See the following Style table

Values for STYLE

Value Description

DTS_CALENDAR Provides a drop-down calendarDTS_UPDOWN Provides a spin control

Related Subroutines



DialogBox DateTime

Version

4.1 Original

WIN.DBEDGETThis subroutine gets data from a multi-line edit box.


36

If the dialog box is shown by WIN.DBSHOW, then the value that is returned is the current value in thedialog box. Otherwise, the value is the value that is stored in memory.

Carriage returns can be typed only into an edit control if the control is created as ES_WANTRETURN.Each carriage return in the edit control is returned as a field mark (character 254), unless the RET.MVflag is true. Then, each carriage return is returned as a value mark (character 253).

Syntax

WIN.DBEDGET (DLG.NAME, NAME, VALUE, RET.MV)

Parameters

The following table describes the parameters of the WIN.DBEDGET command:


DLG.NAME The name of the loaded dialog boxNAME The name of the controlVALUE The current value of the dialog box variableRET.MV Returns multivalued

Examples

The following example prints the lines from an edit control.

CALL WIN.DBEDGET(DLG.NAME, "E1", VALUE, 0)N = DCOUNT(VALUE, CHAR(254))FOR J = 1 TO NPRINT "Paragraph ":J:" = ":VALUE<J>NEXT J

Related Subroutines

WIN.DBGET, WIN.DBEDSET, WIN.DBSET

WIN.DBEDGET2Use this routine to get data from a multi-line edit box.


Carriage returns can be typed only into an edit control if the control is created as ES_WANTRETURN.Each carriage return in the edit control is returned as a field mark (character 254), unless the RET.MVflag is true. Then, each carriage return is returned as a value mark (character 253).

This is similar to WIN.DBEDGET, but has an additional parameter to capture any events that mightoccur while fetching the property. This is useful when a dialog box can receive fast type-ahead when itis allowing uncontrolled navigation between the fields.

Syntax

WIN.DBEDGET2 (DLG.NAME, NAME, VALUE, RET.MV, ESTACK)

WIN.DBEDIT

37

Parameters

The following table describes the parameters of the WIN.DBEDGET2 command:


DLG.NAME The name of the loaded dialog boxNAME The name of the controlVALUE The current value of the dialog box variableRET.MV Returns multivaluedESTACK Variable to store any events that occur during the get

Examples

The following example prints the lines from an edit control.

CALL WIN.DBEDGET2(DLG.NAME, "E1", VALUE, 0, ESTACK)N = DCOUNT(VALUE, CHAR(254))FOR J = 1 TO NPRINT "Paragraph ":J:" = ":VALUE<J>NEXT J

Related Subroutines

WIN.DBGET2, WIN.DBEDSET, WIN.DBEDGET

Version


WIN.DBEDITThis subroutine adds a box that you can use to edit or enter text to a dialog box.

See the Edit control in the Client Scripting Reference for details.

Syntax

WIN.DBEDIT (DBX, NAME, X, Y, W, D, OPTS)

Parameters

The following table describes the parameters of the WIN.DBEDIT command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameX Column positionY Row positionW Width; default width is 40D Depth; default depth is 14OPTS Dynamic array with two fields; see the following Opts table


38

Fields for OPTS

Field Description

1 Style; 1 or a combination of flags. See the Edit control in the Client ScriptingReference for details.

2 Maximum length

Examples


CALL WIN.DBNEW(DBX, DLG.NAME, "Demonstration of Dialog boxes", 10,10,200,160, '','')*CALL WIN.DBLABEL(DBX,"Label 1",4,4,'','','')CALL WIN.DBEDIT(DBX,"E1",40,4,40,'','')CALL WIN.DBTEXT(DBX,"T1",4,24,80,'','C')CALL WIN.DBCHECK(DBX,"C1","Check one",4,36,60,'')

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBSET, WIN.DBEVENT, WIN.DBTEXT, WIN.DBEDGET, WIN.DBGET,WIN.DBEDSET, WIN.DBSET


DialogBox EditText, DialogBox Validate

WIN.DBEDSETThis subroutine sets the value of a multi-line edit control in a dialog box.

If the dialog box is currently shown, the dialog box display is updated. If the dialog box is not shown,the change is stored in memory to display on the dialog box when it is next shown. Both field marks(character 254) and value marks (character 253) are converted to carriage returns in the edit control.

Syntax

WIN.DBEDSET (DLGNAME, NAME, VALUE)

Parameters

The following table describes the parameters of the WIN.DBEDSET command:


DLGNAME The name of the dialog box shownNAME Specifies the nameVALUE The new value for the control

Examples

The following example puts two lines of text in the control.

TEXT = "This is a multi-line edit control"TEXT<-1> = "This is the second line"

WIN.DBENABLE

39

CALL WIN.DBEDSET(DLG.NAME,"E1",TEXT)

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBEDIT, WIN.DBSET, WIN.DBEVENT, WIN.DBTEXT, WIN.DBEDGET,WIN.DBGET, WIN.DBSET

WIN.DBENABLEThis subroutine enables or disables dialog box controls. When a control is enabled, the user can selectit, and when a control is disabled, it displays as gray and cannot be selected.

Syntax

WIN.DBENABLE (DLGNAME, NAMES, ENABLE)

Parameters

The following table describes the parameters of the WIN.DBENABLE command:


DLGNAME The name of the dialog box that has been loaded with WIN.DBLOADNAMES The control names as a multi-field arrayENABLE Enable or disables controls:

0 - Disables controls

1 - Enables controls

Examples

The following example disables ID and Lookup fields.

R.CTRLS=""R.CTRLS<-1> = "LookupButton"R.CTRLS<-1> = "CustId"CALL WIN.DBENABLE("CustMaint", R.CTRLS, 0)

Related Subroutines

WIN.DBENALL


DialogBox Enable

WIN.DBENALLThis subroutine is similar to WIN.DBENABLE, but it enables or disables the entire dialog box or all ofthe named controls in the dialog box.

Named controls are those given a name other than “None” in the control definition.


40

Syntax

WIN.DBENALL (DLGNAME, OPTS, ENABLE)

Parameters

The following table describes the parameters of the WIN.DBENALL command:


DLGNAME The name of the dialog box that has been loaded in WIN.DBLOADOPTS The options to enable or disable the window or controls:

0 - Enables or disables the dialog box window

1 - Enables or disables dialog box controlsENABLE Enable or disable controls:

0 - Disables window or controls

1 - Enables window or controls

Examples

The following example disables all controls except the ProdRef edit text.

CALL WIN.DBENALL(DBXNAME, 1, FALSE)CALL WIN.DBENABLE(DBXNAME, "ProdRef", TRUE)

Related Subroutines

WIN.DBENABLE


DialogBox EnableAll

WIN.DBENDThis subroutine ends the display of a dialog box.

You must use this command to remove the dialog box from the screen, and then use WIN.DBDEL toremove the dialog box from memory.

Syntax

WIN.DBEND (DLGNAME, UPDATE)

Parameters

The following table describes the parameters of the WIN.DBEND command:


DLGNAME The name of the dialog box shown

WIN.DBESTACK

41


UPDATE This variable specifies whether the dialog box values are updated. If theyare updated, the values from the controls are copied to the memory values.Otherwise, the in memory stays the same as when the dialog box was firstshown.

0 - Do not update dialog variable

1 - Update dialog variable

Examples


* Process dialog DlgDemo events1000 BEGIN CASECASE CTRL='OK' CALL WIN.DBEND(DLG.NAME, TRUE) FINISHED=TRUECASE CTRL='Cancel' CALL WIN.DBEND(DLG.NAME,FALSE) FINISHED=TRUEEND CASERETURN

Related Subroutines

WIN.DBSHOW, WIN.DBDEL, WIN.DBGET, WIN.DBSET


DialogBox End

WIN.DBESTACKThis subroutine reads the next event from a dialog box or menu defined using the host routines andstores it in a variable for future processing by WIN.DBEVENT2.

Syntax

WIN.DBESTACK (ESTACK)

Parameters

The following table describes the parameters of the WIN.DBESTACK command:


ESTACK Variable to store the event in

Related Subroutines

WIN.DBEVENT2


42

Version

4.0.1 Original

WIN.DBEVENTThis subroutine waits for an event and returns the event type.

If event arguments are required, use WIN.DBEVENT2.

Syntax

WIN.DBEVENT (DLGNAME, CTRL, ETYPE)

Parameters

The following table describes the parameters of the WIN.DBEVENT command:


DLGNAME The name of a dialog box, which is designated in WIN.DBNEWCTRL The returned control name for an eventETYPE The event type; see the following Event Type table

Values for ETYPE

The following event types are returned:

Value Description

U Unknown - Unrecognized line input. The line is returned in the CTRLparameter.

M Menu - The menu option that is selected is returned.D Default - The control has received the focus. This event is produced by the

edittext, listbox, and combobox controls.V Validate - The control has lost the input focus.C Button-click - The control has been clicked.DC Double-click - Returns that a list box with the LBS_NOTIFY style has been

double-clicked.S Scroll - A scroll bar has been scrolled.Number Event number set up by WIN.DBEVENTS.K Key that is defined with WIN.DBKEY pressed. In this case, the CTRL

parameter will be the key name.

Examples


CALL WIN.DBEVENT(DLG,CTRL,EVENT)*BEGIN CASECASE EVENT = 'U'; PRINT 'Unknown':CASE EVENT = 'M'; PRINT 'Menu':CASE EVENT = 'V'; PRINT 'Validation':CASE EVENT = 'D'; PRINT 'Default':

WIN.DBEVENT2

43

CASE EVENT = 'C'; PRINT 'Button Click':CASE EVENT = 'DC'; PRINT 'Double Click':CASE EVENT = 'S'; PRINT 'Scroll':CASE 1PRINT 'Event ':EVENT:END CASE*IF DLG # '' THENPRINT ' dialog ':DLG:' Control ':CTRLEND ELSEPRINT ' data ':CTRLEND*BEGIN CASECASE DLG = ''; IF CTRL ='*' THEN FINISHED=TRUECASE DLG = DLG.NAME; GOSUB 1000; * Process DlgDemo eventsEND CASE*UNTIL FINISHED DOREPEAT*CALL WIN.TWCLOSE("DLGDEMO")

Related Subroutines

WIN.DBNEVENT, WIN.DBFETCH, WIN.DBEVENT2, WIN.DBEVENTS, WIN.DBKEY

Version

6.0.1 K event

WIN.DBEVENT2This subroutine returns the next event from a dialog box or menu that is defined using the hostroutines.

It should be used in preference to WIN.DBEVENT as it allows the return of events that returnadditional values.

Syntax

WIN.DBEVENT2 (DLG.NAME, CTRL, ETYPE, ARGS, ESTACK)

Parameters

The following table describes the parameters of the WIN.DBEVENT2 command:


DLG.NAME The name of the dialog box the event occurred onCTRL The name of the control that generated the eventETYPE The event type; see the following Event Type tableARGS Comma-separated list of values that are returned by the eventESTACK Event stack; see WIN.DBESTACK, on page 41


44

Values for ETYPE

Value Description

Letter See WIN.DBEVENT for a list of the standard values.Number Event number set up by WIN.DBEVENTS.

Related Subroutines

WIN.DBESTACK, WIN.DBEVENT, WIN.DBEVENTS

Version

4.0.1 Original

WIN.DBEVENTRThis subroutine removes the events associated with the last control added to a dialog box.

Its normal use is to prevent events from being generated that would interfere with a dialog box set upto use type-ahead with WIN.DBTYPEAH.

It can also be used if the host application is not interested in the events for a particular control anddoes not want them returned to the WIN.DBEVENT2 routine.

Syntax

WIN.DBEVENTR (DBX)

Parameters

The following table describes the parameters of the WIN.DBEVENTR command:


DBX The wIntegrate "handle" for a dialog box

Examples

The WIN.TADEMO program provides an example of how this subroutine is used.

Additionally, the following example removes default and validation events from an edit control.

CALL WIN.DBEDIT(DBX, "DESC", 44, Y, 120, 12, "")CALL WIN.DBEVENTR(DBX)

Related Subroutines

WIN.DBTYPEAH, WIN.DBEVENT2

Version

6.0.1 Original

WIN.DBEVENTS

45

WIN.DBEVENTSThis subroutine sets up the events to be returned to the host for the dialog box controls.

These events are retrieved with WIN.DBEVENT2.

For details on the events that are generated, see the Client Scripting Reference.

Syntax

WIN.DBEVENTS (DBX, NAME, EVENTS)

Parameters

The following table describes the parameters of the WIN.DBEVENTS command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameEVENTS Dynamic array of the events to be returned for this control; WIN.DBEVENT2

will return the position of the event in this array when the dialog boxgenerates an event on this control. See the following table for the format ofeach field in the array.

Fields for EVENTS

The events array contains the following multivalues:

Field Description

1 The event name2 The event arguments; the name of the arguments that are associated with the

event (if required)

Examples

The following example sets up events for a tab control Tab1 and tree view Oak.

CALL WIN.DBEVENTS(DBX,'Tab1','SelChanged')CALL WIN.DBEVENTS(DBX,'Oak', 'SelChanged':AM:'EndLabelEdit')

Related Subroutines

WIN.DBEVENT2

Version

4.0.1 Original

WIN.DBFETCHThis subroutine checks the next event if there is one pending, or returns TYPE = "" if no eventexists.

It returns the same value as the WIN.DBEVENT command.


46

You need to use this routine after a validation event is received by the host; then the PC sends the nextevent automatically. The controlling host program can accept or reject the event, depending on theresults of the validation. It allows the controlling host program to preserve the event that could belost by the validation process. If the event returned by WIN.DBFETCH requires action, repost it to theevent queue with WIN.DBPOST when the validation completes.

Syntax

WIN.DBFETCH (DLG, CTRL, TYPE)

Parameters

The following table describes the parameters of the WIN.DBFETCH command:


DLG The name of the dialog boxCTRL The control name for the next eventTYPE The event type of the next event; see the Event table in WIN.DBEVENT

Examples

The following example is taken from the WIN.CUSTMD demonstration program.

* Validation events* These events are often immediately followed by a default for the* Next field or a button click. So we must use WIN.DBFETCH to check* the next event and WIN.DBPOST to re-queue it (if required).*300 CALL WIN.DBFETCH(NEXT.DLG, NEXT.CTRL, NEXT.ETYPE)** If next event is click on cancel don't bother with validationIF NEXT.ETYPE = "C" AND NEXT.CTRL = "Cancel" THENPRINT "Ignoring last event as it is followed by:-"BEGIN CASECASE FLD = "CustRef"; GOSUB 1050; * Validate customer numberCASE FLD = "Name"; GOSUB 1150; * Validate NameCASE FLD = "Street"; CALL WIN.DBGET(DBX.NAME, FLD, CUST.STREET)CASE FLD = "City" ; CALL WIN.DBGET(DBX.NAME, FLD, CUST.CITY)CASE FLD = 'State'; CALL WIN.DBGET(DBX.NAME, FLD, CUST.STATE)CASE FLD = 'Zip'; CALL WIN.DBGET(DBX.NAME, FLD, CUST.ZIP)CASE FLD = 'Tel'; CALL WIN.DBGET(DBX.NAME, FLD, CUST.TEL) CASE FLD = 'Fax'; CALL WIN.DBGET(DBX.NAME, FLD, CUST.FAX) CASE FLD = 'Salesman'; CALL WIN.DBGET(DBX.NAME, FLD, CUST.SALESMAN)CASE FLD = 'Comment'; CALL WIN.DBGET(DBX.NAME, FLD, CUST.COMMENT)CASE FLD = "Discount"; GOSUB 1250; * Validate discountEND CASEIF NEXT.ETYPE # "" THEN CALL WIN.DBPOST(NEXT.DLG, NEXT.CTRL, NEXT.ETYPE)END*RETURN*

Related Subroutines

WIN.DBEVENT, WIN.DBFETCH2

WIN.DBFETCH2

47

WIN.DBFETCH2This subroutine checks the next event if there is one pending, or returns TYPE = "" if no eventexists.

It returns the same values as the WIN.DBEVENT2 command.

You might need to use this routine after a validation event is received by the host; then the PC sendsthe next event automatically. The controlling host program can accept or reject the event, dependingon the results of the validation. It allows the controlling host program to preserve the event that couldbe lost by the validation process. If the event returned by WIN.DBFETCH2 requires action, repost it tothe event queue with WIN.DBPOST2 when the validation completes.

See WIN.DBGET2, on page 49 for an example.

Syntax

WIN.DBFETCH2 (DLG.NAME, CTRL, ETYPE, ARGS, ESTACK)

Parameters

The following table describes the parameters of the WIN.DBFETCH2 command:


DLG.NAME The name of the dialog box the event occurred onCTRL The name of the control that generated the eventETYPE The event type; see the following Event Type tableARGS Comma-separated list of values that are returned by the eventESTACK Variable containing the Event stack

Values for ETYPE

Value Description

Letter See WIN.DBEVENT for a list of the standard values.Number Event number set up by WIN.DBEVENTS.

Related Subroutines

WIN.DBEVENT2, WIN.DBGET2, WIN.DBPOST2

Version


WIN.DBFOCUSThis subroutine sets the input focus to a dialog box control.

Syntax

WIN.DBFOCUS (DLGNAME, NAME)


48

Parameters

The following table describes the parameters of the WIN.DBFOCUS command:


DLGNAME The name of the dialog box set in WIN.DBNEWNAME The name of the control

Examples


* Enable/Disable fields* For first input only ProdRef and cancel button are enabled* While amending, everything is enabled except ProdRef* Also modify cancel button caption to specify its function5150 CALL WIN.DBENALL(DBXNAME,1, AMENDING)CALL WIN.DBENABLE(DBXNAME, "ProdRef", NOT(AMENDING))*IF AMENDING THEN CALL WIN.DBFOCUS(DBXNAME, "Name") CALL WIN.DBCAPT(DBXNAME, "Cancel", "Void")END ELSE * Always enable Cancel CALL WIN.DBENABLE(DBXNAME, "Cancel", TRUE) CALL WIN.DBCAPT(DBXNAME, "Cancel", "Exit") CALL WIN.DBFOCUS(DBXNAME, "ProdRef")END*RETURN

Related Subroutines

WIN.DBSHOW, WIN.DBEVENT

WIN.DBGETThis subroutine gets the current value of a control.


Use WIN.DBGET to return values from a multi-lined edit control.

Syntax

WIN.DBGET (DLG.NAME, NAME, VALUE)

Parameters

The following table describes the parameters of the WIN.DBGET command:


DLG.NAME The name of the loaded dialog boxNAME The name of the control

WIN.DBGET2

49


VALUE The value of the dialog box variable

Examples


* Display result of dialog1100 PRINT @(0,3):@(-3):"You clicked OK or pressed return to end the dialog"PRINTPRINT 'On the dialog you had set:-'CALL WIN.DBGET(DLG.NAME, "E1", VALUE)PRINT 'The Edit field to "':VALUE:'"'CALL WIN.DBGET(DLG.NAME, "C1", VALUE)PRINT "The check box was ":IF VALUE THEN PRINT "Checked" ELSE PRINT "Unchecked"CALL WIN.DBGET(DLG.NAME, "G1", VALUE)PRINT 'You selected radio option "':*BEGIN CASE CASE VALUE = "R1"; PRINT "Radio one": CASE VALUE = "R2"; PRINT "Radio two": CASE VALUE = "R3"; PRINT "Radio three":END CASEPRINT '"'*CALL WIN.DBGET(DLG.NAME, "L1", VALUE)PRINT 'List box option "': VALUE : '"'CALL WIN.DBGET(DLG.NAME, "CB1", VALUE)PRINT 'Combo box value "': VALUE : '"'CALL WIN.DBGET(DLG.NAME, "S1", VALUE)PRINT 'Scroll bar position "': VALUE : '"'

Related Subroutines

WIN.DBSET, WIN.DBEDGET, WIN.DBGETPRP, WIN.DBGETM, WIN.DBGET2

WIN.DBGET2This subroutine gets the value for a controls property after it is loaded to the PC with WIN.DBLOAD.

This is similar to WIN.DBGET and WIN.DBGETPRP, but has an additional parameter to capture anyevents that might occur while fetching the property. This is useful when a dialog box can receive fasttype-ahead when it is allowing uncontrolled navigation between the fields.

For a full list of properties for each control, see the Client Scripting Reference.

Syntax

WIN.DBGET2 (DLG.NAME, NAME, PROP, VALUE, ESTACK)

Parameters

The following table describes the parameters of the WIN.DBGET2 command:


DLG.NAME The name of the loaded dialog box


50


NAME The name of the control to retrieve the property fromPROP The name of the property to retrieve; can be "" to retrieve the default

property for the controlVALUE The value that is returned for the propertyESTACK Variable to store any events that occur during the get

Examples

The following example is from the WIN.CUSTMD3 example available with the addition host demoexamples.

CALL WIN.DBFETCH2(NEXT.DLG, NEXT.CTRL, NEXT.ETYPE, NEXT.ARGS, ESTACK)** If next event is click on cancel don't bother with validationIF NEXT.ETYPE = 'C' AND NEXT.CTRL = 'Cancel' THEN PRINT 'Ignoring last event as it is followed by:-' PRINT 'Event ':NEXT.ETYPE:' from ':NEXT.CTRL FLD = NEXT.CTRL GOSUB 340END ELSE * * Field Validations * Cases for most fields omitted in the manual for brevity BEGIN CASE CASE FLD = 'Street'; CALL WIN.DBGET2(DBX.NAME, FLD, "", CUST.STREET, ESTACK) CASE FLD = 'City' ; CALL WIN.DBGET2(DBX.NAME, FLD, "", CUST.CITY, ESTACK) CASE FLD = "State"; CALL WIN.DBGET2(DBX.NAME, FLD, "", CUST.STATE, ESTACK) END CASE IF NEXT.ETYPE # '' THEN CALL WIN.DBPOST2(NEXT.DLG, NEXT.CTRL, NEXT.ETYPE,NEXT.ARGS, ESTACK)END

Related Subroutines

WIN.DBGET, WIN.DBGETPRP, WIN.DBESTACK, WIN.DBEVENT2, WIN.DBFETCH2, WIN.DBPOST2

Version


WIN.DBGETMThe subroutine gets the value of multiple controls in a dialog box in one call. Using this routine isfaster than multiple calls to WIN.DBGET.

If the dialog box is displayed, the values that are returned are the current values in the dialog box,otherwise the value is the value that is stored in memory.

Use WIN.DBGET to get the value of an individual control.

Syntax

WIN.DBGETM (DLG.NAME, NAMES, VALUES)

WIN.DBGETPRP

51

Parameters

The following table describes the parameters of the WIN.DBGETM command:


DLG.NAME The name of the loaded dialog box.NAMES A dynamic array with the names of the controls to return the values for. The

name can also be specified as control_name.property_name (the propertyname added to the control name with a period to separate them) to returnthe value for a property of the control.

VALUES The variable to receive the control/property values. This is a dynamic arraythat is matched to the NAMES parameter. CR (CHAR 13) is converted to a valuemark, and TAB (CHAR 9) is converted to a sub value mark in the returned field.

Examples

The following example uses WIN.DBGETM instead of WIN.DBGET in the WIN.DBDEMO program.

* Get values from the dialog box used in WIN.DBDEMO using WIN.DBGETM1130 VALUES = ""NAMES = "E1"NAMES<2> = "C1"NAMES<3> = "G1"NAMES<4> = "L1"NAMES<5> = "CB1"NAMES<6> = "S1"CALL WIN.DBGETM(DLG.NAME, NAMES, VALUES)*PRINT 'The Edit field to "':VALUES<1>:'"'PRINT "The check box was ":IF VALUES<2> THEN PRINT "Checked" ELSE PRINT "Unchecked"PRINT 'You selected radio option "':*BEGIN CASECASE VALUES<3> = "R1"; PRINT "Radio one":CASE VALUES<3> = "R2"; PRINT "Radio two":CASE VALUES<3> = "R3"; PRINT "Radio three":END CASEPRINT '"'*PRINT 'List box option "': VALUES<4> : '"'PRINT 'Combo box value "': VALUES<5> : '"'PRINT 'Scroll bar position "': VALUES<6> : '"'RETURN

Related Subroutines

WIN.DBGET, WIN.DBEDGET, WIN.DBGETPRP, WIN.DBSET

Version

5.1.2 Added

WIN.DBGETPRPThis subroutine gets the value for a control’s property after it has been loaded to the PC withWIN.DBLOAD.


52


Syntax

WIN.DBGETPRP (DLG.NAME, NAME, PROPERTY, VALUE)

Parameters

The following table describes the parameters of the WIN.DBGETPRP command:


DLGNAME The name of the dialog box shownNAME Specifies the namePROPERTY Name of the property to setVALUE The value that is returned for the property

Related Subroutines

WIN.DBSETPRP, WIN.DBGET, WIN.DBEDGET, WIN.DBGET2, WIN.DBGETPRPL

Version

4.0.1 Original

WIN.DBGETPRPLThis subroutine gets the value for a control’s property after it has been loaded to the PC withWIN.DBLOAD.

It is available for UniData and UniVerse databases only as it uses functions specific to these platforms.It is usually faster than WIN.DBGETPRP and can be used as a replacement for it. The speed differenceis only significant for large items that contain many attribute or subvalue marks.


Syntax

WIN.DBGETPRPL (DLG.NAME, NAME, PROPERTY, VALUE)

Parameters

The following table describes the parameters of the WIN.DBGETPRPL command:


DLGNAME The name of the dialog box shownNAME Specifies the namePROPERTY Name of the property to setVALUE The value that is returned for the property

Related Subroutines

WIN.DBSETPRP, WIN.DBGET, WIN.DBEDGET, WIN.DBGET2, WIN.DBGETPRP

WIN.DBGRID

53

Version

6.3.5 Original

WIN.DBGRIDThis subroutine adds a grid control to a dialog box. The grid control displays a grid of cells. The datacells start at row 1 column 1. You can change the header information for each row or column bymodifying row 0 or column 0.



Syntax

WIN.DBGRID (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBGRID command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameX Column positionY Row positionW WidthD DepthSTYLE "" or combination of WS_TABSTOP and WS_DISABLED

Related Subroutines

WIN.DBEVENTS, WIN.DBINIPRP, WIN.DBSETPRP, WIN.DBGETPRP, WIN.DBMETHOD


DialogBox Grid

Version

4.0.1 Original

WIN.DBGROUPThis subroutine adds a rectangle group box to a dialog box. A group box contains a group of controlsthat logically belong together.

Use a group box to group radio buttons. WIN.DBGROUP must be used before WIN.DBRADIO tocreate a box with radio buttons.


54

Syntax

WIN.DBGROUP (DBX, NAME, TEXT, X, Y, W, D)

Parameters

The following table describes the parameters of the WIN.DBGROUP command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameTEXT Specifies the text for the captionX Column positionY Row positionW WidthD Depth

Examples


* The group box is the part of the dialog box that contains the radio buttons.*CALL WIN.DBGROUP(DBX,"G1","Group box",4,50,60,52)CALL WIN.DBRADIO(DBX,"R1","Radio One",6,58,50,'',1)CALL WIN.DBRADIO(DBX,"R2","Radio Two",6,72,50,'',0)CALL WIN.DBRADIO(DBX,"R3","Radio Three",6,88,50,'',0)*

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBCAPT, WIN.DBEVENT, WIN.DBRADIO

WIN.DBHEADERThis subroutine adds a header control to a dialog box.



Syntax

WIN.DBHEADER (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBHEADER command:



WIN.DBHTML

55


NAME Specifies the nameTEXT Specifies the text for the captionX Column positionY Row positionW WidthD DepthSTYLE See Client Scripting Reference for details

Related Subroutines



DialogBox Header

Version

4.0.1 Original

WIN.DBHTMLThis subroutine adds an HTML control to a dialog box. An HTML control is an area of the dialog boxthat displays text that has been specified using HTML format.

See the HtmlControl control in the Client Scripting Reference for more details.

Syntax

WIN.DBHTML (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBHTML command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameX Column positionY Row positionW WidthD DepthSTYLE The style for the control

Examples

The following example defines a simple test dialog with an HTML control.

DLGNAME = "HTMLTEST"CALL WIN.DBNEW(DBX,DLGNAME, "HTML TEST", 10,10,200,120, "","")CALL WIN.DBHTML(DBX,"HT", 5,5,190,90,"")


56

CALL WIN.DBEVENTS(DBX,"HT","LinkClick":CHAR(253):"url")CALL WIN.DBINIPRP(DBX, "HT", "HTML", 'Sample <B>HTML</B> Text. <P><A HREF ="link1">Link One</A><P><A HREF ="link2">Link Two</A>')CALL WIN.DBBUTTON(DBX, "CANCEL","Close", 86, 104, 28, 15, 0)

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBINIPRP, WIN.DBSETPRP, WIN.DBEVENTS, WIN.DBEVENT2


DialogBox HtmlControl

Version


WIN.DBIMAGEThis subroutine adds an image to a dialog box. You can use this subroutine if you want to add agraphic to a dialog box to illustrate a point or to add a logo.

Refer to the table in this section listing the image formats supported by wIntegrate. You must includethe full path of the image if it does not reside in the wIntegrate directory.

Syntax

WIN.DBIMAGE (DBX, NAME, FILE, X, Y, W, D)

Parameters

The following table describes the parameters of the WIN.DBIMAGE command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameFILE Specifies the PC file nameX Column positionY Row positionW WidthD Depth

Values for FILE

The following table describes the image formats that are supported:

Value Description

.ico Windows icon format

.bmp Windows bitmap format

.wmf Windows metafile format

.jpg Joint Photographic Expert Group

WIN.DBIMBUT

57

Value Description

.pcx ZSoft image format

Examples


CALL WIN.DBLIST(DBX, "L1", 68,52,50,52, "WS_BORDER | WS_TABSTOP | LBS_NOTIFY")CALL WIN.DBCOMBO(DBX,"CB1",122,52,50,52,'')CALL WIN.DBSCROLL(DBX,"S1", 4,116,60,'','WS_TABSTOP','','')CALL WIN.DBIMAGE(DBX,"I1", "image\computer.wmf",68,116,100,40)

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBEVENT, WIN.IMAGE


DialogBox Graphic

WIN.DBIMBUTThis subroutine adds an image as a push button to a dialog box.

To add functionality to the graphic, you must use the WIN.DBEVENT subroutine.

Syntax

WIN.DBIMBUT (DBX, NAME, FILE, X, Y, W, D)

Parameters

The following table describes the parameters of the WIN.DBIMBUT command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameFILE Specifies the PC file nameX Column positionY Row positionW WidthD Depth

Examples


CALL WIN.DBIMBUT(DBX,"IB","image\normal.bmp",158,36,'','')

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBEVENT, WIN.DBIMAGE, WIN.IMAGE


58


DialogBox Graphic, DialogBox GraphicButton

WIN.DBINIPRPThis subroutine sets the initial value for a controls property when it is loaded to the PC withWIN.DBLOAD.


Syntax

WIN.DBINIPRP (DBX, NAME, PROPERTY, VALUE)

Parameters

The following table describes the parameters of the WIN.DBINIPRP command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the namePROPERTY Name of the property to setVALUE New value of the property

Related Subroutines

WIN.DBSETPRP

Version

4.0.1 Original

WIN.DBINITThis subroutine assigns a script command to be run whenever a dialog box is shown.

Syntax

WIN.DBINIT (DBX, INIT.CMND)

Parameters

The following table describes the parameters of the WIN.DBINIT command:


DBX The wIntegrate "handle" for a dialog boxINIT.CMND The script text to be executed when the dialog is shown


DialogBox InitCommand

WIN.DBINPOK

59

WIN.DBINPOKThis subroutine verifies the input after a validate event.

Syntax

WIN.DBINPOK (DBXNAME, OK, WIN.DBINPOK)

Parameters

The following table describes the parameters of the WIN.DBINPOK command:


DBX The wIntegrate "handle" for a dialog boxOK Returns whether input was correct:

0 - False

1 - TrueWIN.DBINPOK Parameters

Examples


* Cancel was clicked, all we need to do is skip the fields case statement* as the event will arrive in the main loop normally PRINT "Cancel clicked, skipping validation"END ELSE BEGIN CASE CASE ECTRL = "ProdRef"; GOSUB 1000; * Read product record CASE ECTRL = "Name"; GOSUB 1100; * Validate name CASE ECTRL = "Price"; GOSUB 1300; * Validate price END CASEEND*IF ERRMSG = "" THEN CALL WIN.DBINPOK(DBXNAME, TRUE)END ELSE DUM = "" CALL WIN.DBMSGBOX(DBXNAME, ERRMSG, "Product Maintenance", "MB_ICONHAND|MB_OK", DUM) CALL WIN.DBINPOK(DBXNAME, FALSE)END*

WIN.DBKEYThis subroutine sets up user-defined keys for a dialog box.

When a key is pressed after being defined here, it is returned as an event type “K” with the key name inthe CTRL parameter in WIN.DBEVENT and WIN.DBEVENT2.

Syntax

WIN.DBKEY (DBX, KEYNAMES, NAVKEY)


60

Parameters

The following table describes the parameters of the WIN.DBKEY command:


DBX The wIntegrate "handle" for a dialog boxKEYNAMES A dynamic array with the names of the keys to programNAVKEY Set to 1 if these keys are navigation keys, otherwise set to 0; see

WIN.DBTYPEAH, on page 93

Examples

The WIN.TADEMO program provides an example of how this subroutine is used.

Additionally, the following example programs F1 and F2 to return values to the host.

KEYS = ""KEYS<1> = "F1"KEYS<2> = "F2"CALL WIN.DBKEY(DBX, KEYS, 0)

Related Subroutines

WIN.DBTYPEAH, WIN.DBEVENT, WIN.DBEVENT2


DialogBox SetKey

Version

6.0.1 Original

WIN.DBLABELThis subroutine adds a label to a dialog box. Use this when you want to display the name of a text,edit, or list box.

Syntax

WIN.DBLABEL (DBX, TEXT, X, Y, W, D, OPTIONS)

Parameters

The following table describes the parameters of the WIN.DBLABEL command:


DBX The wIntegrate "handle" for a dialog boxTEXT Specifies the text for the captionX Column positionY Row positionW Width; default width is the length of the text multiplied by 4D Depth; default depth is 12

WIN.DBLABEL

61


OPTIONS Available options; see the following Options table

Fields for OPTIONS

The options are specified in a dynamic array of the following fields:

Field Description

1 Alignment:

L - Left

C - Center

R - Right2 Fixed number of dialog units to add to the width3 Put the label in a sunken rectangle if set to 1

Examples

The following example sets up a normal and sunken label.

SINK.TEXT = "";SINK.TEXT<3> = 1; * Sunken text option for text and labelsCALL WIN.DBLABEL(DBX, "This is a normal label",5,8,78,12,"")CALL WIN.DBLABEL(DBX, "This is a sunken label",141,8,78,12,SINK.TEXT)

The following example adds two dialog units to the width of the label.

OPTS = "L"OPTS<2> = 2CALL WIN.DBLABEL(DBX, "Customer", 10, 20, "", "", OPTS)


* Create and show dialog100 DBX=''DLG.NAME="DemoDlg"CALL WIN.TWMSG("Creating Dialog ":DLG.NAME:"...", "Red", "Yellow", "DOUBLE")*CALL WIN.DBNEW(DBX, DLG.NAME, "Demonstration of Dialog boxes", 10,10,200,160,'','')*CALL WIN.DBLABEL(DBX,"Label 1",4,4,'','','')CALL WIN.DBEDIT(DBX,"E1",40,4,40,'','')CALL WIN.DBTEXT(DBX,"T1",4,24,80,'','C')CALL WIN.DBCHECK(DBX,"C1","Check one",4,36,60,'')

Related Subroutines

WIN.DBNEW


DialogBox LText


62

Version

4.1.1 Added Sunken option

WIN.DBLISTThis subroutine adds a list box to a dialog box.

A list box is a rectangular area that contains a list of selectable options. Set the initial data for the listbox with WIN.DBSET, and select an option from the initial list with WIN.DBSELECT. To set tab stopswithin a list box, use the WIN.DBTABS subroutine.

See the listbox control in the Client Scripting Reference for details.

Syntax

WIN.DBLIST (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBLIST command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameX Column positionY Row positionW WidthD DepthSTYLE Specifies the style of the list box; default is LBS_NOTIFY|WS_BORDER. See the

Client Scripting Reference for a full list of styles.

Examples


* The list box is created with WIN.DBLIST, then populated with data later* in the line "CALL WIN.DBSET(DLG.NAME,"L1", R.LIST).CALL WIN.DBLIST(DBX, "L1",68,52,50,52,"WS_BORDER | WS_TABSTOP | LBS_NOTIFY")CALL WIN.DBCOMBO(DBX,"CB1",122,52,50,52,'')CALL WIN.DBSCROLL(DBX,"S1", 4,116,60,'','WS_TABSTOP','','')CALL WIN.DBIMAGE(DBX,"I1", "image\computer.wmf",68,116,100,40)...*IF ERR = 0 THENCALL WIN.DBSET(DLG.NAME,"T1","Centered Text")CALL WIN.DBSET(DLG.NAME,"R1",1)R.LIST = "Option 1"R.LIST<-1>="Option 2"R.LIST<-1>="Option 3"CALL WIN.DBSET(DLG.NAME,"L1", R.LIST)CALL WIN.DBSELECT(DLG.NAME,"L1", "Option 2")CALL WIN.DBSET(DLG.NAME,"CB1",R.LIST)CALL WIN.DBSELECT(DLG.NAME,"CB1", "Option 3")

WIN.DBLISTVW

63

END

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBSET, WIN.DBSELECT, WIN.DBEVENT, WIN.DBTABS, WIN.LOOKUP


DialogBox Listbox, DialogBox Validate, DialogBox ControlCommand

WIN.DBLISTVWThis subroutine adds a list view control that displays a list of items with optional images andadditional information.



Syntax

WIN.DBLISTVW (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBLISTVW command:



Related Subroutines



DialogBox ListView

Version

4.0 Original


64

WIN.DBLOADThis subroutine loads a dialog box.

It must be used to load the dialog box to the PC in order to display it on the wIntegrate screen withWIN.DBSHOW. To remove the dialog box, use WIN.DBDEL.

In most cases it will be faster to use the WIN.DBLOADF routine as a direct replacement of thissubroutine.

Syntax

WIN.DBLOAD (DBX, ERR)

Parameters

The following table describes the parameters of the WIN.DBLOAD command:


DBX The wIntegrate "handle" for a dialog boxERR The error codes returned:

0 - No error.





Examples


CALL WIN.DBLOAD(DBX,ERR)IF ERR THENERR.MSG='Loading with WIN.DBLOAD'* Just delete dialog and try again if we get already exist errorIF ERR = 3 THENCALL WIN.DBDEL(DLG.NAME)CALL WIN.DBLOAD(DBX,ERR)ENDEND

Related Subroutines

WIN.DBNEW, WIN.DBDEL, WIN.DBSHOW, WIN.DBLOADF

WIN.DBLOADFThis subroutine loads a dialog box.

It must be used to load the dialog box to the PC in order to display it on the wIntegrate screen withWIN.DBSHOW. To remove the dialog box, use WIN.DBDEL.

WIN.DBMETHOD

65

This is a faster version of the WIN.DBLOAD routine, but relies on an 8-bit communication line (whichis normally the case) and might have problems if control characters (characters with an ASCII code lessthan 32) are included in the dialog definition.

Syntax

WIN.DBLOADF (DBX, ERR)

Parameters

The following table describes the parameters of the WIN.DBLOADF command:


DBX The wIntegrate "handle" for a dialog boxERR The error codes returned:

0 - No error.





Related Subroutines

WIN.DBNEW, WIN.DBDEL, WIN.DBSHOW, WIN.DBLOAD

Version


WIN.DBMETHODThis subroutine runs a method on a control.

The dialog box containing the control must have been shown (for example, with WIN.DBSHOW).

For a full list of methods for each control, see the Client Scripting Reference.

Syntax

WIN.DBMETHOD (DLG.NAME, NAME, METHOD, ARG.FLAGS, MAT ARGS, RET.FLAG,RET.VALUE)

Parameters

The following table describes the parameters of the WIN.DBMETHOD command:


DLG.NAME The name of the loaded dialog boxNAME Controls nameMETHOD The name of the method to runARG.FLAGS String describing the arguments; see the following tableMAT ARGS 20-element array to hold the arguments


66


RET.FLAG Flag to specify whether the method returns a valueRET.VALUE Value that is returned from the method if RET.FLAG is set to 1

Values for ARG.FLAGS

The ARGS.FLAGS is a string of the following letters, one for each argument for the method:

Value Description

I Input argument. The value from the corresponding element of ARGS is used torun the method.

O Output argument. The value from the corresponding element of ARGS is set tothe value returned from the method for this argument.

B Both ways. The value from the corresponding element of ARGS is used to runthe method, and the value of the argument is returned after the method hasrun.

Examples

The following example fills a range of cells in a grid.

* Fill a range of cells use the FillRange method (find it in the* client scripting reference).ARGS(1) = 1 ;* start rowARGS(2) = 1 ;* start columnARGS(3) = 4 ;* end rowARGS(4) = 6 ;* end columnARGS(5) = "Hello" ;* Fill with the word helloCALL WIN.DBMETHOD(MY.DLGNAME, MY.GRID, "FillRange","IIIII",MAT ARGS,0, RET.VAL)* Get the background colour of a cell 2,2ARGS(1) = 2ARGS(2) = 2CALL WIN.DBMETHOD(MY.DLGNAME, MY.GRID, "GetCellBackColor","II",MATARGS, 1, BACK.COLOR)

The following example fills a tree view control with some dummy values.

BRANCH = ''RESP = ''FOR J = 1 TO 10 METHOD.ARGS(1) = "Root Branch ":J CALL WIN.DBMETHOD(NAME, "TV1", "InsertLine", "I", MAT METHOD.ARGS, 1, BRANCH) FOR K = 1 TO J METHOD.ARGS(1) = "Sub branch ":K METHOD.ARGS(2) = 0 METHOD.ARGS(3) = 0 METHOD.ARGS(4) = BRANCH CALL WIN.DBMETHOD(NAME, "TV1", "InsertLine", "IIII", MAT METHOD.ARGS, 0, RESP) NEXT KNEXT J

See the demonstration program WIN.DBDEMO3, which is option 17 on the WIN.DEMO menu.

Related Subroutines

WIN.DBSETPRP, WIN.DBGETPRP

WIN.DBMNSIZE

67

Version

4.0.1 Original

WIN.DBMNSIZEThis subroutine specifies the minimum size a dialog box can be resized to.

The unit of measure for the WIDTH and DEPTH parameters is in dialog box units. This is calculated as1/4 of the average width and 1/8 of the average depth of the dialog box font.

Syntax

WIN.DBMNSIZE (DLGNAME, WIDTH, DEPTH)

Parameters

The following table describes the parameters of the WIN.DBMNSIZE command:


DLGNAME The name of the dialog box shownWIDTH The minimum width the dialog box can be resized to; use -1 to use the defaultDEPTH The minimum depth the dialog box can be resized to; use -1 to use the default

Related Subroutines

WIN.DBPANEL


DialogBox MinSize

Version

4.2.1 Original

WIN.DBMOVEThis subroutine moves the position of a dialog box.

Syntax

WIN.DBMOVE (DLGNAME, X, Y)

Parameters

The following table describes the parameters of the WIN.DBMOVE command:


DLGNAME The name of the dialog box to moveX The new X-coordinate for the dialog boxY The new Y-coordinate for the dialog box


68


DialogBox Move

Version

4.0.2 Original

WIN.DBMSGBOXThis subroutine displays a message box that is attached to a dialog box. The message box stops alldata from going to the dialog box until the message box is closed.

If you want a message box that is not attached to a dialog, see WIN.MSGBOX, on page 185.

This subroutine truncates the text that is displayed to 150 characters; use WIN.MSGBOX2 to avoid thislimitation.

Syntax

WIN.DBMSGBOX (NAME, TEXT, TITLE, FLAGS, RESP)

Parameters

The following table describes the parameters of the WIN.DBMSGBOX command:


NAME The name of the dialog box that the message box is attached toTEXT The text to display in the message boxTITLE The title for the message box; default is User MessageFLAGS Icon and Response buttons to display in the box; see the following tableRESP The response from the user

Values for FLAGS

Use only one button and one icon flag.

Value Description

MB_OK Displays an OK buttonMB_OKCANCEL Displays OK and Cancel buttonsMB_ABORTRETRYIGNORE Displays Abort, Retry, and Ignore buttonsMB_YESNOCANCEL Displays Yes, No, and Cancel buttonsMB_YESNO Displays Yes and No buttonsMB_RETRYCANCEL Displays Retry and Cancel buttonsMB_DEFBUTTON1 Makes the first button the default buttonMB_DEFBUTTON2 Makes the second button the default buttonMB_DEFBUTTON3 Makes the third button the default buttonMB_ICONHAND Displays the stop sign iconMB_ICONQUESTION Displays the question iconMB_ICONEXCLAMATION Displays the exclamation warning icon

WIN.DBMSGBOX2

69

Value Description

MB_ICONASTERISK Displays the asterisk information icon

Examples


*IF ERRMSG = "" THEN CALL WIN.DBINPOK(DBXNAME, TRUE)END ELSE DUM = "" CALL WIN.DBMSGBOX(DBXNAME, ERRMSG, "Product Maintenance","MB_ICONHAND|MB_OK", DUM) CALL WIN.DBINPOK(DBXNAME, FALSE)END

Related Subroutines

WIN.MSGBOX, WIN.DBATTACH, WIN.MSGBOX2, WIN.DBMSGBOX2


MessageBox

WIN.DBMSGBOX2This subroutine displays a message box that is attached to a dialog box. The message box stops alldata from going to the dialog box until the message box is closed.

If you want a message box that is not attached to a dialog, see WIN.MSGBOX, on page 185.

Unlike WIN.MSGBOX, the text of the message is not truncated to 150 characters.

Syntax

WIN.DBMSGBOX2 (NAME, TEXT, TITLE, FLAGS, RESP)

Parameters

The following table describes the parameters of the WIN.DBMSGBOX2 command:


NAME The name of the dialog box that the message box is attached toTEXT The text to display in the message boxTITLE The title for the message box; default is User MessageFLAGS Icon and Response buttons to display in the box; see the following tableRESP The response from the user

Values for FLAGS

Use only one button and one icon flag.


70

Value Description

MB_OK Displays an OK buttonMB_OKCANCEL Displays OK and Cancel buttonsMB_ABORTRETRYIGNORE Displays Abort, Retry, and Ignore buttonsMB_YESNOCANCEL Displays Yes, No, and Cancel buttonsMB_YESNO Displays Yes and No buttonsMB_RETRYCANCEL Displays Retry and Cancel buttonsMB_DEFBUTTON1 Makes the first button the default buttonMB_DEFBUTTON2 Makes the second button the default buttonMB_DEFBUTTON3 Makes the third button the default buttonMB_ICONHAND Displays the stop sign iconMB_ICONQUESTION Displays the question iconMB_ICONEXCLAMATION Displays the exclamation warning iconMB_ICONASTERISK Displays the asterisk information icon

Related Subroutines

WIN.MSGBOX, WIN.DBATTACH, WIN.MSGBOX2, WIN.DBMSGBOX


MessageBox

Version


WIN.DBMSIZEThis subroutine defines the maximum size of a dialog box, and determines the increment rate of ascroll bar in a large dialog box.

Syntax

WIN.DBMSIZE (DLGNAME, WIDTH, DEPTH, XSTEP, YSTEP)

Parameters

The following table describes the parameters of the WIN.DBMSIZE command:


DLGNAME The name of the dialog box shownWIDTH Maximum width of the dialog box; must be less than or equal to 16383DEPTH Maximum depth of the dialog box; the allowable amount is 16383XSTEP Specifies the number of rows to scroll in each stepYSTEP Specifies the number of columns to scroll in scroll step

WIN.DBMVCTRL

71

Examples

The following example sets the maximum size of the CustMaint dialog box.

CALL WIN.DBNEW(DBX, "CustMaint", "Customer Maintenance", 0, 0, 200, 100,"WS_THICKFRAME | WS_CAPTION | WS_HSCROLL | WS_VSCROLL", "")... add controls to dialog boxCALL WIN.DBLOAD(DBX, ERR);* Load customer maintenance dialog box* Set up full page size to be 4 times that of initial view with* arrows scrolling 1/10 of the size on each clickCALL WIN.DBMSIZE("CustMaint", 400, 200, 40, 20)

Related Subroutines

WIN.DBNEW


DialogBox MaxSize

WIN.DBMVCTRLThis subroutine moves a control on a dialog box that has been shown.

Syntax

WIN.DBMVCTRL (DLGNAME, NAME, X, Y, W, D, DIALOG.UNITS)

Parameters

The following table describes the parameters of the WIN.DBMVCTRL command:


DLGNAME The name of the dialog box shownNAME Specifies the nameX New column position; set to "" to leave unchangedY New row position; set to "" to leave unchangedW New width; set to "" to leave unchangedD New depth; set to "" to leave unchangedDIALOG.UNITS 0 - Dimensions are in pixels

1 - Dimensions are in dialog units

Version

4.1 Original

WIN.DBNEVENTThis subroutine returns the next event from a dialog box during validation of a field if the dialog boxoptions are set to V1 or V2 with WIN.DBOPTION. If there is no event, the ETYPE and CTRL are set to"" (null).


72

Syntax

WIN.DBNEVENT (DBXNAME, CTRL, ETYPE)

Parameters

The following table describes the parameters of the WIN.DBNEVENT command:


DBXNAME The name of the dialog box to checkCTRL The returned control name for an eventETYPE The event type; see the following Event Type table

Values for ETYPE

Value Description

D Default - The control that has the input focus. This event produces edit text,list box, and combo box controls.

V Validation - The control that has lost input focus. This event produces edittext, list box, and combo box controls.

C Button click - Returns that one of the following has been clicked: push button,radio button, check box, image, or image button.

L List box double-click - Returns a list box double-click or a combo boxselection.

Examples


* Use WIN.DBNEVENT to skip validation if cancel button is clicked.NCTRL = ""NTYPE = ""CALL WIN.DBNEVENT(DBXNAME, NCTRL, NTYPE)IF NCTRL = "Cancel" AND NTYPE = "C" THEN* Cancel was clicked, all we need to do is skip the fields case statement* as the event will arrive in the main loop normallyPRINT "Cancel clicked, skipping validation"END ELSE

Related Subroutines

WIN.DBEVENT, WIN.DBFETCH


DialogNextEvent

WIN.DBNEWThis subroutine creates a new dialog box. You must use this command to create a dialog box.

This command starts the definition of a dialog box. You must then use controls within the box tocreate edit, text boxes, labels, and so on (see WIN.DBEDIT, WIN.DBTEXT, and WIN.DBLABEL).Then, load the new dialog box using WIN.DBLOAD, show the box with WIN.DBSHOW, and monitor

WIN.DBNEW

73

events in a loop using WIN.DBEVENT. To close the dialog box, use WIN.DBEND, then delete the boxfrom memory with WIN.DBDEL.

For step-by-step instructions on how to create dialog boxes, see Using host subroutines, on page254.

Syntax

WIN.DBNEW (DBX, NAME, TITLE, X, Y, W, D, STYLE, OPTS)

Parameters

The following table describes the parameters of the WIN.DBNEW command:


DBX The wIntegrate "handle" for a dialog boxNAME The name of the new dialog box; how the dialog is referenced in other dialog

box callsTITLE The title for the new dialog box; appears in the title bar the dialog box and can

be the same as the nameX Column positionY Row positionW WidthD DepthSTYLE See Client Scripting Reference for detailsOPTS Available options; see the following Opts table

Fields for OPTS

The following fields can be set in the options:

Field Description

1.1 Font size; defaults to 8 if OPTS<1> = ""1.2 Font name; defaults to helv if OPTS<1> = ""2 Set to 1 to map characters according to the emulation

Examples


CALL WIN.DBNEW(DBX, DLG.NAME,"Demonstration of Dialog boxes",10,10,200,160,'','')*CALL WIN.DBLABEL(DBX,"Label 1",4,4,'','','')CALL WIN.DBEDIT(DBX,"E1",40,4,40,'','')CALL WIN.DBTEXT(DBX,"T1",4,24,80,'','C')CALL WIN.DBCHECK(DBX,"C1","Check one",4,36,60,'')...CALL WIN.DBLOAD(DBX,ERR)IF ERR THEN ERR.MSG='Loading with WIN.DBLOAD' * Just delete dialog and try again if we get already exist error IF ERR = 3 THEN


74

CALL WIN.DBDEL(DLG.NAME) CALL WIN.DBLOAD(DBX,ERR) ENDEND*IF ERR = 0 THEN CALL WIN.DBSHOW(DLG.NAME, 1, ERR) IF ERR THEN CALL WIN.DBDEL(DLG.NAME) ERR.MSG = 'Displaying with WIN.DBSHOW' ENDEND

The following example is a sample test to show a dialog box in the taskbar.

AM=CHAR(254)DBX=''CALL WIN.DBNEW(DBX, "APPWIND", "App Window", 10,10, 200,100, "":AM:"WS_EX_APPWINDOW", "")CALL WIN.DBLABEL(DBX, "This dialog box shows in the task bar", 10,10,120,14,"")CALL WIN.DBLOAD(DBX, ERR)IF ERR = 0 THEN CALL WIN.DBSHOW("APPWIND",1,ERR) END

Related Subroutines

WIN.DBEDIT, WIN.DBTEXT, WIN.DBLABEL, WIN.DBLOAD, WIN.DBSHOW, WIN.DBEVENT, WIN.DBEND,WIN.DBDEL


DialogBox Create, DialogBox Caption, DialogBox Style, DialogBox Font, DialogBox ExStyle

Version

5.1.3 Support for Extended styles

WIN.DBOPTIONThis subroutine adds the options to a dialog box.

The "V" options lock the host program until WIN.DBINPOK with the “True” option is called. Whenusing V1 and V2, only the following event is saved until the WIN.DBINPOK subroutine is called.WIN.DBINPOK also enables the dialog box if option V2 disabled it.

Syntax

WIN.DBOPTION (DBX, OPTS)

Parameters

The following table describes the parameters of the WIN.DBOPTION command:



WIN.DBOPTION

75


OPTS Available options; see the following Opts table

Values for OPTS

Combine the following in a single string:

Value Description

V0 Run Validate script, and do not block processing of subsequent dialog boxmessages.

V1 Run Validate script, and block processing of subsequent dialog boxprocessing.

V2 Same as V0, but input to dialog is disabled.L Light font. This has no effect and is retained for backwards compatibility only.M Dialog boxes that are defined on the host will use the emulation character

mapping. This is required only if the dialog box is defined on the host and/orthe dialog box values are being sent to or from the host. The emulation canalso be mapped to the host using the MapChars function.

B Change all of the controls in the dialog box to a bold version of the dialog boxfont and resize them.

E Embed a top-level dialog in the web client version.P Popup a top-level dialog in the web client version.C Cache the value of the edit fields on the server for the Java Client versions.

This forces the client to update the server of changes to any edit fields on thedialog box before a key press or event is sent from the client. The values forthe edit fields can then be returned from the server without a round trip to theclient in most circumstances.

S Scroll the control with the focus into view if it is not visible. The control mustsupport the SetFocus event. If a control does not have this event in its list ofevents, it will not be scrolled into view. Any buttons, check boxes, and radiobuttons on the dialog must include the BS_NOTIFY style. The Java Client usesa slightly different algorithm to move controls into view, so positioning after ascroll might be slightly different.

Examples


* Set disable dialog while waiting for host optionCALL WIN.DBOPTION(DBX, "V2")

Related Subroutines

WIN.DBINPOK, WIN.DBNEW


DialogBox Option

Version

6.0.1 Added "E" and "P" options


76

6.1.0 Added "C" option

6.3.7 Added "S" option

WIN.DBPANELThis subroutine adds a divider that splits the dialog box into different areas that are used toautomatically position controls when the dialog box is resized.

When a dialog box is resized, the panels determine the position and size of the controls as follows:

▪ Controls to the left of the left panel are not moved.▪ Controls above the top panel are not moved.▪ Controls to the right of the right panel are moved so they remain the same distance from the right

edge of the dialog box.▪ Controls below the bottom panel are moved so they remain the same distance from the bottom

edge of the dialog box.▪ Controls in the area between all the panels are resized so that their right edge remains the same

distance from the right side of the dialog box, and their bottom edge remains the same distancefrom the bottom of the dialog box.

When any panels are created, the minimum size of the dialog box is restricted so that the controls willnot be moved over each other, and that a resized control will not be smaller than 4x4 pixels.

To override this, use the WIN.DBMSIZE subroutine, but note that panels calculate what controls tomove by the current position of the panel; so if the minimum size is made too small, it is possible toshrink the dialog box to include a control in a panel that was not there before.

The unit of measure for the position parameter is in dialog box units. This is calculated as 1/4 of theaverage width and 1/8 of the average depth of the dialog box font.

Syntax

WIN.DBPANEL (DBX, PANEL, POSITION)

Parameters

The following table describes the parameters of the WIN.DBPANEL command:


DBX The wIntegrate "handle" for a dialog boxPANEL The panel to add; one of “LEFT”, “RIGHT”, “TOP”, or “BOTTOM”POSITION The position of the panel in dialog units

Related Subroutines

WIN.DBMNSIZE


DialogBox Panel

Version

4.2.1 Original

WIN.DBPOST

77

WIN.DBPOSTThis subroutine is used to put an event in the queue again after an event has been checked byWIN.DBFETCH.

Syntax

WIN.DBPOST (DLG.NAME, CTRL, ETYPE)

Parameters

The following table describes the parameters of the WIN.DBPOST command:


DLG.NAME The dialog box nameCTRL The control nameETYPE The event type; see WIN.DBEVENT, on page 42 for details

Examples

The following example is taken from the WIN.CUSTMD demonstration program.

* Validation events* These events are often immediately followed by a default for the* Next field or a button click. So we must use WIN.DBFETCH to check* the next event and WIN.DBPOST to re-queue it (if required).*300 CALL WIN.DBFETCH(NEXT.DLG, NEXT.CTRL, NEXT.ETYPE)** If next event is click on cancel don't bother with validationIF NEXT.ETYPE = "C" AND NEXT.CTRL = "Cancel" THENPRINT "Ignoring last event as it is followed by:-"PRINT "Event ":NEXT.ETYPE:" from ":NEXT.CTRLFLD = NEXT.CTRLGOSUB 340END ELSE** Field ValidationsBEGIN CASECASE FLD = "CustRef"; GOSUB 1050; * Validate customer numberCASE FLD = "Name"; GOSUB 1150; * Validate NameCASE FLD = "Street"; CALL WIN.DBGET(DBX.NAME, FLD, CUST.STREET)CASE FLD = "City" ; CALL WIN.DBGET(DBX.NAME, FLD, CUST.CITY)CASE FLD = "State"; CALL WIN.DBGET(DBX.NAME, FLD, CUST.STATE)CASE FLD = "Zip"; CALL WIN.DBGET(DBX.NAME, FLD, CUST.ZIP)CASE FLD = "Tel";CALL WIN.DBGET(DBX.NAME, FLD, CUST.TEL)CASE FLD = "Fax"; CALL WIN.DBGET(DBX.NAME, FLD, CUST.FAX)CASE FLD = "Salesman"; CALL WIN.DBGET(DBX.NAME, FLD, CUST.SALESMAN)CASE FLD = "Comment"; CALL WIN.DBGET(DBX.NAME, FLD, CUST.COMMENT)CASE FLD = "Discount"; GOSUB 1250; * Validate discountEND CASEIF NEXT.ETYPE # "" THEN CALL WIN.DBPOST(NEXT.DLG, NEXT.CTRL, NEXT.ETYPE)END


78

Related Subroutines

WIN.DBFETCH, WIN.DBEVENT, WIN.DBPOST2

WIN.DBPOST2This subroutine is used to put an event in the queue again after an event has been checked byWIN.DBFETCH2.

See WIN.DBGET2, on page 49 for an example.

Syntax

WIN.DBPOST2 (DLG.NAME, CTRL, ETYPE, ARGS, ESTACK)

Parameters

The following table describes the parameters of the WIN.DBPOST2 command:


DLG.NAME The dialog box nameCTRL The control nameETYPE The event type; see WIN.DBEVENT, on page 42 for detailsARGS Comma-separated list of values that are returned by the eventESTACK The variable containing the event stack

Related Subroutines

WIN.DBFETCH2, WIN.DBGET2, WIN.DBEVENT2

Version


WIN.DBPRGRESThis subroutine adds a progress control to a dialog box. The progress control displays a thick bar thatis increased in length to show the progress of some action.



Syntax

WIN.DBPRGRES (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBPRGRES command:

WIN.DBRADIO

79



Related Subroutines



DialogBox Progress

Version

4.0 Original

WIN.DBRADIOThis subroutine adds a radio button to a dialog box. A radio button is an inset circle that can be clickedon or off. When a radio button is on, it displays a black circle in the center.

Use a group box (WIN.DBGROUP) to group several radio buttons to choose one of several options.

Note: Check boxes are similar to radio buttons, but cannot be grouped. Use check boxes if youwant the user to choose one option.

Syntax

WIN.DBRADIO (DBX, NAME, TEXT, X, Y, W, D, GROUP)

Parameters

The following table describes the parameters of the WIN.DBRADIO command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameTEXT Specifies the text for the captionX Column positionY Row positionW WidthD DepthSTYLE See Client Scripting Reference for details


80


GROUP Designates which button is first radio button in a group. Set the first radiobutton in a group to 1, and set all others in the group to 0. If one button in agroup is selected, wIntegrate automatically turns off other radio buttons in agroup.

Examples


This first line of the example shows the creation of a group box, and the next three lines place radiobuttons within the group box. Note that the radio button R1 has a 1 as the GROUP parameter todesignate it as the first in the group of three buttons.

CALL WIN.DBGROUP(DBX,"G1","Group box",4,50,60,52)CALL WIN.DBRADIO(DBX,"R1","Radio One",6,58,50,'',1)CALL WIN.DBRADIO(DBX,"R2","Radio Two",6,72,50,'',0)CALL WIN.DBRADIO(DBX,"R3","Radio Three",6,88,50,'',0)

Related Subroutines

WIN.DBNEW, WIN.DBLOAD, WIN.DBCAPT, WIN.DBEVENT, WIN.DBGROUP


DialogBox RadioButton, DialogBox ControlCommand

WIN.DBRECTThis subroutine returns the current position of a displayed dialog box or control.

Syntax

WIN.DBRECT (DLGNAME, NAME, OPT, LEFT, TOP, RIGHT, BOTTOM)

Parameters

The following table describes the parameters of the WIN.DBRECT command:


DLGNAME The name of the dialog box shownNAME Controls name; set to "" to return details on the dialog boxOPT The information to return; see the following Opt tableLEFT Returned left position of the dialog box or controlTOP Returned top position of the dialog box or controlRIGHT Returned right position of the dialog box or controlBOTTOM Returned bottom position of the dialog box or control

Values for OPT

Information to return:

WIN.DBSCROLL

81

Value Description

1 Client rectangle. This is the position of the internal dimensions of the dialogor control.

2 Absolute position of dialog box or control. This is the position on the desktopof the control.

Version

4.1 Original

WIN.DBSCROLLThis subroutine adds a scroll bar to a dialog box.

Syntax

WIN.DBSCROLL (DBX, NAME, X, Y, W, D, STYLE, MIN, MAX)

Parameters

The following table describes the parameters of the WIN.DBSCROLL command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameX Column positionY Row positionW Width; default value is 12D Depth; default value is 12STYLE See Client Scripting Reference for detailsMIN The minimum value to scroll; default value is 0MAX The maximum value for the scroll bar; default value is 100

Examples


CALL WIN.DBSCROLL(DBX,"S1", 4,116,60,'','WS_TABSTOP','','')

Related Subroutines



DialogBox ScrollBar

WIN.DBSELECTThis subroutine selects one of several options in a list or combo box dialog box field.


82

Syntax

WIN.DBSELECT (DLGNAME, NAME, TEXT)

Parameters

The following table describes the parameters of the WIN.DBSELECT command:


DLGNAME The name of the dialog box shownNAME Specifies the nameTEXT The text of the line to select

Examples


IF ERR = 0 THENCALL WIN.DBSET(DLG.NAME,"T1","Centered Text")CALL WIN.DBSET(DLG.NAME,"R1",1)R.LIST = "Option 1"R.LIST<-1>="Option 2"R.LIST<-1>="Option 3"CALL WIN.DBSET(DLG.NAME,"L1", R.LIST)CALL WIN.DBSELECT(DLG.NAME,"L1", "Option 2")CALL WIN.DBSET(DLG.NAME,"CB1",R.LIST)CALL WIN.DBSELECT(DLG.NAME,"CB1", "Option 3")END* Here WIN.DBSELECT selects Option 2 in the list box and Option 3 in the combo box

Related Subroutines

WIN.DBSET, WIN.DBLIST, WIN.DBCOMBO, WIN.DBGET, WIN.DBEDGET, WIN.DBEDSET


DialogBox Select

WIN.DBSETThis subroutine sets dialog box controls that were previously created.

You need this subroutine in conjunction with many of the dialog box routines like WIN.DBEDIT,WIN.DBTEXT, WIN.DBCOMBO, and so on.

This sets the default property for the control. See the Client Scripting Reference for details.

For multi-line edit controls, use the WIN.DBEDSET routine.

Syntax

WIN.DBSET (DLGNAME, NAME, VALUE)

Parameters

The following table describes the parameters of the WIN.DBSET command:

WIN.DBSETCOL

83


DLGNAME The name of the dialog box shownNAME Specifies the nameVALUE The value; depends on what type of control

Examples


* The name and position of the text control are created with WIN.DBTEXT, * then the text is set using WIN.DBSET.CALL WIN.DBNEW(DBX, DLG.NAME, "Demonstration of Dialog boxes", 10,10,200,160, '','')*CALL WIN.DBLABEL(DBX,"Label 1",4,4,'','','')CALL WIN.DBEDIT(DBX,"E1",40,4,40,'','')CALL WIN.DBTEXT(DBX,"T1",4,24,80,'','C')CALL WIN.DBCHECK(DBX,"C1","Check one",4,36,60,'')...IF ERR = 0 THEN CALL WIN.DBSET(DLG.NAME,"T1","Centered Text") CALL WIN.DBSET(DLG.NAME,"R1",1) R.LIST = "Option 1" R.LIST<-1>="Option 2" R.LIST<-1>="Option 3" CALL WIN.DBSET(DLG.NAME,"L1", R.LIST) CALL WIN.DBSELECT(DLG.NAME,"L1", "Option 2") CALL WIN.DBSET(DLG.NAME,"CB1",R.LIST) CALL WIN.DBSELECT(DLG.NAME,"CB1", "Option 3")END

Related Subroutines

WIN.DBGET, WIN.DBEDSET, WIN.DBSETPRP, WIN.DBINIPRP

WIN.DBSETCOLThis subroutine sets the foreground and the background color of a specific control within a dialog box.If the parameter CTRLNAME is None, it affects all controls that are named None. See the demonstrationprogram WIN.DBDEMO2, which is option 12 on the WIN.DEMO menu. This program demonstrateshow to set menus, fonts, and colors.

Syntax

WIN.DBSETCOL (DBX, CTRLNAME, FORECOL, BACKCOL)

Parameters

The following table describes the parameters of the WIN.DBSETCOL command:


DBX The wIntegrate "handle" for a dialog boxCTRLNAME Name of the control to changeFORECOL Foreground color


84


BACKCOL Background color

Examples

The following example sets the text to blue in a control called Text1.

* The second line sets the text to white and the background color to* blue in a control called Event. See the demonstration program WIN.DBDEMO2.CALL WIN.DBSETCOL(DBX, "Text1","Blue", "")CALL WIN.DBSETCOL(DBX, "Event", "White", "Blue")

WIN.DBSETFNTThis subroutine sets the font for a specific control within a dialog box.

See the demonstration program WIN.DBDEMO2, which is option 12 on the WIN.DEMO menu. Thisprogram demonstrates how to set menus, fonts, and colors

Syntax

WIN.DBSETFNT (DBX, CTRLNAME, FONTNAME, PTSIZE, STYLE)

Parameters

The following table describes the parameters of the WIN.DBSETFNT command:


DBX The wIntegrate "handle" for a dialog boxCTRLNAME Name of the control to set the font forFONTNAME The name of the font to usePTSIZE Size of the font in pointsSTYLE Styles separated by "|"

Examples

The following example sets the fonts in a dialog box.

CALL WIN.DBSETFNT(DBX, "Text1", "Times New Roman", 18, "FONT_Bold|FONT_Italic")CALL WIN.DBSETFNT(DBX, "Event", "Courier New", 8, "")

WIN.DBSETMNUThis subroutine sets a previously created menu for use in a dialog box.

Note: A dialog box that has a menu cannot have the DS_MODALFRAME style. See WIN.DBNEW, onpage 72.

WIN.DBSETPRP

85

Syntax

WIN.DBSETMNU (DBX, MENUNAME)

Parameters

The following table describes the parameters of the WIN.DBSETMNU command:


DBX The wIntegrate "handle" for a dialog boxMENUNAME The name of menu

Examples

The following example adds a menu to a dialog box.

CALL WIN.MENULOAD("DDMenuBar", MENUBAR)CALL WIN.DBNEW(DBX, DLG.NAME, "Dialog box menus, fonts and colors",10,10,200,160, "",OPTS)CALL WIN.DBSETMNU(DBX, "DDMenuBar")

WIN.DBSETPRPThis subroutine sets the value for a control’s property after it has been loaded to the PC withWIN.DBLOAD.


Syntax

WIN.DBSETPRP (DLG.NAME, NAME, PROPERTY, VALUE)

Parameters

The following table describes the parameters of the WIN.DBSETPRP command:


DLG.NAME The name of the loaded dialog boxNAME Controls namePROPERTY Name of the property to setVALUE New value of the property

Related Subroutines

WIN.DBGETPRP, WIN.DBINIPRP, WIN.DBMETHOD, WIN.DBSETPRPL

Version

4.0.1 Original


86

WIN.DBSETPRPLThis subroutine sets the value for a control’s property after it has been loaded to the PC withWIN.DBLOAD.

This subroutine is available for UniData and UniVerse databases only as it uses functions specific tothese platforms. It is usually faster than WIN.DBGETPRP and can be used as a replacement for it. Thespeed difference is only significant for large items that contain many attribute or subvalue marks.


Syntax

WIN.DBSETPRPL (DLG.NAME, NAME, PROPERTY, VALUE)

Parameters

The following table describes the parameters of the WIN.DBSETPRPL command:


DLG.NAME The name of the loaded dialog boxNAME Controls namePROPERTY Name of the property to setVALUE New value of the property

Related Subroutines

WIN.DBGETPRP, WIN.DBINIPRP, WIN.DBMETHOD, WIN.DBSETPRP

Version

6.3.5 Original

WIN.DBSHOWThis subroutine displays the dialog box on the PC screen.

The dialog must first be created with WIN.DBNEW, and loaded with WIN.DBLOAD.

Syntax

WIN.DBSHOW (DLGNAME, MODAL, ERR)

Parameters

The following table describes the parameters of the WIN.DBSHOW command:


DLGNAME The name of the dialog box shown

WIN.DBSHOWPU

87


MODAL Specifies the dialog box as modal or modeless:

1 - modal

0 - modeless

If the dialog is modal, the session window is disabled until the user closes thedialog box.

ERR This parameter returns error codes; see the following Err table

Values for ERR

The following error codes are returned:

Value Description

1 The call is missing a dialog box name, for example DLGNAME="".2 The dialog box is already shown. This means that it has been displayed and

might not have a WIN.DBEND call to close it.3 The dialog box is not loaded. This means that the dialog might be missing a

WIN.DBLOAD call.4 Unable to create the dialog box window.

Examples

See the WIN.DBDEMO demonstration program for another example of usage.

CALL WIN.DBSHOW(DLG.NAME, 1, ERR)IF ERR THEN CALL WIN.MSGBOX("Unable to show the dialog", "Message", "MB_OK", RESP)END

Related Subroutines

WIN.DBLOAD, WIN.DBEND, WIN.DBNEW


DialogBox Show, DialogBox Window

WIN.DBSHOWPUThis subroutine shows a dialog box as a window and automatically aligns it to the specified control.

If the window cannot be seen fully because the control is too near to an edge of the screen, it isrepositioned so both it and the original control can be seen.

Syntax

WIN.DBSHOWPU (DLGNAME PARENT ALIGNCTRL ALIGNFLAG)

Parameters

The following table describes the parameters of the WIN.DBSHOWPU command:


88


DLGNAME The name of the dialog box shownPARENT The name of the dialog box this window is being popped up fromALIGNCTRL The name of the control with which to align the windowALIGNFLAG The alignment option:

0 - left-align

1 - right-align

Examples

The following example shows the previously defined calculator dialog box.

* Right aligning the dialog to the second icon in AlansUtils toolbarCALL WIN.DBSHOWPU("Calculator","AlansUtils","icon2",1,ERR)

Related Subroutines

WIN.DBSHOW, WIN.DBATTACH


DialogBox PopupWindow

Version

4.2.1 Original

WIN.DBSTATUSThis subroutine verifies whether a dialog box is loaded to the PC and if it is currently shown.

Syntax

WIN.DBSTATUS (NAME, LOADED, SHOWN)

Parameters

The following table describes the parameters of the WIN.DBSTATUS command:


NAME The name of the dialog boxLOADED Returns the dialog load status:

0 - dialog is not loaded

1 - dialog is loadedSHOWN Returns the dialog shown status:

0 - dialog is not shown

1 - dialog is shown

WIN.DBTAB

89

Examples

The following example checks to see whether the dialog box must be loaded, and shows the dialogbox if it is not already displayed.

* DemoDlg definition is in DBXCALL WIN.DBSTATUS ("DemoDlg", LOADED, SHOWN)IF NOT (LOADED) THEN CALL WIN.DBLOAD (DBX, ERR)IF ERR = 0 AND NOT (SHOWN) THEN CALL WIN.DBSHOW("MemoDlg", 1, ERR)END

Related Subroutines

WIN.DBLOAD, WIN.DBSHOW


IsShown, IsDialog

WIN.DBTABThis subroutine adds a tab control to a dialog box. The tab control show tabs across the dialog box.



Syntax

WIN.DBTAB (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBTAB command:



Related Subroutines



90


DialogBox TabControl

Version

4.0 Original

WIN.DBTABSThis subroutine sets the location of the tab stops in a list box control.

Syntax

WIN.DBTABS (DLGNAME, NAME, TABS)

Parameters

The following table describes the parameters of the WIN.DBTABS command:


DLGNAME The name of the dialog box shownNAME Specifies the nameTABS A string containing comma-separated tab positions; measured in dialog units.

Examples

The following example sets up tabs at 20 characters and 60 characters.

CALL WIN.DBTABS(DLGNAME, "CustList", "20, 60")REC<1, 1> = "ID1"REC<1, 2> = "Company1"REC<1, 3> = "Phone rate"...CALL WIN.DBSET(DLGNAME, "CustList", REC)

Related Subroutines

WIN.DBLIST, WIN.DBSHOW


DialogBox SetTabs

WIN.DBTEXTThis subroutine creates a text control in a dialog box.

You can set and change the text of this control with the WIN.DBSET subroutine.

When you need a label that does not change, for example, to display text as a label for a group, edit, orlist box, use WIN.DBLABEL.

WIN.DBTEXT

91

Syntax

WIN.DBTEXT (DBX, NAME, X, Y, W, D, OPTS)

Parameters

The following table describes the parameters of the WIN.DBTEXT command:


DBX The wIntegrate "handle" for a dialog boxNAME Specifies the nameX Column positionY Row positionW WidthD DepthOPTS Available options; see the following Opts table

Fields for OPTS

The options are specified in a dynamic array of the following fields:

Field Description

1 Text justification; can be one of the following values:

L - Left

R - Right

C - Center2 Fixed number of dialog units to add to the width3 Put the label in a sunken rectangle if set to 1

Examples

The following example sets up a normal and sunken text control.

SINK.TEXT = ""SINK.TEXT<3> = 1; * Sunken text option for text and labelsCALL WIN.DBTEXT(DBX, "Text1", 5,22,78,12,"")CALL WIN.DBINIPRP(DBX,"Text1","","This is normal text")CALL WIN.DBTEXT(DBX, "Text2", 141,22,78,12, SINK.TEXT)CALL WIN.DBINIPRP(DBX,"Text2","","This is sunken text")

Related Subroutines

WIN.DBLABEL


DialogBox LText, DialogBox CText, DialogBox RText

Version

4.1.1 Added Sunken and extra width option


92

WIN.DBTRACKThis subroutine adds a trackbar control to a dialog box.



Syntax

WIN.DBTRACK (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBTRACK command:



Related Subroutines



DialogBox Trackbar

Version

4.0.1 Original

WIN.DBTREEVWThis subroutine creates a tree structure control for displaying items. A tree view control is used todisplay hierarchical data. Each line of the control can be expanded to show further lines.

Images can be assigned to each line, state can be changed, and a number can be associated.

Each line of the control has its own unique item ID. Using this item ID it is possible to modify or retrievethe current text, images, state, and data for the line.


WIN.DBTYPEAH

93


Syntax

WIN.DBTREEVW (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBTREEVW command:



Related Subroutines



DialogBox TreeView

Version

4.0 Original

WIN.DBTYPEAHThis subroutine turns on or off type-ahead processing for a dialog box.

When type-ahead processing is on, the script must control all the navigation in the dialog box byredefining the keys that are used to navigate between the fields. This means at least Tab and Shift +Tab should be redefined using WIN.DBKEY with the navigation keys parameter set to 1.

The type-ahead is stopped as soon as an event or non-navigation key press is generated on the dialog,or if type-ahead is directed to a control that does not support it (for example, ActiveX controls, scrollbars, and so on).

The script that is defined on a navigation key should do whatever processing it needs to, and then setthe focus to the next control. If the script determines the value is incorrect, it should set the focus backto the control it is validating, which will also clear any following type-ahead.

To prevent the user from jumping to a field out of order, disable all the other fields except the Acceptand Cancel buttons in the dialog box.

The standard WIN.DBEDIT subroutines automatically define events in the dialog box thatwould interfere with the type-ahead processing, so they should always be followed by a call toWIN.DBEVENTR to remove the events.


94

Syntax

WIN.DBTYPEAH (DBX, OPTION)

Parameters

The following table describes the parameters of the WIN.DBTYPEAH command:


DBX The wIntegrate "handle" for a dialog boxOPTION Set to 1 to use type-ahead in this dialog, or 0 otherwise

Examples

See the host program WIN.TADEMO, on page 241.

Related Subroutines

WIN.DBKEY, WIN.DBFOCUS, WIN.DBENABLE, WIN.DBEVENTR


DialogBox TypeAhead

Version

6.0.1 Original

WIN.DBUNITThis subroutine is used to convert from dialog units to pixels.

Syntax

WIN.DBUNIT (DLGNAME, CNV, VALUE)

Parameters

The following table describes the parameters of the WIN.DBUNIT command:


DLGNAME The name of the dialog box shownCNV The conversion to apply; see the following tableVALUE Values to be converted

Values for CNV

Value Description

0 Convert column pixels to column dialog units.1 Convert row pixels to row dialog units.2 Convert multiple column pixels to column dialog units.3 Convert multiple row pixels to row dialog units.

WIN.DBUPDOWN

95

Value Description

4 Convert column dialog units to column pixels.5 Convert row dialog units to row pixels.6 Convert multiple column dialog units to column pixels7 Convert multiple row dialog units to row pixels.


DialogUnit

Version

4.0.2 Original

WIN.DBUPDOWNThis subroutine adds a spin box (an edit box with up and down arrows) to a dialog box.



Syntax

WIN.DBUPDOWN (DBX, NAME, X, Y, W, D, STYLE)

Parameters

The following table describes the parameters of the WIN.DBUPDOWN command:



Related Subroutines



DialogBox UpDown


96

Version

4.1 Original

WIN.DDECLOSEThis subroutine stops a DDE conversation with another Windows application.

Start a DDE conversation with WIN.DDEOPEN.

Generally you should use OLE/Automation rather than DDE as DDE is an older technology. See theWIN.OB commands for more details.

Syntax

WIN.DDECLOSE (NAME)

Parameters

The following table describes the parameters of the WIN.DDECLOSE command:


NAME The name of the DDE conversation that you specified in WIN.DDEOPEN

Examples

The following example is a part of the WIN.DDEDEMO demonstration program.

* Excel DDE demonstration200 CALL WIN.COLOR("Yellow","Blue")CALL WIN.TWOPEN("ddedemo", "Excel Dynamic Data Exchange demo",10, 5, 70, 16,1)PRINT "To find out the topics Excel supports:-"PRINT "First open a link to the system topic as follows:-"PRINT ' CALL WIN.DDEOPEN("EXCEL_LINK","excel","System", OK)'CALL WIN.DDEOPEN("EXCEL_LINK","excel","System", OK)...CALL WIN.DDEREQ("EXCEL_LINK", "Topics", TOPICS)PRINTVALUE = TOPICS; S = CHAR(9); R = ","; GOSUB 500; * Replace tabsPRINT "The topics known by Excel are"PRINT VALUEPRINTPRINT 'Finally we close the link with'PRINT ' CALL WIN.DDECLOSE("EXCEL_LINK")'CALL WIN.DDECLOSE("EXCEL_LINK")

Related Subroutines

WIN.DDECLOSE, WIN.DDEREQ, WIN.DDEEXEC, WIN.DDEPOKE


DDE Terminate

WIN.DDEEXEC

97

WIN.DDEEXECThis subroutine executes a macro or command in another application using DDE. The format of theMACRO parameter depends on the requirements of the other application.


Syntax

WIN.DDEEXEC (NAME, MACRO)

Parameters

The following table describes the parameters of the WIN.DDEEXEC command:


NAME The name of the current DDE conversation you specified in WIN.DDEOPEN.MACRO The command to run in the other Windows application.

Examples


*PRINT @(-1):"Now to run a few Excel macros to tidy the data up"PRINTPRINT ' CALL WIN.DDEEXEC("EXCEL_SHEET",' : "'" :'[SELECT("R2C2:R8C3","R2C2")]':"')"PRINT ' CALL WIN.DDEEXEC("EXCEL_SHEET", "[COLUMN.WIDTH(1,,,3)]")'CALL WIN.DDEEXEC("EXCEL_SHEET", '[SELECT("R2C2:R8C3","R2C2")]')CALL WIN.DDEEXEC("EXCEL_SHEET", "[COLUMN.WIDTH(1,,,3)]")*PRINT "These two Excel commands select our data then size it to for the best fit"*PRINTPRINT 'Finally we close our link'PRINT ' CALL WIN.DDECLOSE("EXCEL_SHEET")'CALL WIN.DDECLOSE("EXCEL_SHEET")

Related Subroutines

WIN.DDEOPEN, WIN.DDECLOSE, WIN.DDEREQ, WIN.DDEPOKE, WIN.DDETIME


DDE Execute

WIN.DDEEXEC2This subroutine executes a macro or command in another application using DDE. The format of theMACRO parameter depends on the requirements of the other application.


98


Syntax

WIN.DDEEXEC2 (NAME, MACRO, RESP)

Parameters

The following table describes the parameters of the WIN.DDEEXEC2 command:


NAME The name of the current DDE conversation you specified in WIN.DDEOPEN.MACRO The command to run in the other Windows application.RESP Variable to receive the returned status of the command;

0 - no error, otherwise see the description of DDE Execute in the ClientScripting Reference

Examples

The following example is a simple test of status that is returned by WIN.DDEEXEC2.

*XL = "XL"CALL WIN.DDEOPEN(XL, "Excel","Sheet1",OK)IF NOT(OK) THEN PRINT "Excel sheet 1 not started";STOP** Try the beep command that should exist in ExcelCALL WIN.DDEEXEC2(XL,"[BEEP()]",RESP)PRINT "BEEP() macro command ":IF RESP = 0 THENPRINT "successful"END ELSEPRINT "Failed, error code ":RESPEND** Try a made up command that should fail as it's not part* of Excels macro languageCALL WIN.DDEEXEC2(XL,"[MADEUP()]",RESP)PRINT "MADEUP() macro command ":IF RESP = 0 THENPRINT "successful"END ELSEPRINT "Failed, error code ":RESPEND

Related Subroutines

WIN.DDEEXEC


DDE Execute

WIN.DDEOPEN

99

Version

4.1.1 Original

WIN.DDEOPENThis subroutine starts a DDE conversation between wIntegrate and another Windows application thatsupports DDE. The parameters are defined by the other application.


Syntax

WIN.DDEOPEN (NAME, SERVER, TOPIC, OK)

Parameters

The following table describes the parameters of the WIN.DDEOPEN command:


NAME The name of the current DDE conversation you specified in WIN.DDEOPEN.SERVER The remote application’s DDE name.TOPIC The remote application topic name; dependent the application.OK The number that is returned if the link is successful:

0 - the link is not started

1 - the link is started

Examples


* Excel DDE demonstration200 CALL WIN.COLOR("Yellow","Blue")CALL WIN.TWOPEN("ddedemo", "Excel Dynamic Data Exchange demo",10, 5, 70, 16,1)PRINT "To find out the topics Excel supports:-"PRINT "First open a link to the system topic as follows:-"PRINT ' CALL WIN.DDEOPEN("EXCEL_LINK","excel","System", OK)'CALL WIN.DDEOPEN("EXCEL_LINK","excel","System", OK)...CALL WIN.DDEREQ("EXCEL_LINK", "Topics", TOPICS)PRINTVALUE = TOPICS; S = CHAR(9); R = ","; GOSUB 500; * Replace tabsPRINT "The topics known by Excel are"PRINT VALUEPRINTPRINT 'Finally we close the link with'PRINT ' CALL WIN.DDECLOSE("EXCEL_LINK")'CALL WIN.DDECLOSE("EXCEL_LINK")


100

Related Subroutines

WIN.DDECLOSE, WIN.DDEEXEC, WIN.DDEPOKE, WIN.DDEREQ, WIN.DDETIME, WIN.DDEEXEC2


DDE Initiate

WIN.DDEPOKEThis subroutine sends data from wIntegrate to another Windows application using DDE. The otherapplication sets the requirements for the format of the ITEM and VALUE parameters.


Syntax

WIN.DDEPOKE (NAME, ITEM, VALUE)

Parameters

The following table describes the parameters of the WIN.DDEPOKE command:


NAME The name of the current DDE conversation you specified in WIN.DDEOPEN.ITEM The remote application item. This is dependent on the remote application.VALUE The new value of the item. This is dependent on the remote application.

Examples


INPUT DUM:*PRINT @(-1):"First we open a link to the spread sheet 'Sheet1'"PRINT ' CALL WIN.DDEOPEN("EXCEL_SHEET","EXCEL","SHEET1",OK)'CALL WIN.DDEOPEN("EXCEL_SHEET","EXCEL","SHEET1",OK)IF NOT(OK) THENCALL WIN.COLOR("LightRed","")PRINT "We could not open the link so we will exit the demonstration."END ELSEPRINT "We then add the titles to the spreadsheet"PRINT ' CALL WIN.DDEPOKE("EXCEL_SHEET", "R2C2", "Fruit")'PRINT ' CALL WIN.DDEPOKE("EXCEL_SHEET", "R2C3", "Quantity")'CALL WIN.DDEPOKE("EXCEL_SHEET", "R2C2", "Fruit")CALL WIN.DDEPOKE("EXCEL_SHEET", "R2C3", "Quantity")RQM*PRINT "and some data in exactly the same way"R.DATA = "Apple"; R.DATA<1,2> = 20R.DATA<2,1> = "Banana"; R.DATA<2,2> = 30R.DATA<3,1> = "Pear"; R.DATA<3,2> = 10FOR J = 1 TO 3CALL WIN.DDEPOKE("EXCEL_SHEET", "R":(J+3):"C2",R.DATA<J,1>)CALL WIN.DDEPOKE("EXCEL_SHEET", "R":(J+3):"C3", R.DATA<J,2>)NEXT J

WIN.DDEREQ

101

RQM

Related Subroutines

WIN.DDEOPEN, WIN.DDECLOSE, WIN.DDEEXEC, WIN.DDEREQ, WIN.DDETIME


DDE Poke

WIN.DDEREQThis subroutine gets data from another Windows application using DDE.


Syntax

WIN.DDEREQ (NAME, ITEM, VALUE)

Parameters

The following table describes the parameters of the WIN.DDEREQ command:


NAME The name of the current DDE conversation you specified in WIN.DDEOPEN.ITEM The remote application item. This is dependent on the remote application.VALUE The new value of the item. This is dependent on the remote application.

Examples


IF OK THENPRINTPRINT "Press <CR> to continue ":INPUT DUM:PRINT @(-1):"Link opened to Excel system topic"PRINTPRINT "Ask for the Topics items data"PRINT ' CALL WIN.DDEREQ("EXCEL_LINK", "Topics", TOPICS)'TOPICS = ''CALL WIN.DDEREQ("EXCEL_LINK", "Topics", TOPICS)PRINTVALUE = TOPICS; S = CHAR(9); R = ","; GOSUB 500; * Replace tabsPRINT "The topics known by Excel are"PRINT VALUEPRINTPRINT 'Finally we close the link with'PRINT ' CALL WIN.DDECLOSE("EXCEL_LINK")'CALL WIN.DDECLOSE("EXCEL_LINK")


102

Related Subroutines

WIN.DDEOPEN, WIN.DDECLOSE, WIN.DDEEXEC, WIN.DDEPOKE, WIN.DDETIME


DDERequest

WIN.DDETIMEThis subroutine sets the timeout for the DDE link. A timeout is the length of time wIntegrate waits for acommand to execute before generating an error.

If WIN.DDETIME is not set, then 10 seconds is the default timeout.


Syntax

WIN.DDETIME (NAME, TIMEOUT)

Parameters

The following table describes the parameters of the WIN.DDETIME command:


NAME The name of the current DDE conversation you specified in WIN.DDEOPEN.TIMEOUT The number of seconds for the timeout.

Examples

The following example increases the default timeout from 10 to 30 seconds.

CALL WIN.DDETIME("EXCEL_LINK",30)

Related Subroutines

WIN.DDEOPEN, WIN.DDECLOSE, WIN.DDEEXEC, WIN.DDEPOKE, WIN.DDEREQ, WIN.DDEEXEC2


DDE Timeout

WIN.DISPLAYThis subroutine turns on or off the screen display. When the screen display is turned off, nothingis displayed, but the screen is in memory so that when it is turned on, the entire screen displayreappears. When the display is turned off, it continues to receive any updates from the host, which areseen when the display is turned back on.

WIN.DRARC

103

Syntax

WIN.DISPLAY (TURN.ON)

Parameters

The following table describes the parameters of the WIN.DISPLAY command:


TURN.ON 1 "ON" - Turns on the screen display.

Examples

The following example turns off the display while executing Report.

CALL WIN.DISPLAY(0) ;* Turn screen display offEXECUTE "LIST STUDENT LNAME BY LNAME"CALL WIN.DISPLAY(1) ;* Turn screen display back on

Related Subroutines

WIN.SCREEN


Display DisplayOn

WIN.DRARCThis subroutine draws the arc of an ellipse within a rectangle defined by the parameters X1,Y1 to X2,Y2.If X1 and Y1 are null (""), then the upper left of the rectangle is the current graphic cursor position.

Syntax

WIN.DRARC (X1, Y1, X2, Y2, SA, EA, WIN.DRARC)

Parameters

The following table describes the parameters of the WIN.DRARC command:


X1 The X position of the upper left of the rectangleY1 The Y position of the upper left of the rectangleX2 The X position of the lower right of the rectangleY2 The Y position of the lower right of the rectangleSA The degree of the start angleEA The degree of the end angleWIN.DRARC Parameters


104

Examples

The following example is part of the WIN.DRDEMO demonstration program.

* Arcs etc1400 GOSUB 5100; * Erase graphicX = XTLY = YTL + 2*PRINT @(X,Y):"Arcs":CALL WIN.DRARC((X+12)*10,Y*10-15,(X+24)*10,Y*10+25,0,45)*Y = Y + 4PRINT @(X,Y):"Chords":CALL WIN.DRCHORD((X+12)*10,Y*10-15,(X+24)*10,Y*10+25,10,115)*Y = Y + 4PRINT @(X,Y):"Pie segments":CALL WIN.DRPIE((X+12)*10,Y*10-15,(X+24)*10,Y*10+25,0,45)*MSG = "The arcs, chords and pie segments are drawn with:-"MSG<-1> = " WIN.DRARC(X1,Y1,X2,Y2,SA,EA), WIN.DRCHORD(X1,Y1,X2,Y2,SA,EA)"MSG<-1> = "and WIN.DRPIE(X1,Y1,X2,Y2,SA,EA)"*

Related Subroutines

WIN.DRELL, WIN.DRCHORD, WIN.DRPIE, WIN.DRPEN, WIN.DRMOVE, WIN.DRRECT, WIN.DRTEXT,WIN.DRPOLY


Draw Arc, Draw Brush, Draw Chord, Draw Ellipse, Draw Text, Draw Rect, Draw Pie, Draw Pen, DrawPolygon

WIN.DRBRUSHThis subroutine changes the color and style of the brush used in other draw routines. Use it to set thecolor and pattern for shapes.

Syntax

WIN.DRBRUSH (COLOR, STYLE)

Parameters

The following table describes the parameters of the WIN.DRBRUSH command:


COLOR See the following Color tableSTYLE See the following Style table

WIN.DRCHORD

105

Values for COLOR

Value Description

RGB Red, Green, and Blue (RGB) are combined in varying amounts for differentcolors. Minimum amounts of RGB create black; maximum amounts createwhite.

Color name A color name, for example, “Blue,” “Magenta,” “LightGrey,” For a completelist of the color names, see WIN.COLOR.

Values for STYLE

Use the following style names in quotation marks:

Value Description

Solid Specifies a solid colorNull Specifies no color and ignores the COL argumentHorizontal Specifies horizontal linesVertical Specifies vertical linesFDiagonal Specifies diagonal slashes from left to rightBDiagonal Specifies diagonal slashes from right to leftCross Specifies cross hatchingDiagCross Specifies diagonal cross hatching

Examples


* Draw white back ground for drawings*STATE=''CALL WIN.SSTATE(STATE, "")CALL WIN.COLOR("BLACK","WHITE")XTL = 21;YTL = 4; XBR=59; YBR = 14CALL WIN.BOX(XTL-1,YTL-1,XBR+1,YBR+1,0)CALL WIN.DRPEN("Black","Solid","")CALL WIN.DRBRUSH("","Null")

Related Subroutines

WIN.DRPEN


Draw Brush

WIN.DRCHORDThis subroutine draws the chord of an ellipse within a rectangle defined by the parameters X1,Y1 toX2,Y2.

If X1 and Y1 are null (""), then the upper left of the rectangle is the current graphic cursor position.


106

Choose the color and style setting of the chord with WIN.DRPEN, and fill the interior color and stylewith WIN.DRBRUSH.

Syntax

WIN.DRCHORD (X1, Y1, X2, Y2, SA, EA)

Parameters

The following table describes the parameters of the WIN.DRCHORD command:


X1 The X position of the upper left of the rectangleY1 The Y position of the upper left of the rectangleX2 The X position of the lower right of the rectangleY2 The Y position of the lower right of the rectangleSA The degree of the start angleEA The degree of the end angle

Examples


* Arcs etc1400 GOSUB 5100; * Erase graphicX = XTLY = YTL + 2*PRINT @(X,Y):"Arcs":CALL WIN.DRARC((X+12)*10,Y*10-15,(X+24)*10,Y*10+25,0,45)*Y = Y + 4PRINT @(X,Y):"Chords":CALL WIN.DRCHORD((X+12)*10,Y*10-15,(X+24)*10,Y*10+25,10,115)

Related Subroutines

WIN.DRELL, WIN.DRARC, WIN.DRPIE, WIN.DRPEN, WIN.DRMOVE, WIN.DRRECT, WIN.DRTEXT,WIN.DRPOLY, WIN.DRBRUSH



WIN.DRELLThis subroutine draws an ellipse within a rectangle defined by the parameters X1,Y1 to X2,Y2.



WIN.DRERASE

107

Syntax

WIN.DRELL (X1, Y1, X2, Y2, SA, EA)

Parameters

The following table describes the parameters of the WIN.DRELL command:


X1 The X position of the upper left of the rectangleY1 The Y position of the upper left of the rectangleX2 The X position of the lower right of the rectangleY2 The Y position of the lower right of the rectangleSA The degree of the start angleEA The degree of the end angle

Examples


Y = Y + 4PRINT @(X,Y):"Ellipses":CALL WIN.DRELL((X+12)*10,Y*10-3,XBR*10,Y*10+13)*MSG = "The lines/shapes are created with:-"MSG<-1>=" CALL WIN.DRLINE(X1,Y1,X2,Y2)"MSG=MSG:", CALL WIN.DRRECT(X1,Y1,X2,Y2)"MSG<-1>=" CALL WIN.DRPOLY(R.POINTS)"MSG=MSG:" and CALL WIN.DRELL(X1,Y1,X2,Y2)"GOSUB 5000; * Display infoRETURN*

Related Subroutines

WIN.DRCHORD, WIN.DRARC, WIN.DRPIE, WIN.DRPEN, WIN.DRMOVE, WIN.DRRECT, WIN.DRTEXT,WIN.DRPOLY, WIN.DRBRUSH



WIN.DRERASEThis subroutine erases objects drawn by any of the draw routines (WIN.DR).

It also erases images that are drawn by the WIN.IMAGE subroutine. Use this subroutine when you wantto clear the screen of images or drawings.

To erase all objects on an 80 X 24 size screen, use the following code:

CALL WIN.DRERASE(0,0, 799, 239)


108

Syntax

WIN.DRERASE (X1, Y1, X2, Y2)

Parameters

The following table describes the parameters of the WIN.DRERASE command:


X1 The X position of the upper left of the rectangleY1 The Y position of the upper left of the rectangleX2 The X position of the lower right of the rectangleY2 The Y position of the lower right of the rectangle

Examples


* Draw white back ground for drawings*STATE=''CALL WIN.SSTATE(STATE, "")CALL WIN.COLOR("BLACK","WHITE")XTL = 21;YTL = 4; XBR=59; YBR = 14CALL WIN.BOX(XTL-1,YTL-1,XBR+1,YBR+1,0)CALL WIN.DRPEN("Black","Solid","")CALL WIN.DRBRUSH("","Null")*LOOPPRINT @(40,22):" ":@(40,22):INPUT DUM:*UNTIL DUM = "*" DOIF NUM(DUM) THENBEGIN CASECASE DUM = PEN.STYLES; GOSUB 1100CASE DUM = BRUSH.STYLES; GOSUB 1200CASE DUM = SHAPES; GOSUB 1300CASE DUM = ARCS; GOSUB 1400CASE DUM = TEXT; GOSUB 1500END CASEENDREPEAT*CALL WIN.SSTATE("",STATE)*PRINT C22:"Press <CR> to continue ":INPUT DUM:*CALL WIN.DRERASE(XTL*10,YTL*10,XBR*10+9,YBR*10+9)*STOP

Related Subroutines

WIN.DRARC, WIN.DRBRUSH, WIN.DRCHORD, WIN.DRELL, WIN.DRFONT, WIN.DRLINE, WIN.DRPEN,WIN.DRPIE, WIN.DRPOLY, WIN.DRRECT, WIN.DRTEXT, WIN.IMAGE

WIN.DRFONT

109


Draw Erase

WIN.DRFONTThis subroutine sets the font for calls to WIN.DRTEXT. The width and depth are 10 units percharacter. This means that a width of 20 is twice as wide as the current terminal font.

Syntax

WIN.DRFONT (NAME, WIDTH, DEPTH, WEIGHT, STYLE)

Parameters

The following table describes the parameters of the WIN.DRFONT command:


NAME Specifies the name of the font, for example, Helvetica, Times New Roman,and so on.

WIDTH The width of the font in graphic units. On an 80 x 24 terminal, there are 800 x240 graphic units.

DEPTH The depth of the font in graphic units. On an 80 x 24 terminal, there are 800 x240 graphic units.

WEIGHT The weight of the font. The weight options are Light, Normal, Heavy, Bold.STYLE The available font styles are Italic, Underline, Bold.

Examples


CALL WIN.DRFONT("Arial",10,10,"","")CALL WIN.DRTEXT(X*10,Y*10,"Text can be overlaid in any font")*Y = Y + 2CALL WIN.DRFONT("Times New Roman",20,20,"","")CALL WIN.DRTEXT(X*10,Y*10,"At any size")*Y = Y + 2CALL WIN.DRFONT("Courier New",20,20,"","italic")CALL WIN.DRTEXT(X*10,Y*10,"Italics")*Y = Y + 2CALL WIN.DRFONT("Wingdings",30,30,"","")CALL WIN.DRTEXT(X*10,Y*10,"ACEGKNZ")*Y = Y + 4CALL WIN.DRFONT("Consolas",10,10,"","")CALL WIN.DRTEXT(X*10,Y*10, "Fixed or variable pitch")

Related Subroutines

WIN.DRTEXT, WIN.DRPEN, WIN.DRBRUSH


110


Draw Font

WIN.DRLINEThis subroutine draws a line from X1,Y1 to X2,Y2.



Syntax

WIN.DRLINE (X1, Y1, X2, Y2)

Parameters

The following table describes the parameters of the WIN.DRLINE command:


X1 The X position of the upper left of the rectangleY1 The Y position of the upper left of the rectangleX2 The X position of the lower right of the rectangleY2 The Y position of the lower right of the rectangle

Examples


CALL WIN.DRPEN("Red",STYLES<J>,W)CALL WIN.DRLINE((X+12)*10,Y*10+5, XBR*10, Y*10+5)

Related Subroutines

WIN.DRELL, WIN.DRARC, WIN.DRPIE, WIN.DRPEN, WIN.DRMOVE, WIN.DRRECT, WIN.DRTEXT,WIN.DRPOLY, WIN.DRBRUSH


Draw Line, Draw Arc, Draw Brush, Draw Chord, Draw Ellipse, Draw Text, Draw Rect, Draw Pie, DrawPen, Draw Polygon

WIN.DRMOVEThis subroutine moves the graphics cursor to a new position specified by X and Y, but does not drawanything. Move the cursor when you want to use another draw subroutine, starting at a specific pointon the screen.

Syntax

WIN.DRMOVE (X, Y)

WIN.DRPEN

111

Parameters

The following table describes the parameters of the WIN.DRMOVE command:


X New X coordinate of graphics cursorY New Y coordinate of graphics cursor

Examples

The following example moves to 100,200.

CALL WIN.DRMOVE(100,200)

WIN.DRPENThis subroutine changes the color, style, and width of the pen used in drawing. Use it to set the colorfor text, lines, and outlines of shapes.

Syntax

WIN.DRPEN (COLOR, STYLE, WIDTH)

Parameters

The following table describes the parameters of the WIN.DRPEN command:


COLOR See the following Color tableSTYLE See the following Style tableWIDTH Sets the width of the pen; available when you use the "Solid" argument. This

can be a number from 1 to 100.

Values for COLOR

Value Description

RGB Red, Green, and Blue (RGB) are combined in varying amounts for differentcolors. Minimum amounts of RGB create black; maximum amounts createwhite.

Color name A color name, for example, “Blue,” “Magenta,” “LightGrey,” For a completelist of the color names, see WIN.COLOR.

Values for STYLE

Value Description

Solid Specifies a solid colorDash Specifies a dashed line; specify the color of the area outside the dashes with

WIN.DBRUSH

Dot Specifies a dotted line; specify the color of the area outside the dots withWIN.DBRUSH


112

Value Description

DashDot Specifies a line of alternating dashes and dots; specify the color of the areaoutside the dashes and dots with WIN.DBRUSH

DashDotDot Specifies a line of dashes and two dots; specify the color of the area outsidethe dashes and dots with WIN.DBRUSH

Null Specifies no color and ignores the COL argumentInsideFrame Specifies a line that is drawn inside the edge of a polygon

Examples


* Draw white back ground for drawings*STATE=''CALL WIN.SSTATE(STATE, "")CALL WIN.COLOR("BLACK","WHITE")XTL = 21;YTL = 4; XBR=59; YBR = 14CALL WIN.BOX(XTL-1,YTL-1,XBR+1,YBR+1,0)CALL WIN.DRPEN("Black","Solid","")CALL WIN.DRBRUSH("","Null")

Related Subroutines

WIN.DRBRUSH


Draw Brush

WIN.DRPIEThis subroutine draws a pie segment of an ellipse within a rectangle defined by the parameters X1,Y1to X2,Y2.



Syntax

WIN.DRPIE (X1, Y1, X2, Y2, SA, EA)

Parameters

The following table describes the parameters of the WIN.DRPIE command:


X1 The X position of the upper left of the rectangleY1 The Y position of the upper left of the rectangleX2 The X position of the lower right of the rectangleY2 The Y position of the lower right of the rectangleSA The degree of the start angle

WIN.DRPOLY

113


EA The degree of the end angle

Examples


* Arcs etc1400 GOSUB 5100; * Erase graphicX = XTLY = YTL + 2*PRINT @(X,Y):"Arcs":CALL WIN.DRARC((X+12)*10,Y*10-15,(X+24)*10,Y*10+25,0,45)*Y = Y + 4PRINT @(X,Y):"Chords":CALL WIN.DRCHORD((X+12)*10,Y*10-15,(X+24)*10,Y*10+25,10,115)*Y = Y + 4PRINT @(X,Y):"Pie segments":CALL WIN.DRPIE((X+12)*10,Y*10-15,(X+24)*10,Y*10+25,0,45)*MSG = "The arcs, chords and pie segments are drawn with:-"MSG<-1> = " WIN.DRARC(X1,Y1,X2,Y2,SA,EA), WIN.DRCHORD(X1,Y1,X2,Y2,SA,EA)"MSG<-1> = "and WIN.DRPIE(X1,Y1,X2,Y2,SA,EA)"*

Related Subroutines

WIN.DRELL, WIN.DRCHORD, WIN.DRPEN, WIN.DRMOVE, WIN.DRRECT, WIN.DRTEXT, WIN.DRPOLY


Draw Arc, Draw Brush, Draw Chord, Draw Ellipse, Draw Text, Draw Rect, Draw Pie, Draw Pen

WIN.DRPOLYThis subroutine draws a polygon by joining the vertices specified in points.


Syntax

WIN.DRPOLY (POINTS)

Parameters

The following table describes the parameters of the WIN.DRPOLY command:


POINTS Multi-field dynamic array of vertices of the polygon. The X-coordinate is thefirst multivalue, and the Y-coordinate is the second multivalue. A polygoncan have 3 - 5 vertices. The coordinates are based on 10 per character on theterminal screen, with the upper left at 0,0.


114

Examples


*Y = Y + 4PRINT @(X,Y):"Polygons":POINTS=''W = INT((XBR-X-12)/3)-2X1 = X + 12X1 = X1 * 10Y1 = Y * 10 + 5W = W * 5D = 18*FOR J = 3 TO 5A = 0INC = INT(360/J)FOR K = 1 TO JPOINTS<K,1> = X1 + INT(W * COS(A))POINTS<K,2> = Y1 + INT(D * SIN(A))A = A + INCNEXT KCALL WIN.DRPOLY(POINTS)X1 = X1 + W * 2 + 10NEXT J*

Related Subroutines

WIN.DRRECT, WIN.DRPEN, WIN.DRBRUSH


Draw Polygon

WIN.DRRECTThis subroutine draws a rectangle defined by the parameters X1,Y1 to X2,Y2.



Syntax

WIN.DRRECT (X1, Y1, X2, Y2)

Parameters

The following table describes the parameters of the WIN.DRRECT command:


X1 The X position of the upper left of the rectangleY1 The Y position of the upper left of the rectangleX2 The X position of the lower right of the rectangle

WIN.DRTEXT

115


Y2 The Y position of the lower right of the rectangle

Examples


Y = Y + 2PRINT @(X,Y):"Rectangles":CALL WIN.DRRECT((X+12)*10,Y*10-3,XBR*10,Y*10+13)

Related Subroutines

WIN.DRELL, WIN.DRCHORD, WIN.DRPEN, WIN.DRMOVE, WIN.DRTEXT, WIN.DRPOLY


Draw Arc, Draw Brush, Draw Chord, Draw Ellipse, Draw Text, Draw Rect, Draw Pie

WIN.DRTEXTThis subroutine draws text within a rectangle on the screen.

Use this in conjunction with WIN.DRPEN to set the color and WIN.DRFONT to set the font. Fill in therectangle in a color set with WIN.DRBRUSH.

Syntax

WIN.DRTEXT (X1, Y1, TEXT)

Parameters

The following table describes the parameters of the WIN.DRTEXT command:


X1 The column position of the textY1 The row position of the textTEXT The text to display

Examples


CALL WIN.DRFONT("Arial",10,10,"","")CALL WIN.DRTEXT(X*10,Y*10,"Text can be overlaid in any font")*Y = Y + 2CALL WIN.DRFONT("Times New Roman",20,20,"","")CALL WIN.DRTEXT(X*10,Y*10,"At any size")*Y = Y + 2CALL WIN.DRFONT("Courier New",20,20,"","italic")CALL WIN.DRTEXT(X*10,Y*10,"Italics")*Y = Y + 2


116

CALL WIN.DRFONT("Wingdings",30,30,"","")CALL WIN.DRTEXT(X*10,Y*10,"ACEGKNZ")*Y = Y + 4CALL WIN.DRFONT("Consolas",10,10,"","")CALL WIN.DRTEXT(X*10,Y*10, "Fixed or variable pitch")*MSG = "The font and its size, weight and style is first chosen with:-"MSG<-1> = " CALL WIN.DRFONT(NAME,WIDTH,DEPTH,WEIGHT,STYLE)"MSG<-1> = "and then drawn with:-"MSG<-1> = " CALL WIN.DRTEXT(X,Y,TEXT)"*

Related Subroutines

WIN.DRPEN, WIN.DRFONT, WIN.DRBRUSH


Draw Text

WIN.EDDATAThis subroutine runs the wIntegrate Editor to edit a host data item.

Syntax

WIN.EDDATA FILE ITEM1 ITEM2 ITEM3

Parameters

The following table describes the parameters of the WIN.EDDATA command:


FILE The name of the host file that contains the item to be editedITEM1 Host item to editITEM2 Optional second item to edit in FILEITEM3 Optional third item to edit; additional item names can be added after this if

required

Examples

The following example edits a data item in the wIntegrate Editor.

WIN.EDDATA WIN.CUST 1001

Related Subroutines

WIN.EDDICT, WIN.EDPROG, WIN.EDIT

Version


WIN.EDDICT

117

WIN.EDDICTThis subroutine runs the wIntegrate Editor to edit a host dictionary item.

Syntax

WIN.EDDICT FILE ITEM1 ITEM2 ITEM3

Parameters

The following table describes the parameters of the WIN.EDDICT command:


FILE The name of the host file that contains the item to be edited in its dictionaryITEM1 Host dictionary item to editITEM2 Optional second dictionary item to edit in the dictionary of FILEITEM3 Optional third item to edit; additional item names can be added after this if

required

Examples

The following example edits the NAME dictionary item in WIN.CUST using the wIntegrate Editor.

WIN.EDDICT WIN.CUST NAME

Related Subroutines

WIN.EDDATA, WIN.EDPROG, WIN.EDIT

Version


WIN.EDITThis subroutine runs the wIntegrate Editor to edit a host program item.

Syntax

WIN.EDIT FILE ITEM1 ITEM2 ITEM3

Parameters

The following table describes the parameters of the WIN.EDIT command:


FILE The name of the host file that contains the item to be edited. By default, theitem is edited as a host program, but preceding the file name with the wordDICT or DATA causes it to be edited as a dictionary or data host item.

ITEM1 Host item to editITEM2 Optional second item to edit in FILE


118


ITEM3 Optional third item to edit; additional item names can be added after this ifrequired

Examples

The following examples load several items into the wIntegrate Editor.

WIN.EDIT WIN.PROGS WIN.DDE WIN.DEMO WIN.OBDEMO

WIN.EDIT DICT WIN.CUST NAME CONTACT PHONE

Related Subroutines

WIN.EDDATA, WIN.EDDICT, WIN.EDPROG

Version

6.3.4 DICT/DATA editing

WIN.EDPROGThis subroutine runs the wIntegrate Editor to edit a host program item.

Syntax

WIN.EDPROG FILE ITEM1 ITEM2 ITEM3

Parameters

The following table describes the parameters of the WIN.EDPROG command:


FILE The name of the host file that contains the item to be editedITEM1 Host item to editITEM2 Optional second item to edit in FILEITEM3 Optional third item to edit; additional item names can be added after this if

required

Examples

The following example loads several programs into the wIntegrate Editor.

WIN.EDPROG WIN.PROGS WIN.DDE WIN.DEMO WIN.OBDEMO

Related Subroutines

WIN.EDDATA, WIN.EDDICT, WIN.EDIT

WIN.EFFECT

119

Version


WIN.EFFECTThis subroutine sets the effect of the text that follows.

Syntax

WIN.EFFECT (NAME)

Parameters

The following table describes the parameters of the WIN.EFFECT command:


NAME The name of the effect to use for the text. See the following Name table foravailable effects. Any of the effects can be used individually, or concatenatedas a string, for example, DimReverse, BoldUnderline.

Values for NAME

Use one or more names that are concatenated from the table:

Value Description

Normal Normal intensityDim Low intensityReverse Foreground and background colors are reversedUnderline UnderlinedFlash Blinking textBold High intensitySecret Invisible

Examples


* Dummy customer maintenance program200 CALL WIN.EFFECT("NORMAL")PRINT @(0,3):@(-3)PRINT @(30,3):"Customer maintenance":PRINT @(5,5):"Id:":PRINT @(5,7):"1. Name:":PRINT @(5,10):"2. Address:":PRINT @(5,15):"3. Contact:"*PRINT @(25,5):CALL WIN.EFFECT("REVERSE")PRINT " ":CALL WIN.EFFECT("NORMAL")PRINT @(25,7):CALL WIN.EFFECT("REVERSE")PRINT " ":CALL WIN.EFFECT("NORMAL")


120

FOR J = 10 TO 13PRINT @(25,J):CALL WIN.EFFECT("REVERSE")PRINT " ":CALL WIN.EFFECT("NORMAL")NEXT JPRINT @(25,15):CALL WIN.EFFECT("REVERSE")PRINT " ":CALL WIN.EFFECT("NORMAL")PRINT @(52,7):"This area has some useful":PRINT @(52,8):"or important static text":PRINT @(52,9):"displayed in it.":RETURN

Related Subroutines

WIN.COLOR


Color

WIN.EFILLThis subroutine fills an area of the screen with an effect.

Syntax

WIN.EFILL (NAME, LEFT, TOP, RIGHT, BOTTOM)

Parameters

The following table describes the parameters of the WIN.EFILL command:


NAME The name of the effect; see the following Name tableLEFT The left column of the area to fillTOP The top of the area to fillRIGHT The right column of the area to fillBOTTOM The bottom column of the area to fill

Values for NAME

Value Description

Normal Normal intensityDim Low intensityReverse Foreground and background colors are reversedUnderline UnderlinedFlash Blinking textBold High intensity

WIN.EI

121

Value Description

Secret Invisible

Examples


* Emphasise prompt text260 TEXT = "Emphasis for the title and field text can be added by setting up"TEXT = TEXT : " Bold to be a raised style and then paint the bold effect"TEXT = TEXT : " on the drawn screen."GOSUB 2000; * Print textGOSUB 1000; * Continue promptCALL WIN.SETEFFCT("Bold","Black","LightGray","Raised",0)* Have to temporarily put scrollregion back to whole screenCALL WIN.COMSUB("Screen ScrollRegion")CALL WIN.EFILL("Bold", 30,3,49,3)CALL WIN.EFILL("Bold", 5,5,15,5)CALL WIN.EFILL("Bold", 5,7,15,7)CALL WIN.EFILL("Bold", 5,10,15,10)CALL WIN.EFILL("Bold", 5,15,15,15)

Related Subroutines

WIN.EFFECT


Display EffectFill

WIN.EIThis subroutine allows local editing on the host and returns the value. The field is edited entirely onthe desktop and sent to the host as a single input on leaving the field.

This subroutine is useful for editing long text fields that span multiple lines where edit keys and wordwrap are difficult to program on the host.

You can finish the input in one of the following ways:

▪ Entering a carriage return—the default method.▪ Pressing the Esc key (in this case, the value is not updated).▪ Entering this combination: Ctrl+F Shift+End.▪ Defining an exit key in the EXITS parameter.▪ The WIN.EI2 subroutine can be used for more control of the input.

Syntax

WIN.EI (X, Y, LEN, NLINES, NDISPLAY, OPTS, VALID, EXITS, VALUE, ESC)

Parameters

The following table describes the parameters of the WIN.EI command:


X The column position for the input


122


Y The row position for the inputLEN The length of the inputNLINES The number of lines of the inputNDISPLAY The number of lines to display at one timeOPTS Available options; see the following Opts tableVALID See the following Valid tableEXITS Specifies the characters to exit the routine. Set to "" a carriage return exitVALUE The default and returned valuesESC This variable is set to 1 if the input was exited with the escape key; otherwise

it is set to 0

Values for OPTS

Options are used in conjunction with the validation parameter. The options for the WIN.EIsubroutine can be one or more of the option letters, concatenated and inside of quotation marks, forexample, "AM":

Value Description

M Makes the validation parameter mandatoryU Converts input into uppercaseB Beeps when an error occursD Shows the error on a dialog boxS Displays the error on the status barA Causes an automatic carriage return; the field is automatically finished when

the last character is typedV Validates on exit by exit_charsP(char) Pad the background with the specified character

Values for VALID

Validation checks the input against the specified pattern. During input, validation checks eachcharacter for specified patterns. For instance, if a field must have three alphabetic characters, a dash,and two numeric characters, the validation pattern would look like: "3A"-"2N". You can also specifyminimum or maximum occurrences of a pattern by numbers in parentheses (min(max)).

Value Description

N A numeric characterA An alphabetic character"x" Any character"text" Text inside of quotation marks. To designate a choice of characters or text,

which is separated the choices by a vertical bar (|). Example: "'EXIT'"|"'QUIT""Example: "IN | '*'"

WIN.EI

123

Examples

The following example is the entire WIN.EIDEMO demonstration program. To understand how thissubroutine works, enter WIN.EIDEMO from your database prompt. The program demonstrates howWIN.EI creates edit input fields with mandatory input parameters.

* WIN.EIDEMO* Demonstration of the Edit Input command using the WIN.EI subroutine* Compile for: GENERIC AP MD ME PI PR SQ UD UL UP UV UC IN* Copyright (c) 1991-93. Impact Business Systems*DIM R.TEST(7)MAT R.TEST = ""*PROMPT ''SCREEN = @(-1):"WIN.EIDEMO"SCREEN = SCREEN : @(20,0):"Demonstration of WIN.EI subroutine"SCREEN = SCREEN : @(0,2):"1. Any entry"SCREEN = SCREEN : @(0,4):"2. Mandatory Entry"SCREEN = SCREEN : @(0,6): "3. Pure Numeric"SCREEN = SCREEN : @(0,8): "4. 1 to 3 Alpha '-' 2 digits"SCREEN = SCREEN : @(0,10):"5. Numeric, 'EXIT' or 'HI'"SCREEN = SCREEN : @(0,12):"6. Text Entry"*PRINT SCREEN:C22 = @(0,22):@(-4)ESC = ''*LOOPPRINT C22:"Press number (without <CR>) or * to end":VALUE = ''EXIT = "*"CALL WIN.EI(40,22,1,1,1, "AM","N", EXIT, VALUE, ESC)IF ESC OR EXIT # "" THEN VALUE = '*'UNTIL VALUE = '*' DOBEGIN CASECASE VALUE = 1; GOSUB 100; * Test 1CASE VALUE = 2; GOSUB 200; * Test 2CASE VALUE = 3; GOSUB 300; * Test 4CASE VALUE = 4; GOSUB 400; * Test 4CASE VALUE = 5; GOSUB 500; * Test 5CASE VALUE = 6; GOSUB 600; * Test 6END CASEREPEAT*STOP*100 CALL WIN.EI(30,2,10,"","","","","", R.TEST(1), ESC)RETURN*200 CALL WIN.EI(30,4,15, "","","M","", "", R.TEST(2), ESC)RETURN*300 CALL WIN.EI(30,6,8,"","","","0N", "", R.TEST(3), ESC)RETURN*400 CALL WIN.EI(30,8,25,"","","U","1-3A'-'2N", "", R.TEST(4), ESC)RETURN*500 CALL WIN.EI(30,10,15,"","","U","1N0N|'EXIT'|'HI'", "", R.TEST(5), ESC)RETURN*


124

600 CALL WIN.EI(30,12,25,12,3,"","","",R.TEST(6), ESC)RETURN*END

Related Subroutines

WIN.LI, WIN.EI2


EditInput

WIN.EI2This subroutine uses input data from a user and allows simple editing of the data before it is sent backto the host.

If the Edit Input Keys parameter is set in Setup > Preferences, then the Soft Edit keys are used fornavigation in the input.

You can finish the input in one of the following ways:

▪ Entering a carriage return on the last line of input for multiple line inputs.▪ Pressing the Esc key (in this case, the value is not updated unless CHAR(27) is set to be an exit key.▪ Entering this combination: Ctrl+F Shift+End.▪ Defining an exit key in the EXITS parameter.▪ Pressing a key that is defined in the exit_keys field of the parameters.▪ The WIN.EI2 subroutine is an enhanced version of the WIN.EI subroutine.

Syntax

WIN.EI2 (X, Y, LEN, NLINES, PARAMS, VALUE, EXITKEY, STATE)

Parameters

The following table describes the parameters of the WIN.EI2 command:


X The column position for the input.Y The row position for the input.LEN The length of the input.NLINES The number of lines of the input.PARAMS A dynamic array specifying additional parameters for the input. See the

Params table for details. If set to "", the default values are used.VALUE The value to be input. On entry to the routine, this is the initial value to be

used.EXITKEY The key value or name that is used to exit the routine. This is "" if the field was

exited with return, CHAR(27) if the escape key was used, or the name or valueof the exit key that is specified in the PARAMS argument. If the return value isCHAR(27), the variable is not updated.

WIN.EVAL

125


STATE This is a dynamic array containing the state of the input on exit. Passing thisvalue back to the input routine next time the field is edited will restore theediting position.

Fields for PARAMS

The first four fields of the array are unused.

Field Description

5 The number of columns to display; default is the LEN parameter.6 The number of lines to display; default is the NLINES parameter.7 Options. See the OPTS parameter of WIN.EI.8 Validation. See the VALIDS parameter of WIN.EI.9 Exit chars; additional characters that will cause the input to exit.10 Exits keys. A value mark separated list of the keys that cause the input to exit.

The key names can be found by looking at the names that are displayed in theSetup > Keyboard menu option. For example, "Escape":@VM:"F1".

Examples

See the WIN.EI2DEMO host program in the WIN.PROGS file.

Related Subroutines

WIN.EI


EditInput2

Version


WIN.EVALThis subroutine evaluates a script expression and returns the result.

Syntax

WIN.EVAL (EXPRESSION, RESULT)

Parameters

The following table describes the parameters of the WIN.EVAL command:


EXPRESSION The script expression to be evaluatedRESULT Variable to hold the result


126

WIN.EXPORTThis subroutine exports a PC file to the host computer. It calls the RunExportFile menu command, soto understand this subroutine, you can look at the Run > Export File dialog box.


Syntax

WIN.EXPORT (PCFILE, FILE, ITEMS, FIELDS, OPTS, STATUS)

Parameters

The following table describes the parameters of the WIN.EXPORT command:


PCFILE The full path name of the PC file to exportFILE The name of the host file to hold the export file contentsITEMS The item names to use on the exported fileFIELDS The field names of the fields to exportOPTS Available options; see the following Opts tableSTATUS The returned status; the returns are "OK", "Cancel", or "Error"

Fields for OPTS

Field Description

1 Format. A file format for the DOS file. Valid formats are ASC, CSV, CQV, XLS,XLSX, FIX, WK1, MRG, RAW, TSV, HEX, XML, and HTML.

The default is the extension in the FILE parameter.2 Overwrite. Specifies options of overwriting an existing file:

"Yes" (default)

"No"

"Combine" – not supported on all formats3 Multiple disks. True to export from multiple floppy disks.6 Translate. This option is available to change characters as they are exported,

according to the Translation:

"None"

"ASCII" (default)

"All"7 Translation. The default is "\255,\r\n\f\r\n,\254,\r\n". If you want to use a

format other than ASCII, you must go into the Export dialog box and deletethe Translation definition.

8 AutoExit. Exits the Export monitor at the end of the transfer. The default is"True".

9 Inform. Notify the user when export is finished. The default is "False".

WIN.FKEY

127

Field Description

10 Timeout. The maximum number of seconds to wait for a response from thehost. The default is "5".

11 Retries. The maximum number of retries. The default is "3".12 Use formatting information. Set to 1 to use the formatting information from

the host dictionary items in the export.

Examples

The following example exports the Orders spreadsheet to the NEW.ORDERS host file.

STATUS = ""OPTS = ""CALL WIN.EXPORT("c:\excel\orders.xls", "NEW.ORDERS", "#", "*", OPTS, STATUS)

Related Subroutines

WIN.IMPORT, WIN.TRANSFER


Dialog RunImportFile, Set

Version

4.1 New options OPTS<12>

WIN.FKEYThis subroutine programs function keys, as in wIntegrate's keyboard that is accessed from Setup> Keyboard. If the KEYS parameter is "" (null), WIN.FKEY assumes that DEFS contains definitionsstarting with the F1 key.

Syntax

WIN.FKEY (KEYS, DEFS)

Parameters

The following table describes the parameters of the WIN.FKEY command:


KEYS A multi-field dynamic array that matches DEFSDEFS Key definitions that can contain function key or names; see the following Keys

table

Values for KEYS

The following key codes can be used:

Value Description

1-12 F1 to F1213-24 Shift + F1 to Shift + F12


128

Value Description

25-36 Ctrl + F1 to Ctrl + F1237-48 Ctrl + Shift + F1 to Ctrl + Shift + F12

Examples

The following example programs the F1, F3, and Shift + F2 keys.

KEYS = "";DEFS = ""KEYS<1> = 1;DEFS<1> = "Key 1"KEYS<2> = 3;DEFS<2> = "Key 3"KEYS<3> = 14;DEFS<3> = "Keys Shift F2"CALL WIN.FKEY(KEYS,DEFS)* Set shift F1 to run wIntegrate HelpCALL WIN.FKEY("Shift_F1", "\mInvoke HelpIndex")

WIN.FSCRIPTThis subroutine sends a script to the PC to be executed.

This is similar to the WIN.HSCRIPT routine but uses a different technique to transfer the script to thePC. In most cases, this routine is faster than WIN.HSCRIPT.

Syntax

WIN.FSCRIPT (SCRIPT)

Parameters

The following table describes the parameters of the WIN.FSCRIPT command:


SCRIPT The text of the script to be run

Related Subroutines

WIN.HSCRIPT

WIN.FTPCLOSEThis subroutine closes a file which was previously opened by WIN.FTPOPEN.

Syntax

WIN.FTPCLOSE

Examples

See the WIN.FTPDEMO program in the WIN.PROGS file.

WIN.FTPCON

129

Related Subroutines

WIN.FTPOPEN

Version

4.1 Original

WIN.FTPCONThis subroutine connects wIntegrate to a remote FTP server. You can only have one FTP connectionper session.

Syntax

WIN.FTPCON (SERVERNAME, USERNAME, PASSWORD, RESP)

Parameters

The following table describes the parameters of the WIN.FTPCON command:


SERVERNAME The name of IP address of the FTP server.USERNAME The user name on the server. Set this and password to "" to log on as an

anonymous user (where your username is anonymous and your password isyour email address).

PASSWORD The password that is required for this user to log on to the FTP server.RESP "" if logon was successful, otherwise an error message.

Examples


Version


WIN.FTPDELThis subroutine deletes a file on an FTP server.

Use WIN.FTPMKDIR to delete a directory.

Syntax

WIN.FTPDEL (FILENAME)

Parameters

The following table describes the parameters of the WIN.FTPDEL command:


130


FILENAME The name of the file to delete from the FTP server

Examples


Version


WIN.FTPDIRThis subroutine checks if a directory exists on an FTP server.

Syntax

WIN.FTPDIR (DIRNAME, EXISTS)

Parameters

The following table describes the parameters of the WIN.FTPDIR command:


DIRNAME The name of the directory to checkEXISTS Set to 1 if directory exists; otherwise 0

Examples


Version


WIN.FTPDISCThis subroutine disconnects the FTP session.

Syntax

WIN.FTPDISC

Related Subroutines

WIN.FTPCON

Examples


WIN.FTPFILE

131

Version

4.0.4 Original

WIN.FTPFILEThis subroutine checks whether a file exists on an FTP server.

Syntax

WIN.FTPFILE (FILENAME, EXISTS)

Parameters

The following table describes the parameters of the WIN.FTPFILE command:


FILENAME The name of the file to checkEXISTS Set to 1 if file exists; otherwise 0

Examples


Version


WIN.FTPGETThis subroutine copies a file from the FTP server to the local PC.

Syntax

WIN.FTPGET (REMOTE.FILE, PC.FILE, TYPE, RESP)

Parameters

The following table describes the parameters of the WIN.FTPGET command:


REMOTE.FILE The name of the file on the FTP server.PC.FILE The name of the file on the PC.TYPE The type of file to retrieve:

0 - ASCII text file (the default). Select this option only if the file is a readableASCII file. This ensures the end-of-line characters are converted appropriatelybetween local and remote file systems.

1 - Binary file.RESP "" if the file transferred OK, otherwise an error message.


132

Examples


Version


WIN.FTPGETDRThis subroutine returns the name of the current directory on the FTP server.

Syntax

WIN.FTPGETDR (DIRECTORY)

Parameters

The following table describes the parameters of the WIN.FTPGETDR command:


DIRECTORY Returned directory name

Examples


Version


WIN.FTPINFOThis subroutine returns information about the specified file on the FTP server.

Note: Not all of the information that is returned by this function can be relied upon (theinformation that is returned depends on the remote FTP site).

Syntax

WIN.FTPINFO (FILENAME, INFO)

Parameters

The following table describes the parameters of the WIN.FTPINFO command:


FILENAME The name of the file to retrieve information onINFO A text string with the information separated by spaces in the order:

length,date,time,attributes

WIN.FTPLIST

133

Examples


Version


WIN.FTPLISTThis subroutine returns a list of the files and/or subdirectories on an FTP server matching the criteriathat you specify in a dynamic array.

Syntax

WIN.FTPLIST (FILESPEC, OPTS, RESP)

Parameters

The following table describes the parameters of the WIN.FTPLIST command:


FILESPEC The files to return. This can be a wild-card expression to match files.OPTS Specifies other matching options. See the following Opts table for more

information.RESP A dynamic array of the files and/or directories that match the specification.

Values for OPTS

The OPTS field specifies which files or subdirectories to match. The default option is 0. The options 4and 32 can be used alone or added to other option numbers.

Value Description

0 Returns files only.1 Returns files and directories.2 Returns files; includes directories in square brackets.3 Returns files; includes directories that are prefixed with ">".4 Returns only subdirectories.32 Do not include current directory.

Examples


Version


WIN.FTPMKDIRThis subroutine creates a directory on the FTP server.


134

Syntax

WIN.FTPMKDIR (DIRNAME)

Parameters

The following table describes the parameters of the WIN.FTPMKDIR command:


DIRNAME The name of the directory to create

Examples


Version


WIN.FTPOPENThis subroutine opens a file on the FTP server for reading and writing.

Only one file can be opened at a time, and only calls to the WIN.FTPREAD and WIN.FTPWRITE FTProutines should be made until WIN.FTPCLOSE is called. The file must be closed when finished withWIN.FTPCLOSE.

Syntax

WIN.FTPOPEN (FILENAME, OPTS, RESP)

Parameters

The following table describes the parameters of the WIN.FTPOPEN command:


FILENAME The name of the file to open.OPTS Specifies the file and operation type. You cannot open a remote file for both

reading and writing, so the options must reflect which operation is intended.See the following Opts table.

RESP 1 if file could be opened; otherwise 0.

Values for OPTS

Value Description

1 Read Binary.2 Write ASCII text. Select this option only if you are reading or writing

readable ASCII text—this ensures the end-of-line characters are convertedappropriately between local and remote file systems.

3 Write Binary.

WIN.FTPPOS

135

Examples


Version


WIN.FTPPOSThis subroutine moves the position in the currently open file to the specified location.

Syntax

WIN.FTPPOS (POSITION)

Parameters

The following table describes the parameters of the WIN.FTPPOS command:


POSITION The new position in the file:

0 - the start of the file

1 - can be used for the end of the file

Examples


Version


WIN.FTPPUTThis subroutine copies a file from the local PC to the FTP server.

Syntax

WIN.FTPPUT (PC.FILE, REMOTE.FILE, TYPE, RESP)

Parameters

The following table describes the parameters of the WIN.FTPPUT command:


PC.FILE The name of the file on the PC.REMOTE.FILE The name of the file on the FTP server.


136


TYPE The type of file to retrieve:

0 - ASCII text file (the default). Select this option only if the file is a readableASCII file. This ensures the end-of-line characters are converted appropriatelybetween local and remote file systems.

1 - Binary file.RESP "" if the file transferred OK, otherwise an error message.

Examples


Version


WIN.FTPREADThis subroutine reads bytes from the currently open file on the FTP server.

The file must have been opened for read access with WIN.FTPOPEN.

Syntax

WIN.FTPREAD (VALUE, MAX.BYTES, CONVERT)

Parameters

The following table describes the parameters of the WIN.FTPREAD command:


VALUE Variable to receive the bytes readMAX.BYTES The maximum number of bytes to read; set to "" for the default value of

approximately 30KCONVERT Data conversion to use on reply; see the following Convert table

Values for CONVERT

Value Description

"" No conversion"TEXT" Convert cr/lf to field mark"HEX" Return each byte in the file as a 2-digit hex number"FT" Return in wIntegrate’s file transfer format

Examples


WIN.FTPRMDIR

137

Version


WIN.FTPRMDIRThis subroutine removes (deletes) the specified directory from the FTP server.

Syntax

WIN.FTPRMDIR (DIRNAME)

Parameters

The following table describes the parameters of the WIN.FTPRMDIR command:


DIRNAME The name of the directory to delete

Examples


Version


WIN.FTPSCRThis subroutine loads a script from the FTP server and runs it.

Syntax

WIN.FTPSCR (SCRIPTNAME, OK)

Parameters

The following table describes the parameters of the WIN.FTPSCR command:


SCRIPTNAME The file name of the script to run on the serverOK 1 if the script started OK, otherwise 0

Examples


Version



138

WIN.FTPSCRPTThis subroutine transfers the script to the PC using FTP and then runs it.

It requires a connection made to the FTP server with WIN.FTPCON and a temporary file on the hostthat can also be accessed through FTP.

Syntax

WIN.FTPSCRPT (SCRIPTNAME, MAT FTP.OPTS, OK)

Parameters

The following table describes the parameters of the WIN.FTPSCRPT command:


SCRIPTNAME The file name of the script to run on the serverMAT FTP.OPTS 10-element array of additional information that is required for the transfer;

see the following tableOK 1 if the script started OK, otherwise 0

Fields for MAT FTP.OPTS

Field Description

1 Handle to temporary file2 Path to temporary file for the FTP server3-10 Reserved. Set to ""

Examples

The following example runs Excel using the "Run" script command.

DIM OPTS(10)MAT OPTS = ""OPEN "", "TEMP" TO OPTS(1) ELSE STOP "No TEMP file"OPTS(2) = "/usr/uv/account/TEMP";* Path to serverCALL WIN.FTPCON("server","username","password", RESP)IF RESP = "" THENCALL WIN.FTPSCRPT("Run 'excel.exe'", MAT OPTS, OK)CALL WIN.FTPDISCEND

Related Subroutines

WIN.FTPCON, WIN.FTPSCR

Version


WIN.FTPSETDR

139

WIN.FTPSETDRThis subroutine sets the current directory on the FTP server. This is useful because it allows the FTProutines to then refer to file names and subdirectories without having to specify their full paths.

Syntax

WIN.FTPSETDR (DIRNAME)

Parameters

The following table describes the parameters of the WIN.FTPSETDR command:


DIRNAME The directory name to be set as the current directory

Examples


Version


WIN.FTPSETVThis subroutine sets the script variable or dialog box property with the specified value using FTP.

It requires a connection made to the FTP server with WIN.FTPCON and a temporary file on the hostthat can also be accessed through FTP.

Syntax

WIN.FTPSETV (VARNAME, VALUE, MAT FTP.OPTS, OK)

Parameters

The following table describes the parameters of the WIN.FTPSETV command:


VARNAME Name of the script variable to set; can also be the name of a dialog boxproperty

VALUE The value to set the variableMAT FTP.OPTS 10-element array of additional information that is required for the transfer;

see the following tableOK 1 if the variable was transferred OK, otherwise 0

Fields for MAT FTP.OPTS

Field Description

1 Handle to temporary file2 Path to temporary file for the FTP server


140

Field Description

3-10 Reserved. Set to ""

Examples

The following example puts the contents of the record REC in the grid.

*DIM OPTS(10)MAT OPTS = ""OPEN "", "TEMP" TO OPTS(1) ELSE STOP "No TEMP file"OPTS(2) = "/usr/uv/account/TEMP";* Path to server*GOSUB 100 ;* Create the dialog box with the Grid on itGOSUB 200 ;* Set up the data for the grid in REC*CALL WIN.FTPCON("server","username","password", RESP)IF RESP = "" THEN* Set the grids data property to display the dataCALL WIN.FTPSETV("GridTest.Grid1.Data",REC, MAT OPTS, RESP)IF RESP = 0 THEN ERR = 7ENDCALL WIN.FTPDISC*IF ERR THEN PRINT "UNABLE TO LOAD, ERROR = ":ERR;STOP*CALL WIN.DBSHOW(DLGNAME, 0, ERR)IF ERR THEN PRINT "UNABLE TO SHOW, ERROR = ":ERR;STOP

Version


WIN.FTPWRITEThis subroutine writes bytes to the currently open file on the FTP server.

The file must have been opened for write access with WIN.FTPOPEN.

Syntax

WIN.FTPWRITE (VALUE, CONVERT)

Parameters

The following table describes the parameters of the WIN.FTPWRITE command:


VALUE Data to write to the FTP fileCONVERT Data conversion to use on the VALUE before writing it to the server file

Values for CONVERT

Value Description

"" No conversion

WIN.FTTOASC

141

Value Description

"TEXT" Convert cr/lf to field mark"HEX" Return each byte in the file as a 2-digit hex number"FT" Return in wIntegrate’s file transfer format

Examples


Related Subroutines

WIN.FTPOPEN

Version


WIN.FTTOASCConverts a 7-bit file transfer string to ASCII format. The file transfer format represents controlcodes and other special characters as one or two 7-bit values. The 7-bit data can be sent across anycommunications line.

Syntax

WIN.FTTOASC (VALUE)

Parameters

The following table describes the parameters of the WIN.FTTOASC command:


VALUE The string to convert

Related Subroutines

WIN.ASCTOFT

WIN.GET64.UDThis subroutine gets the value of a script variable or property. It can only be used on UniData hostsystems because it relies on the Base64 encoding function built into UniBasic.

Syntax

WIN.GET64.UD (VARNAME, VALUE, ISTEXT, TRANSCR)

Parameters

The following table describes the parameters of the WIN.GET64.UD command:


142


VARNAME The name of the script variable or script property to retrieve the value ofVALUE The value of the variable that is specified in VARNAMEISTEXT 1 if the variable is text and should be converted according to the current host

encoding/emulation; 0 if the variable is binary and should not be subjected toany conversion

TRANSCR Specifies the mapping from CR (CHAR(13)) and TABS (CHAR(9)) to field marksand value marks; see the following Transcr table

Values for TRANSCR

Value Description

0 No mapping1 Map CR to field mark and TAB to value mark2 Map CR to field mark and TAB to value mark. Additionally strips out any

linefeeds (CHAR(10))

Related Subroutines

WIN.GETVAL, WIN.GETVAR, WIN.GETDATA


Host Send, Encode

Version


WIN.GETDATAThis subroutine returns the value or contents of a global variable. The variable can contain ASCIIcharacters less than 32 and greater than 126, including tabs and carriage returns.

If your variables contain only ASCII characters between 32 and 126, use the faster WIN.GETVARsubroutine.

Syntax

WIN.GETDATA (VARNAME, VALUE)

Parameters

The following table describes the parameters of the WIN.GETDATA command:


VARNAME The name of the variable to returnVALUE The value of the variable that is specified in VARNAME

WIN.GETLIST

143

Examples

The following example finds and prints the current value of UserName.

CALL WIN.GETDATA("UserName", VALUE)PRINT "The current UserName is ": VALUE

Related Subroutines

WIN.GETVAR, WIN.SETDATA, WIN.SETVAR, WIN.DBGET, WIN.DBSET, WIN.SETLIST

WIN.GETLISTSince PC items generally have lines that are separated by carriage returns, and values that areseparated by tabs, this subroutine is provided to convert these characters to field marks (CHAR 254)and value marks (CHAR 253). This subroutine gets the value or contents of a global or local variable.The variable can contain ASCII characters less than 32 and greater than 126, including tabs andcarriage returns.


Syntax

WIN.GETLIST (VARNAME, VALUE)

Parameters

The following table describes the parameters of the WIN.GETLIST command:



Examples

The following example gets the value of the PC item PCREC and converts it to the host item format.

CALL WIN.GETLIST("PCREC", HOSTREC)WRITE HOSTREC ON FILE, ID

Related Subroutines

WIN.GETDATA, WIN.GETVAR, WIN.SETDATA, WIN.SETLIST, WIN.SETVAR, WIN.DBGET, WIN.DBSET,WIN.GETLISTL

WIN.GETLISTLSince PC items generally have lines that are separated by carriage returns, and values that areseparated by tabs, this subroutine is provided to convert these characters to field marks (CHAR 254)and value marks (CHAR 253). This subroutine gets the value or contents of a global or local variable.The variable can contain ASCII characters less than 32 and greater than 126, including tabs andcarriage returns.


144


This subroutine is available for UniData and UniVerse databases only because it uses functions specificto these platforms. It is usually faster than WIN.GETLIST and can be used as a replacement for it.The speed difference is only significant for large items that contain many attribute or subvalue marks.

Syntax

WIN.GETLISTL (VARNAME, VALUE)

Parameters

The following table describes the parameters of the WIN.GETLISTL command:



Examples

The following example gets the value of the PC item PCREC and converts it to the host item format.

CALL WIN.GETLISTL("PCREC", HOSTREC)WRITE HOSTREC ON FILE, ID

Related Subroutines

WIN.GETDATA, WIN.GETVAR, WIN.SETDATA, WIN.SETLIST, WIN.SETVAR, WIN.DBGET, WIN.DBSET,WIN.GETLIST

Version

6.3.5 Original

WIN.GETPARAMThis subroutine returns a wIntegrate menu option variable.

For a list of variables, see the information about menu options in the Client Scripting Reference.

Syntax

WIN.GETPARAM (NAME, VALUE)

Parameters

The following table describes the parameters of the WIN.GETPARAM command:


NAME The name of the parameter or variable to returnVALUE The value of the parameter that is specified in NAME

WIN.GETVAL

145

Examples

The following example looks for and returns the wIntegrate Title name.

VALUE = ""CALL WIN.GETPARAM("Title", VALUE)PRINT VALUE

Related Subroutines

WIN.SETPARAM


Get

WIN.GETVALThis subroutine retrieves a value sent to the host by the Host Send script command. A Host Sendcommand must be run before this subroutine is called.

Syntax

WIN.GETVAL (VAR)

Parameters

The following table describes the parameters of the WIN.GETVAL command:


VAR Name of the variable to put the retrieved value in

Examples

The following example gets the current application directory and version of wIntegrate.

CALL WIN.COMSUB("Host Send AppDir;Host Send Version")CALL WIN.GETVAL(WINTDIR)CALL WIN.GETVAL(WINTVER)

Version

4.0.1 Original

WIN.GETVARThis subroutine returns the contents of a global variable.

It is like WIN.GETDATA, but it can be used only if the variable has a simple value; this makes thetransfer faster. No characters with ASCII values less than 32 or more than 126. This means there can beno carriage returns, tabs, or 8-bit characters. This routine is similar to WIN.GETDATA, but runs fasterand sends less data along communication lines.


146

Syntax

WIN.GETVAR (VARNAME, VALUE)

Parameters

The following table describes the parameters of the WIN.GETVAR command:



Examples

The following example finds and prints the current value of UserName.

CALL WIN.GETVAR("UserName", VALUE)PRINT "The current UserName is ": VALUE

Related Subroutines

WIN.GETDATA, WIN.SETDATA, WIN.SETVAR, WIN.DBGET, WIN.DBSET, WIN.SETLIST

WIN.HGLASSThis subroutine switches on and off the hourglass cursor. Use this when you are running a process andwant to disable the cursor.

Syntax

WIN.HGLASS (MODE, FLAG)

Parameters

The following table describes the parameters of the WIN.HGLASS command:


MODE Specifies local or global mode for the hourglass display:

0 - Local mode; displays the hourglass only when the cursor is over thewIntegrate window

1 - Global mode; displays the hourglass anywhere on screenFLAG Switches the hourglass on and off:

0 - Hourglass off

1 - Hourglass on

Examples

The following example turns on the hourglass in local mode while running a select statement.

* The WIN.HGLASS subroutine with both parameters as zero turns off* the hourglass and enables the cursor.* Turn on the hourglass while running a select statement

WIN.HOSTVER

147

CALL WIN.HGLASS(0,1)EXECUTE "SSELECT COURSES"CALL WIN.HGLASS(0,0)

WIN.HOSTVERThis subroutine allows you to check the Host program’s version and machine type. EnterWIN.HOSTVER at the command prompt.

The version is read from the WIN.PROGS file, item HOSTVER. In versions 6.3.5 and later, youcan see the host version by running the Query Builder when it is shown on the host screen by theWIN.SERVER program.

Syntax

WIN.HOSTVER

Examples

The following example checks the host version.

:WIN.HOSTVERHost Programs: Version: 6.3.5 Machine Type: UV Parameter File: WIN.PROGS

WIN.HOTSPOTThis subroutine creates hot spots on the screen. The hot spot executes a defined command inresponse to a mouse click. Hot spots override but do not change any definition in Setup > Mouse. Iftwo hot spots occupy the same area, the most recent will take precedence.

Syntax

WIN.HOTSPOT (SPOTS)

Parameters

The following table describes the parameters of the WIN.HOTSPOT command:


SPOTS Defines the position and command for the hot spot; if SPOTS is null, hot spotsare removed.

Fields for SPOTS

The hot spots are defined as one hot spot per field with the following values:

Field Description

1.1 The hot spot upper left X-coordinate1.2 The hot spot upper left Y-coordinate1.3 The hot spot lower right X-coordinate


148

Field Description

1.4 The hot spot lower right Y-coordinate1.5 The hot spot command; default is to send down the field number of the hot

spot10 The value to return to the host on a single-click with Shift held down. If not

specified or "" the Shift click action is not used. When sent to the host, thisvalue is appended with a <CR>.

11 The value to return to the host on a single-click with Ctrl held down. If notspecified or "" the Ctrl click action is not used. When sent to the host, thisvalue is appended with a <CR>.

12 The value to return to the host on a single-click with Ctrl+Shift held down.If not specified or "" the Ctrl+Shift click action is not used. When sent to thehost, this value is appended with a <CR>.

Examples

The following example is taken from the WIN.HSDEMO demonstration program.

*AM=CHAR(254)VM=CHAR(253)R.SPOTS=''R.COLS=''* Set up array of areas for hot spotsR.SPOTS<-1>=0:VM:13:VM:79:VM:20;R.COLS<-1>="Blue"R.SPOTS<-1>=15:VM:15:VM:39:VM:16;R.COLS<-1>="LightRed"R.SPOTS<-1>=40:VM:15:VM:65:VM:16;R.COLS<-1>="Yellow"R.SPOTS<-1>=15:VM:17:VM:39:VM:18;R.COLS<-1>="LightCyan"R.SPOTS<-1>=40:VM:17:VM:65:VM:18;R.COLS<-1>="LightGreen"** Cover the remaining area so we can tell people what;'s going onR.SPOTS<-1>=0:VM:0:VM:79:VM:12:VM:"DESC"R.SPOTS<-1>=0:VM:21:VM:79:VM:23:VM:"PROMPT"R.SPOTS<-1>=58:VM:23:VM:78:VM:23:VM:"*"...* Define hotspotsCALL WIN.HOTSPOT(R.SPOTS)C22=@(0,22):@(-4)

WIN.HOTSPOT2This subroutine creates hot spots on the screen. The hot spot executes a defined command inresponse to a mouse click. Hot spots override but do not change any definition in Setup > Mouse. Iftwo hot spots occupy the same area, the most recent will take precedence.

Use this instead of the WIN.HOTSPOT routine if you want to specify a double-click response on thehot spot, or to set individual styles for each hot spot.

Syntax

WIN.HOTSPOT2 (SPOTS)

WIN.HSCRIPT

149

Parameters

The following table describes the parameters of the WIN.HOTSPOT2 command:


SPOTS Defines the position and command for the hot spot; if SPOTS is null, hot spotsare removed.

Fields for SPOTS

The following specifies the multivalues to set for each hot spot:

Field Description

1 The left column of the hot spot.2 The top row of the hot spot.3 The right column of the hot spot.4 The bottom row of the hot spot.5 The value to return to the host on a single-click. Use "" for the position of

the hot spot in the SPOTS dynamic array. When sent to the host, this value isappended with a <CR>.

6 The value to return from the host on a double-click. No value is sent if thisfield is not set.

7 The style of the hot spot:

0 - Hot spot is transparent. The default is 0.

1 - Hot spot is raised with a grey/white border.

2 - Hot spot is sunk with a grey/white border.

3 - Hot spot looks like a text box with a 2 pixel grey/white and black border.

4 - overrides the screen color. Use it by itself, or add it to other flag numbers.8 Foreground color (see WIN.COLOR, on page 21 for how to specify this).

Default is "Black".9 Background color (see WIN.COLOR, on page 21 for how to specify this).

Default is "White".

Version

4.1 Original

WIN.HSCRIPTThis subroutine allows you to define a script, then transfers it to the PC as a single script. Use thissubroutine when you want to run PC scripts from the host. This subroutine assumes the scriptscontain only ASCII characters 32 to 126.

If you include ASCII characters outside of these parameters, use the WIN.HSCRIPTC subroutine.

Syntax

WIN.HSCRIPT (SCRIPT)


150

Parameters

The following table describes the parameters of the WIN.HSCRIPT command:


SCRIPT The script or scripts to transfer to the PC

Examples

The following example sends a script to the PC to show a message. It brings up a message boxdepending whether the time is before or after noon.

* Create a message box dependent on time of daySCRIPT = ''SCRIPT<-1> = 'T = Oconv(Time(),"MT")'SCRIPT<-1> = 'If Field(T,":",1) > 12 Then'SCRIPT<-1> = ' MessageBox "Good Afternoon"'SCRIPT<-1> = 'Else'SCRIPT<-1> = ' MessageBox "Good Morning"'SCRIPT<-1> = 'EndIf'CALL WIN.HSCRIPT(SCRIPT)END

Related Subroutines

WIN.COMSUB, WIN.HSCRIPTC, WIN.FSCRIPT

WIN.HSCRIPTCThis subroutine allows you to define a script, then transfers the script to the PC as a single script. Usethis subroutine when you want to use PC scripts on the host.

This subroutine allows any ASCII character to be in the SCRIPT, and for this reason, runs more slowlythan WIN.HSCRIPT.

Syntax

WIN.HSCRIPTC (SCRIPT)

Parameters

The following table describes the parameters of the WIN.HSCRIPTC command:


SCRIPT The script or scripts to transfer to the PC

Examples

The following example sends a script to the PC and brings up a message box. It brings up a messagebox depending whether the time is before or after noon.

* Create a message box dependent on time of daySCRIPT = ''SCRIPT<-1> = 'T = Oconv(Time(),"MT")'SCRIPT<-1> = 'If Field(T,":",1) > 12 Then'SCRIPT<-1> = ' MessageBox "Good Afternoon"'

WIN.ILADD

151

SCRIPT<-1> = 'Else'SCRIPT<-1> = ' MessageBox "Good Morning"'SCRIPT<-1> = 'EndIf'CALL WIN.HSCRIPTC(SCRIPT)END

Related Subroutines

WIN.COMSUB, WIN.HSCRIPT, WIN.FSCRIPT

WIN.ILADDThis subroutine adds the image in the specified bitmap file to the named image list.

Syntax

WIN.ILADD (NAME, FILENAME, MASK, FLAGS, RESP)

Parameters

The following table describes the parameters of the WIN.ILADD command:


NAME Image list nameFILENAME File name of bitmap file to addMASK Color to use as mask (use "" for no mask)FLAGS Can be one of the following:

0x0001 - Load image as a monochrome image

0x0020 - Map first pixel to Window background

0x0040 - Use system default size

0x1000 - Map button edge colorsRESP Index number where the image was added to the image list, or -1 if

unsuccessful

Version


WIN.ILCOUNTThis subroutine returns the number of images within the named image list.

Syntax

WIN.ILCOUNT (NAME, RESP)

Parameters

The following table describes the parameters of the WIN.ILCOUNT command:


152


NAME Image list nameRESP Returned number of images in the image list

Version


WIN.ILDELETEThis subroutine deletes the image list.

Syntax

WIN.ILDELETE (NAME)

Parameters

The following table describes the parameters of the WIN.ILDELETE command:


NAME Image list name

Version


WIN.ILICONThis subroutine adds the image in the specified icon file to the named image list.

Syntax

WIN.ILICON (NAME, FILENAME, RESP)

Parameters

The following table describes the parameters of the WIN.ILICON command:


NAME Image list nameFILENAME File name of icon file to addRESP Index number where the image was added to the image list, or -1 if

unsuccessful

Version


WIN.ILINFO

153

WIN.ILINFOThis subroutine returns information on the pixel layout of an image within the image list.

Syntax

WIN.ILINFO (NAME, IMAGE.NO, PLANES, BPP)

Parameters

The following table describes the parameters of the WIN.ILINFO command:


NAME Image list nameIMAGE.NO The index of the image to return the values ofPLANES Returned number of planes in the imageBPP Returned number of bits per pixel in the image

Version


WIN.ILISIZEThis subroutine returns the width and depth of the images that are stored in the specified image list.

Syntax

WIN.ILISIZE (NAME, WIDTH, DEPTH)

Parameters

The following table describes the parameters of the WIN.ILISIZE command:


NAME Image list nameWIDTH Returned width of each imageDEPTH Returned depth of each image

Version


WIN.ILLOADThis subroutine loads an image list from a file. The file can contain multiple images.

Syntax

WIN.ILLOAD (NAME, FILENAME, OPTS, RESP)


154

Parameters

The following table describes the parameters of the WIN.ILLOAD command:


NAME Image list nameFILENAME File name of bitmap file to addOPTS Available options; see the following Opts tableRESP Set to 1 if load was successful, otherwise 0

Fields for OPTS

Field Description

1 Width of each image in the list; default is 02 Maximum number of images the list can contain; default is number that are

loaded3 Color for transparency mask; default is no mask4 Type of image file:

0 - bitmap (default)

1 - icon

2 - cursor5 Flags. Can be one of the following:

0x0001 - Load image as a monochrome image

0x0020 - Map first pixel to Window background

0x0040 - Use system default size

0x1000 - Map button edge colors

Version


WIN.ILNEWThis subroutine loads an image list from a file. The file can contain multiple images.

Syntax

WIN.ILNEW (NAME, WIDTH, DEPTH, OPTS, RESP)

Parameters

The following table describes the parameters of the WIN.ILNEW command:


NAME Image list nameWIDTH Width of each image in the listDEPTH Depth of the image listOPTS Available options; see the following Opts table

WIN.ILREMOVE

155


RESP Set to 1 if load was successful, otherwise 0

Fields for OPTS

Field Description

1 Color depth of the image mask in bits: 0 (default), 4, 8, 16, 24, 32 or 254 (aspecial value for Device Dependent Bitmap). The result of the default (0) valueis dependent on the display driver, which usually a color depth of 4 for newwindows display drivers, or a value of 254 (DDB) for older display drivers.

2 Color for transparency mask. Default is no mask.3 Initial size of image list. Default is 4.4 Maximum size of image list. Default is 0.

Version


WIN.ILREMOVEThis subroutine removes an image from an image list.

Syntax

WIN.ILREMOVE (NAME, INDEX)

Parameters

The following table describes the parameters of the WIN.ILREMOVE command:


NAME Image list nameINDEX Index of the image to remove

Version


WIN.IMAGEThis subroutine displays an image on the wIntegrate screen. You must specify the full path of the filename.

Syntax

WIN.IMAGE (FILENAME, LEFT, TOP, RIGHT, BOTTOM, CLIP)

Parameters

The following table describes the parameters of the WIN.IMAGE command:


156


FILENAME The name of the PC file where the image is storedLEFT Position of the left side of the imageTOP Position of the top of the imageRIGHT Position of the right side of the imageBOTTOM Position of the bottom of the imageCLIP Sets whether to clip or scale the image:

0 - scales the image

1 - clips the image

Examples

The following example is taken from the WIN.IMDEMO demonstration program.

*CALL WIN.IMAGE("IMAGE\COMPUTER.WMF", 40,5,70,17, 0)*PRINT @(0,18): "The image above was displayed by :-"PRINT ' CALL WIN.IMAGE("IMAGE\COMPUTER.WMF", 40,4,70,18,0)'END

Related Subroutines

WIN.IMOPEN, WIN.IMCLOSE, WIN.IMCHANGE


Draw Image, FileExist

WIN.IMCHANGEThis subroutine changes an image that was opened by WIN.IMOPEN. Specify the full path of thefile unless the file is stored in the wIntegrate directory. You must use WIN.IMCLOSE to close the PCimage file.

Syntax

WIN.IMCHANGE (IMAGE.NO, FILENAME)

Parameters

The following table describes the parameters of the WIN.IMCHANGE command:


IMAGE.NO The number of the image that is specified in WIN.IMOPENFILENAME The full path of the PC image file

Examples

The following example is a simple demonstration of the image window subroutines.

* This demonstrates how to open, change, and close image windows

WIN.IMCLOSE

157

PRINT "To display an image in a window, use WIN.IMOPEN"CALL WIN.IMOPEN(1,"image\normal.bmp",0,0,8,8)PRINT "Close the window, then press Enter to continue"INPUT DUM:* Change the imagePRINT "Then change the image with WIN.IMCHANGE"CALL WIN.IMCHANGE(1,"image\pressed.bmp")* Close the image filePRINT "Close the window, then press Enter to continue"INPUT DUM:PRINT "Then close the image file with WIN.IMCLOSE"CALL WIN.IMCLOSE(1)END

Related Subroutines

WIN.IMOPEN, WIN.IMCLOSE, WIN.IMAGE


DialogBox Graphic

WIN.IMCLOSEThis subroutine closes a PC image file that was opened with the WIN.IMOPEN subroutine.

Syntax

WIN.IMCLOSE (IMAGE.NO)

Parameters

The following table describes the parameters of the WIN.IMCLOSE command:


IMAGE.NO The number of the image that is specified in WIN.IMOPEN

Examples


* This demonstrates how to open, change, and close image windowsPRINT "To display an image in a window, use WIN.IMOPEN"CALL WIN.IMOPEN(1,"image\normal.bmp",0,0,8,8)PRINT "Close the window, then press Enter to continue"INPUT DUM:* Change the imagePRINT "Then change the image with WIN.IMCHANGE"CALL WIN.IMCHANGE(1,"image\pressed.bmp")* Close the image filePRINT "Close the window, then press Enter to continue"INPUT DUM:PRINT "Then close the image file with WIN.IMCLOSE"CALL WIN.IMCLOSE(1)END


158

Related Subroutines

WIN.IMOPEN, WIN.IMCHANGE, WIN.IMAGE


DialogBox Graphic

WIN.IMOPENThis subroutine opens a window to contain a PC image file on the wIntegrate screen. Specify the fullpath of the file unless the file is stored in the wIntegrate directory.

You must use WIN.IMCLOSE to close the PC image file. The window size and position are relative tothe size of the Windows system font being used.

Syntax

WIN.IMOPEN (IMAGE.NO, FILENAME, LEFT, TOP, RIGHT, BOTTOM)

Parameters

The following table describes the parameters of the WIN.IMOPEN command:


IMAGE.NO A number that you specify for this imageFILENAME The name of the PC file where the image is storedLEFT Position of the left side of the imageTOP Position of the top of the imageRIGHT Position of the right side of the imageBOTTOM Position of the bottom of the image

Examples


* This demonstrates how to open, change, and close image windowsPRINT "To display an image in a window, use WIN.IMOPEN"CALL WIN.IMOPEN(1,"image\normal.bmp",0,0,8,8)PRINT "Close the window, then press Enter to continue"INPUT DUM:* Change the imagePRINT "Then change the image with WIN.IMCHANGE"CALL WIN.IMCHANGE(1,"image\pressed.bmp")* Close the image filePRINT "Close the window, then press Enter to continue"INPUT DUM:PRINT "Then close the image file with WIN.IMCLOSE"CALL WIN.IMCLOSE(1)END

Related Subroutines

WIN.IMCHANGE, WIN.IMCLOSE, WIN.IMAGE

WIN.IMPORT

159


DialogBox Graphic

WIN.IMPORTThis subroutine imports data from the host computer to a PC file. It calls the RunImportFile menucommand, so to understand this subroutine, you can look at the Run > Import File menu option.


Syntax

WIN.IMPORT (PCFILE, FILE, ITEMS, FIELDS, OPTS, STATUS)

Parameters

The following table describes the parameters of the WIN.IMPORT command:


PCFILE The full path name of the PC file where the data will be savedFILE The name of the host file to exportITEMS The items or records in the host file to exportFIELDS The fields or attributes of the records to exportOPTS Available options; see the following Opts tableSTATUS The returned status; "OK", "Cancel", or "Error"

Fields for OPTS

Field Description

1 Format. A file format for the DOS file. Valid formats are ASC, CSV, CQV, XLS,XLSX, FIX, WK1, MRG, RAW, TSV, HEX, XML, and HTML.

The default is the extension in the FILE parameter.2 Overwrite. Specifies options of overwriting an existing file:

"Yes" (default)

"No"

"Combine" – not supported on all formats3 Mode. Mode for import:

"Normal"

"Capture"

"Reformat"4 Suppress ID. Suppress the item ID from the import:

0 - Do not suppress ID

1 - Suppress ID5 Field descriptions. Import field descriptions as first record of import.


160

Field Description

6 Translate. This option is available to change characters as they are exported,according to the Translation:

"None"

"ASCII" (default)

"All"7 Translation. The default is "\255,\r\n\f\r\n,\254,\r\n". If you want to use a

format other than ASCII, you must go into the Export dialog box and deletethe Translation definition.

8 AutoExit. Exits the Export monitor at the end of the transfer. The default is"True".

9 Inform. Notify the user when export is finished. The default is "False".10 Timeout. The maximum number of seconds to wait for a response from the

host. The default is "5".11 Retries. The maximum number of retries. The default is "3".13 Numeric conversion. Multivalued field with the following values:13.1 Number conversion on 1; 0 for off13.2 Separator character13.3 Currency symbol13.4 Decimal symbol14 Multivalue options. Multivalued field with the followings values:14.1 Explode multivalues: 1 for on; 0 for off14,2 Repeat multivalues: 1 for on; 0 for off15 Dictionary options. Multivalued field with the followings values:15.1 Use formatting information15.2 Left-justified fields are text15.3 Right-justified fields are numeric

Examples

The following example imports the item IMPORT.TEXT from WIN.PROGS to the PC file C:\imptext.txt.

CALL WIN.IMPORT("c:\imptext.txt", "WIN.PROGS", "IMPORT.TEXT", "", "", STATUS)

The next example imports a spreadsheet to Excel with no item IDs and notifies the user when it isdone.

OPTS = ""OPTS<3> = "Capture"OPTS<4> = " True"OPTS<9> = "True"CALL WIN.IMPORT("c:\excel\orders.xls", "ORDER", "SSELECT ORDER BY CUST.NAME","CUST.NAME QUANTITY VALUE", OPTS, STATUS)

Related Subroutines

WIN.EXPORT

WIN.INFOBOX

161


Dialog RunImportFile

Version

4.1 New options OPTS<15>

WIN.INFOBOXThis subroutine displays text in an information box. This box always has a header of "HostInformation". If the info box is displayed, and you call WIN.INOFOBOX again and change the text, theexisting box displays the new text. To close the info box, call WIN.INFOBOX and list the text as null.

This subroutine truncates the text to 150 characters, use WIN.INFOBOX2 to show longer text.

Syntax

WIN.INFOBOX (TEXT, FLAGS)

Parameters

The following table describes the parameters of the WIN.INFOBOX command:


TEXT The text to display in the info boxFLAGS The position of the box on the screen:

T - Top

B - Bottom

C - Center

Examples

The following example displays an info box while running report.

CALL WIN.INFOBOX("Selecting data for the Student report","C")EXECUTE "LIST STUDENT FNAME MAJOR BY MAJOR"CALL WIN.INFOBOX("","")RETURNEND

Related Subroutines

WIN.INFOBOX2


Infobox

WIN.INFOBOX2This subroutine displays text in an information box. This box always has a header of "HostInformation". If the info box is displayed and you call WIN.INOFOBOX2 again and change the text,


162

the existing box displays the new text. To close the info box, call WIN.INFOBOX2 and list the text asnull.

Unlike WIN.INFOBOX, this subroutine does not truncate the text to 150 characters.

Syntax

WIN.INFOBOX2 (TEXT, FLAGS)

Parameters

The following table describes the parameters of the WIN.INFOBOX2 command:


TEXT The text to display in the info boxFLAGS The position of the box on the screen:

T - Top

B - Bottom

C - Center

Examples

The following example displays an info box while running report.

CALL WIN.INFOBOX2("Selecting data for the Student report","C")EXECUTE "LIST STUDENT FNAME MAJOR BY MAJOR"CALL WIN.INFOBOX2("","")RETURNEND

Related Subroutines

WIN.INFOBOX


Infobox

Version


WIN.INPBOXThis subroutine displays a dialog box and waits for a response.

Syntax

WIN.INPBOX (TEXT, TITLE, LEN, RESP)

Parameters

The following table describes the parameters of the WIN.INPBOX command:

WIN.INVOKE

163


TEXT The text that appears in the dialog boxTITLE The caption for the dialog boxLEN The length of the input boxRESP The response to wait for

Examples

The following example prompts the user for a response.

RESP=""CALL WIN.INPBOX("Enter your login name","Login",10,RESP)PRINT "Hello ":RESP, "welcome to UniData"END

WIN.INVOKEThis subroutine invokes a wIntegrate menu command.

For a full list of menu commands, see the information about menu options in the Client ScriptingReference.

Syntax

WIN.INVOKE (MENU.DLG)

Parameters

The following table describes the parameters of the WIN.INVOKE command:


MENU.DLG The menu command to run. You can also use abbreviations for thecommands.

Examples

The following example copies data to the clipboard using Edit > Copy special.

CALL WIN.INVOKE("EditCopySpecial")

Related Subroutines

WIN.SHOW


Invoke

WIN.LIThis subroutine calls the Edit Input routine. It edits an area of the screen from the current cursorposition to the position specified in LEN, and returns the result.


164

You can use this subroutine to edit host data, just as you can with the WIN.EI subroutine, but thisroutine requires fewer parameters.

Syntax

WIN.LI (VALUE, LEN, ESC)

Parameters

The following table describes the parameters of the WIN.LI command:


VALUE The text returnedLEN The length of the edit areaESC Returns 0 if Esc is not pressed; 1 if Esc is pressed

Related Subroutines

WIN.EI


EditInput, Cursor

WIN.LICINFOThis subroutine returns the license information for this copy of wIntegrate.

Syntax

WIN.LICINFO (INFO)

Parameters

The following table describes the parameters of the WIN.LICINFO command:


INFO Variable to set with a dynamic array of the license information

Fields returned in INFO:

Field Description

1 Registered to name2 Organization3 Serial Number4 Maximum number of users

Version

4.2.1 Original

WIN.LOOKUP

165

WIN.LOOKUPThis subroutine displays a dialog box from which the user can make a selection. The R.TABLEparameter details how the dialog box looks, and R.LIST is the list of options to choose from.

Syntax

WIN.LOOKUP (R.TABLE, R.LIST, REF)

Parameters

The following table describes the parameters of the WIN.LOOKUP command:


R.TABLE Specifies how the dialog box looks, such as caption, column and width, andso on; see the following table

R.LIST List of options that are listed in the dialogREF The first multivalue of the line or field from R.LIST

Fields for R.TABLE

Field Description

1 The caption for the dialog box2 Column headings within the dialog box3 Column sizes in the dialog box4 Number of lines to show in the list box5 The start position to display the dialog or null ("")6 Parent dialog for lookup box7 Displays the hourglass cursor while building the lookup dialog box8 Map character depending on emulation if set to 1

Examples

The following example is part of the WIN.LUDEMO demonstration program.

* Set up lookup detailsR.TABLE = "Choose a fruit" ;* Lookup titleR.TABLE<2,1> = "Code"; R.TABLE<3,1> = 5 ;* Column titles and sizesR.TABLE<2,2> = "Fruit"; R.TABLE<3,2> = 12R.TABLE<4> = 5 ;* Number of lines to showR.TABLE<5,1> = 50; R.TABLE<5,2> = 8 ;* Start position of dialog** Set up dataR.LIST = ''R.LIST<1,1> = 'AP'; R.LIST<1,2> = 'Apple'R.LIST<2,1> = 'BN'; R.LIST<2,2> = 'Banana'R.LIST<3,1> = 'KW'; R.LIST<3,2> = 'Kiwi'R.LIST<4,1> = 'OR'; R.LIST<4,2> = 'Orange'R.LIST<5,1> = 'PR'; R.LIST<5,2> = 'Pear'*REF = ''CALL WIN.LOOKUP(R.TABLE, R.LIST, REF)


166

Related Subroutines

WIN.LOOKUPM


DialogBox commands

WIN.LOOKUPMThis subroutine displays a dialog box from which the user can make one or more selections. TheR.TABLE parameter details how the dialog box looks, and R.LIST is the list of options to choose from.

Syntax

WIN.LOOKUPM (R.TABLE, R.LIST, REF)

Parameters

The following table describes the parameters of the WIN.LOOKUPM command:


R.TABLE Specifies how the dialog box looks, such as caption, column and width, andso on; see the following table

R.LIST List of options that are listed in the dialogREF The first multivalue of the line or field from R.LIST

Fields for R.TABLE

Field Description

1 The caption for the dialog box2 Column headings within the dialog box3 Column sizes in the dialog box4 Number of lines to show in the list box5 The start position to display the dialog or null ("")6 Parent dialog for lookup box7 Displays the hourglass cursor while building the lookup dialog box8 Map character depending on emulation if set to 1

Examples

The following example shows a list of fruit to choose items from.

* Set up lookup detailsR.TABLE = "Choose one or more fruits" ;* Lookup titleR.TABLE<2,1> = "Code"; R.TABLE<3,1> = 5 ;* Column titles and sizesR.TABLE<2,2> = "Fruit"; R.TABLE<3,2> = 12R.TABLE<4> = 5 ;* Number of lines to showR.TABLE<5,1> = 50; R.TABLE<5,2> = 8 ;* Start position of dialog** Set up dataR.LIST = ''R.LIST<1,1> = 'AP'; R.LIST<1,2> = 'Apple'

WIN.MENUATT

167

R.LIST<2,1> = 'BN'; R.LIST<2,2> = 'Banana'R.LIST<3,1> = 'KW'; R.LIST<3,2> = 'Kiwi'R.LIST<4,1> = 'OR'; R.LIST<4,2> = 'Orange'R.LIST<5,1> = 'PR'; R.LIST<5,2> = 'Pear'*REF = ''CALL WIN.LOOKUPM(R.TABLE, R.LIST, REF)

Related Subroutines

WIN.LOOKUP


DialogBox commands

Version


WIN.MENUATTThis subroutine attaches a submenu to an existing menu.

Use this when you need to attach a menu to a menu bar as a submenu. You might want to createsubmenus at the same time you create the menu bar because the menu tree is created withWIN.MENULOAD. Any attached menu is activated by the WIN.MENUIN subroutine.

Syntax

WIN.MENUATT (MENU, SUBMENU, TITLE, POS)

Parameters

The following table describes the parameters of the WIN.MENUATT command:


MENU Specifies the menu that the submenu will be on; default is the "MainMenu"SUBMENU The name of the submenu to attachTITLE The text on the main menu that the submenu will be onPOS The position on the main menu where the submenu will be attached

Examples

The following example is part of the WIN.MENUDEMO demonstration program.

* Attaching/Detaching in action1900 IF MENU.SHOW = 1 THENCALL WIN.MENUATT('', "Demo","&Demo","Help")CALL WIN.MSTATE("Demo",9,1,1)MENU.SHOW = 2PRINT C23:"Select menu option from the Demo menu on the main menu bar":END ELSECALL WIN.MENUDET('', "Demo")CALL WIN.MSTATE("Demo",9,0,1)MENU.SHOW= 1


168

PRINT C23:"Select the menu option from the Popup menu":ENDRETURN

Related Subroutines

WIN.MENUDEL, WIN.MENUDET, WIN.MENUIN, WIN.MENULOAD


Menu Attach, Menu Enable

WIN.MENUDELThis subroutine deletes a menu from the computer's memory. Use this when you no longer need toshow a menu.

If you want to delete a submenu and not the main menu, you must use WIN.MENUDET to detach it.

For the demonstration program WIN.MENUDEMO, a new submenu is attached to the main wIntegratemenu, then deleted using WIN.MENUDEL.

Syntax

WIN.MENUDEL (NAME)

Parameters

The following table describes the parameters of the WIN.MENUDEL command:


NAME The name of the menu to delete

Examples


*IF MENU.SHOW = 2 THEN CALL WIN.MENUDET('',"Demo")CALL WIN.MENUDEL("Demo")CALL WIN.MENUDEL("DemoSub")*PRINT C23:PRINT C22:"End of Demonstration, Press <CR> to continue":INPUT DUM:*STOP

Related Subroutines

WIN.MENUATT, WIN.MENUDET, WIN.MENUIN, WIN.MENULOAD


Menu Delete

WIN.MENUDET

169

WIN.MENUDETThis subroutine detaches a submenu from a menu.

Syntax

WIN.MENUDET (MENU, SUBMENU)

Parameters

The following table describes the parameters of the WIN.MENUDET command:


MENU The name of the menu from which to detach the submenu; default is the"MainMenu"

SUBMENU The name of the submenu to detach

Examples


* Attaching/Detaching in action1900 IF MENU.SHOW = 1 THEN CALL WIN.MENUATT('', "Demo","&Demo","Help") CALL WIN.MSTATE("Demo",9,1,1) MENU.SHOW = 2 PRINT C23:"Select menu option from the Demo menu on the main menu bar":END ELSE CALL WIN.MENUDET('', "Demo") CALL WIN.MSTATE("Demo",9,0,1) MENU.SHOW= 1 PRINT C23:"Select the menu option from the Popup menu":ENDRETURN*

Related Subroutines

WIN.MENUATT, WIN.MENUDEL, WIN.MENUIN, WIN.MENULOAD


Menu Detach, IsOnMenu

WIN.MENUINThis subroutine enables a submenu, then waits for input. When it receives input, it is disabled.

Syntax

WIN.MENUIN (MENU, SUBMENU, RMENU, OPT)

Parameters

The following table describes the parameters of the WIN.MENUIN command:


170


MENU The name of the main menu the submenu is attached to; default is the"MainMenu"

SUBMENU The name of the submenu to enableRMENU Returns the name that the menu was given when it was createdOPT Returns the option number of the menu item, counting the top

Examples


*IF MENU.SHOW = 1 THEN CALL WIN.POPUPIN("Demo",45,10,MENU,OPT)END ELSE CALL WIN.MENUIN("", "Demo", MENU, OPT)END*PRINT @(0,18):@(-4):"Response, Menu = '":MENU:"', Option = '":OPT:"'": * BEGIN CASE CASE MENU = '' IF OPT = 'ESC' THEN PRINT CMSG:'This means no option has been selected from the menu': END ELSE PRINT CMSG:'This is keyboard input of ':OPT: CASE MENU = "Demo" PRINT CMSG:"This means the top level menu ":MENU:", had option ":OPT:' selected':

Related Subroutines

WIN.MENUATT, WIN.MENUDEL, WIN.MENUDET, WIN.MENULOAD

WIN.MENULDFThis subroutine loads a menu to the PC before it is attached or shown on the main menu bar. DEF is arecord that contains one field for each menu option. Each field consist of up to four multivalues (DEF).

This is a faster version of the WIN.MENULOAD routine, but relies on an 8-bit communication line andcan have problems if control characters (characters with an ASCII code less than 32) are included inthe dialog definition.

Syntax

WIN.MENULDF (NAME, DEF)

Parameters

The following table describes the parameters of the WIN.MENULDF command:


NAME The name of the menu to loadDEF The menu definition; see the following Def table

WIN.MENULOAD

171

Fields for DEF

Field Description

1 This is the text for the menu. Use dash (-) as a horizontal separator. Use (>) tolead to a submenu defined in DEF Value 2. See the example in this section.

2 Text to send to the host when a menu option is selected. This refers to asubmenu if the text starts with (>). A null value ("") defines it for use withWIN.MENUIN and WIN.POPUPIN.

3 This is text to display as “help” in the status bar when an option ishighlighted. This text can be only one line.

4 Optional file name of image to place against this menu item. The image mustbe a 16 pixel wide by 16 pixel high Windows bitmap file. If the full path of theimage is not given, it is assumed to be relative to the application directory.

Related Subroutines

WIN.MENUATT, WIN.MENUDEL, WIN.MENUDET, WIN.MENUIN, WIN.MSTATE, WIN.MENULOAD

Version


WIN.MENULOADThis subroutine loads a menu to the PC before it is attached or shown on the main menu bar. DEF is arecord that contains one field for each menu option. Each field consist of up to four multivalues (DEF).

In most cases, it will be faster to use the WIN.MENULDF host routine instead of this routine.

Syntax

WIN.MENULOAD (NAME, DEF)

Parameters

The following table describes the parameters of the WIN.MENULOAD command:


NAME The name of the menu to loadDEF The menu definition; see the following Def table

Fields for DEF

Field Description

1 This is the text for the menu. Use dash (-) as a horizontal separator. Use (>) tolead to a submenu defined in DEF Value 2. See the example in this section.

2 Text to send to the host when a menu option is selected. This refers to asubmenu if the text starts with (>). A null value ("") defines it for use withWIN.MENUIN and WIN.POPUPIN.

3 This is text to display as “help” in the status bar when an option ishighlighted. This text can be only one line.


172

Field Description

4 Optional file name of image to place against this menu item. The image mustbe a 16 pixel wide by 16 pixel high Windows bitmap file. If the full path of theimage is not given, it is assumed to be relative to the application directory.

Examples


* First define submenuSUBDEF = ''SUBDEF<1>="&Creating"SUBDEF<2>="&Attaching"SUBDEF<3>="&Displaying"CALL WIN.MENULOAD("DemoSub",SUBDEF)** Define Main menuDEF = ''DEF<-1>='&Format of DEF':VM:VM:"Description of DEF argument"DEF<-1>='&DEF used for this menu':VM:VM:"Definition used for this menu"DEF<-1>='&Popup arguments':VM:VM:"Arguments to WIN.POPUPIN"DEF<-1>='>&Submenus':VM:"DemoSub"DEF<-1>='Se&parators'DEF<-1>='Setting menu &item state'DEF<-1>='-'DEF<-1>='Attaching to &MainMenu':VM:VM:"Details on attaching to main menu"DEF<-1>='&Attached to Main':VM:VM:"Attach/Unattach from main menu"DEF<-1>='-'DEF<-1>='E&xit Demo':VM:VM:"FIN the menu demonstration"NO.OPTS = DCOUNT(DEF,AM)*PRINT C22:"Press <CR> to continue with demonstration":INPUT DUM: PRINT C22:*CALL WIN.MENULOAD("Demo",DEF)

Related Subroutines

WIN.MENUATT, WIN.MENUDEL, WIN.MENUDET, WIN.MENUIN, WIN.MSTATE, WIN.MENULDF

Version

6.0.3 Added item images

WIN.MLADDRThis subroutine displays a mail system dialog box, allowing the user to address a message by selectingaddress book addresses.

If any of the variables MAIL.TO, MAIL.CC, or MAIL.BCC contain names when this command is called,those names will appear pre-selected in the dialog box. Specified recipient names can be fullnames, partially unresolved names, or full email addresses, for example, “Mary Doe”, “Mary”, and“[email protected]”. Specified multiple recipients can be separated with a semi-colon, fieldmark (CHAR(254)), or value mark (CHAR(253)).

WIN.MLAVAIL

173

If, for any reason, the addressing was unsuccessful, the contents of the variables MAIL.TO, MAIL.CC, orMAIL.BCC will be unchanged.

Syntax

WIN.MLADDR (MAIL.TO, MAIL.CC, MAIL.BCC, OPTS, DELIM)

Parameters

The following table describes the parameters of the WIN.MLADDR command:


MAIL.TO Name of the variable that receives the names of the primary recipientsMAIL.CC Name of the variable that receives the names of the copy recipientsMAIL.BCC Name of the variable that receives the names of the blind copy recipientsOPTS Available options; see the following Opts tableDELIM Delimiter to separate the returned names:

0 - semi-colon (";")

1 - field mark (CHAR(254))

2 - value mark (CHAR(253))

Values for OPTS

Value Description

4 Disable mail user interaction

Examples

The following example allows a user to select other recipients before sending message.

SEND.TO = "Demi"SEND.TO<-1> = "Jodie"SEND.CC=""SEND.BCC=""CALL WIN.MLADDR(SEND.TO, SEND.CC, SEND.BCC, 0, 1)PRINT "You want to send to ":DCOUNT(SEND.TO, CHAR(254)):" people"

Version

4.0.1 Original

WIN.MLAVAILThis subroutine checks if the mail system and a default user profile are available. It is a convenientway of checking that the mail system is available before using any of the other mail commands orfunctions.

Syntax

WIN.MLAVAIL (RESP)


174

Parameters

The following table describes the parameters of the WIN.MLAVAIL command:


RESP "" if the mail system is available, otherwise error text with the reason forfailure

Examples

The following example is a simple program to check whether email is available.

RESP = ""CALL WIN.MLAVAIL(RESP)IF RESP = "" THEN PRINT "Email is available on this machine"END ELSE PRINT "Email is NOT available on this machine" PRINT RESPEND

Version

4.2.1 Original

WIN.MLDELETEThis subroutine deletes a mail message.

Syntax

WIN.MLDELETE (ID, OPTS)

Parameters

The following table describes the parameters of the WIN.MLDELETE command:


ID ID of the message to delete; retrieved using the WIN.MLNEXT orWIN.MLFIND functions


Values for OPTS

Value Description

0 (default)4 Disable Mail user interaction

Examples

The following example deletes all messages from Sabrina.

IDS = ""CALL WIN.MLFIND("Sabrina", 16, IDS)

WIN.MLFIND

175

IF IDS # "" ThenCNT = COUNT(IDS, CHAR(254))+1FOR J = 1 TO CNTCALL WIN.MLDELETE(IDS<J>, 0)NEXT JEND

Version

4.0.1 Original

WIN.MLFINDThis subroutine finds all available mail messages matching specified criteria.

Once the messages have been found, they can be read or deleted, using WIN.MLREAD orWIN.MLDELETE, respectively.

The original order option returns messages in the order they are stored in the mail system. This can bein chronological order (which is used by default). The reason for this option is that some mail systemsmight not support chronological order, in which case this function will fail with an error.

Note that if, for example, the Match Sender and Match Subject options are selected, the function willreturn the ID of the first message that contains the specified pattern in either the sender or the subject.

Syntax

WIN.MLFIND (PATTERN, OPTS, IDS)

Parameters

The following table describes the parameters of the WIN.MLFIND command:


PATTERN The text to search for in a message. The text will be searched for in thelocation specified in the OPTS parameter. If PATTERN is not supplied (or nosearch location is specified in the OPTS parameter), the function returns thenext message meeting the search criteria specified in the OPTS parameterbut without performing any pattern matching. Pattern matching is not case-sensitive.

OPTS Available options; see the following Opts tableIDS Variable to return the list of IDs in; field mark (CHAR(254)) separated.

Values for OPTS

Value Description

0 Search all messages (default)1 Search unread messages only2 Original order4 Disable Mail user interaction8 Reverse order of results16 Match sender32 Match subject


176

Value Description

64 Match attachment128 Match time

Examples

The following example counts the number of unread messages on the subject of Dilbert.

IDS=""CALL WIN.MLFIND("Dilbert", 33, IDS)PRINT DCOUNT(IDS, CHAR(254))

The following example lists the titles of all unread messages.

IDS = ""CALL WIN.MLFIND("",1,IDS)IF IDS # "" THEN CNT = COUNT(Ids, CHAR(254)) + 1 MSG.HDR = "" TEXT = "" ATTS = "" STATE= "" SUBJECTS = "" FOR J = 1 TO CNT CALL WIN.MLREAD(IDS<J>, MSG.HDR,TEXT,ATTS,STATE,0) PRINT MSG.HDR<4> NEXT JELSE PRINT "No unread messages"END

Version

4.0.1 Original

WIN.MLLOOKUPThis subroutine returns details about a mail recipient given a full or partial name.

NAME can contain a full name or a partially unresolved name, for example, "Mary Doe", or "Mary".Multiple recipients cannot be specified.

If, for any reason, details cannot be ascertained, the returned NAME and ADDRESS variables will beempty.

If there is ambiguity over the partially resolved name that is specified, the mail system might display adialog box allowing the user to select one of several possible full names.

Syntax

WIN.MLLOOKUP (NAME, ADDRESS, OPTS)

Parameters

The following table describes the parameters of the WIN.MLLOOKUP command:

WIN.MLLOOKUP

177


NAME Name of the variable that contains the full or partial name to look up. Onreturn, it will receive the full name of the recipient. If the NAME variable isempty, the mail address book is displayed.

ADDRESS Name of the variable that will receive the address of the recipient.OPTS Available options; see the following Opts table

Values for OPTS

The options can be combined by addition.

Value Description

0 (default)1 Display full details4 Disable Mail user interaction

Examples

The following example displays Sheila's full name and address.

NAME = "Sheila"ADDRESS = ""CALL WIN.MLLOOKUP(NAME,ADDRESS,0)PRINT NAMEPRINT ADDRESS

The following example displays the address book.

NAME = ""ADDRESS = ""CALL WIN.MLLOOKUP(NAME, ADDRESS,0)

The following examples displays Sandra's full details.

NAME = "Sandra"ADDRESS = ""CALL WIN.MLLOOKUP(NAME, ADDRESS, 1)

The following example checks Sally's name before sending a message.

NAME = "Sally"ADDR = ""CALL WIN.MLLOOKUP(NAME,ADDR,0)IF NAME # "" THEN CALL WIN.MLSEND(NAME, "", "", "Greetings!", "How about a drink after work?", "", 0, RESP)END

Version

4.0.1 Original


178

WIN.MLNEXTThis subroutine finds the next available mail message matching specified criteria. It is intended to beused iteratively so that all mail messages can be enumerated.

Once the messages have been found, they can be read or deleted, using WIN.MLREAD orWIN.MLDELETE, respectively.

The original order option returns messages in the order they are stored in the mail system. This can bein chronological order (which is used by default). The reason for this option is that some mail systemsmight not support chronological order, in which case this function will fail with an error.

Note that if, for example, the Match Sender and Match Subject options are selected, the function willreturn the ID of the first message that contains the specified pattern in either the sender or the subject.

Syntax

WIN.MLNEXT (ID, Pattern, OPTS)

Parameters

The following table describes the parameters of the WIN.MLNEXT command:


ID The ID of the message to start searching from. If it is not set, then the firstmessage matching the criteria specified by the OPTS parameter is read. Onreturn, ID will contain the ID of the message found. If it is not set on return,there are no more matching messages. Message IDs are in an internal mailformat and not intended for user display.

PATTERN The text to search for in a message. The text will be searched for in thelocation specified in the OPTS parameter. If PATTERN is not supplied (or nosearch location is specified in the OPTS parameter), the function returns thenext message meeting the search criteria specified in the OPTS parameterbut without performing any pattern matching. Pattern matching is not case-sensitive.


Values for OPTS

Value Description

0 Search all messages (default)1 Search unread messages only2 Original order4 Disable Mail user interaction16 Match sender32 Match subject64 Match attachment128 Match time

WIN.MLREAD

179

Examples

The following example searches for and displays the first unread message from Pamela.

ID = ""CALL WIN.MLNEXT(ID, "Pam", 17)IF ID # "" THEN CALL WIN.MLREAD(ID, MSG.HDR, TEXT, ATTACHMENTS, STATE, 0) PRINT MSG.HDR<4> PRINT FOR J = 1 TO DCOUNT(TEXT, CHAR(254)) PRINT TEXT<J> NEXTEND

The following example deletes the fourth message of June 22nd.

ID = ""J = 1LOOPCALL WIN.MLFIND(ID, "/06/22", 128)WHILE J < 4 AND ID # "" DOJ = J + 1REPEATIF ID # "" THEN CALL WIN.MLDELETE(ID)END

Version

4.0.1 Original

WIN.MLREADThis subroutine reads a mail message.

Syntax

WIN.MLREAD (ID, MSG.HDR, TEXT, ATTACHMENTS, STATE, OPTS)

Parameters

The following table describes the parameters of the WIN.MLREAD command:


ID The ID of the message to read. This ID is retrieved from the WIN.MLNEXT orWIN.MLFIND functions.

MSG.HDR The name of the variable that receives a dynamic array of the messageheader. See the following MSG.HDR table.

TEXT The name of the variable that receives the actual message text. CRs areconverted to field marks (CHAR(254)) and tabs to value marks (CHAR(253)).

ATTACHMENTS The name of the variable that receives the full path names of attachment files.STATE The name of the variable that receives the message state. See the following

State table.


180



Fields for MSG.HDR

Field Description

1 From2 To3 CC4 Subject5 Date/Time

Values for STATE

Value Description

0 Read1 Unread2 File(s) attached

Values for OPTS

Value Description

0 (default)1 Do not mark as read2 Make message text first attachment4 Disable Mail user interaction

Examples

The following example displays subject and text from the first unread message.

ID = ""CALL WIN.MLFIND(ID, "", 1)IF ID # "" THEN CALL WIN.MLREAD(ID, HDR, TEXT, ATTACHMENTS, STATE, 0) PRINT HDR<4> PRINT FOR J = 1 TO DCOUNT(TEXT, CHAR(254)) PRINT TEXT<J> NEXT JEND

The following example displays the attachment file from a specific message.

CALL WIN.MLFIND(ID, "Map of Treasure", 32)IF ID # "" THEN CALL WIN.MLREAD(ID, HDR, TEXT, ATTACHMENT, STATE, 0) CALL WIN.COMSUB("Run '":ATTACHMENT:"'") * We really ought to delete the file after viewing itEND ELSE PRINT "Sorry, no treasure!"

WIN.MLSEND

181

END

Version

4.0.1 Original

WIN.MLSENDThis subroutine sends a mail message.

Recipient names can be full names, partially unresolved names, or full email addresses, for example,"Mary Doe", "Mary", or "[email protected]". Multiple recipients can be specified by separatingthem with a semi-colon, field mark (CHAR(254)), or value mark (CHAR(253)).

Text can be split into multiple lines by either a field mark (CHAR(254)) or a value mark (CHAR(253)).

Multiple attachment files can be specified by separating them with a semi-colon, field mark(CHAR(254)), or value mark (CHAR(253)).

Syntax

WIN.MLSEND (MAIL.TO, MAIL.CC, MAIL.BCC, SUBJECT, TEXT, ATTACHMENTS,OPTS, RESP)

Parameters

The following table describes the parameters of the WIN.MLSEND command:


MAIL.TO Name of the variable that receives the names of the primary recipientsMAIL.CC Name of the variable that receives the names of the copy recipientsMAIL.BCC Name of the variable that receives the names of the blind copy recipientsSUBJECT Title or subject of the messageTEXT Actual message textATTACHMENTS Full path names of any attachment filesOPTS Available options; see the following Opts tableRESP If an error occurs, this parameter will contain text describing what went

wrong. There will be no indication of error if this parameter is not used.

Values for OPTS

Value Description

0 (default)1 Review message before sending. The email is displayed by the email client

application, and the user can view it before clicking the Send button.4 Disable mail system user interaction. If the email client application is not

logged on to the email server, setting this option will prevent the login dialogfrom appearing and the email will not be sent. Note that this option might notsuppress security warnings from the mail client that another application istrying to send an email. This option overrides option 1.


182

Examples

The following example ask employees to attend a meeting.

RESP=""CALL WIN.MLSEND("Bill;Ben", "", "", "Meeting at 10:30 today in my Office", "Attend or else!", "", 0, RESP)

The following example asks managers to attend a meeting.

SEND.TO = "Algernon"SEND.TO<-1> = "Emily"SEND.TO<-1> = "Nigel"SEND.CC = "Caterers"SUBJECT = "Meeting at 12:00 today at the Swimming Pool Bar"AM = CHAR(254)TEXT = "Dear Friends" : AM : AMTEXT = TEXT : "Would you mind attending this meeting?" : AMTEXT = TEXT : "Thank you so much." : AM : AMTEXT = TEXT : "Your friend, Uriah."RESP = ""CALL WIN.MLSEND(SEND.TO, SEND.CC, "", SUBJECT, TEXT, "c:\Temp\Country Club Map.gif", 1, RESP)IF RESP # "" THEN PRINT RESPEND


Mail Send

Version


WIN.MOUSEThis subroutine programs mouse buttons.

Syntax

WIN.MOUSE (KEYS, DEFS)

Parameters

The following table describes the parameters of the WIN.MOUSE command:


KEYS Mouse buttons to define. A multi-field dynamic array that is matched toDEFS. The definitions can contain mouse button numbers or names. See thefollowing Keys table for the mouse numbers/names.

DEFS Definitions for mouse buttons.

Values for KEYS

Use the following numbers or names for the mouse buttons:

WIN.MOUSEDEF

183

Value Description

1 Left-click mouse2 Right-click mouse3 Both buttons mouse clicks4 Shift + Left-click mouse5 Shift + Right-click mouse6 Shift + Both buttons mouse clicks7 Ctrl + Left-click mouse8 Ctrl + Right-click mouse9 Ctrl + Both buttons mouse clicks10 Ctrl + Shift + Left-click mouse11 Ctrl + Shift + Right-click mouse12 Ctrl + Shift + Both buttons mouse clicks

Examples

The following example programs MouseLeft, MouseRight, and MouseBoth.

KEYS ='';DEFS = ''KEYS<1> = 1;DEFS<1> = 'Left Mouse button clicked'KEYS<2> = 2;DEFS<2> = 'Right Mouse button clicked'KEYS<3> = 3;DEFS<3> = 'Both mouse buttons clicked'CALL WIN.MOUSE(KEYS,DEFS)

The following example assigns the popup copymenu to the right mouse button.

The copymenu script is in the application directory, otherwise the full path must be specified.* Assign copymenu to right mouse buttonCALL WIN.MOUSE("MouseRight", "\mScript 'example\script\copymenu'")

Related Subroutines

WIN.MOUSEDEF, WIN.MOUSEIN


Set MouseLeft, Set MouseRight, Set MouseBoth

WIN.MOUSEDEFThis subroutine is used when the host needs to know when and where mouse buttons are clicked. Itprograms the mouse buttons so that they enter the X and Y coordinates and a button number whenthe mouse is clicked on the wIntegrate screen.

The necessary values are hard coded within this routine, and overwrite the current settings. Theformat is recognized by the WIN.MOUSEIN command and returned. See the example for theWIN.MOUSEIN command.


184

Syntax

WIN.MOUSEDEF

Related Subroutines

WIN.MOUSEIN

WIN.MOUSEINThis subroutine waits until a mouse button is pressed and then splits the result into the position and abutton type.

For this routine to work, you must first call the WIN.MOUSEDEF routine, which programs the mousebuttons.

Syntax

WIN.MOUSEIN (X, Y, BUTTON)

Parameters

The following table describes the parameters of the WIN.MOUSEIN command:


X The column number returnedY The row number returnedBUTTON The button type returned; see the following table

Values for BUTTON

The following button numbers are returned:

Value Description

1 Left2 Right3 Both+3 Shift + left, right, or both+6 Ctrl + left, right, or both+9 Ctrl + Shift + left, right, or both

Examples

The following example waits for the Ctrl key + click on line 23.

*Set up the mouseCALL WIN.MOUSEDEFLOOPCALL WIN.MOUSEIN(X.Y.BUTTON)* End the loop when Control+MouseLeft button is clicked on line 23UNTIL Y = 23 AND BUTTON = 7 DO...

WIN.MSGBOX

185

REPEAT

Related Subroutines

WIN.MOUSEDEF

WIN.MSGBOXThis subroutine creates and displays a message box. You must specify the text, icon, and responsebuttons to display.

This subroutine truncates the text of the message to 150 characters. Use WIN.MSGBOX2 to showlarger amounts of text.

Syntax

WIN.MSGBOX (TEXT, TITLE, FLAGS, RESP)

Parameters

The following table describes the parameters of the WIN.MSGBOX command:


TEXT The text to display in the message boxTitle The title for the message boxFLAGS Icon and Response buttons to display in the box; see the following tableRESP The response from the user

Values for FLAGS

Use one icon and one button flag together separated by a vertical bar (|).

Value Description



186

Examples

The following example demonstrates how to show two message boxes within a program.

* Show a message boxCALL WIN.MSGBOX("Create report?", " ", "MB_OKCANCEL | MB_ICONHAND", RESP)IF RESP = "Yes" THEN GOSUB 100100* Record a report to file "recrept"CALL WIN.RECON("recrept.txt", 1)* Run a reportEXECUTE "LIST STUDENT LNAME MAJOR"CALL WIN.STATLINE("Creating report...")* Turn off recordingCALL WIN.RECOFF(1)CALL WIN.STATLINE("")CALL WIN.MSGBOX("Display the report?", "Student Report", "MB_YESNOCANCEL | MB_ICONQUESTION ", RESP)IF RESP = "Yes" THEN GOSUB 200RETURN200* Display the report on the screenCALL WIN.PLAYBACK("recrept.txt")RETURNEND

Related Subroutines

WIN.INFOBOX, WIN.INPBOX, WIN.MSGBOX2, WIN.DBMSGBOX, WIN.DBMSGBOX2, WIN.INFOBOX2


MessageBox

WIN.MSGBOX2This subroutine creates and displays a message box. You must specify the text, icon, and responsebuttons to display.

Unlike WIN.MSGBOX, this subroutine can show text with more than 150 characters.

Syntax

WIN.MSGBOX2 (TEXT, TITLE, FLAGS, RESP)

Parameters

The following table describes the parameters of the WIN.MSGBOX2 command:


TEXT The text to display in the message boxTitle The title for the message boxFLAGS Icon and Response buttons to display in the box; see the following tableRESP The response from the user

WIN.MSGBOX2

187

Values for FLAGS

Use one icon and one button flag together separated by a vertical bar (|).

Value Description


Examples

The following example demonstrates how to show two message boxes within a program.

* Show a message boxCALL WIN.MSGBOX2("Create report?", " ", "MB_OKCANCEL | MB_ICONHAND", RESP)IF RESP = "Yes" THEN GOSUB 100100* Record a report to file "recrept"CALL WIN.RECON("recrept.txt", 1)* Run a reportEXECUTE "LIST STUDENT LNAME MAJOR"CALL WIN.STATLINE("Creating report...")* Turn off recordingCALL WIN.RECOFF(1)CALL WIN.STATLINE("")CALL WIN.MSGBOX2("Display the report?", "Student Report", "MB_YESNOCANCEL | MB_ICONQUESTION ", RESP)IF RESP = "Yes" THEN GOSUB 200RETURN200* Display the report on the screenCALL WIN.PLAYBACK("recrept.txt")RETURNEND

Related Subroutines

WIN.INFOBOX, WIN.INPBOX, WIN.INFOBOX2, WIN.MSGBOX, WIN.DBMSGBOX, WIN.DBMSGBOX2


MessageBox


188

Version


WIN.MSTATEThis subroutine modifies an option on the menu. The CHECK parameter adds or deletes a check marknext to the option. ENABLE makes a menu option available, or makes it gray to disable it.

Syntax

WIN.MSTATE (NAME, OPTION, CHECK, ENABLE)

Parameters

The following table describes the parameters of the WIN.MSTATE command:


NAME The name of the menuOPTION The option numberCHECK 1 - Option is checked

0 - Option is not checkedENABLE 1 - Enables the option

0 - Disables the option

Examples


* Attaching/Detaching in action1900 IF MENU.SHOW = 1 THEN CALL WIN.MENUATT('', "Demo","&Demo","Help") CALL WIN.MSTATE("Demo",9,1,1) MENU.SHOW = 2 PRINT C23:"Select menu option from the Demo menu on the main menu bar": END ELSE CALL WIN.MENUDET('', "Demo") CALL WIN.MSTATE("Demo",9,0,1) MENU.SHOW= 1 PRINT C23:"Select the menu option from the Popup menu":ENDRETURN

Related Subroutines

WIN.MENUDEL, WIN.MENUDET, WIN.MENUATT

WIN.OBEXISTThis subroutine returns TRUE if an object with the given name exists.

WIN.OBGET

189

Syntax

WIN.OBEXIST (NAME, RESP)

Parameters

The following table describes the parameters of the WIN.OBEXIST command:


NAME The name of the objectRESP 1 - if object exists; 0 if it does not

Version

4.0.3 Original

WIN.OBGETThis subroutine gets an automation object from a file or retrieves an active object.

Call WIN.OBREL to release the object when it has been finished with.

Syntax

WIN.OBGET (NAME, FILENAME, PROGID, RESP)

Parameters

The following table describes the parameters of the WIN.OBGET command:


NAME The name of the objectFILENAME Name of the file to get the object from. If omitted, an active object with the

PROGID specified is retrieved.PROGID The automation object or its class ID in {}. If omitted, the default object for the

specified file name is returned.RESP 0 or the error code. See the Object Get table in the Client Scripting Reference.

Related Subroutines

WIN.OBREL


Object Get

Version

4.0.3 Original

WIN.OBGETPRPThis subroutine gets the value for an object’s property.


190

Syntax

WIN.OBGETPRP (NAME, PROPERTY, VALUE)

Parameters

The following table describes the parameters of the WIN.OBGETPRP command:


NAME The name of the objectPROPERTY Name of the property to setVALUE The value that is returned for the property

Version

4.0.3 Original

WIN.OBMETHODThis subroutine runs a method on an automation object.

Syntax

WIN.OBMETHOD (NAME, METHOD, ARG.FLAGS, MAT ARGS, RET.FLAG, RET.VALUE)

Parameters

The following table describes the parameters of the WIN.OBMETHOD command:


NAME The name of the objectMETHOD The name of the method to runARG.FLAGS String describing the arguments; see the following tableMAT ARGS 20-element array to hold the argumentsRET.FLAG Flag to specify whether the method returns a value:

0 - No return value

1 - Returns a value

2 - RET.VALUE is the name of an object to be attached to the return valueRET.VALUE Value that is returned from the method if RET.FLAG is set to 1, or name of new

object if RET.FLAG is set to 2

Values for ARG.FLAGS

Value Description

I Input argument. The value from the corresponding element of ARGS is used torun the method.

O Output argument. The value from the corresponding element of ARGS is set tothe value returned from the method for this argument.

WIN.OBNEW

191

Value Description

B Both ways. The value from the corresponding element of ARGS is used to runthe method, and the value of the argument is returned after the method hasrun.

N Input argument (name). Value is the name of a script variable.D Input argument (dispatch pointer). Value is the name of an existing object.

Examples

See the host program WIN.OBDEMO in the WIN.PROGS file.

Version

4.0.3 Original

WIN.OBNEWThis subroutine create a new automation object.

Call WIN.OBREL to release the object when it has been finished with.

Syntax

WIN.OBNEW (NAME, PROGID, RESP)

Parameters

The following table describes the parameters of the WIN.OBNEW command:


NAME The name of the objectPROGID The automation object or its class ID in {}RESP 0 or the error code; see the Object Get table in the Client Scripting Reference

Related Subroutines

WIN.OBREL


Object New

Version

4.0.3 Original

WIN.OBRELThis subroutine releases an automation object. It should be called on any automation objects you use.

This includes objects that are created with WIN.OBNEW or WIN.OBGET, or retrieved from propertiesor method calls using WIN.OBSET or WIN.OBMETHOD.


192

Syntax

WIN.OBREL (NAME)

Parameters

The following table describes the parameters of the WIN.OBREL command:


NAME The name of the object

Related Subroutines

WIN.OBNEW, WIN.OBSET, WIN.OBGET, WIN.OBMETHOD


Object Release

Version

4.0.3 Original

WIN.OBSETThis subroutine sets a new object with the value of an object’s property. Use this when an object’sproperty returns a dispatch pointer to create a wIntegrate object that uses the dispatch pointer.

Syntax

WIN.OBSET (NAME, PROPERTY, VALUE)

Parameters

The following table describes the parameters of the WIN.OBSET command:


NAME The name of the objectPROPERTY Name of the property to which returns a dispatch pointerVALUE New value of the property


Object Set

Version

4.0.3 Original

WIN.OBSETPRPThis subroutine sets the value for an object’s property.

WIN.OBVTYPE

193

Syntax

WIN.OBSETPRP (NAME, PROPERTY, VALUE)

Parameters

The following table describes the parameters of the WIN.OBSETPRP command:


NAME The name of the objectPROPERTY Name of the property to setVALUE New value of the property

Version

4.0.3 Original

WIN.OBVTYPEThis subroutine modifies VALUE so that it is treated as a specific type when used as an argument forWIN.OBMETHOD. See the VarType script command in the Client Scripting Reference for details.

Syntax

WIN.OBVTYPE (TYPE, VALUE)

Parameters

The following table describes the parameters of the WIN.OBVTYPE command:


TYPE The type to return the object inVALUE The value to be converted

Related Subroutines

WIN.OBMETHOD


VarType

Version

4.0.3 Original

WIN.PCBROWSEThis subroutine shows the File > Open and File > Save dialog box on the PC and allows the user toselect a file name.


194

Syntax

WIN.PCBROWSE (PROMPT, DEFAULTFILE, OPTS, TYPES, EXT, RESULT)

Parameters

The following table describes the parameters of the WIN.PCBROWSE command:


PROMPT The title to display in the title of the Browse dialog box.DEFAULTFILE The default file name to be displayed when the dialog box is shown.OPTS Options:

0 - Show Open dialog box

1 - Show Save As dialog box

Add 2 to suppress Must Exist/Overwrite prompt. Add 4 to allow the selectionof multiple files.

TYPES The file types to show in the dialog box. List the name of the file type first,then the extension for this type separated by a "|".

EXT The default extension to use if a file name without an extension is entered inthe file name field.

RESULT Name of a variable to set with the file name chosen by the user. This will bea dynamic array of all the files selected if the multiple file selection optionwas specified. If the user presses the Cancel button, a null ("") file name isreturned.

Examples

The following example shows how to browse using the defaults.

CALL WIN.PCBROWSE("Browse using defaults","","","","",RESP)PRINT "File name entered = ":RESP

The following example shows how to browse from the C:\ location.

CALL WIN.PCBROWSE('Browse with "Save"', "C:\*.*",1,"","",RESP)

The following example shows how to browse with types and default extension.

TYPES = "Text 'Files'|*.txt|"TYPES = TYPES : 'All "Files"|*.*'*CALL WIN.PCBROWSE("Browse with types", "C:\*.TXT",1,TYPES, "TXT", RESP)PRINT "File name entered = ":RESP


FileBrowse

Version

4.3/5.01 Original

6.1 Added selection of multiple files option

WIN.PCCLOSE

195

WIN.PCCLOSEThis subroutine closes a PC file that was opened by WIN.PCOPEN.

Syntax

WIN.PCCLOSE (NAME)

Parameters

The following table describes the parameters of the WIN.PCCLOSE command:


NAME The identifier that is given to the file in WIN.PCOPEN

Examples

The following example writes text to a file.

CALL WIN.PCOPEN("new","C:\pctest\pcnew.txt", OK)IF OK THEN * open pcnew.txt NEW.DEF = "This is written by the WIN.PCWRITE subroutine" CALL WIN.PCWRITE("new", NEW.DEF, "TEXT") * Close the file CALL WIN.PCCLOSE("new")END

Related Subroutines

WIN.PCOPEN, WIN.PCREAD, WIN.PCWRITE


File Close

WIN.PCCOPYThis subroutine makes a copy of a file on the PC.

Syntax

WIN.PCCOPY (FROMFILE, TOFILE, OVERWRITE)

Parameters

The following table describes the parameters of the WIN.PCCOPY command:


FROMFILE The name of the file to copyTOFILE The name for the copy of the fileOVERWRITE 1 to overwrite any existing file with the same name; otherwise 0


196


File Copy

Version

4.3/5.0.1 Original

WIN.PCCREATEThis subroutine creates a PC file.

Use this call if your application needs to create a file. Then, use the WIN.PCDELETE subroutine todelete it when it is no longer necessary.

The subroutine assumes the file is in the wIntegrate directory if the full path name of the file is notspecified.

Syntax

WIN.PCCREATE (FILE)

Parameters

The following table describes the parameters of the WIN.PCCREATE command:


FILE The name that you specify for the new PC file. Include the full path name if thefile is not created in the wIntegrate directory.

Examples

The following example is a demo program for WIN.PC subroutines.

* Make a new directory C:\pctestCALL WIN.PCMKDIR("C:\pctest")** Verify the PC directory C:\pctestCALL WIN.PCDIR("C:\pctest", PCTEST.FOUND)IF PCTEST.FOUND THEN** Check if pcnew.txt exists in the pctest directoryCALL WIN.PCFILE("C:\pctest\pcnew.txt", EXIST)IF EXIST THEN GOSUB 100 ELSE GOSUB 200STOP100CALL WIN.PCEDIT("C:\pctest\pcnew.txt")RETURN200CALL WIN.PCCREATE("C:\pctest\pcnew.txt")CALL WIN.PCEDIT("C:\pctest\pcnew.txt")RETURNEND

WIN.PCDELETE

197

Related Subroutines

WIN.PCEDIT, WIN.PCFILE

WIN.PCDELETEThis subroutine deletes a PC file. Use this call if your application needs to create a temporary file andyou want to delete it when it is no longer necessary.


Syntax

WIN.PCDELETE (FILE)

Parameters

The following table describes the parameters of the WIN.PCDELETE command:


FILE The name of the PC file to delete. Include the full path name if the file is notcreated in the wIntegrate directory.

Examples

The following example deletes the file that is created in the WIN.PCCREATE example program.

* Check if pcnew.txt exists in the pctest directoryCALL WIN.PCFILE("C:\pctest\pcnew.txt", EXIST)IF EXIST THEN CALL WIN.PCDELETE("C:\pctest\pcnew.txt")END

Related Subroutines

WIN.PCCREATE

WIN.PCDIRThis subroutine verifies that a PC directory exists.


Syntax

WIN.PCDIR (DIR, EXIST)

Parameters

The following table describes the parameters of the WIN.PCDIR command:


DIR The name of the PC directory to verify


198


EXIST Returns a 1 if the directory exists; 0 if it does not

Examples


* Make a new directory C:\pctestCALL WIN.PCMKDIR("C:\pctest")** Verify the PC directory C:\pctestCALL WIN.PCDIR("C:\pctest", PCTEST.FOUND)IF PCTEST.FOUND THEN** Check if pcnew.txt exists in the pctest directoryCALL WIN.PCFILE("C:\pctest\pcnew.txt", EXIST)IF EXIST THEN GOSUB 100 ELSE GOSUB 200STOP100 CALL WIN.PCEDIT("C:\pctest\pcnew.txt")RETURN200 CALL WIN.PCCREATE("C:\pctest\pcnew.txt")CALL WIN.PCEDIT("C:\pctest\pcnew.txt")RETURNEND

Related Subroutines

WIN.PCMKDIR, WIN.PCCREATE

WIN.PCEDITThis subroutine opens a PC file into the editor that is specified in Setup > Application.


Syntax

WIN.PCEDIT (FILE)

Parameters

The following table describes the parameters of the WIN.PCEDIT command:


FILE The name of the PC file to edit. Include the full path name if the file is notcreated in the wIntegrate directory.

Examples


* Make a new directory C:\pctestCALL WIN.PCMKDIR("C:\pctest")** Verify the PC directory C:\pctest

WIN.PCEOF

199

CALL WIN.PCDIR("C:\pctest", PCTEST.FOUND)IF PCTEST.FOUND THEN** Check if pcnew.txt exists in the pctest directoryCALL WIN.PCFILE("C:\pctest\pcnew.txt", EXIST)IF EXIST THEN GOSUB 100 ELSE GOSUB 200STOP100CALL WIN.PCEDIT("C:\pctest\pcnew.txt")RETURN200CALL WIN.PCCREATE("C:\pctest\pcnew.txt")CALL WIN.PCEDIT("C:\pctest\pcnew.txt")RETURNEND

Related Subroutines

WIN.PCCREATE, WIN.PCFILE


Dialog FileEdit, Set, Invoke

WIN.PCEOFThis subroutine checks a file that is opened by WIN.PCOPEN to see whether it is at the end of file.

Syntax

WIN.PCEOF (NAME, ATEOF)

Parameters

The following table describes the parameters of the WIN.PCEOF command:


NAME Name that is used to open the fileATEOF Returns 1 when at the end of the file; otherwise 0

Related Subroutines

WIN.PCOPEN

Version


WIN.PCFILEThis subroutine verifies the existence of a PC file.


200

Syntax

WIN.PCFILE (FILE, EXIST)

Parameters

The following table describes the parameters of the WIN.PCFILE command:


FILE The full path name of the PC file to verifyEXIST Returns a 1 if the file exists; 0 if it does not

Examples

The following example verifies the PC file C:\windows\system\sysedit.exe.

CALL WIN.PCFILE("C:\windows\system\sysedit.exe", SYSEDIT.OK)IF SYSEDIT.OK THEN PRINT "Run sysedit.exe"

The following example demonstrates how this subroutine works where the file does not already exist.

* Demo program for WIN.PC subroutines* Make a new directory C:\pctestCALL WIN.PCMKDIR("C:\pctest")** Verify the PC directory C:\pctestCALL WIN.PCDIR("C:\pctest", PCTEST.FOUND)IF PCTEST.FOUND THEN** Check if pcnew.txt exists in the pctest directoryCALL WIN.PCFILE("C:\pctest\pcnew.txt", EXIST)IF EXIST THEN GOSUB 100 ELSE GOSUB 200STOP100CALL WIN.PCEDIT("C:\pctest\pcnew.txt")RETURN200CALL WIN.PCCREATE("C:\pctest\pcnew.txt")CALL WIN.PCEDIT("C:\pctest\pcnew.txt")RETURNEND

Related Subroutines

WIN.PCCREATE, WIN.PCEDIT


FileExist

WIN.PCINFOThis subroutine returns information about a file or directory. If the file does not exist, it returns null.

WIN.PCLIST

201

Syntax

WIN.PCINFO (FILE, INFO)

Parameters

The following table describes the parameters of the WIN.PCINFO command:


FILE The name of the file on which you want informationINFO The information that is returned is in the following order:

1 - file length

2 - date of last update

4 - time of last update

8 - attributes

Examples

The following example gets info on pcnew.txt.

PC.INFO = ""CALL WIN.PCINFO("C:\pctest\pcnew.txt", PC.INFO)PRINT "Information on file pcnew.txt " : PC.INFO* This program returns the following information: Information on file pcnew.txt* 34 05/02/2014 14:25:12 A


FileInfo

WIN.PCLISTThis subroutine checks a folder and returns a list of the files or subdirectories matching the criteriathat you specify in a dynamic array.

Syntax

WIN.PCLIST (FILESPEC, OPTS, RESP)

Parameters

The following table describes the parameters of the WIN.PCLIST command:


FILESPEC The files to return; can be a wild card expression to match filesOPTS Specifies other matching options; see the following Opts tableRESP A dynamic array of the files or folders that match the specification

Values for OPTS

The options field specifies which files or subdirectories to match. The default option is 0. The options4, 8, 16, and 32 can be used alone or added to other option numbers.


202

Value Description

1 Returns files and directories2 Returns files; includes directories in square brackets4 Returns only subdirectories8 Returns only hidden files16 Returns only system files32 Do not include current directory


FileList

Version


WIN.PCMKDIRThis subroutine creates a new PC directory.

Use this with the WIN.PCDIR subroutine to verify that the directory does not already exist.

Syntax

WIN.PCMKDIR (DIR)

Parameters

The following table describes the parameters of the WIN.PCMKDIR command:


DIR The name of the directory to create. Include the full path name if the file is notcreated in the wIntegrate directory.

Examples


* Make a new directory C:\pctestCALL WIN.PCMKDIR("C:\pctest")** Verify the PC directory C:\pctestCALL WIN.PCDIR("C:\pctest", PCTEST.FOUND)IF PCTEST.FOUND THEN** Check if pcnew.txt exists in the pctest directoryCALL WIN.PCFILE("C:\pctest\pcnew.txt", EXIST)IF EXIST THEN GOSUB 100 ELSE GOSUB 200STOP100CALL WIN.PCEDIT("C:\pctest\pcnew.txt")RETURN200CALL WIN.PCCREATE("C:\pctest\pcnew.txt")CALL WIN.PCEDIT("C:\pctest\pcnew.txt")

WIN.PCMOVE

203

RETURNEND

Related Subroutines

WIN.PCDIR, WIN.PCCREATE

WIN.PCMOVEThis subroutine moves/renames a file on the PC.

Syntax

WIN.PCMOVE (FROM.FILE, TOFILE, OVERWRITE)

Parameters

The following table describes the parameters of the WIN.PCMOVE command:


FROM.FILE File to move/renameTOFILE Destination/new name for the fileOVERWRITE 1 to overwrite the destination file; otherwise 0


File Move

Version

4.3/5.0.1 Original

WIN.PCOPENThis subroutine opens a PC file.

To close the file, use WIN.PCCLOSE.

Syntax

WIN.PCOPEN (NAME, FILE, OK)

Parameters

The following table describes the parameters of the WIN.PCOPEN command:


NAME The identifier that you give to the PC fileFILE The name of the PC file to openOK Returns 1 if the file exists; 0 if not


204

Examples

The following example verifies whether pcnew.txt is open.

CALL WIN.PCOPEN("new","C:\pctest\pcnew.txt", OK)IF OK THEN GOSUB 100100 *open pcnew.txtNEW.DEF = "This is written by the WIN.PCWRITE subroutine"CALL WIN.PCWRITE("new", NEW.DEF, "TEXT")* Close the fileCALL WIN.PCCLOSE("new")RETURNEND

Related Subroutines

WIN.PCCLOSE, WIN.PCREAD, WIN.PCWRITE


File Open

WIN.PCPOSThis routine moves the file pointer a number of bytes into a file opened by WIN.PCOPEN. The positionis the number of bytes from the beginning of the file. The first character in the file is 0. To move to theend of the file, use position -1. The default is -1, the end of the file.

Syntax

WIN.PCPOS (NAME, POS)

Parameters

The following table describes the parameters of the WIN.PCPOS command:


NAME The identifier for the file that is designated in WIN.PCOPENPOS The number of bytes from the beginning of the file; The character in the file is

0. To move to the end of the file, position -1. The default is the end of the file.

Examples

The following example verifies whether pcnew.txt is open.

CALL WIN.PCOPEN("new","C:\pctest\pcnew.txt", OK)IF OK THEN GOSUB 100100 *open pcnew.txtNEW.DEF = "This is written by the WIN.PCWRITE subroutine"CALL WIN.PCPOS("new", 0) ;* Go to the start of the fileCALL WIN.PCWRITE("new", NEW.DEF, "TEXT") * Close the file CALL WIN.PCCLOSE("new")RETURNEND

WIN.PCPRINT

205

Related Subroutines

WIN.PCOPEN, WIN.PCREAD, WIN.PCWRITE, WIN.PCCLOSE


File Pointer

WIN.PCPRINTThis subroutine prints a PC file to the printer designated in File > Printer Setup. If the file is not in thewIntegrate directory, you must specify the full path of the file.

Syntax

WIN.PCPRINT (FILE)

Parameters

The following table describes the parameters of the WIN.PCPRINT command:


FILE The name of the file to print

Examples

The following example prints the new pcnew.txt file.

CALL WIN.PCPRINT("C:\pctest\pcnew.txt")

Related Subroutines

WIN.PCEDIT

WIN.PCREADThis subroutine reads data from a file opened with the WIN.PCOPEN routine. A maximum of 15Kof data can be read in one call to this routine. The file pointer is moved to the end of the file so thatsubsequent calls to the routine will read more data from the file.

Note: This routine has no error checking when the data is transferred.

Syntax

WIN.PCREAD (NAME, VAR, MAX.BYTES, CONVERT)

Parameters

The following table describes the parameters of the WIN.PCREAD command:


NAME The identifier for the file that is designated in WIN.PCOPEN


206


VAR The variable for data to read toMAX.BYTES The maximum number of bytes to readCONVERT The conversion of the data read; see the following Convert table

Values for CONVERT

This table describes the data conversion options for this routine.

Value Description

"" No conversion"TEXT" Converts field marks to carriage returns"HEX" Return each byte in the file as a 2-digit hex number"FT" Return in wIntegrate’s file transfer format

Examples

The following example reads Excel spreadsheets as hex and stores on the host file.

CALL WIN.PCOPEN("SHEET", PCFILENAME, OK)IF OK THEN COUNT = 0 LOOP CALL WIN.PCREAD("SHEET", REC, "", "HEX") UNTIL REC = "" DO COUNT = COUNT + 1 WRITE REC ON F.SHEETS, PCFILENAME : COUNT REPEAT CALL WIN.PCCLOSE("SHEET")END

Related Subroutines

WIN.PCOPEN, WIN.PCPOS, WIN.PCWRITE


File Read

WIN.PCREADALThis subroutine reads data from a file opened by WIN.PCOPEN. It reads data from the current fileposition to the end of the file.

Note: This routine does not check for the maximum size of a variable on the host system.

Syntax

WIN.PCREADAL (NAME, VAR, CONVERT)

Parameters

The following table describes the parameters of the WIN.PCREADAL command:

WIN.PCREADLN

207


NAME Name that is used to open the fileVAR The variable the data will be read in toCONVERT The conversion of the data to be read; see the table in WIN.PCREAD, on page

205 for details

Examples

The following example reads the entire readme.txt file.

CALL WIN.PCOPEN("FH", " C:\readme.txt ", OK)IF OK THEN CALL WIN.PCREADAL("FH",REC,"TEXT") CALL WIN.PCCLOSE("FH")END


File Read

Version


WIN.PCREADLNThis subroutine reads a single line from a file opened by WIN.PCOPEN.

Syntax

WIN.PCREADLN (NAME, VALUE, MAX.BYTES)

Parameters

The following table describes the parameters of the WIN.PCREADLN command:


NAME Name that is used to open the fileVALUE Returned text of the lineMAX.BYTES Maximum number of bytes to read. "" is the default (256)

Examples

The following example prints out the lines from a file previously opened.

LOOP CALL WIN.PCEOF(FH,EOF)UNTIL EOF DO CALL WIN.PCREADLN(FH,VALUE,"") PRINT VALUEREPEAT


208

Related Subroutines

WIN.PCREAD, WIN.PCREADAL


File Read

Version


WIN.PCRMDIRThis subroutine deletes a folder on the PC. The folder must exist before this routine is called.

Syntax

WIN.PCRMDIR (DIR)

Parameters

The following table describes the parameters of the WIN.PCRMDIR command:


DIR The path of the folder to delete. If a full path is not given, the folder isassumed to be a subfolder of the wIntegrate folder.


File DeleteDir

WIN.PCRUNThis subroutine runs another Windows application on the PC.

Syntax

WIN.PCRUN (PROG, ARGS)

Parameters

The following table describes the parameters of the WIN.PCRUN command:


PROG The name of the application to runARGS The path of the application executable and the file of a particular document,

if necessary

Examples


* Excel DDE demonstration

WIN.PCRUN2

209

200 CALL WIN.COLOR("Yellow","Blue")CALL WIN.TWOPEN("ddedemo", "Excel Dynamic Data Exchange demo",10, 5, 70, 16,1)PRINT "To find out the topics Excel supports:-"PRINT "First open a link to the system topic as follows:-"PRINT ' CALL WIN.DDEOPEN("EXCEL_LINK","excel","System", OK)'CALL WIN.DDEOPEN("EXCEL_LINK","excel","System", OK)*IF NOT(OK) THEN PRINT PRINT "We couldn't start the link so we shall try to start Excel" PRINT 'and try again' PRINT ' CALL WIN.PCRUN("EXCEL","")' PRINT ' CALL WIN.DDEOPEN("EXCEL_LINK","excel","System", OK)' CALL WIN.PCRUN("EXCEL","") CALL WIN.DDEOPEN("EXCEL_LINK","excel","System", OK) IF NOT(OK) THEN PRINT CALL WIN.COLOR("lightred","") PRINT 'We are unable to start Excel, so the demo will stop.' PRINT "If you do own Excel, try starting it and then re-running the demo." ENDEND*


Dialog Run Program, Set, Invoke

WIN.PCRUN2This subroutine runs an application or file on the PC.

It extends WIN.PCRUN to allow further control over the starting of the application and to return astatus code.

Syntax

WIN.PCRUN2 (PATH, ARGUMENTS, OPTS, RESP)

Parameters

The following table describes the parameters of the WIN.PCRUN2 command:


PATH The path to the program or file nameARGUMENTS Additional arguments if PATH is a programOPTS Available options; see the following Opts tableRESP Returns a value specifying whether the file or program ran. If the value is

greater than 32, the program was launched correctly. If it was less than orequal to 32, an error occurs. See the following Resp table.

Fields for OPTS

The OPTS is a dynamic array that contains the following. Setting OPTS to "" gives the default value forall the options.


210

Field Description

1 Show option. The show option is a request. The applications will notnecessarily start with the specified show state. It can be one of the following:

0 - Show and activate (default)

1 - Minimize

2 - Maximize

3 - Hide

4 - Show but do not activate2 Verb to run on the application. Either “Open” to open a document or

run an application, or “Print” to print a file (Print is not supported by allapplications).

3 Default directory (default none) for program to start in.

Values for RESP

The following table shows the error codes returned:

Value Description

31 No association found for file type, or verb not supported.0 System was out of memory, or executable file was corrupted.2 File was not found.3 Path was not found.Others Executable would not load or run under Windows.

Examples

The following example runs Notepad minimized.

CALL WIN.PCRUN2("notepad.exe","",1,RESP)IF RESP < 32 THEN PRINT "Failed to run notepad, error code ":RESPEND ELSE PRINT "Notepad started"

Related Subroutines

WIN.PCRUN


Run

Version


WIN.PCSCRIPTThis subroutine runs a script from the PC. The default file extension is .wis, and the directory isassumed to be wIntegrate unless you specify otherwise.

WIN.PCWRITE

211

Syntax

WIN.PCSCRIPT (SCRIPT, ARGS)

Parameters

The following table describes the parameters of the WIN.PCSCRIPT command:


SCRIPT The full path of the script. If the script is in the directory, this is null ("").ARGS The arguments to pass to the script.

Examples

The following example runs the wc.wis (Command Line dialog box) script.

CALL WIN.PCSCRIPT("example\script\wc.wis", "")


Chain

WIN.PCWRITEThis subroutine writes data to a PC file that was opened with WIN.PCOPEN. A maximum of 15K ofdata can be written in one call to this routine. The file pointer is moved to the end of the file so thatsubsequent calls to the routine will write more data to the file.

Note: This routine has no error checking when the data is transferred.

Syntax

WIN.PCWRITE (NAME, BYTES, CONVERT)

Parameters

The following table describes the parameters of the WIN.PCWRITE command:


NAME The identifier for the file that is designated in WIN.PCOPENBYTES The bytes to write to a fileCONVERT The conversion of the data during transfer; see the following Convert table

Values for CONVERT

This table describes the data conversion options for this routine.

Value Description

"" No conversion"TEXT" Converts field marks to carriage returns"HEX" Return each byte in the file as a 2-digit hex number


212

Value Description

"FT" Return in wIntegrate’s file transfer format

Examples

The following example writes text to a file.

CALL WIN.PCOPEN("new","C:\pctest\pcnew.txt", OK)IF OK THEN GOSUB 100100 *open pcnew.txtNEW.DEF = "This is written by the WIN.PCWRITE subroutine"CALL WIN.PCWRITE("new", NEW.DEF, "TEXT")* Close the fileCALL WIN.PCCLOSE("new")RETURNEND

Related Subroutines

WIN.PCOPEN, WIN.PCCLOSE, WIN.PCREAD


File Write

WIN.PIESUBThis subroutine draws a pie chart on the screen. The subroutine uses the default options if theparameter OPTS is null.

Syntax

WIN.PIESUB (TITLE, LABELS, REGIONS, OPTS)

Parameters

The following table describes the parameters of the WIN.PIESUB command:


TITLE The title that you specify for the pie chartLABELS Labels for the regionsREGIONS The attribute names for the list of dataOPTS Available options; see the following Opts table

Fields for OPTS

Field Description

1 Reserved2 Screen Position2.1 Left; default is 02.2 Top; default is 02.3 Right; default is 79

WIN.PLAYBACK

213

Field Description

2.4 Bottom; default is 233 Suppress Labels3.1 Suppresses Values in the legend3.2 Suppresses percentages around chart4 Colors. Multivalued list of the colors to use. Leave as "" for the default

six colors: RGB_LightRed, RGB_Yellow, RGB_LightGreen, RGB_LightBlue,RGB_LightMagenta and RGB_LightCyan.

Examples

The following example is part of the WIN.PIEDEMO demonstration program.

*CALL WIN.BOX(0,1,79,1,1)*LABELS = ''VALUES = ''LABELS<1> = 'Computers'; VALUES<1> =200LABELS<2> = 'Stationery'; VALUES<2> = 500LABELS<3> = 'Accessories'; VALUES<3> = 50*R.OPTS = ''R.OPTS<2,1> = 15R.OPTS<2,2> = 3R.OPTS<2,3> = 65R.OPTS<2,4> = 17*CALL WIN.PIESUB("Products sold", LABELS, VALUES, R.OPTS)*PRINT @(0,18):PRINT "The above graph was created by the subroutine call"PRINTPRINT " CALL WIN.PIESUB('Products sold',LABELS, VALUES, R.OPTS)"PRINT @(0,22):"Press <CR> to continue:":INPUT DUM:*STOP

Related Subroutines

WIN.BARSUB


(See Draw Commands)

WIN.PLAYBACKThis subroutine plays back a recorded file.

Syntax

WIN.PLAYBACK (FILE)


214

Parameters

The following table describes the parameters of the WIN.PLAYBACK command:


FILE The name of the recorded file. You must specify the full path of the PC file, orthe subroutine assumes the file is in the wIntegrate directory.

Examples

The following example records and plays back a report.

* Record a report to file "recrept"CALL WIN.RECON("recrept.txt", 1)* Demonstrate status bar textCALL WIN.STATLINE("Selecting data...")* Run a reportEXECUTE "LIST STUDENT LNAME MAJOR"CALL WIN.STATLINE("Creating report...")* Turn off recordingCALL WIN.RECOFF(1)*INPUT DUMCALL WIN.STATLINE("Displaying report...")* Display the report on the screenCALL WIN.PLAYBACK("recrept.txt")CALL WIN.STATLINE("")END

Related Subroutines

WIN.RECOFF, WIN.RECON


Dialog EditPlay, Set, Invoke

WIN.POPUPINThis subroutine shows the menu that is defined in MENU and waits for input. The subroutine returnsthe menu name in RMENU and the option in OPT. If no option is selected, then RMENU is "null" and OPTis "Esc".

Syntax

WIN.POPUPIN (MENU, X, Y, RMENU, OPT)

Parameters

The following table describes the parameters of the WIN.POPUPIN command:


MENU The name that you specify for the menuX The column position of the upper left of the menuY The row position of the upper left of the menu

WIN.PRINTOFF

215


RMENU The name of the menu where the option is selectedOPT The selected option

Examples


*IF MENU.SHOW = 1 THEN CALL WIN.POPUPIN("Demo",45,10,MENU,OPTEND ELSE CALL WIN.MENUIN("", "Demo", MENU, OPT)END

Related Subroutines

WIN.MENULOAD, WIN.MENUDEL, WIN.MENUATT, WIN.MENUDET


Menu PopUp

WIN.PRINTOFFThis subroutine turns off local (PC) printing that was turned on with WIN.PRINTON. The SCREEN.ONparameter needs to match the SCREEN.OFF parameter in WIN.PRINTON.

Syntax

WIN.PRINTOFF (SCREEN.ON)

Parameters

The following table describes the parameters of the WIN.PRINTOFF command:


SCREEN.ON 0 - Turns off the screen while printing

1 - Turns on the screen while printing

Examples

The following example sends a host report to the local printer.

CALL WIN.PRINTON(0)GOSUB 100100*Send report to screen and printer...CALL WIN.PRINTOFF(0)


216

Related Subroutines

WIN.PRINTON


Capture, Screen On

WIN.PRINTONThis subroutine turns on local (PC) printing. Any text that displays after this command also goes to theprinter. When SCREEN.OFF is set to 1, the data goes to the printer and is not displayed on the screen.Turn off printing with the WIN.PRINTOFF subroutine.

Syntax

WIN.PRINTON (SCREEN.OFF)

Parameters

The following table describes the parameters of the WIN.PRINTON command:


SCREEN.OFF 0 - Turns off the screen while printing

1 - Turns on the screen while printing

Examples

The following example sends a report to the local printer.

CALL WIN.PRINTON(0)GOSUB 100100*Send report to screen and printer...CALL WIN.PRINTOFF(0)

Related Subroutines

WIN.PRINTOFF


Capture, Screen Off

WIN.PRTPAUSEThis subroutine pauses or continues the output to a printer from the WIN.PRINTON subroutine toallow the data to be sent to the screen or other subroutines to be called which are not recorded.

WIN.RECOFF

217

Syntax

WIN.PRTPAUSE (PAUSE, SCREEN.OFF)

Parameters

The following table describes the parameters of the WIN.PRTPAUSE command:


PAUSE 1 - Pause the printing

0 - Restart the printing after the pauseSCREEN.OFF This should match the SCREEN.OFF parameter of WIN.PRINTON. When set to

1, it turns screen output back on while the printing is paused.

Examples

The following example updates the status bar with the printout’s progress.

CALL WIN.PRTPAUSE(1,0)CALL WIN.STATLINE(PC:"% complete")CALL WIN.PRTPAUSE(0,0)

Related Subroutines

WIN.PRINTON


Capture Pause, Capture Continue

Version


WIN.RECOFFThis subroutine stops the recording of raw data from the host to a PC file named in WIN.RECON. TheSCREEN.ON parameter should match the SCREEN.OFF parameter that you set in WIN.RECON.

Syntax

WIN.RECOFF (SCREEN.ON)

Parameters

The following table describes the parameters of the WIN.RECOFF command:


SCREEN.ON Turns the screen back on if it was turned off in WIN.RECON.

0 - Keeps the screen turned off

1 - Turns the screen back on


218

Examples

The following example demonstrates how to begin recording a file.

* Record a report to file "recrept"CALL WIN.RECON("recrept.txt", 1)* Demonstrate status bar textCALL WIN.STATLINE("Selecting data...")* Run a reportEXECUTE "LIST STUDENT LNAME MAJOR"CALL WIN.STATLINE("Creating report...")* Turn off recordingCALL WIN.RECOFF(1)*INPUT DUMCALL WIN.STATLINE("Displaying report...")* Display the report on the screenCALL WIN.PLAYBACK("recrept.txt")CALL WIN.STATLINE("")END

Related Subroutines

WIN.RECON, WIN.PLAYBACK


Capture, Screen Off

WIN.RECONThis subroutine records raw data from the host computer to a PC file. You must specify the full path ofthe PC file, or the subroutine assumes the file is in the wIntegrate directory.

Turn off the recording with the WIN.RECOFF subroutine.

Syntax

WIN.RECON (FILE, SCREEN.OFF)

Parameters

The following table describes the parameters of the WIN.RECON command:


FILE The name of the file where the recording is stored.SCREEN.OFF Turns off the screen if you want to hide processing. Turn the screen back on

with WIN.RECON set to 1.

0 - Keeps the screen turned on

1 - Turns off the screen

Examples

The following example demonstrates how to record a file.

* Record a report to file "recrept"

WIN.RECPAUSE

219

CALL WIN.RECON("recrept.txt", 1)* Demonstrate status bar textCALL WIN.STATLINE("Selecting data...")* Run a reportEXECUTE "LIST STUDENT LNAME MAJOR"CALL WIN.STATLINE("Creating report...")* Turn off recordingCALL WIN.RECOFF(1)*INPUT DUMCALL WIN.STATLINE("Displaying report...")* Display the report on the screenCALL WIN.PLAYBACK("recrept.txt")CALL WIN.STATLINE("")END

Related Subroutines

WIN.RECOFF, WIN.PLAYBACK


Capture, Screen Off

WIN.RECPAUSEThis subroutine pauses or continues the output to a file from the WIN.RECON subroutine to allow thedata to be sent to the screen or other subroutines to be called that are not recorded.

Syntax

WIN.RECPAUSE (PAUSE, SCREEN.OFF)

Parameters

The following table describes the parameters of the WIN.RECPAUSE command:


PAUSE 1 - pause the recording

0 - restart the recording after the pauseSCREEN.OFF This should match the SCREEN.OFF parameter of WIN.RECON. When set to 1,

it turns screen output back on while the recording is paused.

Examples

The following example updates the status bar with the recording’s progress.

CALL WIN.RECPAUSE(1,0)CALL WIN.STATLINE(PC:"% complete")CALL WIN.RECPAUSE(0,0)

Related Subroutines

WIN.RECON


220


Capture Pause, Capture Continue

Version


WIN.RSEXECThis subroutine allows you to define a script, then transfer it to the PC as a single script and run it on adifferent session from the current session.

Note: A script that is run on the remote session in this way should either complete quickly or run amulti-tasking script command, for example, Yield, Enter, and so on.

Syntax

WIN.RSEXEC (SCRIPT, SESSION)

Parameters

The following table describes the parameters of the WIN.RSEXEC command:


SCRIPT The text of the script to transferSESSION The name of the session to run the script on

Examples

The following example puts text in the remote status bar.

CALL WIN.RSEXEC("Print 'This text came from a remote session", NAME)

Related Subroutines

WIN.RSEXIST, WIN.RSSCRIPT, WIN.RSNAME, WIN.RSSTART


Session Execute

Version

4.2.1 Original

WIN.RSEXISTThis subroutine checks if the named session is currently running.

WIN.RSNAME

221

Syntax

WIN.RSEXIST (SESSION, RESP)

Parameters

The following table describes the parameters of the WIN.RSEXIST command:


SESSION The session name to checkRESP Set to 1 if the session exists, 0 if it does not

Examples

The following example checks if a session called “session2” is running.

CALL WIN.RSEXIST("Session2", RESP)IF RESP = 1 THEN PRINT "Session 2 is running"

Related Subroutines

WIN.RSEXEC, WIN.RSSCRIPT, WIN.RSNAME, WIN.RSSTART


Sessions

Version

4.2.1

WIN.RSNAMEThis subroutine returns the name of the session it is run upon.

Syntax

WIN.RSNAME (NAME)

Parameters

The following table describes the parameters of the WIN.RSNAME command:


NAME The session name returned

Examples

The following example checks if this session is “session2”.

CALL WIN.RSNAME(NAME)IF NAME = "Session2" THEN PRINT "This program should not be run on Session2" STOP


222

END

Related Subroutines

WIN.RSEXEC, WIN.RSEXIST, WIN.RSSCRIPT, WIN.RSSTART


Get(Name)

Version

4.2.1 Original

WIN.RSSCRIPTThis subroutine allows you to run a script that exists on the client PC in a session other than the onethat runs this command.

Note: A script that is run on the remote session in this way should either complete quickly or run amulti-tasking script command, for example, Yield, Enter, and so on.

Tip: To find/modify the session name for a session, use the Setup > Preferences > Options page.

Syntax

WIN.RSSCRIPT (FILENAME, ARGUMENT, SESSION)

Parameters

The following table describes the parameters of the WIN.RSSCRIPT command:


FILENAME The PC file name of the script to run.ARGUMENT The argument for the script. The remote session receives this in the

CommandLine global variable.SESSION The name of the session to run the script on.

Examples

The following example runs RsTest on another session.

* Run RsTest script with the parameter "hello" on session2PRINT "Running RsTest.wis"CALL WIN.RSSCRIPT("RsTest","hello", "session2")

Related Subroutines

WIN.RSEXEC, WIN.RSEXIST, WIN.RSNAME, WIN.RSSTART

WIN.RSSTART

223


Session Script

Version

4.2.1 Original

WIN.RSSTARTThis subroutine starts the named session file. This is identical to selecting File > Another from themenu. Because of the multi-tasking nature of Windows, the session is unlikely to have finished startingwhen the routine returns.

Syntax

WIN.RSSTART (FILENAME)

Parameters

The following table describes the parameters of the WIN.RSSTART command:


FILENAME The file name of the session file to start

Examples

The following example starts up another session.

* Start up session file SFILE that has session name NAME.PRINT "Starting remote session"CALL WIN.RSSTART(SFILE)** Give the session 10 seconds to start upJ = 0LOOP CALL WIN.RSEXIST(NAME, RESP) J = J + 1UNTIL J = 10 OR RESP = 1 SLEEP 1 ;* RQM on some host systemsREPEAT*IF RESP = 0 THEN PRINT "Session isn't running. Can't do tests!" STOPEND

Related Subroutines

WIN.RSEXEC, WIN.RSEXIST, WIN.RSSCRIPT, WIN.RSNAME

Version

4.2.1


224

WIN.RWSUBThis subroutine is the host side of the Report Wizard. It uses the service Subroutine to ensure that theuser has permissions to complete the requested actions.

You can trap this command and execute it at your inputs to allow server actions to run while not at adatabase prompt.

Syntax

WIN.RWSUB

WIN.SCREENThis subroutine turns on or off screen output. You might want to use this command when you want tohide system messages, or want to keep the screen blank while processing a call.

Syntax

WIN.SCREEN (TURN.ON)

Parameters

The following table describes the parameters of the WIN.SCREEN command:


TURN.ON 0 or OFF - Turns off screen output

1 or ON - Turns on screen output

Examples

The following example turns off the display while executing SSELECT.

CALL WIN.SCREEN(0) ;* Turn screen offEXECUTE "SSELECT COURSES"CALL WIN.SCREEN(1) ;* Turn screen on

Related Subroutines

WIN.DISPLAY


Screen On, Screen Off

WIN.SDUMPThis subroutine copies the current screen, then stores it in a file or sends it to the printer. To store thescreen as a file, the file name must have a .txt or .bmp extension. Specify the full path of the storagefile, or wIntegrate assumes it to be in the wIntegrate directory.

WIN.SENDKEYS

225

Syntax

WIN.SDUMP (DEVICE, FORMAT)

Parameters

The following table describes the parameters of the WIN.SDUMP command:


DEVICE The device is "Printer" or the PC file name. The default is "Printer".FORMAT Specifies how to save the file. Options are "TEXT" or "BITMAP".

Examples

The following example runs a report on students.

EXECUTE "SORT STUDENT LNAME FNAME BY LNAME"* Copy the current on-screen report to PC fileCALL WIN.SDUMP("C:\temp\report.txt", "TEXT")END


Dialog EditCopyTo, Set, Invoke, Invoke EditSelectScreen, Invoke EditCopySpecial

WIN.SENDKEYSThis subroutine sends keystrokes to an application. Use this with applications that do not supportDDE.

The keystrokes will be sent to the active window, so use WIN.ACTIVATE to change the focus to theapplication window.

Syntax

WIN.SENDKEYS (KEYS, WAIT)

Parameters

The following table describes the parameters of the WIN.SENDKEYS command:


KEYS The keystrokes that you want to send to the other application; see thefollowing Keys table for special key combinations

WAIT Returns the following:

0 - Return immediately

1 - Wait until the keystrokes are sent

Values for KEYS

This table describes how to use a character to designate special keys like Shift, Ctrl, and so on. Usethe character in front of the key it modifies.


226

Value Description

+ Designates the Shift key^ Designates the Ctrl key% Designates the Alt key+^% Designates the use of all three of the above together{char num} Designates the use of a key more than once

Examples

The following example puts a report name on line one of a text document using Notepad. It prints outa message if the task is not running. If the task is running, WIN.ACTIVATE changes the focus to theNotepad document and prints the report name on the first line.

* Verify the report "recrept.txt" is runningCALL WIN.TASK("Notepad - RECREPT.TXT", RUNNING)IF RUNNING THEN GOSUB 100 ELSEPRINT "recrept.txt is not running, open it and try again"RETURN100* Change the active window from wIntegrate to NotepadCALL WIN.ACTIVATE("Notepad - RECREPT.TXT")* Send the report name to the Notepad reportCALL WIN.SENDKEYS("STUDENT REPORT", 1)RETURNEND

Related Subroutines

WIN.ACTIVATE


SendKeys

WIN.SERIALThis subroutine returns the wIntegrate serial number.

Syntax

WIN.SERIAL (SERIAL)

Parameters

The following table describes the parameters of the WIN.SERIAL command:


SERIAL Returns the wIntegrate serial number

Examples

The following example returns the wIntegrate serial number.

CALL WIN.SERIAL(SERIAL.NO)

WIN.SERVER

227

PRINT "Your wIntegrate serial number is ":SERIAL.NO

Related Subroutines

WIN.VERSION


Serial (built-in constant)

WIN.SERVERThis subroutine is the host side of the PC server program. You can trap this command and execute it atyour inputs to allow server actions to run while not at a database prompt.

The server script library calls this subroutine. For more information, see the Client Scripting Reference.

To stop WIN.SERVER from echoing back the commands sent to it by the server script library, edit anitem that is named "SERVERMASK" in the WIN.PARAM (or WIN.PROGS if WIN.PARAM does not exist inyour account) file with the first field set to 1.


Syntax

WIN.SERVER

Version

6.0.3 Added SERVERMASK item

WIN.SET64.UDThis subroutine sets a global script variable or a script property. It creates a new global script variableif necessary. This subroutine is only available on UniData as it uses the Base64 encoding function builtinto UniBasic.

Syntax

WIN.SET64.UD (VARNAME, VALUE, ISTEXT, TRANCR)

Parameters

The following table describes the parameters of the WIN.SET64.UD command:


VARNAME The name of the global script variable or script property to setVALUE The value to set the variable toISTEXT 1 if VALUE contains text that should have the current host encoding and

emulation mappings that are applied to it; 0 if it is binary data


228


TRANCR Controls the mapping between field marks and CR (CHAR(13)), and valuemarks and TAB (CHAR(9)) as specified in the following Trancr table

Values for TRANCR

Value Description

0 No mapping1 Map field mark to CR and value mark to TAB2 Map field mark to CR followed by LF (CHAR(10)) and value mark to TAB

Related Subroutines

WIN.SETVAR, WIN.SETVAL, WIN.SETDATA, WIN.SETLIST


Host Get, Encode

Version


WIN.SETDATAThis subroutine sets the value or contents of a global or dialog variable. The variable can contain ASCIIcharacters less than 32 and greater than 126, including tabs and carriage returns.

If your variables contain only ASCII characters between 32 and 126, use the faster WIN.SETVARsubroutine.

Syntax

WIN.SETDATA (VARNAME, VALUE)

Parameters

The following table describes the parameters of the WIN.SETDATA command:


VARNAME The name of the variableVALUE The value of the variable that is specified in VARNAME

Examples

The following example sets and prints the current value of UserName.

CALL WIN.SETDATA("UserName", VALUE)CALL WIN.HSCRIPT("Print UserName")

WIN.SETEFFCT

229

Related Subroutines

WIN.GETVAR, WIN.SETLIST, WIN.SETVAR, WIN.DBGET, WIN.DBSET

WIN.SETEFFCTThis subroutine sets the color and style for a terminal effect. This works the same as Setup > Colorswhen you change the foreground and background colors and the style for a certain effect.

Syntax

WIN.SETEFFCT (NAME, FORE.COL, BACK.COL, STYLE, JOIN)

Parameters

The following table describes the parameters of the WIN.SETEFFCT command:


NAME The name of the effect. "Normal", "Dim", "Reverse", "Underline", "Flash","Bold", or "Secret". Effects can be combined by concatenating their names,for example, DimReverse.

FORE.COL The foreground or text color. See WIN.COLOR, on page 21 for availablecolors.

BACK.COL The background color. See WIN.COLOR, on page 21 or the colors.STYLE The style to use. See the following Style table.JOIN Joins lines on drawn boxes. This is like selecting the Join Lines check box in

Setup > Colors.

Values for STYLE

Value Description

None No border for the effectRaised A raised border that makes text appear above the backgroundInset An inset borderTextBox A defined inset border around the textBorder A plain black border around the textRaised2 A heavy raised border around the textInset2 A heavy inset border around the text

Examples

The following example changes the Bold effect to Magenta text on a blue background with a definedraised border.

CALL WIN.SETEFFCT("Bold", "Magenta", "Blue", "Raised2", "")


Set (Effect)


230

WIN.SETLISTSince PC items generally have lines that are separated by carriage returns and values that areseparated by tabs, this subroutine is provided to convert to these characters from field marks (CHAR254) and value marks (CHAR 253).

This subroutine sets the value or contents of a global or local variable. The variable can contain ASCIIcharacters less than 32 and greater than 126, including tabs and carriage returns.


Syntax

WIN.SETLIST (VARNAME, VALUE)

Parameters

The following table describes the parameters of the WIN.SETLIST command:



Examples

The following example sets the value of the PC item PCREC and converts from the host item format.

READ HOSTREC FROM FILE, ID THENCALL WIN.SETLIST("PCREC", HOSTREC)END

Related Subroutines

WIN.GETDATA, WIN.GETVAR, WIN.SETDATA, WIN.DBGET, WIN.DBSET, WIN.SETVAR, WIN.SETLISTL

WIN.SETLISTLSince PC items generally have lines that are separated by carriage returns and values that areseparated by tabs, this subroutine is provided to convert to these characters from field marks (CHAR254) and value marks (CHAR 253).

This subroutine sets the value or contents of a global or local variable. The variable can contain ASCIIcharacters less than 32 and greater than 126, including tabs and carriage returns.


This subroutine is available for UniData and UniVerse databases only as it uses functions specific tothese platforms. It is usually faster than SETEFFCT and can be used as a replacement for it. The speeddifference is only significant for large items that contain many attribute or subvalue marks.

Syntax

WIN.SETLISTL (VARNAME, VALUE)

WIN.SETPARAM

231

Parameters

The following table describes the parameters of the WIN.SETLISTL command:



Examples

The following example sets the value of the PC item PCREC and converts from the host item format.

READ HOSTREC FROM FILE, ID THENCALL WIN.SETLISTL("PCREC", HOSTREC)END

Related Subroutines

WIN.GETDATA, WIN.GETVAR, WIN.SETDATA, WIN.DBGET, WIN.DBSET, WIN.SETVAR, WIN.SETLIST

Version

6.3.5 Original

WIN.SETPARAMThis subroutine sets a session variable.

For a full list of the session variables, see the information about menu options in the Client ScriptingReference.

Syntax

WIN.SETPARAM (NAME, VALUE)

Parameters

The following table describes the parameters of the WIN.SETPARAM command:


NAME The name of the parameter or variable to setVALUE The value of the parameter that is specified in NAME

Examples

The following example sets the wIntegrate title.

CALL WIN.SETPARAM("Title", "Title changed by WIN.SETPARAM")

Related Subroutines

WIN.GETPARAM


232


Set

WIN.SETVALThis subroutine sends a value from the host to the Host Get script command. A Host Get commandmust be run before this subroutine is called.

Syntax

WIN.SETVAL (VALUE, OPTS)

Parameters

The following table describes the parameters of the WIN.SETVAL command:


VALUE The value to send to the PCOPTS Reserved; must be set to ""

Examples

The following example sends a brief message to the user.

CALL WIN.COMSUB("Host Get msg;MessageBox msg")CALL WIN.SETVAL("Please logoff the system","")


Host Get

Version

4.1.0 Original

WIN.SETVARThis subroutine sets the contents of a global variable.

It is like WIN.GETDATA, but it can be used only if the variable has a simple value; this makes thetransfer faster. No characters with ASCII values less than 32 or more than 126. This means there can beno carriage returns, tabs, or 8-bit characters. This routine is similar to WIN.GETDATA, but runs fasterand sends less data along communication lines.

Syntax

WIN.SETVAR (VARNAME, VALUE)

Parameters

The following table describes the parameters of the WIN.SETVAR command:

WIN.SHARE

233



Examples

The following example sets and prints the current value of UserName.

CALL WIN.SETVAR("UserName", VALUE)CALL WIN.HSCRIPT("Print UserName")

Related Subroutines

WIN.GETVAR, WIN.SETDATA, WIN.DBGET, WIN.DBSET, WIN.SETLIST

WIN.SHAREThis subroutine enables another user account to use the host programs. It should be executed fromthe account where the host programs were originally installed.

It sets up the necessary file pointers and catalogs the host programs.

Syntax

WIN.SHARE

WIN.SHOWThis subroutine displays the dialog box that is normally called from a menu command. For example,you might want to open wIntegrate windows like FileOpen, FileEdit, and so on from a script.

For a full list of the available menu options, see the information about menu options in the ClientScripting Reference.

Syntax

WIN.SHOW (MENU.DLG)

Parameters

The following table describes the parameters of the WIN.SHOW command:


MENU.DLG The name of the menu command that calls the dialog box

Examples

The following example opens the Import File dialog box.

CALL WIN.SHOW("RunImportFile")


234

Related Subroutines

WIN.INVOKE


Show

WIN.SLOADThis subroutine loads or restores a screen that is previously saved with WIN.SSAVE.

Syntax

WIN.SLOAD (FILE)

Parameters

The following table describes the parameters of the WIN.SLOAD command:


FILE The PC file that the screen was saved to with the WIN.SSAVE subroutine.

Examples

The following example saves the current screen named white1 (white background, black text).

* Then the program executes a sort statement * to a new screen (blue background, magenta text).* When the user enters a carriage return after* the report, the screen returns to white 1.* Save the current screenCALL WIN.SSAVE("white1")CALL WIN.COLOR("Magenta", "Blue")EXECUTE "SORT CUSTOMER BY NAME CITY"INPUT DUM* Restore the screen after executing the sortCALL WIN.SLOAD("white1")

Related Subroutines

WIN.SSAVE, WIN.SSTORE, WIN.SRESTORE


Screen Load, Screen Save

WIN.SPULLThis subroutine restores a screen that was saved with WIN.SPUSH. Use this when you want to restorethe screen while running commands, reports, and so on.

WIN.SPUSH

235

Syntax

WIN.SPULL

Examples

The following example saves the current screen, executes the SORT statement, then restores thescreen to show the SORT results. The SORT statement is not shown at the database prompt.

* Save the current screenCALL WIN.SPUSHEXECUTE "SORT CUSTOMER BY NAME CITY"* Restore the screen after executing the sortCALL WIN.SPULL

Related Subroutines

WIN.SPUSH


Screen Restore, Screen Remove

WIN.SPUSHThis subroutine stores the current screen in memory.

Restore the screen with WIN.SPULL.

Syntax

WIN.SPUSH

Examples

The following example saves the current screen, executes the SORT statement, then restores thescreen to show the SORT results. The SORT statement is not shown at the database prompt.

* Save the current screenCALL WIN.SPUSHEXECUTE "SORT CUSTOMER BY NAME CITY"* Restore the screen after executing the sortCALL WIN.SPULL

Related Subroutines

WIN.SPULL


Screen Restore, Screen Remove

WIN.SREMOVEThis subroutine deletes the screen that is stored in PC memory by the WIN.SSTORE subroutine.


236

Syntax

WIN.SREMOVE (NAME)

Parameters

The following table describes the parameters of the WIN.SREMOVE command:


NAME The name of the host file where the screen is stored

Examples


*PRINT @(5,20):"Enter M to see how the mouse can be programmed to selectoptions":PRINT @(0,22):"Enter your choice or * to quit:"CALL WIN.SSTORE("demo");* Store current screen in memory...*CALL WIN.SREMOVE("demo") ;* Delete saved screenCALL WIN.COLOR("off","") ;* Turn off colouring of text

Related Subroutines

WIN.SSTORE, WIN.SSAVE, WIN.SLOAD


Screen Remove

WIN.SRESTOREThis subroutine restores a screen that is saved in PC memory by WIN.SSTORE.

Syntax

WIN.SRESTORE (NAME)

Parameters

The following table describes the parameters of the WIN.SRESTORE command:


NAME The name of the screen stored in memory with WIN.SSTORE

Examples


* Run a demonstration1000 CALL WIN.COLOR("off",""); * Turn off text colouring

WIN.SSAVE

237

CALL @EXECSUB(PROG, '',0); * Execute/Perform programPRINT @(-1):CALL WIN.SRESTORE("demo");* Restore menu screenRETURN

Related Subroutines

WIN.SSTORE, WIN.SREMOVE, WIN.SSAVE


Screen Restore

WIN.SSAVEThis subroutine saves the current screen.

It can be restored with WIN.SLOAD.

Syntax

WIN.SSAVE (FILE)

Parameters

The following table describes the parameters of the WIN.SSAVE command:


FILE The name of the PC file that will store the screen

Examples

The following example saves the current screen named white1 (white background, black text).

* Then the program executes a sort statement* to a new screen (blue background, magenta text).* When the user enters a carriage return after* the report, the screen returns to white 1.* Save the current screenCALL WIN.SSAVE("white1")CALL WIN.COLOR("Magenta", "Blue")EXECUTE "SORT CUSTOMER BY NAME CITY"INPUT DUM* Restore the screen after executing the sortCALL WIN.SLOAD("white1")

Related Subroutines

WIN.SLOAD, WIN.SSTORE, WIN.SRESTORE


Screen Save


238

WIN.SSTATEThis subroutine saves the current screen state (cursor position, current effects, and so on) and restoresit.

Syntax

WIN.SSTATE (OLD.STATE, NEW.STATE)

Parameters

The following table describes the parameters of the WIN.SSTATE command:


OLD.STATE The state of the screen before the changeNEW.STATE The change to the screen; null if there is no change

Examples

The following example saves the screen during a program.

*CALL WIN.SSTATE(OLD.STATE,"")CALL WIN.COLOR("White","Blue")...*GOSUB 120; * Restore effect we changedCALL WIN.TWCLOSE("INFO")CALL WIN.SSTATE("",OLD.STATE)*STOP

Related Subroutines

WIN.SSAVE, WIN.SSTORE, WIN.SREMOVE


Cursor(6)

WIN.SSTOREThis subroutine stores the current screen in memory.

The saved screen is restored with WIN.SRESTORE. WIN.SSTORE stores the screen in the PCmemory, and WIN.SSAVE saves the screen to a PC file.

Syntax

WIN.SSTORE (NAME)

WIN.STACK

239

Parameters

The following table describes the parameters of the WIN.SSTORE command:


NAME The name that you give to the stored screen

Examples


*PRINT @(5,20):"Enter M to see how the mouse can be programmed to selectoptions":PRINT @(0,22):"Enter your choice or * to quit:"CALL WIN.SSTORE("demo");* Store current screen in memory...*CALL WIN.SREMOVE("demo") ;* Delete saved screenCALL WIN.COLOR("off","") ;* Turn off colouring of text

Related Subroutines

WIN.SRESTORE, WIN.SSAVE, WIN.SREMOVE


Screen Store

WIN.STACKThis subroutine turns on and off the database line stacker. All lines that are typed into the computerare recorded after WIN.STACK is turned on.

Use this routine in a program where you have previously called WIN.TCL with the ".E" to display theTCL Command Stack dialog box. You might want to use this routine if you want to use the stack ofcommands on another host.

Note: You can also run the PC script wintsys\script\TCLStack.wis to edit lines.

Syntax

WIN.STACK (TURN.ON)

Parameters

The following table describes the parameters of the WIN.STACK command:


TURN.ON 0 or "OFF" - Turns off the line stacker

1 or "ON" - Turns on the line stacker


240

Related Subroutines

WIN.STACKOFF, WIN.STACKON

WIN.STACKOFFThis subroutine turns off the capture of ECL commands for the TCL command stack.

These routines are used with the TCL Command Stack—a small dialog box that contains a list of themost current commands that were issued from the database prompt.

See the WIN.TCL subroutine with the ".E" option.

Syntax

WIN.STACKOFF

Related Subroutines

WIN.STACKON, WIN.STACK, WIN.TCL

WIN.STACKONThis subroutine turns on the capture of ECL commands for the TCL command stack.

These routines are used with the TCL Command Stack—a small dialog box that contains a list of themost current commands that were issued from the database prompt.

See the WIN.TCL subroutine with the ".E" option.

Syntax

WIN.STACKON

Related Subroutines

WIN.STACKOFF, WIN.STACK, WIN.TCL

WIN.STATLINEThis subroutine displays a line of text on the wIntegrate status bar.

Syntax

WIN.STATLINE (TEXT)

Parameters

The following table describes the parameters of the WIN.STATLINE command:


TEXT The text that you want to display on the status bar

WIN.TADEMO

241

Examples

The following example informs the user what is happening while the report is generated and recordedto a file.

* Record a report to file "recrept.txt"CALL WIN.RECON("recrept.txt", 1)* Demonstrate status bar textCALL WIN.STATLINE("Selecting data...")* Run a reportEXECUTE "LIST STUDENT LNAME MAJOR"CALL WIN.STATLINE("Creating report...")* Turn off recordingCALL WIN.RECOFF(1)*INPUT DUMCALL WIN.STATLINE("Displaying report...")* Display the report on the screenCALL WIN.PLAYBACK("recrept.txt")CALL WIN.STATLINE("")END


Print

WIN.TADEMOThis subroutine demonstrates the use of type-ahead using WIN.DBTYPEAH and related subroutines.

Syntax

WIN.TADEMO

Related Subroutines

WIN.DBTYPEAH, WIN.DBEVENTR, WIN.DBKEY

Version

6.0.1 Original

WIN.TASKThis subroutine checks to see whether a Windows task is running. The task name must be exactly as itdisplays in the Windows task list (usually the title of the main application window).

Syntax

WIN.TASK (TASKNAME, RUNNING)

Parameters

The following table describes the parameters of the WIN.TASK command:


242


TASKNAME The name of the window as it is shown in the Windows task list. If thetaskname is null, the subroutine activates the wIntegrate window.

RUNNING Returns 0 if not running; returns 1 if running

Examples

The following example prints out a message if the task is not running.

* If the task is running, WIN.ACTIVATE changes the focus * to the Notepad document and prints the report name on the first line.* Verify the report "recrept.txt" is runningCALL WIN.TASK("Notepad - RECREPT.TXT", RUNNING)IF RUNNING THEN GOSUB 100 ELSEPRINT "recrept.txt is not running, open it and try again"RETURN100 * Change the active window from wIntegrate to NotepadCALL WIN.ACTIVATE("Notepad - RECREPT.TXT")* Send the report name to the Notepad reportCALL WIN.SENDKEYS("STUDENT REPORT", 1)RETURNEND

Related Subroutines

WIN.APP


IsTask

WIN.TCLThis subroutine saves the current screen and enters the database or ECL (TCL) interpreter. You canenter WIN.TCL at the database prompt, and then a "?" to display the full list of available commands.

The commands available are:

▪ .E turns on the ECL stacker.▪ .W starts the wIntegrate command line as in the WIN.COMLINE subroutine.▪ .A starts the Query Builder Dialog Box. For more information about Query Builder, see the

wIntegrate User Guide.▪ EX quits the TCL interpreter and restores the screen.▪ Q quits the TCL interpreter and restores the screen.▪ ? lists the available commands.

Syntax

WIN.TCL

Related Subroutines

WIN.STACK, WIN.STACKON, WIN.STACKOFF, WIN.TCL

WIN.TITLE

243

WIN.TITLEThis subroutine sets the title for a wIntegrate session. The title appears in the title bar of thewIntegrate window.

Syntax

WIN.TITLE (TITLE)

Parameters

The following table describes the parameters of the WIN.TITLE command:


TITLE The new name of the wIntegrate session

Examples

The following example puts the wIntegrate version in the title.

* Return the wIntegrate version numberCALL WIN.VERSION(VERSION)PRINT "You are running wIntegrate version ": VERSION* Change the Title to "wIntegrate x.x"CALL WIN.TITLE("wIntegrate ":VERSION)END


Set Title

WIN.TRANSFERThis subroutine is the host side of the file transfer routines (Run > Import File, Run > Export File, andRun > Bridge Copy).

If file transfers are executed from within a host program, WIN.TRANSFER must be executed to enablethe host side of the transfer to operate.


Syntax

WIN.TRANSFER

Examples

The following example is of a simple host menu that allows file transfers.

* At a host menu input the user can enter options to run host programs.* Also allow for files transfer initiated from the PC to start the host* side of the file transfer, removing the need for the user to* run file transfers at the command prompt (ECL)INPUT CMND: ;* from keyboard or wIntegrate program


244

BEGIN CASECASE CMND = 1 ;* User keyboard input EXECUTE "CUST.MAINT"CASE CMND = 2 ;* User keyboard input EXECUTE "PROD.MAINT"CASE CMND = "WIN.TRANSFER"; * From Run File Import/Export etc EXECUTE "WIN.TRANSFER"CASE CMND = "WIN.SERVER"; * From Query Builder etc. EXECUTE "WIN.SERVER"END CASE

The following example runs a file transfer from a script on the host.

READ TRANSFER.SCRIPT FROM SCRIPT.FILE, "CUST.IMPORT" THEN CALL WIN.HSCRIPT(TRANSFER.SCRIPT) EXECUTE "WIN.TRANSFER"END

Related Subroutines

WIN.IMPORT, WIN.EXPORT

WIN.TWCLOSEThis subroutine closes a text window opened with WIN.TWOPEN.

Syntax

WIN.TWCLOSE (NAME)

Parameters

The following table describes the parameters of the WIN.TWCLOSE command:


NAME The name of the text window that is specified in WIN.TWOPEN

Examples

The following example is a part of the WIN.TWDEMO demonstration program.

*PRINT @(0,22) : 'Press <CR> to create DEMO1 window ':INPUT DUM:CALL WIN.COLOR("Yellow","blue")CALL WIN.TWOPEN("DEMO1","Text window DEMO1",10,13,75,16,2)PRINT "This window was created with:-"PRINT 'CALL WIN.TWOPEN("DEMO1","Text window DEMO1",10,13,75,16,2)'PRINTPRINT 'Press <CR> to create DEMO2 window ':INPUT DUM:CALL WIN.TWOPEN("DEMO2","Text window DEMO2", 34,2,72,6,1)PRINT 'We now have two windows opened using WIN.TWOPEN, DEMO1 & DEMO2, ':PRINT 'which we can switch between with WIN.TWUSE'PRINTPRINT 'Press <CR> to go to the DEMO1 window ':INPUT DUM:

WIN.TWFOOT

245

CALL WIN.TWUSE("DEMO1")PRINT @(-1):'We are now back in our DEMO1 window. This was achieved by the call'PRINT ' CALL WIN.TWUSE("DEMO1")'PRINT 'Press <CR> to close both windows and continue ':INPUT DUM:CALL WIN.TWCLOSE("DEMO1")CALL WIN.TWCLOSE("DEMO2")

Related Subroutines

WIN.TWOPEN, WIN.TWFOOT, WIN.TWPULL, WIN.TWPUSH, WIN.TWMSG


Screen Restore, Screen ScrollRegion

WIN.TWFOOTThis subroutine adds a footer to a text box created with the WIN.TWOPEN subroutine.

Syntax

WIN.TWFOOT (NAME, TEXT, POS)

Parameters

The following table describes the parameters of the WIN.TWFOOT command:


NAME The name of the textbox created with WIN.TWOPENTEXT The text of the footerPOS Specifies the position of the text on the line:

L - Left-justified

R - Right-justified

C - Centered on the line

Examples


* Set up box to display informationCALL WIN.COLOR("White","Blue")CALL WIN.TWOPEN("INFO","Information",1,18,78,22,"DOUBLE")CALL WIN.COLOR("Black","White")CALL WIN.TWFOOT("INFO","Press <CR> to continue","R")CALL WIN.COLOR(TEXT.COL,"Blue")

Related Subroutines

WIN.TWOPEN, WIN.TWMSG, WIN.TWPULL, WIN.TWPUSH, WIN.TWCLOSE


246

WIN.TWMSGThis subroutine opens a text message window called "MSG", which is centered on the screen. Closethis window with a call to WIN.TWCLOSE("MSG").

Syntax

WIN.TWMSG (TEXT, FGCOL, BGCOL, BORDER)

Parameters

The following table describes the parameters of the WIN.TWMSG command:


TEXT The text to display in the message window.FGCOL The foreground or text color. See WIN.COLOR, on page 21 for available

colors.BGCOL The background color. See WIN.COLOR, on page 21 or the colors.BORDER Specifies the style for the window:

SPACES - blank border

SINGLE - single-line border

DOUBLE - double-line border

MIX - alternate dots and block

BLOCK - solid block

Examples


* Create and show dialog100 DBX=''DLG.NAME="DemoDlg"CALL WIN.TWMSG("Creating Dialog ":DLG.NAME:"...", "Red", "Yellow", "DOUBLE")

Related Subroutines

WIN.TWOPEN, WIN.TWCLOSE

WIN.TWOPENThis subroutine opens a text window on the wIntegrate screen. A text window scrolls independentlyof the main wIntegrate window. You can have several of these boxes active at the same time, whichmeans that each of them requires a unique name.

If you want to display more than one text window at a time, you can show them in different parts ofthe screen using WIN.TWUSE. If you want one window on top of another, use WIN.TWPUSH to “push”a window on top of an already active one, and WIN.TWPULL to “pull” the various text windows off themain screen.

WIN.TWOPEN

247

Syntax

WIN.TWOPEN (NAME, TITLE, LEFT, TOP, RIGHT, BOTTOM, STYLE)

Parameters

The following table describes the parameters of the WIN.TWOPEN command:


NAME The name or identifier of the text window; how the program will identify thistext window for other subroutines

TITLE The title of the text window; displays at the top of the text window. To add afooter to the window, see WIN.TWFOOT, on page 245

LEFT Specifies the coordinate for the left side of the boxTOP Specifies the coordinate for the top of the boxRIGHT Specifies the coordinate for the right side of the boxBOTTOM Specifies the coordinate for the bottom of the boxSTYLE Style of the box; see the following Style table

Values for STYLE

Value Description

"SPACES" Blank border"SINGLE" Single-line border"DOUBLE" Double-line border"MIX" Alternate dot and block"BLOCK" Solid block

Examples


It shows how to open two different text windows.

*PRINT @(0,22) : 'Press <CR> to create DEMO1 window ':INPUT DUM:CALL WIN.COLOR("Yellow","blue")CALL WIN.TWOPEN("DEMO1","Text window DEMO1",10,13,75,16,2)PRINT "This window was created with:-"PRINT 'CALL WIN.TWOPEN("DEMO1","Text window DEMO1",10,13,75,16,2)'PRINTPRINT 'Press <CR> to create DEMO2 window ':INPUT DUM:CALL WIN.TWOPEN("DEMO2","Text window DEMO2", 34,2,72,6,1)PRINT 'We now have two windows opened using WIN.TWOPEN, DEMO1 & DEMO2, ':PRINT 'which we can switch between with WIN.TWUSE'PRINTPRINT 'Press <CR> to go to the DEMO1 window ':INPUT DUM:CALL WIN.TWUSE("DEMO1")PRINT @(-1):'We are now back in our DEMO1 window. This was achieved by the call'PRINT ' CALL WIN.TWUSE("DEMO1")'PRINT 'Press <CR> to close both windows and continue ':INPUT DUM:


248

CALL WIN.TWCLOSE("DEMO1")CALL WIN.TWCLOSE("DEMO2")

Related Subroutines

WIN.TWMSG, WIN.TWCLOSE, WIN.TWFOOT, WIN.TWPULL, WIN.TWPUSH


Screen Store, Screen ScrollRegion, Display Box

WIN.TWPULLThis subroutine “pulls” or closes stacked text windows created by the WIN.TWPUSH subroutine. Itcloses the last window opened if there are multiple windows.

Syntax

WIN.TWPULL

Examples


*CALL WIN.COLOR("White","Red")CALL WIN.TWPUSH("Stacked window 1", 20, 5, 60, 17, 3)PRINTPRINT "This window was created with:-"PRINTPRINT ' CALL WIN.TWPUSH("Stacked window 1", 20, 5, 60, 17, 3)'PRINTPRINT 'Press <CR> to stack another window':INPUT DUM:*CALL WIN.TWPUSH("Stacked window 2",30,3,55,15,2)PRINT 'This window was created'PRINT 'on top of the last with'PRINTPRINT 'CALL WIN.TWPUSH("Stacked window 2",30,3,55,15,2)'PRINTPRINT 'Press <CR> to remove this'PRINT 'window from the stack' :INPUT DUM:CALL WIN.TWPULLPRINT @(-1):'We got back here by calling'PRINT ' CALL WIN.TWPULL'PRINTPRINT 'Press <CR> to continue':INPUT DUM:CALL WIN.TWPULL

Related Subroutines

WIN.TWPUSH

WIN.TWPUSH

249



WIN.TWPUSHThis subroutine opens a stackable text window. If you want one text window to display on top ofanother, use WIN.TWPUSH to “push” a window on top of an already active one, and WIN.TWPULL to“pull” the various text windows off the main screen.

Syntax

WIN.TWPUSH (TITLE, LEFT, TOP, RIGHT, BOTTOM, STYLE)

Parameters

The following table describes the parameters of the WIN.TWPUSH command:


TITLE The title of the text windowLEFT Specifies the coordinate for the left side of the boxTOP Specifies the coordinate for the top of the boxRIGHT Specifies the coordinate for the right side of the boxBOTTOM Specifies the coordinate for the bottom of the boxSTYLE Style of the box; see the following Style table

Values for STYLE

Value Description

"SPACES" Blank border"SINGLE" Single-line border"DOUBLE" Double-line border"MIX" Alternate dot and block"BLOCK" Solid block

Examples


*CALL WIN.COLOR("White","Red")CALL WIN.TWPUSH("Stacked window 1", 20, 5, 60, 17, 3)PRINTPRINT "This window was created with:-"PRINTPRINT ' CALL WIN.TWPUSH("Stacked window 1", 20, 5, 60, 17, 3)'PRINTPRINT 'Press <CR> to stack another window':INPUT DUM:*CALL WIN.TWPUSH("Stacked window 2",30,3,55,15,2)PRINT 'This window was created'PRINT 'on top of the last with'


250

PRINTPRINT 'CALL WIN.TWPUSH("Stacked window 2",30,3,55,15,2)'PRINTPRINT 'Press <CR> to remove this'PRINT 'window from the stack' :INPUT DUM:CALL WIN.TWPULLPRINT @(-1):'We got back here by calling'PRINT ' CALL WIN.TWPULL'PRINTPRINT 'Press <CR> to continue':INPUT DUM:CALL WIN.TWPULL

Related Subroutines

WIN.TWPULL


Screen Store, Screen ScrollRegion

WIN.TWUSEThis subroutine switches focus between two or more text windows.

Create text windows with the WIN.TWOPEN subroutine, and close them with WIN.TWCLOSE.

Syntax

WIN.TWUSE (NAME)

Parameters

The following table describes the parameters of the WIN.TWUSE command:


NAME The name of the text window to display

Examples


CALL WIN.TWOPEN("DEMO2","Text window DEMO2", 34,2,72,6,1)PRINT 'We now have two windows opened using WIN.TWOPEN, DEMO1 & DEMO2, ':PRINT 'which we can switch between with WIN.TWUSE'PRINTPRINT 'Press <CR> to go to the DEMO1 window ':INPUT DUM:CALL WIN.TWUSE("DEMO1")PRINT @(-1):'We are now back in our DEMO1 window. This was achieved by the call'PRINT ' CALL WIN.TWUSE("DEMO1")'PRINT 'Press <CR> to close both windows and continue ':INPUT DUM:CALL WIN.TWCLOSE("DEMO1")CALL WIN.TWCLOSE("DEMO2")

WIN.USESTYLE

251

Related Subroutines

WIN.TWOPEN, WIN.TWCLOSE



WIN.USESTYLEThis subroutine turns on effect drawing. Use this subroutine when using chiselled effect styles.

Syntax

WIN.USESTYLE (USE.STYLE)

Parameters

The following table describes the parameters of the WIN.USESTYLE command:


USE.STYLE True or False flag to turn on the chiselled effect style

Examples


* Raised input only230 TEXT = "For an easy Chiselled effect we will just raise the input fields"TEXT = TEXT : " which are currently displayed in REVERSE."GOSUB 2000;* Print textPRINTTEXT = "Before any Chiselled effects will be displayed they must be"TEXT = TEXT : " enabled first."GOSUB 2000;* Print TextGOSUB 1000;* Continue promptCALL WIN.USESTYLE(TRUE)CALL WIN.SETEFFCT("Reverse","Black","LightGray","Raised",0)PRINT 'Enable Styles:'PRINT 'Reverse to Raised:'CALL WIN.COLOR(CODE.COL,"")PRINT @(18,0):"CALL WIN.USESTYLE(TRUE)":PRINT @(18,1):'CALL WIN.SETEFFCT("Reverse","Black","LightGray","Raised",0)'CALL WIN.COLOR(TEXT.COL,"")GOSUB 1000;* Continue promptRETURN

Related Subroutines

WIN.SETEFFCT, WIN.EFILL


Effect, EffectExtent


252

WIN.VERSIONThis subroutine returns the version number of the running wIntegrate session.

Syntax

WIN.VERSION (VERSION)

Parameters

The following table describes the parameters of the WIN.VERSION command:


VERSION Variable set to the current version number of wIntegrate

Examples

The following example returns the wIntegrate version number.

CALL WIN.VERSION(VERSION)PRINT "You are running wIntegrate version ": VERSION

Related Subroutines

WIN.SERIAL


The built-in Version constant.

WIN.XLADDWSThis subroutine adds a worksheet from an Excel file to an existing Excel file.

Excel must be installed on the PC to use this routine. The final file will be written in the format for theversion of Excel that is installed on the PC.

The source of this subroutine is an example of using the WIN.OB subroutines to automate Excel.

Syntax

WIN.XLADDWS (XLFILE, ADDFILE, OPTS, RESP)

Parameters

The following table describes the parameters of the WIN.XLADDWS command:


XLFILE The file name of the Excel file to add the worksheet to.ADDFILE The Excel file containing the worksheet to add.OPTS The number of the worksheet to add the worksheet after. For example, the

first worksheet is number 1; the second is number 2. The worksheet mustexist in the file, or an error will be shown in the Script Monitor.

WIN.XLADDWS

253


RESP The result of the command. See the following table. If a file cannot be found,then Excel will display an error message.

Values for RESP

The following error codes are returned:

Value Description

0 No error.1 Unable to open XLFILE.2 Unable to get the Automation interface to XLFILE.3 Unable to open ADDFILE.4 Unable to get the Automation interface to ADDFILE.

Examples

The following example adds XLMORD1 to 5 to XLMTEST.

* USERDIR is the folder containing the files*MAIN.FILE = USERDIR:"XLMTEST.XLS"*PREFIX = "XLMORD"RESP = ""*FOR J = 1 TO 5 ADD.FILE = PREFIX:J:".XLS" PRINT "Adding ":ADD.FILE:"...": ADD.FILE = USERDIR:ADD.FILE CALL WIN.XLADDWS(MAIN.FILE, ADD.FILE, J, RESP) IF RESP = 0 THEN PRINT "Succeeded" END ELSE PRINT "Failed. Error code ":RESPNEXT J*

Related Subroutines

WIN.OBGET, WIN.OBSET, WIN.OBSETPRP, WIN.OBREL, WIN.OBMETHOD

Version

4.3/5.0.1 Original

254

Chapter 3: Using host subroutinesThe Host Program Demonstration WIN.DEMO shows how the supplied subroutines can drive desktopfunctionality. The subroutines accept parameters and generate script statements that are sent to thePC for execution.

Prerequisite

Before you can run the WIN.DEMO demonstration, the wIntegrate application and host programsmust be installed. See the information about installing the application, host programs, and starting asession in the wIntegrate Installation and Configuration manual.

About this task

The WIN.DEMO program gives you a chance to see how the wIntegrate subroutines work and howto develop your application interface with them. At the end of each section, there is a list of relatedsubroutines. Find complete descriptions and examples in Host subroutines, on page 12.

This main demonstration program incorporates several other demonstration programs that youcan run independently from the database prompt. You can also view the code of any wIntegratesubroutine or demonstration programs in the WIN.PROGS directory.

The following steps describe how to use the WIN.DEMO program.

Procedure

1. Click the Windows Start button and select All Programs > wIntegrate > wIntegrate.2. At the prompt, enter your user name and password, and enter the account name or path to which

you want to connect.

WIN.DEMO options

255

3. When you are logged in, type WIN.DEMO, and press Enter.The Host Program Demonstration appears.

Figure 1: WIN.DEMO

The main screen of the WIN.DEMO program appears with a list of wIntegrate functions to select.4. Select any of the functions by entering the corresponding number and pressing Enter. You can

also click an option number to select it.

Results

You are given a choice of options showing how easy it is to get powerful results from wIntegrate withminimum programming effort. Each option shows the relevant line of Basic code that is used by thehost program. All of the wIntegrate subroutines are fully described in Host subroutines, on page 12.

WIN.DEMO optionsThe following section provides examples of each function from the WIN.DEMO program.

Bar graphs

Select option 1 to display a bar graph.

Chapter 3: Using host subroutines

256

Figure 2: Bar graph

You can combine multiple bar graphs, pie charts, and images on one screen. The program thatdisplays this graph is WIN.BARDEMO, which you can run from the database prompt.

Host subroutines

Subroutine Description

WIN.BARSUB This subroutine uses the wIntegrate draw commands to create a bar chart.

Pie charts

Select option 2 to display a pie chart.

Images

257

Figure 3: Pie chart

The program that displays this chart is WIN.PIEDEMO, which you can run from the database prompt.

Host subroutines


WIN.PIESUB This subroutine draws a pie chart on the screen.

Images

Select option 3 to display an image.


258

Figure 4: Image

The program that displays this image is WIN.IMDEMO, which you can run from the database prompt.

Host subroutines


WIN.IMAGE This subroutine displays an image on the wIntegrate screen.WIN.IMCHANGE This subroutine changes an image that was opened by WIN.IMOPEN.WIN.IMCLOSE This subroutine closes a PC image file that was opened with the WIN.IMOPEN

subroutine.WIN.IMOPEN This subroutine opens a window to contain a PC image file on the wIntegrate

screen.

Drawings

Select option 4 to display the drawing capabilities of wIntegrate.

Drawings

259

Figure 5: Drawings

As with images, charts, and graphs, all the drawing features are scaled when the window size ischanged.

The program that displays the drawings is WIN.DRDEMO, which you can run from the databaseprompt.

Between each topic of this demonstration, the WIN.DRERASE subroutine is called to clear thedrawings.

Pen Styles

The pen determines the outlines of shapes and sets the text foreground color.


260

Figure 6: Drawings demo - Pen Style

Brush Styles

The brush determines the inside of draw objects and sets the text background color.

Figure 7: Drawings demo - Brush Style

Shapes

wIntegrate can draw lines, rectangles, polygons, and ellipses.

Drawings

261

Figure 8: Drawings demo - Shapes

Text

You can display text in any font available to Windows, including the graphics font sets such as Symbol.

Figure 9: Drawings demo - Text

Host subroutines


WIN.DRARC This subroutine draws the arc of an ellipse within a rectangle defined by theparameters X1,Y1 to X2,Y2.

WIN.DRBRUSH This subroutine changes the color and style of the brush used in other drawroutines.


262


WIN.DRCHORD This subroutine draws the chord of an ellipse within a rectangle defined by theparameters X1,Y1 to X2,Y2.

WIN.DRELL This subroutine draws an ellipse within a rectangle defined by the parametersX1,Y1 to X2,Y2.

WIN.DRERASE This subroutine erases objects drawn by any of the draw routines (WIN.DR).WIN.DRFONT This subroutine sets the font for calls to WIN.DRTEXT.WIN.DRLINE This subroutine draws a line from X1,Y1 to X2,Y2.WIN.DRMOVE This subroutine moves the graphics cursor to a new position specified by X and

Y, but does not draw anything.WIN.DRPEN This subroutine changes the color, style, and width of the pen used in drawing.WIN.DRPIE This subroutine draws a pie segment of an ellipse within a rectangle defined by

the parameters X1,Y1 to X2,Y2.WIN.DRPOLY This subroutine draws a polygon by joining the vertices specified in points.WIN.DRRECT This subroutine draws a rectangle defined by the parameters X1,Y1 to X2,Y2.WIN.DRTEXT This subroutine draws text within a rectangle on the screen.

Colors

Select option 5 to display the available colors.

Figure 10: Colors

Screen and text colors can be changed in Setup > Colors. See the wIntegrate User Guide forinstructions.

Text windows

263

Host subroutines


WIN.COLOR This subroutine sets the current color on the terminal.WIN.COLOUR Same as WIN.COLOR.

Text windows

Select option 6 to get a demonstration on how to create text windows on the host screen. You cancreate simultaneous windows and switch between them, or create stacked windows that must beremoved from the stack in reverse order.

Figure 11: Text windows


264

Figure 12: Text windows - Stacked

The program that displays text windows is WIN.TWDEMO, which you can run from the databaseprompt.

Host subroutines


WIN.TWCLOSE This subroutine closes a text window opened with WIN.TWOPEN.WIN.TWFOOT This subroutine adds a footer to a text box created with the WIN.TWOPEN

subroutine.WIN.TWMSG This subroutine opens a text message window called "MSG", which is centered

on the screen.WIN.TWOPEN This subroutine opens a text window on the wIntegrate screen.WIN.TWPULL This subroutine “pulls” or closes stacked text windows created by the

WIN.TWPUSH subroutine.WIN.TWPUSH This subroutine opens a stackable text window.WIN.TWUSE This subroutine switches focus between two or more text windows.

Hot spots

Select option 7 to display hot spots, which are areas of the screen that trigger a script when clicked on.Ctrl, Shift, and Ctrl+Shift click combinations are supported.

DDE Demo

265

Figure 13: Hot spots

You might want to display images or charts on the screen and define these areas as hot spots leadingto other displays or actions.

The program that displays hot spots is WIN.HSDEMO, which you can run from the database prompt.

Host subroutines


WIN.HOTSPOT This subroutine creates hot spots on the screen.WIN.HOTSPOT2 Same as WIN.HOTSPOT.

DDE Demo

Select option 8 to demonstrate the power of Dynamic Data Exchange (DDE), a host program thatcontrols another PC application.

DDE is a Windows convention that wIntegrate incorporates as a server and as a client. For example,you can use wIntegrate to send or to receive data from another application.


266

Figure 14: DDE Demo

The program that runs the DDE demo is WIN.DDEDEMO, which you can run from the databaseprompt.

Running the demonstration

After you select the DDE Demo option 7 from the main WIN.DEMO screen, you see the relatedBasic program code lines to use when developing an application that calls and controls anotherapplication, as seen in the previous figure. The following steps walk you through how to continue thedemonstration.

1. Type Y and press Enter to continue the demonstration.The program first checks if Excel is already running, and starts Excel if it is not started. IfwIntegrate cannot successfully start Excel, start it yourself then return to wIntegrate and run theDDE demo again.

2. Resize the Excel window so that you can view both it and the window screen.3. From the wIntegrate window, press Enter after you read what the demo is doing and to proceed

to the next screen. Continue following the demo’s instructions.Depending on your version of Excel, you might need to create a new blank Sheet1 if it is notalready created. This means, for example, if you are on Excel 2013, you must click Blankworkbook from the Excel start screen to continue the wIntegrate demo.

Some descriptions and numbers are sent to the Excel spreadsheet. A SUM command is sent to anothercell to total the numbers. Finally, the columns are selected and the “Format Column Width Best Fit”command is executed so that the columns accommodate the data correctly.

The following figure shows the result of the DDE in Excel.

Menus

267

Figure 15: Excel results

Host subroutines


WIN.DDECLOSE This subroutine stops a DDE conversation with another Windows application.WIN.DDEEXEC This subroutine executes a macro or command in another application using

DDE.WIN.DDEEXEC2 Same as WIN.DDEEXEC.WIN.DDEOPEN This subroutine starts a DDE conversation between wIntegrate and another

Windows application that supports DDE.WIN.DDEPOKE This subroutine sends data from wIntegrate to another Windows application

using DDE.WIN.DDEREQ This subroutine gets data from another Windows application using DDE.WIN.DDETIME This subroutine sets the timeout for the DDE link.

Menus

Select option 9 to display how you can create wIntegrate menus from the host.


268

Figure 16: Menu

The program that displays the menu is WIN.MENUDEMO, which you can run from the databaseprompt.

The code for this demo program can be especially useful if you need to learn how to create and attachmenus and submenus.

The first menu is a pop-up menu. Click Attached to Main to see the same menu appear on theWindows menu bar. Click Exit Demo to return to the main demonstration menu.

Host subroutines


WIN.MENUATT This subroutine attaches a submenu to an existing menu.WIN.MENUDEL This subroutine deletes a menu from the computer's memory.WIN.MENUDET This subroutine detaches a submenu from a menu.WIN.MENUIN This subroutine enables a submenu, then waits for input. When it receives

input, it is disabled.WIN.MENULOAD This subroutine loads a menu to the PC before it is attached or shown on the

main menu bar.WIN.MENULDF Alternative version of WIN.MENULOAD.

Dialog box lookup

Select option 10 to show how to create a Windows dialog box that can look up items for selection bythe user.

Dialog boxes

269

Figure 17: Dialog box lookup

The program that displays the dialog box lookup is WIN.LUDEMO, which you can run from thedatabase prompt.

Host subroutines


WIN.LOOKUP This subroutine displays a dialog box from which the user can make a selection.WIN.LOOKUPM This subroutine displays a dialog box from which the user can make one or

more selections.

Dialog boxes

Select option 11 to show how a dialog box is created and driven from a host program.

This demonstration of the host-driven GUI is very significant for developers of multi-valued systems.It shows how a dialog box can be driven from a host Basic program in the same way as a characterscreen.

The host program has field-by-field control over the logic. After each user input, it can validate theinput, set defaults for other fields, and determine which field should have the focus for the next input.

Two events are generated after each field is entered – the validation event and the default event.This demonstration shows the validation events only in a blue window on the character screen.The logic has to throw away the default event if the validation event fails, and the user has to be re-prompted for that field. Note whether the Editor has the ability to add a host-driven dialog box to aBasic program; for more information about the Editor, see the Client Scripting Reference.


270

Figure 18: Dialog box


After you select the Dialog Box demo option 11 from the main WIN.DEMO screen, you see steps onhow to use WIN.DB subroutines to define a dialog box, as seen in the previous figure. The followingsteps walk you through how to continue the demonstration.

1. Press Enter to continue the demonstration.A dialog box appears with the Events Received block on the wIntegrate screen, as shown in thefollowing figure.

Figure 19: Dialog box demonstration

2. Click a control in the dialog box.An appropriate message is sent to the host, as shown in the following figure.

Dialog boxes

271

Figure 20: Dialog box demonstration with messages sent to host

3. Continue clicking controls to define the dialog box. When you are done, click OK to save and closethe dialog box.The values of each control are sent to the host, as shown in the following figure.

Figure 21: Dialog box demonstration with values of each control

Host subroutines


WIN.DBANIM This subroutine adds an animation control to a dialog box.WIN.DBATTACH This subroutine attaches a modal dialog box to an existing dialog box.


272


WIN.DBAXCTRL This subroutine adds an ActiveX control to a dialog box.WIN.DBBOX This subroutine adds a 3D box or line to a dialog box. This is used as a visual

way to enclose or separate area of the dialog box.WIN.DBBUTTON This subroutine adds a raised rectangle push button to a dialog box.WIN.DBCAPT This subroutine changes the caption of an existing window or button.WIN.DBCHECK This subroutine adds a square check box to a dialog box.WIN.DBCHILD This subroutine attaches a modeless dialog box to an existing dialog box.WIN.DBCOMBO This subroutine adds a combo box to a dialog box. A combo box is a text field or

edit field combined with a list box.WIN.DBCTRL This subroutine adds a control of the specified class to the dialog box.WIN.DBDEL This subroutine deletes a dialog box that was loaded using WIN.DBLOAD.WIN.DBDTTIME This subroutine adds a date/time control to a dialog box. The date/time control

displays a control into which provides entry of a date, a time, or both.WIN.DBEDGET This subroutine gets data from a multi-line edit box.WIN.DBEDGET2 Improved version of WIN.DBEDGET.WIN.DBEDIT This subroutine adds a box that you can use to edit or enter text to a dialog box.WIN.DBEDSET This subroutine sets the value of a multi-line edit control in a dialog box.WIN.DBENABLE This subroutine enables or disables dialog box controls.WIN.DBENALL This subroutine is similar to WIN.DBENABLE, but it enables or disables the

entire dialog box or all of the named controls in the dialog box.WIN.DBEND This subroutine ends the display of a dialog box.WIN.DBESTACK This subroutine reads the next event from a dialog box or menu defined

using the host routines and stores it in a variable for future processing byWIN.DBEVENT2.

WIN.DBEVENT This subroutine waits for an event and returns the event type.WIN.DBEVENT2 Improved version of WIN.DBEVENT.WIN.DBEVENTR This subroutine removes the events associated with the last control added to a

dialog box.WIN.DBEVENTS This subroutine sets up the events to be returned to the host for the dialog box

controls.WIN.DBFETCH This subroutine checks the next event if there is one pending, or returns TYPE

= "" if no event exists.WIN.DBFETCH2 Improved version of WIN.DBFETCH.WIN.DBFOCUS This subroutine sets the input focus to a dialog box control.WIN.DBGET This subroutine gets the current value of a control.WIN.DBGET2 Improved version of WIN.DBGET.WIN.DBGETM The subroutine gets the value of multiple controls in a dialog box in one call.

Using this routine is faster than multiple calls to WIN.DBGET.WIN.DBGETPRP This subroutine gets the value for a control’s property after it has been loaded

to the PC with WIN.DBLOAD.WIN.DBGETPRPL This subroutine gets the value for a control’s property after it has been loaded

to the PC with WIN.DBLOAD.WIN.DBGRID This subroutine adds a grid control to a dialog box. The grid control displays a

grid of cells.WIN.DBGROUP This subroutine adds a rectangle group box to a dialog box. A group box

contains a group of controls that logically belong together.

Dialog boxes

273


WIN.DBHEADER This subroutine adds a header control to a dialog box.WIN.DBHTML This subroutine adds an HTML control to a dialog box. An HTML control is an

area of the dialog box that displays text that has been specified using HTMLformat.

WIN.DBIMAGE This subroutine adds an image to a dialog box. You can use this subroutine ifyou want to add a graphic to a dialog box to illustrate a point or to add a logo.

WIN.DBIMBUT This subroutine adds an image as a push button to a dialog box.WIN.DBINIPRP This subroutine sets the initial value for a controls property when it is loaded to

the PC with WIN.DBLOAD.WIN.DBINIT This subroutine assigns a script command to be run whenever a dialog box is

shown.WIN.DBINPOK This subroutine verifies the input after a validate event.WIN.DBKEY This subroutine sets up user-defined keys for a dialog box.WIN.DBLABEL This subroutine adds a label to a dialog box. Use this when you want to display

the name of a text, edit, or list box.WIN.DBLIST This subroutine adds a list box to a dialog box.WIN.DBLISTVW This subroutine adds a list view control that displays a list of items with

optional images and additional information.WIN.DBLOAD This subroutine loads a dialog box.WIN.DBLOADF Alternative version of WIN.DBLOAD.WIN.DBMETHOD This subroutine runs a method on a control.WIN.DBMNSIZE This subroutine specifies the minimum size a dialog box can be resized to.WIN.DBMOVE This subroutine moves the position of a dialog box.WIN.DBMSGBOX This subroutine displays a message box that is attached to a dialog box. The

message box stops all data from going to the dialog box until the message boxis closed.

WIN.DBMSGBOX2 Improved version of WIN.DBMSGBOX.WIN.DBMSIZE This subroutine defines the maximum size of a dialog box, and determines the

increment rate of a scroll bar in a large dialog box.WIN.DBMVCTRL This subroutine moves a control on a dialog box that has been shown.WIN.DBNEVENT This subroutine returns the next event from a dialog box during validation of a

field if the dialog box options are set to V1 or V2 with WIN.DBOPTION.WIN.DBNEW This subroutine creates a new dialog box.WIN.DBOPTION This subroutine adds the options to a dialog box.WIN.DBPANEL This subroutine adds a divider that splits the dialog box into different areas that

are used to automatically position controls when the dialog box is resized.WIN.DBPOST This subroutine is used to put an event in the queue again after an event has

been checked by WIN.DBFETCH.WIN.DBPOST2 Improved version of WIN.DBPOST.WIN.DBPRGRES This subroutine adds a progress control to a dialog box. The progress control

displays a thick bar that is increased in length to show the progress of someaction.

WIN.DBRADIO This subroutine adds a radio button to a dialog box.WIN.DBRECT This subroutine returns the current position of a displayed dialog box or

control.WIN.DBSCROLL This subroutine adds a scroll bar to a dialog box.


274


WIN.DBSELECT This subroutine selects one of several options in a list or combo box dialog boxfield.

WIN.DBSET This subroutine sets dialog box controls that were previously created.WIN.DBSETCOL This subroutine sets the foreground and the background color of a specific

control within a dialog box.WIN.DBSETFNT This subroutine sets the font for a specific control within a dialog box.WIN.DBSETMNU This subroutine sets a previously created menu for use in a dialog box.WIN.DBSETPRP This subroutine sets the value for a control’s property after it has been loaded

to the PC with WIN.DBLOAD.WIN.DBSETPRPL This subroutine sets the value for a control’s property after it has been loaded

to the PC with WIN.DBLOAD.WIN.DBSHOW This subroutine displays the dialog box on the PC screen.WIN.DBSHOWPU This subroutine shows a dialog box as a window and automatically aligns it to

the specified control.WIN.DBSTATUS This subroutine verifies whether a dialog box is loaded to the PC and if it is

currently shown.WIN.DBTAB This subroutine adds a tab control to a dialog box. The tab control show tabs

across the dialog box.WIN.DBTABS This subroutine sets the location of the tab stops in a list box control.WIN.DBTEXT This subroutine creates a text control in a dialog box.WIN.DBTRACK This subroutine adds a trackbar control to a dialog box.WIN.DBTREEVW This subroutine creates a tree structure control for displaying items. A tree view

control is used to display hierarchical data.WIN.DBTYPEAH This subroutine turns on or off type-ahead processing for a dialog box.WIN.DBUNIT This subroutine is used to convert from dialog units to pixels.WIN.DBUPDOWN This subroutine adds a spin box (an edit box with up and down arrows) to a

dialog box.

Chiselled effects

Select option 13 to show steps for making a character screen look like a Windows dialog box. Thesechiselled effects do not change the operation of the host Basic program, which is not aware of thedifferent screen display. Here, the chiselled effects are based on emulation attributes, so the result isdependent on the way attributes are used. You can also assign effects to attributes manually in Setup> Colors.

Press Enter to go through the demo and see the screen change with more effects. The bottom of thescreen explains which subroutines are being used to accomplish the different effects.

Chiselled effects

275

Figure 22: Chiselled effects demo

The following figure shows how the same screen looks like after chiselled effects are added.

Figure 23: Data entry screen with chiselled effects


276

Note: You might have to add extra line spacing in Setup > Character > Extra Line Space to havethe graphic boxes appear as they do in the previous figure. Otherwise, the graphic boxes mightoverlap. The previous figure has “4” selected for Extra Line Space.

The program that displays the chiselled effects demo is WIN.CEDEMO, which you can run from thedatabase prompt.

Host subroutines


WIN.EFFECT This subroutine sets the effect of the text that follows.WIN.EFILL This subroutine fills an area of the screen with an effect.WIN.SETEFFCT This subroutine sets the color and style for a terminal effect.WIN.USESTYLE This subroutine turns on effect drawing.

Background images

Select option 14 to show how wIntegrate is able to show an image as the background of the emulationscreen.

Figure 24: Background image

You can use the host routine WIN.SETEFFCT to change the text colors to give a better contrast betweenthe text and the image.

The program that displays the background image is WIN.BKDEMO, which you can run from thedatabase prompt.

FTP

277

Host subroutines


WIN.BKIMAGE This subroutine specifies a background image for the session screen.

FTP

Select option 15 to run wIntegrate FTP scripts. When you do the FTP demo, the host subroutinecreates wIntegrate scripts to control the FTP functionality on your desktop machine.

Figure 25: FTP


After you select the FTP Demo option 15 from the main WIN.DEMO screen, you see the information onhow you can control a remote FTP server from your host, as seen in the previous figure. The followingsteps walk you through how to continue the demonstration.

1. Press Enter to continue the demonstration.The program describes the WIN.FTP subroutines that are used to allow the host to control theFTP server.

2. Read through the screen and proceed to the next screen by pressing Enter.3. Enter your server details to connect to the FTP server, and press Enter.


278

Figure 26: FTP server connection

4. Press Enter again to start accessing the FTP server from within wIntegrate.The FTP demonstration shows the available options that allow you to control the FTP server, asshown in the following figure.

Figure 27: FTP server from wIntegrate

The program that displays the FTP demo is WIN.FTPDEMO, which you can run from the databaseprompt.

Host subroutines


WIN.FTPCLOSE This subroutine closes a file which was previously opened by WIN.FTPOPEN.

Object (Automation) demo

279


WIN.FTPCON This subroutine connects wIntegrate to a remote FTP server.WIN.FTPDEL This subroutine deletes a file on an FTP server.WIN.FTPDIR This subroutine checks if a directory exists on an FTP server.WIN.FTPDISC This subroutine disconnects the FTP session.WIN.FTPFILE This subroutine checks whether a file exists on an FTP server.WIN.FTPGET This subroutine copies a file from the FTP server to the local PC.WIN.FTPGETDR This subroutine returns the name of the current directory on the FTP server.WIN.FTPINFO This subroutine returns information about the specified file on the FTP server.WIN.FTPLIST This subroutine returns a list of the files and/or subdirectories on an FTP server

matching the criteria that you specify in a dynamic array.WIN.FTPMKDIR This subroutine creates a directory on the FTP server.WIN.FTPOPEN This subroutine opens a file on the FTP server for reading and writing.WIN.FTPPOS This subroutine moves the position in the currently open file to the specified

location.WIN.FTPPUT This subroutine copies a file from the local PC to the FTP server.WIN.FTPREAD This subroutine reads bytes from the currently open file on the FTP server.WIN.FTPRMDIR This subroutine removes (deletes) the specified directory from the FTP server.WIN.FTPSCR This subroutine loads a script from the FTP server and runs it.WIN.FTPSCRPT This subroutine transfers the script to the PC using FTP and then runs it.WIN.FTPSETDR This subroutine sets the current directory on the FTP server.WIN.FTPSETV This subroutine sets the script variable or dialog box property with the specified

value using FTP.WIN.FTPWRITE This subroutine writes bytes to the currently open file on the FTP server.

Object (Automation) demo

Select option 16 to demonstrate the use of (OLE) Automation to control other applications through theObject subroutines.


280

Figure 28: Automation demo

The program that runs the automation is WIN.OBDEMO, which you can run from the databaseprompt.


After you select the Object (Automation) demo option 16 from the main WIN.DEMO screen, yousee the names of the most commonly used object subroutines, as seen in the previous figure. Thefollowing steps walk you through how to continue the demonstration.

1. Type Y and press Enter to continue the demonstration.2. From the wIntegrate window, press Enter after you read what the demo is doing and to proceed

to the next screen. Continue following the demo’s instructions. An Excel window appears. IfwIntegrate cannot successfully start Excel, start it yourself then return to wIntegrate and run theObject (Automation) demo again.

3. Resize the Excel window so that you can view both it and the window screen.4. Continue following the demo’s instructions. As you continue, the Excel window populates.

The Excel window populates with a new sheet, gets an object from the sheet to allow it to bemanipulated, populates the sheet with data, and uses various methods of the Excel Automation modelto choose cells and create a chart from them.

The following figure shows the result of the Object Automation in Excel.

Dialog boxes: common controls

281

Figure 29: Excel results

Host subroutines


WIN.OBEXIST This subroutine returns TRUE if an object with the given name exists.WIN.OBGET This subroutine gets an automation object from a file or retrieves an active

object.WIN.OBGETPRP This subroutine gets the value for an object’s property.WIN.OBMETHOD This subroutine runs a method on an automation object.WIN.OBNEW This subroutine create a new automation object.WIN.OBREL This subroutine releases an automation object. It should be called on any

automation objects you use.WIN.OBSET This subroutine sets a new object with the value of an object’s property.WIN.OBSETPRP This subroutine sets the value for an object’s property.WIN.OBVTYPE This subroutine modifies VALUE so that it is treated as a specific type when used

as an argument for WIN.OBMETHOD.


Select option 17 to show how a Windows dialog box is created and monitored from a host programusing the common controls available in all versions of Windows.


282

Figure 30: Dialog boxes: common controls


After you select the Dialog Box demo option 17 from the main WIN.DEMO screen, you see steps onhow to use WIN.DB subroutines to define a dialog box, as seen in the previous figure. The followingsteps walk you through how to continue the demonstration.

1. Press Enter to continue the demonstration.A dialog box appears with the Events Received block on the wIntegrate screen, as shown in thefollowing figure.

Figure 31: Dialog box demonstration

2. Click a tab in the dialog box.


283

An appropriate message is sent to the host, as shown in the following figure.

Figure 32: Dialog box demonstration with messages sent to host

3. Continue clicking controls to define the dialog box. When you are done, click OK to save and closethe dialog box.The values of each control are sent to the host.

Typical common controls include tabs, list views, tree views, spinners, sliders, progress bars, andmore.

Host subroutines


WIN.DBAXCTRL This subroutine adds an ActiveX control to a dialog box.WIN.DBBOX This subroutine adds a 3D box or line to a dialog box. This is used as a visual

way to enclose or separate area of the dialog box.WIN.DBBUTTON This subroutine adds a raised rectangle push button to a dialog box.WIN.DBCHECK This subroutine adds a square check box to a dialog box.WIN.DBCOMBO This subroutine adds a combo box to a dialog box. A combo box is a text field or

edit field combined with a list box.WIN.DBCTRL This subroutine adds a control of the specified class to the dialog box.WIN.DBDTTIME This subroutine adds a date/time control to a dialog box. The date/time control

displays a control into which provides entry of a date, a time, or both.WIN.DBEDIT This subroutine adds a box that you can use to edit or enter text to a dialog box.WIN.DBGRID This subroutine adds a grid control to a dialog box. The grid control displays a

grid of cells.WIN.DBGROUP This subroutine adds a rectangle group box to a dialog box. A group box

contains a group of controls that logically belong together.WIN.DBHEADER This subroutine adds a header control to a dialog box.


284


WIN.DBHTML This subroutine adds an HTML control to a dialog box. An HTML control is anarea of the dialog box that displays text that has been specified using HTMLformat.

WIN.DBIMAGE This subroutine adds an image to a dialog box. You can use this subroutine ifyou want to add a graphic to a dialog box to illustrate a point or to add a logo.

WIN.DBIMBUT This subroutine adds an image as a push button to a dialog box.WIN.DBLABEL This subroutine adds a label to a dialog box. Use this when you want to display

the name of a text, edit, or list box.WIN.DBLIST This subroutine adds a list box to a dialog box.WIN.DBLISTVW This subroutine adds a list view control that displays a list of items with

optional images and additional information.

285

Appendix A: The service subroutinewIntegrate has client-side tools such as Query Builder, Import File, Export File, and the Report Wizard,which allow the user to see data from the host database. In some cases, users are not permitted tosee the contents of all the files or fields within records. You can create a custom Service Subroutine tofilter what the user can see, according to their credentials.

The service subroutine that you define is called by three wIntegrate host programs:

▪ WIN.TRANSFER – acts as the host end of data transfer processing, for example, whenever the FileTransfer Monitor is displayed.

▪ WIN.SERVER – the host end of Query Builder, Report Wizard, and other client/server processes.▪ WIN.RWSUB – a subroutine called by WIN.SERVER while the Report Wizard is running.

Calling a service subroutineThe service subroutine is called by WIN.TRANSFER and WIN.SERVER at two points:

▪ Before the host program sends data to the PC. For example, a list of files, dictionary items or holdentries.

▪ As a final check immediately before a process is executed. For example, in Query Builder where auser might enter a query statement manually.

The service subroutine is used automatically in the same way by both WIN.TRANSFER andWIN.SERVER. It is also used by WIM.RWSUB to determine which hold entries a user is permitted tosee.

Using the service subroutineChoose the name for your service subroutine and define it in attribute 1 of an item SERVICESUB inthe WIN.PROGS file.

Tip: View the contents of the WIN.SERVER host program to see how it determines the name ofthe service subroutine.

ExamplesIf you call your service subroutine MYSERVICE, this is how you would define it.

:AE WIN.PROGS SERVICESUBTop of "SERVICESUB" in "WIN.PROGS", 1 line, 9 characters.*--: P001: MYSERVICEBottom.*--:

In the previous example, the existence of the MYSERVICE item causes WIN.TRANSFER, WIN.SERVER,and WIN.RWSUB to call your subroutine with the following parameters.

Syntax

CALL MYSERVICE (ACTION, MAT SS.ARGS, ARG)

Appendix A: The service subroutine

286

Parameters

The following table describes the parameters of the service subroutine:


ACTION Action code for current call to the service routineMAT SS.ARGS Array of 30 elements for additional information/parametersARG Main parameter/return value

The service subroutine is always called with ACTION = 1 (SSA.INIT), which allows the serviceroutine to tell the calling program at what times it requires to be called. This means only the actionsthat the service subroutine is required to process need any code.

Entries for the parameter array MAT SS.ARGS:

Index Name Description

1 SS.PROGID Program ID - set before first call. Currently:

1 - Host Server (WIN.SERVER)

2 - File Transfer (WIN.TRANSFER)

3 - Report Wizard (WIN.RWSUB)2 SS.PARAM Environment parameters - This is the dynamic array set by the

WIN.PARAM subroutine. It contains host-specific informationsuch as the maximum record size.

3 SS.RESULT Second result parameter - usually specifies whether ARGvalidates or what to do with any change to ARG.

4 SS.EXTRA1 Additional information. See individual action descriptions fordetails.

5 SS.EXTRA2 Additional information. See action description.6-9 Reserved Reserved for future expansion.10-30 User Available to the user.

The SS.PROGID and SS.PARAM members of the SS.ARGS array are set up for all calls. The user areaof the array is left untouched between calls to the various subroutines.

Entries for ACTION:


1 SSA.INIT Initialization - first action that is always called.2 SSA.FILESEL Set up/modify select for list of files.3 SSA.FILECHK Check each file name before displaying.4 SSA.FIELDSEL Set up/modify select for list of fields.5 SSA.FIELDCHK Check each field name before displaying.6 SSA.EXECCHK Check commands to be executed (WIN.SERVER only).7 SSA.TRANCHK Check parameters for file transfer (WIN.TRANSFER only).8 SSA.SLAVEON Set up/modify environment and turn on slave printing.9 SSA.SLAVEOFF Reset environment and turn off slave printing.10 SSA.HPRTON Set up environment before host printing.11 SSA.HPRTOFF Reset environment after host printing.12 SSA.READCHK Check OK to read field/item.

Action code details

287


13 SSA.WRITECHK Check OK to write field/item.14 SSA.DELETECHK Check OK to delete field/item.

Action code details

Each action that is described in the following tables has the same format: a title that consists of anaction code, action name, and a brief description. The On Entry columns list the parameters that areset for the routine when it is called by the host program. The On Exit columns list the parameters thatthe routine can change.

Action code 1: SSA.INIT - Initialization

Parameter On Entry On Exit

ARG "" ARG is a dynamic array specifying on which actions to call theroutine

This call is made at the beginning of the program with the SS.PROGID and SS.PARAM fieldscompleted. It allows the user area of SS.ARGS to be initialized and ARG to be set up to specify whenthe service subroutine should be called. Each action to be specified is set up by putting the number 1in the field with the same index as the action code.

ARG<SSA.FILESEL> = 1 ;* Want file selection hookARG<SSA.FIELDSEL> = 1 ;* Want field selection hook

Action code 2: SSA.FILESEL - File selection


ARG Default selectstatement to use

New selection statement to use or list of file names

SS.EXTRA1 Account nameSS.RESULT 1 - ARG contains select statement

2 - ARG is list of file names

This call is made before the select statement is run to provide the list of file names for the Files scriptcommand or the Files button on the file transfer. The service subroutine can modify the list of files asseen by the user.

Action code 3: SSA.FILECHK - Check file name


ARG File name File name to use (SS.RESULT = 1)SS.EXTRA1 Account NameSS.RESULT 1 - Use file name

0 - Do not use file name


288

This call is made before a file name is passed up to the PC from the Files script command and the Filesbutton on the file transfer. It allows extra checks to be made to a file name just before it is added tothe list of files.

Action code 4: SSA.FIELDSEL - Field selection


ARG Default selectstatement

New select statement or list of field names

SS.EXTRA1 File nameSS.EXTRA2 AccountSS.RESULT 1 - ARG contains select statement

2 - ARG is list of file names

This call is made before the select statement is run, which provides the list of field names for the Fieldsscript command or the Fields button on the File Transfer. It allows the select statement that is used forfield listing to be modified or replaced by a list of specific field names.

Action code 5: SSA.FIELDCHK - Check field name


ARG Field nameSS.EXTRA1 File nameSS.EXTRA2 AccountSS.RESULT 1 - Use field name

2 - Do not use field name

This call is made before a selected field is transferred to the host in the Fields script command or fromthe Fields button on the File Transfer. It allows extra checks to be made to a field name just before it isadded to the list of fields.

Action code 6: SSA.EXECCHK - Check commands to be executed


ARG Dynamic array oflines to be executed

Actual statement to be executed

SS.RESULT 0 - Invalid execute statement

1 - Statement OKSS.EXTRA1 Error message or "" for no message (SS.RESULT = 0)

This routine is called just before the host server executes the statements that are passed to it by theMExec command (which is used to run the query for the Query Builder). It allows the statements to bechecked to ensure correct file names and field names.

Action code details

289

Action code 7: SSA.TRANCHK - Check parameters for file transfer


ARG Information to bechecked. (Dynamicarray with the fieldsas described belowthe table)

SS.RESULT 1 - OK

0 - Invalid parametersSS.EXTRA1 error message (SS.RESULT = 0)

Dynamic array fields for ARG:

1. Mode▪ 1 - Import▪ 2 - Export

2. Account name containing the file3. “DICT” or “DATA”4. File name5. Item(s)6. Fields7. Options as multivalued field

▪ 7,1 1= Capture▪ 7,2 1= Overwrite▪ 7,3 1= Append▪ 7,4 1= ID-SUPP▪ 7,5 1= Show field descriptions▪ 7,6 1= Use Reformat Mode

8. Additional items9. Current account name

This routine is called just before the actual file transfer is started after the details are sent from the PC.It allows extra checks on the file transfer file names, fields, and so on.

Action code 8: SSA.SLAVEON - Slave printer on


ARG Destination forcapture usually"Printer"

Destination for capture

SS.RESULT 0 - All processing done here

1 - Do standard processing

2 - Just turn on capture to printer (in main program)

This routine is called to just before the data for slave printing is sent to the screen in the host serverprogram. It can be used to set up the host/PC environment for the local printout and also to run aspecific Capture script command to turn on the local printer.

If SS.RESULT = 0 on exit, the local printer must be turned on within this routine.


290

Use lines similar to the following example:

SCRIPT = "Screen Off" SCRIPT<-1> = 'Capture On ServerPrint,"' : ARG : '"'CALL WIN.HSCRIPT(SCRIPT)

Action code 9: SSA.SLAVEOFF - Slave printer off


SS.RESULT 0 - All processing done in subroutine

1 - Do standard processing

2 - Just turn off capture to printer

This routine is called after the listing for local printing finishes. Use it to reset local/PC environment if itwas changed in SSA.SLAVEON or to turn off the capture.

If SS.RESULT = 0 on exit, the local printer must be turned off in this subroutine.

Action code 10: SSA.HPRTON - Host printer setup


(none) No entry parameters No exit parameters

This routine is called before printing to the host. It allows the print destination to be changed or thesettings to be modified.

Action code 11: SSA.HPRTOFF - Host printer reset


(none) No entry parameters No exit parameters

This routine is called after printing to the host. It allows the host printer destination settings to bereset.

Action code 12: SSA.READCHK - Check OK to read field/item


ARG File nameSS.RESULT 0 - Access denied

1 - Access grantedSS.EXTRA1 Item nameSS.EXTRA2 Field number (or ""

for whole record)

This routine is called to check that a user has authority to read a host field or item.

Action code 13: SSA.WRITECHK - Check OK to write field/item


ARG File name

Example subroutines

291


SS.RESULT 0 - Access denied

1 - Access grantedSS.EXTRA1 Item nameSS.EXTRA2 Field number (or ""

for whole record)

This routine is called to check that a user has authority to write a host field or item.

Action code 14: SSA.DELETECHK - Check OK to delete field/item


ARG File nameSS.RESULT 0 - Access denied

1 - Access grantedSS.EXTRA1 Item name

This routine is called to check that a user has the authority to delete a field or item.

Example subroutinesThese example subroutines are installed in the WIN.PROGS file where all wIntegrate host programsare stored.

WIN.SSUB

This sample service subroutine reads the file/field select statements from an item called"FILE.SELECT" on WIN.PROGS.

The format of this record is as follows:

Field 1 - File name to select for list of file names

Field 2 - Alternate selection to use for list of file names

Field 3 - Alternate selection to use for list of fields

WIN.SSUB1

This sample service subroutine demonstrates all the non-printing service hooks. It was compiled forUniBasic and will need minor modifications to get it to work correctly on other host systems.

WIN.SSUB2

This sample service subroutine prevents the user from exporting data from the PC to the host. It showshow to use a user’s credentials to restrict importing and exporting data for specific files.

292

Appendix B: National Language Support (NLS)UniVerse has a special mode that offers NLS. With NLS mode enabled, you can use UniVerse in variouslanguages and countries.

UniVerse NLS handles special characters like value marks differently to regular UniVerse. For thisreason, alternative versions of some host subroutines are supplied that support UniVerse NLS. Theseroutines can also be used on a non-NLS enabled version of UniVerse.

The subroutines are described in the following table.

NLS subroutine Standard routine

WIN.ASCTO.UN WIN.ASCTOFTWIN.DBLOA.UN WIN.DBLOADWIN.DDEPO.UN WIN.DDEPOKEWIN.FTPRE.UN WIN.FTPREADWIN.FTPWR.UN WIN.FTPWRITEWIN.FTTOA.UN WIN.FTTOASCWIN.GETDA.UN WIN.GETDATAWIN.HSCRI.UN WIN.HSCRIPTCWIN.IMCHA.UN WIN.IMCHANGEWIN.IMOPE.UN WIN.IMOPENWIN.PCRAL.UN WIN.PCREADALWIN.PCREA.UN WIN.PCREADWIN.PCWRI.UN WIN.PCWRITEWIN.SDUMP.UN WIN.SDUMPWIN.SENDK.UN WIN.SENDKEYSWIN.SETDA.UN WIN.SETDATA

293

Appendix C: Reading the TCL command lineinput buffer in D3

The following section describes information relevant to D3 platforms.

The WIN.ARGS.xx wIntegrate subroutines parse the command line into a variable. The xx representsthe machine type to support different syntax, for example WIN.ARGS.UV.

On D3 systems, the routine WIN.ARGS.AP is used to parse the command line. However, it makes useof the user exit U0003, which is no longer supported on D3.

Because user exits are no longer officially supported on D3, it would be ideal to change theWIN.ARGS.AP subroutine to use either the TCLREAD or SENTENCE() statements; however, theTCLREAD and SENTENCE() statements can give unpredictable results when used in subroutines.

So if you want to read the command line arguments, you must manually modify any program thatcalls WIN.ARGS.AP to remove the subroutine call and replace it with the relevant code.

For example, in WIN.PROGS WIN.EDIT, you would replace the call to the WIN.ARGS.APsubroutine.

Original code:

.

.

.READ MACHINE.TYPE FROM F.BP, "MACHINE.TYPE" ELSE MACHINE.TYPE = "GENERIC"MACHINE.TYPE = MACHINE.TYPE<1>*SUB.SUFFIX = ''IF MACHINE.TYPE # 'GENERIC' THEN SUB.SUFFIX = '.' : MACHINE.TYPEARGSUB = "WIN.ARGS" : SUB.SUFFIX*ARGS = ""CALL @ARGSUB(ARGS)DORD = ""FILENAME = ARGS<2>...

New code for D3:

.

.

.READ MACHINE.TYPE FROM F.BP, "MACHINE.TYPE" ELSE MACHINE.TYPE = "GENERIC"MACHINE.TYPE = MACHINE.TYPE<1>*SUB.SUFFIX = ''IF MACHINE.TYPE # 'GENERIC' THEN SUB.SUFFIX = '.' : MACHINE.TYPE*TCLREAD CMD.LINECMD.LINE = TRIM(CMD.LINE)NN = DCOUNT(CMD.LINE," ")ARGS = ""FOR N = 1 TO NNARGS<N> = FIELD(CMD.LINE," ",N)NEXT N

Appendix C: Reading the TCL command line input buffer in D3

294

*DORD = ""FILENAME = ARGS<2>...

295

Appendix D: Loading a dialog using the Basicsubroutines

wIntegrate was originally designed to allow the host to control all aspects of the PC, including full GUIinterfaces indistinguishable from any other client application. However there are new considerationswhen driving a GUI application from the host. One of these is the time taken to communicatebetween the two devices. This section introduces you to the concepts behind reducing the number ofcommunication round trips between the host and client. This makes a big difference to performance.

You can use the Basic host subroutines to control a Windows-based graphical application in exactlythe same way that a Basic programs would drive a character application. The critical aspect here is thefield-by-field processing in U2, which does the following:

▪ Validates each field on input▪ Determines which field to input next▪ Sets the values for the next field

This is achieved by using the supplied Basic subroutines to display the dialog and do inputs instead ofthe Basic CRT and INPUT equivalents. For example, to create a regular Windows dialog box, you haveto use several subroutines in the WIN.PROGS file in succession:

1. WIN.DBNEW, which creates a new dialog box2. Any number of subroutines that add controls to the dialog box3. WIN.DBLOAD, which loads the dialog box from the host onto the client machine4. WIN.DBSHOW, which shows the dialog box on the client machine

The following sections describe how the dialog boxes are loaded into the PC and subsequentlydisplayed. This is important due to the number of exchanges between the host and PC. Every roundtrip costs valuable time and delays the user.

WIN.DBLOADWIN.DBLOAD sends the dialogs to the PC with the following exchange:

Host: "Has dialog x been shown?"

Client: "No"

Host: "OK, has dialog x been loaded into memory?"

Client: "No"

Host: "OK, load dialog x"

Host: "Did you load dialog box x?"

Client: "Yes"

Here is the equivalent code in its simplest form:

Note: The control character "stx" (in Basic this is CHAR(2)) is used by the waiting Basic programto determine the beginning of the response from the client PC, as users are unlikely to type thischaracter.

SUBROUTINE WIN.DBLOAD(DBX, ERR)

Appendix D: Loading a dialog using the Basic subroutines

296

...

* Check if dialog is already displayedIF ERR = 0 THEN CALL WIN.COMSUB("Enter stx:IsShown(":NAME:")") GOSUB 100; * Get response IF RESP = '1' THEN ERR = 2END ** Check if dialog has already been sent to the PCIF ERR = 0 THEN CALL WIN.COMSUB("Enter stx:IsDialog(":NAME:")") GOSUB 100; * Get response IF RESP = '1' THEN ERR = 3 ELSE BUILD=TRUEEND* SCRIPT = ''IF BUILD THEN SCRIPT = DBX IF SCRIPT[LEN(SCRIPT)-8,9] # "EndCreate" THEN SCRIPT<-1>='EndCreate' CALL WIN.HSCRIPTC(SCRIPT)

CALL WIN.COMSUB("Enter stx:IsDialog(":NAME:")") GOSUB 100; * Get response IF RESP # '1' THEN ERR = 4END

This is relatively inefficient as unnecessary exchanges are made.

Here is a more efficient version. For information on scripting syntax, see the Client Scripting Referencemanual.

* Check if dialog is already displayed IF ERR = 0 THEN CALL WIN.COMSUB("If IsShown(":NAME:") Then; Enter stx:2; Else If IsDialog(":NAME:") Then; Enter stx:3; Else; Enter stx:0;Endif") GOSUB 100; * Get response BEGIN CASE CASE RESP="2"; ERR = 2 CASE RESP="3"; ERR = 3 CASE 1; BUILD = TRUE END CASE END* SCRIPT = '' IF BUILD THEN SCRIPT = DBX IF SCRIPT[LEN(SCRIPT)-8,9] # "EndCreate" THEN SCRIPT<-1>='EndCreate' CALL WIN.HSCRIPTC(SCRIPT) CALL WIN.COMSUB("Enter stx:IsDialog(":NAME:")") GOSUB 100; * Get response IF RESP # '1' THEN ERR = 4 END

In the first IF statement, the script tests for whether the dialog is already shown or loaded. The dialogis only loaded in the second IF statement if this is necessary.

Note: You can improve responsiveness by enabling the TCP No Delay option in the Setup >Windows Sockets and Setup > SSL dialogs. This disables the Nagle algorithm which pauses for200ms before sending data across the network in case more data is coming. Using the TCP No

WIN.DBSHOW

297

Delay option will probably cause a larger number of smaller packets to be sent, but this is notusually an issue on today’s networks.

WIN.DBSHOWWIN.DBSHOW displays the dialog with the following exchange:

Host: "Has dialog x been shown?" (If the dialog was just loaded, the host already knows this.)

Client: "No"

Host: "Has dialog x been loaded?" (Again, if the dialog was just loaded, the host knows this too.)

Client: "Yes"

Host: "OK, show dialog x"

Host: "Has dialog x been shown?"

Client: "Yes"

Here is the equivalent code in its simplest form:

SUBROUTINE WIN.DBSHOW(DLGNAME, MODAL, ERR)

...

* Check if dialog is already displayedIF ERR = 0 THEN CALL WIN.COMSUB("Enter stx:IsShown(":DLGNAME:")") GOSUB 100; * Get response IF RESP = '1' THEN ERR = 2END * Check if dialog existsIF ERR = 0 THEN CALL WIN.COMSUB("Enter stx:IsDialog(":DLGNAME:")") GOSUB 100; * Get response IF RESP = '0' THEN ERR = 3 ELSE SHOW=TRUEEND SCRIPT = ''

IF SHOW THEN DCMND="Window" IF MODAL THEN DCMND = "Show" SCRIPT='DialogBox ':DCMND:' ':DLGNAME CALL WIN.HSCRIPT(SCRIPT) CALL WIN.COMSUB("If Not(IsShown(":DLGNAME:")) Then Wait Delay 50; Enter stx:IsShown(":DLGNAME:")") GOSUB 100; * Get response IF RESP[1,1]="D" OR RESP[1,1] = "C" THEN GOSUB 100;* Ignore Default/Click IF RESP # '1' THEN ERR = 4END

...

This is relatively inefficient as unnecessary exchanges are made, and each one makes a round tripbetween the host and the client.

Appendix D: Loading a dialog using the Basic subroutines

298

Here is a more efficient version using a script:

IF ERR = 0 THEN SCRIPT = "HScript=`If IsShown(":DLGNAME:") Then" SCRIPT = SCRIPT : ";Enter stx:2" SCRIPT = SCRIPT : ";Else If Not(IsDialog(":DLGNAME:")) Then" SCRIPT = SCRIPT : ";Enter stx:3" SCRIPT = SCRIPT : ";Else" SCRIPT = SCRIPT : ";Enter stx:0" DCMND="Window" IF MODAL THEN DCMND = "Show" SCRIPT = SCRIPT : ';DialogBox ':DCMND:' ':DLGNAME SCRIPT = SCRIPT : ";EndIf`" SCRIPT = SCRIPT : ";Execute HScript" CALL WIN.COMSUB(SCRIPT) GOSUB 100; * Get response ERR = RESPENDIF ERR = 0 THEN CALL WIN.COMSUB("If Not(IsShown(":DLGNAME:")) Then Wait Delay 50; enter stx:IsShown(":DLGNAME:")") GOSUB 100; * Get response IF RESP[1,1]="D" OR RESP[1,1] = "C" THEN GOSUB 100;* Ignore Default/Click IF RESP # '1' THEN ERR = 4END

The logic is embedded in as script, but this time it is longer and built as a separate variable.

WIN.DBLOADSHOWIf you want to both load and show a dialog, a single routine can achieve this more efficiently than twoseparate routines. For example:

IF ERR = 0 THEN SCRIPT = "If IsShown(":NAME:") Then" SCRIPT<-1>="Enter stx:2" SCRIPT<-1>="Else If IsDialog(":NAME:") Then" SCRIPT<-1>="Enter stx:3" SCRIPT<-1>="Else" SCRIPT<-1>="Enter stx:0" SCRIPT<-1>= DBX IF SCRIPT[LEN(SCRIPT)-8,9] # "EndCreate" THEN SCRIPT<-1>='EndCreate' DCMND="Window" IF MODAL THEN DCMND = "Show" SCRIPT<-1> ='DialogBox ':DCMND:' ':NAME SCRIPT<-1>="EndIf" CALL WIN.HSCRIPTC(SCRIPT) GOSUB 100; * Get response BEGIN CASE CASE RESP="2"; ERR = 2 CASE RESP="3"; ERR = 3 CASE 1 CALL WIN.COMSUB("If Not(IsShown(":NAME:")) Then Wait Delay 50; enter stx:IsShown(":NAME:")") GOSUB 100; * Get response IF RESP[1,1]="D" OR RESP[1,1] = "C" THEN GOSUB 100;* Ignore Default/Click IF RESP # '1' THEN ERR = 4 END CASE

WIN.DBLOADSHOW

299

END

The program both loads a dialog and shows it, achieving the same as WIN.DBLOAD andWIN.DBSHOW if they are run separately. It works by creating a script with the required logic andsending it to the PC to be executed, instead of controlling the logic from the host which would requirea round trip between the host and the client each time.

Rocket wIntegrate Host Subroutines...

Documents

Transcript of Rocket wIntegrate Host Subroutines...