Home > Articles > Home & Office Computing > Microsoft Windows Vista & Home Server

  • Print
  • + Share This
This chapter is from the book

Using the WScript Object

WSH provides a built-in object named WScript for all scripts in all languages. We've used its Echo method in many of the examples in this book. WScript has several other methods and properties, as listed in Reference List 3.2, that you might find useful in writing scripts.

Reference List 3.2. Properties and Methods of the WScript Object

Properties

Arguments

Returns a collection of WshArguments objects, representing the strings on the command line used to start WScript or Cscript. For example, if a script is started with the command

WScript myscript.vbs aaa bbb

or

myscript aaa bbb

then WScript.arguments.item(0) would yield "aaa" and WScript.arguments.item(1) would yield "bbb".WScript.arguments.length gives the number of arguments.

I discuss arguments in more detail in the next section.

BuildVersion

Returns a number identifying the current version of Windows Script Host. This number might vary between versions of Windows and as WSH is updated through Windows Update. I have seen WSH on Windows 7 return 0 for this property. I would not trust it to be usable.

FullName

Returns the full path and filename of the WSH program that is running your script (for example, c:\Windows\System32\cscript.exe).

Interactive

A Boolean value: True if the script is running in Interactive mode and False if in Batch mode. You might set this property using the //I or //B switch on the command line, or you might directly set the value in a script (for example, WScript.Interactive = False). In Batch mode, message and input boxes do not appear.

Name

Returns the name of the script host program (for example, "Windows Script Host").

Path

Returns the name of the directory containing the script host program (for example, "c:\Windows\System32").

ScriptFullName

Returns the full path and name of your script file (for example, "c:\test\myscript.vbs").

ScriptName

Returns the name of your script file (for example, "myscript.vbs").

StdErr, StdIn, and StdOut

These are file streams that can be used to read from the standard input or write to the standard output and error files. I discuss these in Chapter 4, "File and Registry Access." These properties are available with cscript only, not wscript.

Version

Returns the version of WSH (for example, "Version 5.7").

Methods

CreateObject( progid [ , prefix ] )

Similar to the built-in CreateObject function. With a prefix argument, it creates connected objects that can communicate events to the script. (Events are beyond the scope of this book.)

ConnectObject object , prefix

Connects an existing object to the script using event handler functions whose names begin with the string prefix .

DisconnectObject object

Disconnects the script from an object's events.

Echo arg [ , arg ] ...

Displays any number of arguments of any type, formatted as strings and separated by spaces. Cscript writes them to the standard output, whereas WScript displays them in a pop-up message box.

GetObject(filename [, progid][, prefix])

Creates an object based on information stored in a file (for example, a document). If progid is not specified, it is determined from the file type. prefix might be specified to connect object events to the script.

GetObject can also obtain a reference to a preexisting object by specifying a special name called a moniker. This is illustrated extensively in Chapters 7 and 8.

Quit [ errorcode ]

Terminates the script. If a numeric value is specified, it is returned as the process's exit code—this can be useful when running scripts from batch files.

Sleep msec

Causes the script to pause for msec milliseconds. For example, WScript.sleep 1000 pauses for one second.

Of the properties and methods listed, the most useful are the Echo and Arguments properties. Let's see how you can use arguments to control what a script does when you run it.

Retrieving Command-Line Arguments

The use of command-line arguments is a common way of specifying information to a script at the moment it's run. The most common use for this is to write scripts that manipulate files, user accounts, or computers. The script can be written in a generic way, so that you can specify the particular files, people, or what-have-you at the time you run the script. For example, a script to process a file could be written like this:

   filename = "specialdocument.doc"
   'statements to operate on the file named filename
   u22ee.jpg

However, if you wanted to use this script to work with a different file, you'd have to edit the script. If you want a more general-purpose script, write the script to get the filenames from its command line, so you can simply type something like this:

   C:\> myscript some.doc another.doc

Then, the script will operate on the files whose names you typed, rather than on a file whose name is built in to the script.

Usually, each programming language has its own way of providing command-line arguments to a program, but in the WSH environment, there is only one way they are obtained—through the WScript object's Arguments property.

The WScript.Arguments property returns a collection of objects, one for each item listed on the script's command line. You can write a script to use these arguments this way, more or less:

   for each filename in WScript.arguments
       ' statements to operate on the file named filename
       u22ee.jpg
   next

Of course, you have to use whatever method of manipulating objects and collections is appropriate to the script language you're using (this example is in VBScript). With script myscript.vbs, the command line

   C:\> myscript some.doc another.doc

sets up the WScript.Arguments collection with two items: some.doc and another.doc. In VBScript, the for each statement lets your script process them in turn.

If you don't specify any command-line arguments, though, this script does nothing at all. It's best to have a script tell the user how to use it properly in this case. Here's a scheme for writing command-line scripts that you might find to be handy.

Alternatively, you might want your script to operate on a default file if no files are named on the command line. Such a script should use a subroutine to do the actual processing of the files, so the subroutine can be called with either the default file or with specified files. In VBScript, it looks like this:

   if WScript.arguments.length = 0 then
       ' no arguments on command line -- process file "default.file"
       process "default.file"
   else
       ' process each of the files named on the command line
       for each filename in WScript.arguments
           process filename
       next
   end if
   sub process (filename)
      ' statements to process filename
      u22ee.jpg
   end sub

In Chapter 9, I show you how to use more powerful types of command-line processing.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020