Günter Born

Windows Scripting Host Tutorial

© G. Born – Windows Scripting Host Tutorial

II

Günter Born
Windows Scripting Host Tutorial

This is the English version of the book:

"Inside Windows Scripting Host",
Microsoft Press Germany, 1999
ISBN 3-86063-495-X

Published by Günter Born

Copyright © 1999 by Günter Born
http://ourworld.compuserve.com/homepages/Guenter_Born

All rights reserved. No part of the contents of this document may be reproduced or transmitted in
any form or by any means without the written permission of the author/publisher.

Disclaimer
The materials, sample code, andfiles in this text and from referenced sources are provided AS IS
WITHOUT WARRANTY OF ANY KIND AND ARE PROVIDED WITHOUT ANY IMPLIED
WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY. Use of the materials
and code is to be undertaken entirely at your risk, and the results that may be obtained from that
use are dependent on the user.

© G. Born – Windows Scripting Host Tutorial

 III
G. Born:
Windows Scripting Host Tutorial

Preface XXI
Introduction XXIII
Why I wrote this book? XXIII
How to use this book? XXIV
A few other remarks XXV

1 Introduction into WSH 1

What is the Windows Script Host? 1
What can we do with WSH scripts? 2
A few remarks about JScript/VBScript 3
How to install WSH? 4
How to check whether WSH is installed? 4
Install WSH in Windows 98 4
Windows 95/Windows NT 4.0 5
How to create and use scripts 7
Let's create our first (VBScript) script 7
Same sample, but now in JScript 9
How to execute WSH scripts? 10
Launch a script in Windows 10
Using the Windows Command Prompt to execute scripts 10
Set the script properties 12
How to submit parameters to a script? 13
Passing arguments in Cscript.exe 17
Remarks about the scripting samples shipped with Microsoft Windows 98 19

2 Development Tools 21
A few tips to edit scripts 21
How to create a script? 21
Edit existing script files? 23

© G. Born – Windows Scripting Host Tutorial

IV
Define your own Edit script command 23
Script Editors 25
EditPlus 27
PrimalSCRIPT script editor 27
Other editors 28
The OLE/COM Object Viewer 28
Using the Object Browser 30
Installing/uninstalling ActiveX controls 33
Uninstalling OCX files 35
Script debugging 37
Trace your programs 37
Using the Microsoft Script Debugger 39
Microsoft Script Debugger commands 41
Execute a script step-by-step? 42
Using the Step Over and Step Out mode 43
Using breakpoints 43
Showing the Call Stack 43
Show interims values using the Command Window 44

3 Simple Dialogs in WSH 45

Using the Echo method 45
Using Echo in VBScript 46
Echo and the Windows Command Prompt 47
Using the Echo method in JScript 48
How to get a line feed within a dialog box? 49
Using MsgBox in VBScript 50
Define the buttons and the icon 51
Which button was clicked in a dialog box? 52
Using the Popup method 54
Using Popup in JScript? 55
Can we use Popup also in VBScript? 57

© G. Born – Windows Scripting Host Tutorial

 V
4 Working with WSH objects 59
Using the WScript object 59
Displaying WSH and script properties 59
Retrieving properties in VBScript 61
Retrieving properties in JScript 62
Retrieving the script engine's properties 63
Accessing script arguments 65
Two solutions in VBScript 66
A solution in JScript 68
Accessing environment variables 69
Global remarks 70
How to access environment variables per script? 71
Using environment variables in VBScript 73
How to read environment variables in JScript 75
How to set environment variables 76
Deleting environment variables 78
Expanding environment variables 80
Get and release objects 82
Create objects 82
CreateObject or GetObject? 84
Using DisconnectObject 85
Execute other programs from scripts 86
Remarks about the Run method 86
Launch the Windows Editor from VBScript 88
How to call the Windows calculator from JScript? 89
A few remarks about the Quit method 90
Wait for process termination and check exit codes 90
Using Run to execute MS-DOS commands 92

5 User Input in scripts 95

User input in VBScript 95

© G. Born – Windows Scripting Host Tutorial

VI
User input in JScript 97
JScript-user input using a second script 97
Internet Explorer for JScript user input 100
Implementing an InputBox function in HTML 101
Call the function within the HTML document 101
The InputBox implementation for JScript 102
An InputBox ActiveX control 107

6 Using forms 111

User Forms with Internet Explorer 111
Creating a Dialog using showModalDialog 111
Using Internet Explorer for dialogs 115
Creating Forms using Internet Explorer 118
The HTML code for the form 118
DHTML code to control your form 119
A WSH script to use the form 122
A JScript WSH script to access the form 126
Form input using a CallBack function 128
Using ActiveX controls as forms 131
Using an ActiveX control for an about dialog box 131
Using the About dialog from a WSH script 136
Using a form for user input 137
Creating the form using VB 5 CCE 138
How to define global variables to keep user input values? 142
How to implement the form handling methods? 142
How to use the ActiveX control in a WSH script? 143
Using the form in JScript 145
Implementing a password input dialog 145
A WSH script using the password input 147

7 Shortcuts 151
A few Basics 151

© G. Born – Windows Scripting Host Tutorial

 VII
Creating a Shortcut with CreateShortcut 152
Creating a Shortcut to the Current Script File 152
The JScript Implementation 154
Using the SpecialFolders object 156
Displaying all Special Folders Entries 157
The JScript Implementation 159
Finding the Path to a Special Folder 160
The JScript Implementation 162
Creating a Shortcut on the Desktop 163
The JScript Implementation 165
Creating a Shortcut in the Start menu 167
The implementation in JScript 170
Creating Shortcuts with Parameters 172
The JScript Implementation 175
Creating a Shortcut to a Website 177
The JScript Implementation 179

8 Extended WSH features 181

Using Network Resources 181
User name, Domain, Computer name 181
The JScript Implementation 183
Mapping Printers 183
Control and Maintenance of Printer Mappings 184
Mapping a Printer in VBScript 185
Run-time Errors 185
Run-time Error Handling in VBScript 186
The JScript Implementation 188
Printer Mapping in JScript 5.0 with Error Trapping 189
Executing a Script within Each Login 190
Listing all Mapped Printers 191
The JScript Implementation 192
Mapping Network Drives 193

© G. Born – Windows Scripting Host Tutorial

VIII
The JScript Implementation 196
The JScript 5.0 Implementation 198
Accessing the Windows Registry 199
Registry Access using WSH 201
Registry Access with VBScript 202
The Jscript Implementation 205
Run-time Error Handling for Registry Access 206
Checking the Existence of a key in VBScript 209
Using the WSHKeyExist1-Method 211
Using the WSHKeyExist1 Method in VBScript 212
The Jscript Implementation 214
Changing the Windows Install Path 215
Hiding the Last User Name at Login 217
Retrieving the Workgroup Name 218
The JScript 5.0 Implementation 220

9 Using file system commands 223

The FileSystemObject object model 223
Create a FileSystemObject object 224
Create an object reference in VBScript 224
Create an object reference in JScript 224
Accessing FileSystemObject methods 225
Accessing drives 226
How to list all drives on a machine 226
How to implement the sample in VBScript 227
How to implement the sample in JScript 230
Showing drive properties 231
Retrieving drive properties in JScript 235
Accessing files and folders 236
Showing all sub-folders of a folder 237
The JScript implementation to list subfolders 239
Recursive folder processing 240

© G. Born – Windows Scripting Host Tutorial

 IX
Create, move, rename and delete folders 245
How to create a new folder 245
How to retrieve the parent folder? 246
Rename, copy or move a folder 247
Deleting folders 248
Implementing the sample Folder1.vbs 248
Folder1.js: The implementation in JScript 251
List all files within a folder 253
The file list sample, implemented in JScript 255
Accessing file attributes and -date 256
The implementation in VBScript 257
The implementation in JScript 259
Just another problem with CreationDate 260
Copy and delete files 264
Sample: Implementation in VBScript 265
Sample: Implementation in JScript 266
How to create backup copies using scripts? 268
Accessing text files 273
Read from a text file 273
The VBScript implementation 274
The JScript implementation 275
Writing into a text file 276
The VBScript implementation 277
The JScript implementation 278
Append to a text file 279
A sample in VBScript 280
Implementing the sample in JScript 281
File dialogs 281
Show a dialog to select a folder 282
Using a file dialog 286

10 ActiveX controls programming 289

© G. Born – Windows Scripting Host Tutorial

X
VB 5 CCE the basics 289
What is VB 5 CCE? 289
Create a new ActiveX-Project 290
Introduction into VB 5 CCE 291
About projects, classes, modules and properties 292
The code window 294
The properties window 295
Inserting controls into a Form 297
Creating an OCX file 298
Create an install file for an ActiveX control 300
How to get information about objects? 301
Create an object description for the object browser 302
A project sample 303
ActiveX samples 305
Implementing the WSHKeyExist1 method 305
A Wait method for Scripts 309
A method to play sounds within a script 314
WSHShell- and WSHAppActivate methods 318
Implementing the WSHShell method 318
Implementing the WSHAppActivate method 320
Testing WSHShell and WSHAppActivate 321
The SendKeys problem 322
Implementing a WSHSendKeys method 325
Remarks about the WSHSendKeys method 325
Remarks about the WSHSendKeys implementation 327
Sample 1: Launch and terminate Calc.exe 328
Sample 2: Manipulating two applications using WSHSendKeys 331
Sample 3: Clipboard handling using WSHSendKeys 333
Using WSHSendKeys to create a new user account 336
How to handle windows? 343
The WSHFindWindow method 343

© G. Born – Windows Scripting Host Tutorial

 XI
The WSHIsWindow method 344
The WSHIsIconic method 345
The WSHShowWindow method 347
The WSHSetForegroundWindow method 349
The WSHMoveWindow method 350
The WSHFlashWindow method 351
Sample 1: Manipulate a window 352
Sample 2: A moving and flashing window 354
Shutdown Windows 95/98 using a script 358
A script using the WSHExitWindows method 359

11 WSH and Microsoft Office 363

Using Microsoft Excel 363
The Excel object model 363
A sample to access Excel 364
Set the window properties 365
The implementation in VBScript 366
An implementation in JScript 367
Create an Excel worksheet and add the content 369
The VBScript implementation 371
The JScript Implementation 373
Writing WSH information into a worksheet 375
The VBScript Implementation 377
The JScript implementation 379
Load an Excel XLS file and read the data 382
Implementing the sample in VBScript 383
An implementation in JScript 384
Importing a CSV file in Excel 386
How to import CSV files into several columns? 389
Using Microsoft Word 393
The Word 97 object model 393
Sample 1: Access Word from a script 394

© G. Born – Windows Scripting Host Tutorial

XII
How to implement the sample in VBScript 397
The JScript implementation 398
Create a Word document and write data 400
The implementation in VBScript 402
The JScript Implementation 404
Read data from a Word DOC file 406
How to use the Word Open dialog 409
Using Microsoft Access 411
The Microsoft Access 97 object model 411
The DBEngine object model 412
The Workspace object 413
The Database object 413
Working with Access Databases 413
Using Outlook 418
The Outlook object model 418
Create an E-mail entry in Outlook 419
Create a new contact 422
Create a new note 423
Create a new task entry 425

12 How to...? 427

Programming tricks 427
How to debug? 427
How to handle Run-time errors? 427
JScript run-time error handling 428
How use WSH- and Script-Engine properties? 429
How to get the script's path? 429
How to get the current directory? 430
How to calculate Date differences 431
How to use Event handling? 431
Implement an event handler in VBScript 432
How it work's in JScript? 434

© G. Born – Windows Scripting Host Tutorial

 XIII
Script calls and parameters 436
How to launch a script using Drag & Drop? 436
WSH scripts and the Windows NT-Scheduler 437
How to access script arguments? 437
How to call external applications? 437
Long file names within scripts 438
How to execute system calls using Run? 438
Shutdown with RunDLL32.exe 438
Backdoors to shutdown/restart Windows 9X 439
How to invoke the CopyDisc dialog? 442
How to invoke the Format dialog? 443
How to invoke the Open With dialog? 443
How to invoke the Screen Saver property page? 444
Network mappings with Run 444
User dialogs and output 445
How to implement user dialogs in scripts? 445
How to use tabs and line feeds? 445
How to get a user input within scripts? 446
How to use console input/output? 446
How to log script output? 449
A UserLog sample in VBScript 450
File handling 452
How to check whether a file/folder exists? 452
How to check whether an Access Database is in use? 452
How to copy files 453
How to search a file? 453
How to list all shortcut files? 454
Sound and Multimedia 455
Using the WSHPlaySound method 455
Using the WSHMciExecute method 457
How to play sound with the MCI control? 458

© G. Born – Windows Scripting Host Tutorial

XIV
How to play Multimedia files 459
Accessing the Windows shell 461
How to arrange desktop windows? 461
How to open folder windows? 463
How to access Windows Shell-dialogs? 464
How to use a user defined file dialog? 467
Remarks about implementing the ActiveX control 469
Miscellaneous 471
How to call a DUN connection 471
How to obtain the IP-address? 473
How to retrieve system information? 474
How to use ADSI? 475
How to bind to a directory service? 475
ADSI: How to create an User? 476
ADSI: How to change passwords? 478
ADSI: How to change a User's Description? 479
ADSI: How to delete a User from a machine or a domain? 479
ADSI: How to disable an User's account? 479
ADSI: How to add a User to a Group? 480
ADSI: How to display all users of a group? 480
ADSI: How to display Groups? 481
Accessing Data with ADO 482
Create your DB Provider 482
A sample to read a CSV file 483

A WSH short reference 487

The WScript object 487
Properties of the WScript object 487
Methods of the WScript object 488
The WshArguments object 489
The WshShell object 489
Properties of the WshShell object 489

© G. Born – Windows Scripting Host Tutorial

 XV
Methods of the WshShell object 489
The WshNetwork object 491
The properties of the WshNetwork object 491
The methods of the WshNetwork object 491
The WshCollection object 493
The WshEnvironment object 493
The properties of the WshEnvironment object 493
The methods of the WshEnvironment object 494
The WshShortcut object 494
The properties of the WshShortcut object 494
The methods of the WshShortcut object 495
The WshSpecialFolders object 495
The properties of the WshSpecialFolders object 495
The WshUrlShortcut object 496
The properties of the WshUrlShortcut object 496
The methods of the WshShortcut object 496

B WSHExtend Programmers Reference 497

The WinExt object model 497
Using the object 497
The WSHKeyExist method 497
The WSHKeyExist1 method 498
The WSHGetTime method 498
The WSHGetDate method 498
The WSHInputBox method 498
The WSHSendKeys method 498
The WSHWait method 499
The WSHAppActivate method 499
The WSHShell method 499
The WSHBeep method 500
The WSHFindWindow method 500
The WSHIsWindow method 500

© G. Born – Windows Scripting Host Tutorial

XVI
The WSHIsIconic method 501
The WSHFlashWindow method 501
The WSHMoveWindow method 501
The WSHSetForegroundWindow method 501
The WSHExitWindows method 501
The WSHPlaySound method 502
The WSHMciExecute method 502
The WSHFileDialog method 502
The WSHAbout method 502

C Introduction into VBScript 503

Statements, continued lines and comments 503
VBScript statements 503
Continued lines 503
Comments 504
Remarks about the structure of a VBScript program 504
Variables and constants 505
Constants 505
Intrinsic constants 506
Variables 506
Some remarks about VBScript data types 507
Variant subtypes 508
The Option Explicit keyword 508
Using the Dim statement 510
Public and Private within a variable declaration 510
Array declaration with Dim 510
Variable names 511
Operators 511
Arithmetic operators 511
Assigning object references with the Set-Operator 512
Logical Operators 512
Comparison operators 514

© G. Born – Windows Scripting Host Tutorial

 XVII
Operator priorities 515
Control structures 515
If ... Then 515
If ... Then ... Else 515
If ... Then ... ElseIf 516
Select Case 516
Loops 517
Do While ... Loop 517
Do Until ... Loop 517
Do ... Loop While 517
Do ... Loop Until 518
Exit Do 518
For ... Next 518
For Each ... Next 518
Exit For 519
While ... Wend 519
Procedures and functions 519
Functions 519
Passing arguments ByRef/ByVal 521
Built-in functions 521
Procedures 521
Remarks about parameter passing (ByRef, ByVal) 522

D Introduction into JScript 525

Basics 525
What's JScript? 525
The structure of a JScript-program 525
Comments 526
Remarks about JScript statements 526
Continued lines 527
Several statements per line 527
Constants 527

© G. Born – Windows Scripting Host Tutorial

XVIII
Variables 528
Remarks about the variable scope 528
Variable names 529
Remarks about values and data types 530
Remarks about data subtypes 531
Special escape characters within strings 531
Expressions and operators 532
Assignment operator 532
Comparison operators 532
Calculation operators 533
Increment and decrement operators 533
Logical operators 534
Control structures 535
if statement 535
Conditional operator 536
for loop 536
for ... in loop 538
while loop 538
do ... while loop 538
switch statement 539
break and continue 540
Built-in-objects and -functions 540
Functions 540
Built-in-functions 541
Objects 541

E Useful WSH Internet sites 543

Microsoft's WSH websites/newsgroups 543
Other WSH Websites 543

F Further Readings 547

G About the Author 549

© G. Born – Windows Scripting Host Tutorial

 XIX
Index 551

© G. Born – Windows Scripting Host Tutorial