Writing VBScripts

Brief Background of VBScript

• Overview of Scripting Architecture
• Supported Software Platforms
• The Visual Basic Programming Model

• Language Structure
  • Comments
  • Variables
    • Types of Variables
    • Variable Typing
    • Variable Naming
    • Number of Variables Allowed
    • Dim
    • Option Explicit
    • Uninitialized Variables
    • Constant Variables
    • Empty
    • Null
    • Nothing
    • True and False
    • Variable Scope and Global Variables.
    • Arrays and Declarations
    • Dim and ReDim
  • Procedures
    • Sub
    • Call
    • Exit Sub
  • User-Built Functions
  • Operators
    • Assignments
    • Math
    • String
    • Comparison
  • Built-In Functions
    • Conversions
    • Dates/Times
    • Math
    • exp, log, sqr
    • Array Functions
    • String Functions
    • Instr, InStrB
    • Lcase, Ucase
  • Variants
  • Program Flow
    • Do...Loop
    • For...Next
    • If...Then...Else
    • Select Case
    • While...Wend
  • Error Handling
  • User Interface
  • Resources
• Summary
• Q&A
• Workshop
• Quiz

Chapter Six

Writing VBScripts

Today you will learn VBScript. You have already used quite a bit of VBScript. You implemented VBScript by both hand coding directly on the HTML page, as covered on Day 2, and with the three editing tools you looked at Day 4: Word, HoTMetaL, and the ActiveX Control pad. Yesterday you used VBScript in some of the examples of programming inside the Internet Explorer. Today, after looking briefly at the background of VBScript, you will learn many aspects of the language from variables to error handling. By the end of the day, you will have examined dozens of examples, and you will be ready to use VBScript in a project.

Brief Background of VBScript

VBScript grew out of Visual Basic, a programming language that has been around for several years. Visual Basic is the basis for scripting languages in the Microsoft Office, Word, Access, Excel, and PowerPoint. Visual Basic is component based. You build a Visual Basic Program by placing components onto a form and then using the Visual Basic language to lace them together. Visual Basic also gave rise to the grandfather of the ActiveX control, the Visual Basic Control (VBX). Visual Basic Controls shared a common interface that allowed them to be placed on a Visual Basic form. This was one of the first wide-spread uses of component-based software. VBXs gave way to OLE Controls (OCXs), which were renamed ActiveX. So when Microsoft took an interest in Internet affairs, they moved OCX to ActiveX modeled VBScript after Visual Basic.

Overview of Scripting Architecture

To learn VBScript you will cover the following topics. There will be several examples and a test at the end—so pay attention.

• Software platforms that support VBScript
  
  
• The VBScript programming model
  
  
• Variable types
  
  
• Operators
  
  
• Variable scope
  
  
• Functions
  
  
• Program flow structures
  
  
• User-interface elements of VBScript.
  
  

Supported Software Platforms

As of this writing only one Web browser supports VBScript: Internet Explorer from Microsoft. It can be downloaded at http://www.microsoft.com/ie/ie.asp.

Internet Explorer is freeware in its third version. The other major Web browser, NetScape, has no built-in capability to run VBScript or use ActiveX objects. However, it is very probable that by the time you read this, there will be a plug-in module for NetScape that will support both VBScript and ActiveX objects. NetScape is available at http://home.netscape.com.

Microsoft currently controls both the ActiveX and VBScript standards. But, Microsoft did recently publish its intention to transfer the ActiveX standard to a industry-standards body.

The bottom line is that if you need to use VBScript and ActiveX right now, you have to use the Internet Explorer as your target software platform.

The Visual Basic Programming Model

VBScript is a procedural language . To those of you who are new to programming, a procedural language uses subroutines as the basic unit. During previous Days, you have seen many subroutines used to do work on a Web page. For example, during Day 5, "Programming for Internet Explorer," you wrote the following subroutine inside an HTML page you called boxes.asp.

Sub LoadMe() Alert "This Space for Rent" Answer = Confirm("Launch the Shuttle?") String1 = Prompt("Enter Here","Defaulted Text") Alert string1 end sub

Everything between Sub and end sub is a procedure. VBScript and procedural languages in general are strong in the areas of ease of use, and speed of implementation. The downside of procedural languages is that large projects tend to become unmanageable. Web pages, have to be passed across the Net in a reasonable period of time, which favors small code, making VBScript is a good fit.

What about all those objects you used on Day 5? Good question! You have used objects such as window.document.write() and the ActiveX objects TextBox, Label, and Layout, so it is possible to use objects inside VBScript. What is not possible is creating objects with VBScript.

Language Structure

Let's get to know VBScript. We will start off with a discussion of the general elements of the language, and before you are through, you will cover every keyword in VBScript. Most of the examples you use to learn VBScript will be run from within the framework of template.asp, shown in Listing 6.1.

Listing 6.1. template.asp .

<HTML> <HEAD> <TITLE>Example Template</TITLE> <SCRIPT LANGUAGE="VBScript" > <!-- Sub LoadMe() ' Your Code Here end sub Sub OutofHere() ' Your Code Here end sub --> </SCRIPT> </HEAD> <BODY Language="VBS" onLoad="LoadMe" onUnload = "OutofHere"> </BODY> </HTML>

Notice how the Language attribute of the <SCRIPT> tag is set to VBScript . We have covered all the elements of this Web page during the previous days of the week. As you can see, it assigns two functions to two window object events. One function, Loadme() is assigned to the onLoad event. This causes Loadme to be run whenever the page is loaded. OutofHere() is assigned to the onUnload event and is be fired every time you leave the page.

VBScript is not case sensitive. In VBScript, a Rose is a ROSE is a rose. This will be a little unsettling for those of you coming from a C or C++ programming background but old hat for those of you familiar with Pascal or Visual Basic. You are free to capitalize at will. There will be a few cases, discussed later today when I will recommend the use of capitalization but its use is entirely up to you.

So how do you tell one line from another? In VBScript all you have to do is start a new line. Observe the following code:

</SCRIPT> <SCRIPT LANGUAGE="VBScript"> <!-- Sub CommandButton1_Click() parent.frames(1).navigate TextBox2.Text label1.caption = parent.frames(1).location.href end sub --> </SCRIPT>

Notice the lines have no visible terminator. Some languages, such as C, use a semicolon (;) as the terminator for a line. Lines of code in VBScript use the line feed at the end of the line as a terminator.

If you feel the need to pack several lines of code on one line, use a colon (:) to separate them, as shown in Listing 6.2.

Listing 6.2. separate.asp .

<HTML> <HEAD> <TITLE>Example Template</TITLE> <SCRIPT LANGUAGE="VBScript" > <!-- Sub LoadMe() ' Your Code Here A = A + 1 : A = A + 1: A = A + 1 document.open:document.write:document.close end sub Sub OutofHere() ' Your Code Here end sub --> </SCRIPT> </HEAD> <BODY Language="VBS" onLoad="LoadMe" onUnload = "OutofHere"> </BODY> </HTML>

Notice how this is embedded into template.asp. Running this program produces the number 3. Multiple program lines on the same physical line will also annoy any programming purists you work with. I recommend you keep to one statement per line. Keep your code well organized and easy to read.

Listing 6.2 is the only example using the entire template that I will show you. You will focus on the code inside.

Indentation is not required to make the language work. Compare the following code segments.

Sub LoadMe() ' Your Code Here A = A + 1 A = A + 1 A = A + 1 document.open document.write document.close end sub

runs the same as

Sub LoadMe() ' Your Code Here A = A + 1 A = A + 1 A = A + 1 document.open document.write document.close end sub

But the second example won't win you many points for style. I recommend that you use indentation to help organize your code so that if you or others ever have to go back and maintain it, your code will be easier to understand. You will see examples of indentation used for clarity throughout this chapter.

Comments

Comments can make your life (or the life of someone who looks at your work later) much easier. Remarks are not required in VBScript. But, if you want to leave remarks in your code you have two choices: Rem and '; Any characters from the start of the remark to the end of the line are ignored when the script is run. The next segment is an example of Rem:

<SCRIPT LANGUAGE="VBScript"> <!-- rem Here is rem used on a separate line Sub CommandButton1_Click():Rem This is rem after a comment, notice the : parent.frames(1).location.href = TextBox2.Text label1.caption = parent.frames(1).location.href end sub --> </SCRIPT>

If you use the Rem at the end of a line, you must use a colon (:) or you will get an error. Here is the same example using a single quote (').

<SCRIPT LANGUAGE="VBScript"> <!-- 'remark used on a separate line Sub CommandButton1_Click()'This is rem after a comment, notice the there is no : parent.frames(1).location.href = TextBox2.Text label1.caption = parent.frames(1).location.href end sub --> </SCRIPT>

Variables

Variables are those things you learned in high school algebra. You remember, the class you knew would never apply to your "real" life. Well, we were wrong. Without variables, computer languages could do little more than power player pianos or music boxes, limited to doing preset tasks over and over. Variables are what allowed you to send people to the moon, build addictive games like Doom, or make interactive Web pages.

Types of Variables

VBScript has only one variable type, the Variant. The Variant can be any type of data. For example this line

string1 = "hello world"

sets the value of string1 to "hello world". In the very next line you could type:

string1 = 2 + 2

Try it yourself. Add the code in Listing 6.3 to template.asp.

Listing 6.3. The variant.asp subroutine .

Sub LoadMe() ' Your Code Here string1 = "hello world" window.document.open window.document.writeln("<PRE>") window.document.writeln(string1) string1 = 2 + 2 window.document.writeln(string1) window.document.writeln("</PRE>") window.document.close end sub

Save it as variant.asp, then run it in the browser. You should see

hello world 4

on your Web page. Remember the <PRE> (Preformatted Text) tag allows the browser to execute the new line character that the writln function generates.

Variable Typing

This example also suggests that VBScript is loosely typed. This means that in VBScript you can add an int to a real without using a conversion function. A strongly typed language would not allow you to add an int to a float, or a string to an int. Modify the code you just did so it looks like Listing 6.4.

Listing 6.4. Using loosely typed variables .

Sub LoadMe() ' Your Code Here string1 = "42" window.document.open window.document.writeln("<PRE>") window.document.writeln(string1) string2 = 2 + string1 window.document.writeln(string2) window.document.writeln("</PRE>") window.document.close end sub

Save it as loosetyp.asp and run it in the browser. You should see

42 44

proving that VBScript is loosely typed. The advantage to a loosely typed language is that you don't have to remember lots of conversion functions. The disadvantage is that you are at the mercy of the language interpreter. The interpreter determines what conversions need to be done and how. You need to keep an eye on these automatic conversions. In the section later today that covers the built-in functions of VBScript, you will cover conversion functions in VBScript that give you the ability to precisely change one type to another.

Variable Naming

What can you name the Variant variables? There are four rules for naming a VBScript variable:

• Begin with an alphabetic character.
  
  
• Do not include an embedded period.
  
  
• Do not exceed 255 characters.
  
  
• Make it unique in the scope in which it is declared.
  
  

This means a variable such as 22street would return an error like the one shown in Figure 6.1

Figure 6.1. Results of an improper variable name .

This error was generated by changing string1 in variant.asp to 22street, as shown in this pseudo code:

Sub LoadMe() ' Your Code Here 22street = "hello world" window.document.open window.document.writeln("<PRE>") window.document.writeln(string1) 22street = 2 + 2 window.document.writeln(string1) window.document.writeln("</PRE>") window.document.close end sub

Number of Variables Allowed

Now that you know how to name a variable, the next question is, how many variables can you use? The answer is that a particular form can have no more that 127 variables. This shouldn't be a limitation unless you do some kind of heavy duty number crunching on the forms. But it is a small enough number that you need to remember it just in case one of your contemporaries (you would never make this mistake) puts 128 variables on a form.

Dim

Dim declares variables . Declaring variables is easy, and optional, in VBScript. Consider Listing 6.5.

Listing 6.5. Using the Dim statement .

Sub LoadMe() ' Your Code Here Dim string1 string1 = "I was declared" window.document.open window.document.writeln("<PRE>") window.document.writeln(string1) string2 = "I wasn't declared" window.document.writeln(string2) window.document.writeln("</PRE>") window.document.close end sub

Notice how string1 is declared using and string2 is not declared. The form will produce the lines:

I was declared I wasn't declared

Not declaring your variables will work, but will not sit well with programming purists. Or you may be working in a corporation that has programming standards requiring all variables to be declared. There is a way in VBScript to require all variables to be declared: Option Explicit.

Option Explicit

Placing Option Explicit at the beginning of a <SCRIPT> section generates an exception whenever your code tries to use a variable that is not declared. Modify the Listing 6.5 to use Option Explicit as shown in Listing 6.6.

Listing 6.6. Using Option Explicit to force variable declaration .

<SCRIPT LANGUAGE="VBScript" > <!-- Option Explicit Sub LoadMe() ' Your Code Here Dim string1 string1 = "I was declared" window.document.open window.document.writeln("<PRE>") window.document.writeln(string1) string2 = "I wasn't declared" window.document.writeln(string1) window.document.writeln("</PRE>") window.document.close end sub Sub OutofHere() ' Your Code Here end sub --> </SCRIPT>

Showing this page results in the error box shown in Figure 6.2.

Figure 6.2. Option Explicit at work.

Option Explicit applies only to the <SCRIPT> section in which it is declared. Look at Listing 6.7.

Listing 6.7 Where Option Explicit applies .

<SCRIPT LANGUAGE="VBScript" > <!-- Sub LoadMe() ' Your Code Here Dim string1, string2 string1 = "I was declared" window.document.open window.document.writeln("<PRE>") window.document.writeln(string1) string2 = "So Was I!" window.document.writeln(string2) window.document.writeln("</PRE>") window.document.close end sub --> </SCRIPT> <SCRIPT LANGUAGE="VBScript" > <!-- Sub OutofHere() ' Your Code Here exitmessage = "Thats all folks" window.alert(exitmessage) end sub --> </SCRIPT>

Notice how there are two <SCRIPT> sections and only one has Option Explicit. Run Listing 6.7 (optexp02.asp). You will get:

I was declared So Was I!

Notice that you leave the Web page by loading a new one; you will fire the onunload event and get the alert box as shown in Figure 6.3

Figure 6.3. The Alert box fired in the Unload event.

The second section of <SCRIPT> was not effected by the Option Explicit in the first block.

Uninitialized Variables

If you use Dim to declare a variable then print that variable, what will be in it? I have spent days in other languages tracking down bugs caused by uninitialized variables where the variable was assigned to some random number. VBScript does not support this kind of frustration. Variables in VBScript are given a value of a zero-length string ("") when they are declared in the Dim statement. Let's prove it. Enter the code in Listing 6.8.

Listing 6.8 Testing variable initialization .

Sub LoadMe() ' Your Code Here Dim string1, string2 window.document.open window.document.writeln("<PRE>") window.document.write("string1 = ") window.document.writeln(string1) window.document.write("string2 = ") window.document.writeln(string2) window.document.writeln("</PRE>") window.document.close end sub

Save it as initial.asp and run it. You will get the output:

string1 = string2 =

which shows the initial value to be empty. Modify the code slightly as shown in Listing 6.9 (initial2.asp).

Listing 6.9. More On initialzation .

Sub LoadMe() ' Your Code Here Dim string1, string2 window.document.open window.document.writeln("<PRE>") window.document.write("string1 = ") window.document.writeln(string1) window.document.write("string2 = ") window.document.writeln(4 + string2) window.document.writeln("</PRE>") window.document.close end sub

This treats the second variable, string2, as a number and produces the following output:

string1 = string2 = 4

The output shows that string2's initial value, when expressed as a number, is 0.

Constant Variables

In general, VBScript does not support the idea of constant variables . A constant variable is one of those programming oxymorons that means a variable that cannot be changed once it is declared. A constant variable is used to hold things such as the value of pi, which should not be open to the interpretation of the programmer. This prevents the programmer from improving on pi or accidentally changing pi. Unfortunately you don't have constant variables in VBScript, but there are ways to work around this limitation.

To implement constants in your Web pages, give them a unique identifier like PI or MAXROWS (I recommend all uppercase letters—it is the C programmer in me) and invent a stiff penalty for programmers that change them during the course of a program (I recommend reassignment as the tech writer for a group of assembly language programmers—they hate that).

After telling you that you cannot declare a constant variable, I have to tell you now that VBScript contains five built-in constant variables: Empty, Null, Nothing, True, and False. Again, since VBScript is not case sensitive, I recommend that you capitalize these in your code.

Empty

The Empty keyword is used to indicate an uninitialized variable value. Let's see if it works. Type in the Listing 6.10 as const01.asp.

Listing. 6.10. Using the Empty keyword for variables .

Sub LoadMe() ' Your Code Here Dim string1 window.document.open window.document.write("string1 is empty ") if (string1 = empty) then window.document.writeln("<PRE>") else window.document.write("string1 is not empty ") end if window.document.writeln("</PRE>") window.document.close end sub

Now run it. You will get the result:

string1 is empty

The same result is achieved by using the isEmpty function inside the if statement. Empty is different from the next constant Null. Let's find out how.

Null

Null means that a variable contains no valid data. This is different than the uninitialized data that empty refers to. Assign a value of Null and then test for it by using the function IsNull, as shown in const02.asp (Listing 6.11).

Listing 6.11. Using the Null constant .

Sub LoadMe() ' Your Code Here Dim string1 string1 = Null window.document.open window.document.writeln("<PRE>") if (string1 = empty) then window.document.write("string1 is empty ") end if if (isNull(string1)) then window.document.write("string1 Null ") end if window.document.writeln("</PRE>") window.document.close end sub

When you run Listing 6.11, it bypasses the first if statement and produces the output:

string1 is Null

A variable can be set to Null and then tested later in the program to see if any data has been put in it. A Null variant contains no data where an empty variant contains uninitialized data.

Nothing

Nothing differs from both Null and Empty in that it is applied to objects and has no associated testing function. When you set an object to Nothing, you sever any ties the variable had to the object. To set an object to Nothing, you use the Set statement as in

Set MyObject = Nothing

Doing this reallocates any system memory or resources allocated to the object. You can use the following code:

if isObject(MyObject) then MyObject.document.open MyObject.document.write("Written by MyObject") MyObject.document.close end if Set MyObject = Nothing

However, if you try to use MyObject after setting it to Nothing, you get one or two messages saying that the object is not initialized and then you get a GP fault, which takes down your Internet Explorer. I would not use this method to de-allocate memory and resources. If you use it, I recommend you test your objects (if MyObject = nothing then...) before using them. As you shall see later in the day, VBScript cleans up after itself pretty well.

True and False

The last two constants are True and False . These two are the classic boolean constant variables. In VBScript, they have the internal values of -1 for True and 0 for False. This means you can not use the old C trick of assuming true is any value that is not zero. Try the code in Listing 6.12 (const03.asp) and see.

Listing 6.12. Using True and False .

Sub LoadMe() ' Your Code Here Vartwo = -1 Varthree = 10 if Vartwo = True then window.document.open window.document.writeln("<PRE>") window.document.writeln("Vartwo is True") window.document.writeln("</PRE>") window.document.close end if if VarThree = true then window.document.open window.document.writeln("<PRE>") window.document.writeln("VarThree is True") window.document.writeln("</PRE>") window.document.close end if end sub

As predicted, this produces the result:

Vartwo is True

Variable Scope and Global Variables.

The scope of a variable has to do with where it is visible within the structure of a program or an HTML page. Look at Listing 6.13 (scope01.asp).

Listing 6.13. scope01.asp .

<SCRIPT LANGUAGE="VBScript" > <!-- Dim MyVariable MyVariable = "Global edition of My Variable" Sub LoadMe() ' Your Code Here window.document.open window.document.writeln("<PRE>") window.document.write("In LoadMe MyVariable is ") window.document.writeln(MyVariable) ThingOne ThingTwo window.document.writeln("</PRE>") window.document.close end sub Sub ThingOne() dim Myvariable MyVariable = "ThingOne edition of MyVariable" window.document.write("In ThingOne MyVariable is ") window.document.writeln(MyVariable) end sub Sub ThingTwo() window.document.write("In ThingTwo MyVariable is ") window.document.writeln(MyVariable) end sub --> </SCRIPT>

This produces the output:

In LoadMe MyVariable is Global edition of My Variable In ThingOne MyVariable is ThingOne edition of MyVariable In ThingTwo MyVariable is Global edition of My Variable

The first thing you should notice is that the MyVariable declared outside of the functions is visible to all functions in the <SCRIPT> making it global. Then, when a variable is declared inside ThingOne with the same name, that local variable is used inside procedure ThingOne. Just to prove you didn't overwrite the global MyVariable, ThingTwo writes the value of MyVariable, and you see that the global MyVariable hasn't changed. Also worth noting here is how the Window object is global. The Window object is visible from anywhere in your HTML page. Change the code so ThingOne and ThingTwo are in a different <SCRIPT> tag (See Listing 6.14, scope02.asp):

Listing 6.14. scope02.asp .

<SCRIPT LANGUAGE="VBScript" > <!-- Dim MyVariable MyVariable = "Global edition of My Variable" Sub LoadMe() ' Your Code Here window.document.open window.document.writeln("<PRE>") window.document.write("In LoadMe MyVariable is ") window.document.writeln(MyVariable) ThingOne ThingTwo window.document.writeln("</PRE>") window.document.close end sub --> </SCRIPT> <SCRIPT LANGUAGE="VBScript" > <!-- Sub ThingOne() dim Myvariable MyVariable = "ThingOne edition of MyVariable" window.document.write("In ThingOne MyVariable is ") window.document.writeln(MyVariable) end sub Sub ThingTwo() window.document.write("In ThingTwo MyVariable is ") window.document.writeln(MyVariable) end sub --> </SCRIPT>

Run the page. The results are identical. So scope applies across <SCRIPT> sections.

Arrays and Declarations

You can also create arrays of variables. An array is a collection of variables of the same type. If you have an array of MyThings, you would get the first element of MyThings by writing MyThings(0). If you want the second element, you would type, MyThings(1), and so on where 0 and 1 reflect the index of the array. VBScript uses parentheses, (), to enclose the index. Arrays can have more than one dimension. For example, Dim MYArray(10,10) creates an array with 100 possible values. Arrays where the first element is stored in the element zero are called zero-based arrays. Arrays in VBScript are zero based. To declare an array, you use the same Dim function you used to declare a single variable.

Dim and ReDim

There are two ways to declare an array. The first is to declare the size of the array in the Dim statement, as shown in Listing 6.15 (array01.asp).

Listing 6.15. array01.asp .

<SCRIPT LANGUAGE="VBScript" > <!-- Sub LoadMe() Dim string1(2) string1(0) = "This is " string1(1) = "the end " alert string1(0) & string1(1) end sub -->

This code produces an Alert dialog, as shown in Figure 6.4.

Figure 6.4. Results of array01.asp.

If you want to vary the memory requirements of your array at runtime, you would Dim the array without a value and then use ReDim to set and reset the size. This is shown in Listing 6.16 (array02.asp).

Listing 6.16. array02.asp .

<SCRIPT LANGUAGE="VBScript" > <!-- Sub LoadMe() Dim string1() ReDim string1(2) string1(0) = "This is " string1(1) = "the end " alert string1(0) & string1(1) ReDim string1(3) string1(0) = "This is " string1(1) = "the end " string1(0) = "Really " alert string1(0) & string1(1) & string1(2) end sub --> </SCRIPT>

Notice how the array is declared using Dim string(), and then redimensioned twice using the ReDim function. This allows you to dimension the array according to runtime requirements.

Now that you know everything about variables, or at least enough to start using variables, you can become formally introduced to the structure where you will be doing most of your work: the procedure.

Procedures

In general, a procedure contains programming instructions and can be assigned to events or called from other functions. You have seen procedures in every example today. To be more precise, you have seen one kind of procedure in every example today: the subroutine. The other kind of procedure is the function. Let's look at subroutines first.

Sub

The keyword Sub starts a subroutine . A subroutine is a collection of program statements that fall between the keyword Sub and the end sub statement, which marks the end of the subroutine. The general structure, that you have used many times already, appears in the following syntax:

Sub LoadMe() ' Declare Variables Dim string1() ReDim string1(2) ' Do some Work string1(0) = "This is " string1(1) = "the end " alert string1(0) & string1(1) ReDim string1(3) string1(0) = "This is " string1(1) = "the end " string1(0) = "Really " alert string1(0) & string1(1) & string1(2) ' Leave when we are done end sub

A subroutine can also have arguments. Arguments are variables that are passed to the subroutine. Type in and run Listing 6.17 (sub01.asp).

Listing 6.17. sub01.asp .

Sub LoadMe() ' Your Code Here firstnum = window.Prompt("Enter a number",10) secondnum = window.Prompt("Enter another number",20) SumONumbers firstnum, secondnum end sub Sub SumONumbers(a, b) answer = a + b window.document.open window.document.writeln("<PRE>") window.document.write("The Answer is -> ") window.document.writeln(answer) window.document.writeln("</PRE>") window.document.close end sub

The idea here is pretty straight forward: Have the user enter two numbers and then call a function to add them together (use the defaults 10 and 20) and display them.

Run the page, you will get

The Answer is -> 1020

Wait a minute! Adding 10 and 20 should equal 30, not 1020! Remember before, in this discussion of variables, that you saw how the language does conversions for you. In this case the computer is treating the inputs as strings and adding them together. Later today, in the section on built-in VBScript functions, you will revisit this example and use some of VBScripts built-in procedures to make the numbers add up.

Call

Call is an optional element that can be used to start a subroutine . If you do use it, you must enclose any arguments in parentheses. For example, the call to SumONumbers in Listing 6.17 could be rewritten:

call SumONumbers( firstnum, secondnum)

There is no particular advantage to using call.

Exit Sub

Exit Sub provides a way to leave a subroutine somewhere other than the End Sub. When Exit Sub is called, the program resumes running on the line after the call to the subroutine, as in Listing 6.18 (sub02.asp).

Listing 6.18. sub02.asp .

Sub LoadMe() ' Your Code Here firstnum = 10 secondnum = 30 SumONumbers firstnum, secondnum end sub Sub SumONumbers(a, b) answer = a + b window.document.open window.document.writeln("<PRE>") window.document.write("The Answer is -> ") window.document.writeln(answer) window.document.writeln("</PRE>") window.document.close if (a + b) > 0 then exit sub end if window.document.open window.document.writeln("<PRE>") window.document.write("Error, negative sum") window.document.writeln("</PRE>") window.document.close end sub

Left as it is, this page performs the exit sub in the middle of SumONumbers and displays the number 40. If you change one of the variables in the LoadMe subroutine to be a negative number, then the second message, "Error, negative sum", is displayed. I do not recommend using exit sub. I have found that in the long run, it is harder to maintain procedures with multiple exit points than procedures with a single exit.

There are a couple of things you can't do with subroutines. First, you can not declare a subroutine inside another procedure. Second, you can not pass a reference to an argument. The variables passed to a subroutine are copies of the originals, changing these copies has no effect on the original. Third, a subroutine cannot be used as part of an expression, as in, Var1 = Var2 + MySub, because a subroutine doesn't return a value. To return a value, you use the other type of procedure called a function.

User-Built Functions

A function has the same general structure as a subroutine but functions have different keywords and the capability to return a value. Type in the code in Listing 6.19 (sub03.asp):

Listing 6.19. sub03.asp .

Sub LoadMe() ' Your Code Here window.document.open window.document.writeln("<PRE>") window.document.write("The Answer is -> ") window.document.writeln(RADtoDeg(3.14)) window.document.writeln("</PRE>") window.document.close end sub Function RADtoDEG(Radian) RADtoDEG = Radian * 57.32 end Function

This is a simple radians to degrees function. Notice the keyword Function is at the beginning and end. Also see how the value of the function is assigned using the function name. If no value is assigned the function value is assigned to uninitialized, which is 0 if the function is used in a numeric expression and "" if the function is used as a string.

Functions can not be declared inside other procedures. And, like subroutines, the arguments passed to the function are only copies, changing the copies has no effect on the original variables.

Functions are strung together with operators. Let's see what you can use to operate.

Operators

Operators determine what you do to variables and functions. There are five types of operators: assignment, math, mtring, comparison, and object. Let's start with the most used, assignments.

Assignments

You use assignment operators all the time to assign one value to another; assignment variables are the heart of programming. VBScript has two ways to assign one value to another, the equal symbol (=) and Set.

The = Operator

You have already used the equal sign (=) hundreds of times in this guide. We use it so much, we start to take it for granted. It does the simplest and most powerful thing you can do in a program, assign one variable to another. The general form is myvariable = someothervariable, or myvariable = somevalue. It can be used to assign everything in VBScript except objects.

Set

The Set keyword is used to define objects. Type in the following and call it set01.asp (see Listing 6.20).

Listing 6.20. set01.asp .

Sub LoadMe() ' Your Code Here Set MyWindow = window MyWindow.document.open MyWindow.document.writeln("<PRE>") MyWindow.document.writeln("Did this with my own object") MyWindow.document.writeln("</PRE>") MyWindow.document.close end sub

In this example, you use the Set function to set the variable MyWindow to the object window. When used this way, setting a variable to an object, Set creates a reference to the object. You are free to create as many references to an object as you want using Set. Set does not create a new object, only a reference to it.

Set can also be used to assign a variable to a value other than a set. For example, you could write Set MyVariable = 9, and it would be the same as MyVariable = 9. Set is optional for variable assignment but required when objects are assigned.

Math

The math functions are another group we tend to take for granted. The important thing to note as you go through these operators is how they work on various combinations of integer and real numbers.

Addition (+)

The + operator covers both reals and integers in that it can be used to add any two numbers together. Consider Listing 6.21:

Listing 6.21 The addition operator .

Sub LoadMe() ' Your Code Here example1 = 2 + 2 example2 = 5.67 + 1 example3 = 9.9 + 4.568 window.document.open window.document.writeln("<PRE>") window.document.write("example 1 = ") window.document.writeln(example1) window.document.write("example 2 = ") window.document.writeln(example2) window.document.write("example 3 = ") window.document.writeln(example3) window.document.writeln("</PRE>") window.document.close end sub

This produces the result:

example 1 = 4 example 2 = 6.67 example 3 = 14.468

Here you add two integers and get an integer. You also add an integer and a real and get a real.

Subtraction (-)

Subtraction also applies to both integers and reals. Look at Listing 6.22 (math02.asp):

Listing 6.22. math02.asp .

Sub LoadMe() ' Your Code Here example1 = 2 - 20 example2 = 5.67 - 1 example3 = 9.9 - 4.568 window.document.open window.document.writeln("<PRE>") window.document.write("example 1 = ") window.document.writeln(example1) window.document.write("example 2 = ") window.document.writeln(example2) window.document.write("example 3 = ") window.document.writeln(example3) window.document.writeln("</PRE>") window.document.close end sub

This page produces the result:

example 1 = -18 example 2 = 4.67 example 3 = 5.332

Again, an integer minus an integer is an integer. Any other combination is a real.

Exponentiation (^)

This symbol raises a number by a power as illustrated in Listing 6.23 (math03.asp):

Listing 6.23. math03.asp .

Sub LoadMe() ' Your Code Here example1 = 2 ^ 8 example2 = 5.67 ^ 2 example3 = 9.9 ^ 4.568 window.document.open window.document.writeln("<PRE>") window.document.write("example 1 = ") window.document.writeln(example1) window.document.write("example 2 = ") window.document.writeln(example2) window.document.write("example 3 = ") window.document.writeln(example3) window.document.writeln("</PRE>") window.document.close end sub

This produces the following result:

example 1 = 256 example 2 = 32.1489 example 3 = 35323.3243300256

Modulus Arithmetic (Mod)

The Mod function divides the first number by the second number and returns the remainder, as show in Listing 6.24 (math04.asp):

Listing 6.24. math04.asp .

Sub LoadMe() ' Your Code Here example1 = 2 Mod 8 example2 = 2 Mod 5.67 example3 = 4.5 Mod 4600.9 window.document.open window.document.writeln("<PRE>") window.document.write("example 1 = ") window.document.writeln(example1) window.document.write("example 2 = ") window.document.writeln(example2) window.document.write("example 3 = ") window.document.writeln(example3) window.document.writeln("</PRE>") window.document.close end sub

Real numbers are rounded to integers during the Mod. The results of the above are as follows:

example 1 = 2 example 2 = 2 example 3 = 4

Multiplication (*)

This operator multiplies two numbers, as shown in Listing 6.25 (math05.asp):

Listing 6.25. math05.asp .

Sub LoadMe() ' Your Code Here example1 = 2 * 8 example2 = 2 * 5.67 example3 = 4.5 * 4600.9 window.document.open window.document.writeln("<PRE>") window.document.write("example 1 = ") window.document.writeln(example1) window.document.write("example 2 = ") window.document.writeln(example2) window.document.write("example 3 = ") window.document.writeln(example3) window.document.writeln("</PRE>") window.document.close end sub

This returns the following result:

example 1 = 16 example 2 = 11.34 example 3 = 20704.05

Note that an integer times an integer returns an integer. All other combinations return a real.

Division (/)

Division works the same way as multiplication. See the Listing 6.26 (math06.asp):

Listing 6.26. math06.asp .

Sub LoadMe() ' Your Code Here example1 = 25 / 8 example2 = 2 / 5.67 example3 = 4.5 / 4600.9 window.document.open window.document.writeln("<PRE>") window.document.write("example 1 = ") window.document.writeln(example1) window.document.write("example 2 = ") window.document.writeln(example2) window.document.write("example 3 = ") window.document.writeln(example3) window.document.writeln("</PRE>") window.document.close end sub

This page results in

example 1 = 3.125 example 2 = 0.352733686067019 example 3 = 9.78069508139712E-04

which shows that in the case of division, all cases return a real.

Integer Division (\)

This is the companion function to Mod. Where Mod returns the remainder the division operator returns the integer result of the division. See Listing 6.27 (math07.asp):

Listing 6.27. math07.asp .

Sub LoadMe() ' Your Code Here example1 = 25 \ 8 example2 = 2000 \ 5.67 example3 = 400.5 \ 46.9 window.document.open window.document.writeln("<PRE>") window.document.write("example 1 = ") window.document.writeln(example1) window.document.write("example 2 = ") window.document.writeln(example2) window.document.write("example 3 = ") window.document.writeln(example3) window.document.writeln("</PRE>") window.document.close end sub

This page results in the following lines:

example 1 = 3 example 2 = 333 example 3 = 8

Negation (-)

The final math operator is negation (-). This is a straightforward concept. If you set a = 2, then write a line such as, a = -a, the final value of a is -2. This operator simply returns the negative.

String

There is only one string operator : concatenation (&). This allows you to lace strings together. If a variable is not a string, using concatenation (&) converts it to one. Look at Listing 6.28 (string01.asp):

Listing 6.28. string01.asp .

Sub LoadMe() ' Your Code Here part1 = "This is " part2 = "just a " part3 = "test" window.document.open window.document.write("Together the parts are->" & part1 & part2 & part3) window.document.close end sub

This produces the following line:

Together the parts are->This is just a test

Comparison

Comparison operators are used inside VBScript's Control structures to test the relationship between variables. We will cover these operators using essentially the same Web page. It covers the cases of comparing number to number, number to string, and string to string.

Equality (=)

Some languages have a special symbol for testing equality to keep assignment and equality separate; VBScript does not. Instead, VBScript keeps them separate strictly by context. Look at Listing 6.29 (comp01.asp)

Listing 6.29. comp01.asp .

Sub LoadMe() ' Your Code Here num1 = 10 num2 = 10 string1 = "10" string2 = "Hello" if num1 = num2 then Alert("num1 equals num2") else Alert("num1 is not equal to num2") end if if num1 = string1 then Alert("num1 equals string1") else Alert("num1 is not equal to string1") end if if string1 = string2 then Alert("string2 equals string1") else Alert("string1 is not equal to string2") end if end sub

The way the preceding code is written, it will pop up alert boxes to tell you:

• Num1 equals num2
  
  
• Num1 is not equal to string1
  
  
• string2 is not equal to string1
  
  

Experiment with the numbers and the text on this and on all the following comparison examples to see what to expect from the specific comparison operator.

Inequality (<>)

The inequality test is the guideend for the equality test you just looked at. It uses the symbol <>. Check out Listing 6.30 (comp02.asp):

Listing 6.30. comp02.asp .

Sub LoadMe() ' Your Code Here num1 = 21 num2 = 10 string1 = "Hello" string2 = "Hello" if num1 <> num2 then Alert("num1 is not equal to num2") else Alert("num1 equals num2") end if if num1 <> string1 then Alert("num1 is not equal to string1") else Alert("num1 equals string1") end if if string1 <> string2 then Alert("string1 is not equal to string1") else Alert("string2 equals string1") end if end sub

Given the numbers at the start of the subroutine, this example tells you:

• num1 is not equal to num2
  
  
• num1 is not equal to string1
  
  
• string2 equals to string1
  
  

Other Comparison Operators

These comparison operators are used frequently to compare numbers and text, usually for the purpose of sorting a list of numbers or names. less than (<) and greater than(>) return true when the number on the left of the expression is less than but not equal to the number on the right or greater than but not equal to the number on the right. Adding an equal = to either one includes the number on the right. See Listing 6.31 for greater understanding (comp03.asp):

Listing 6.31. comp03.asp .

Sub LoadMe() ' Your Code Here item1 = 21 item2 = 10 if itme1 < item2 then Alert("item1 one is less than item2") end if if itme1 > item2 then Alert("item1 one is greater than item2") end if if item1 <= item2 then Alert("item1 one is less than or equal to item2") end if if item1 >= item2 then Alert("item1 one is greater than or equal to item2") end if end sub

Notice you didn't call the variable num1 or string1. These comparison operators work on both strings and numbers.

Is

The Is operator compares two objects. Let's look at Listing 6.32 (comp04.asp).

Listing 6.32. comp04.asp .

Sub LoadMe() ' Your Code Here set Window1 = window set Window2 = window.document set Window3 = window window.document.open window.document.writeln("<PRE>") if Window1 Is Window2 then window.document.writeln("Window1 is Window2") end if if Window1 Is Window3 then window.document.writeln("Window1 is Window3") end if window.document.writeln("</PRE>") window.document.close end sub

This returns

Window1 is Window3

The result not only shows you how Is works, it also reinforces the idea of using Set to create multiple references to the same object.

and, or, and xor

The keywords and, 0r, and xor allow you to compare the results of one expression with another using boolean logic. The syntax for And, Or, and Xor is the same:

Expression1 And Expression2

Where expression is a function that returns a boolean or a statement using one of the comparison operators similar to:

A >= B

The logic used in these three operators is described in Tables 6.1, 6.2, and 6.3.

Table 6.1. Using And.

Table 6.2. Using Or.

Table 6.3. Using Xor.

Listing 6.33 (comp05.asp) is an example using these operators.

Listing 6.33. comp05.asp .

Sub LoadMe() ' Your Code Here A = 10 B = 10 C = 30 window.document.open window.document.writeln("<PRE>") if (A = B) or (B = C) then window.document.writeln("Passed or") end if if (A = B) and (B = C) then window.document.writeln("Passed and") end if if (A = B) xor (B = C) then window.document.writeln("Passed xor") end if window.document.writeln("</PRE>") window.document.close end sub

Notice how the expressions are grouped within (). These operators can be used in the same expression. Two similar, but less commonly used, operators are Eqv (equivalance), and Imp (implication). The syntax of these two operators is the same as the group you just looked at, but the logic of these two operators is a not intuitive and is contained in Tables 6.4 and 6.5.

Table 6.4. Eqv.

Table 6.5. Imp.

Operator Precedence

You have seen that it is possible to combine several comparison operators from the arithmetic, comparison, and logical groups on one line. You have also seen that the operators can be grouped within () to clarify the order of operation. When expressions are not grouped within () what happens?

First the arithmetic operators are evaluated. Within the Arithmetic group, the precedence is:

• exponentiation (^)
  negation (-)
  multiplication and division (*,/)
  integer division (\)
  modulus arithmetic (Mod)
  addition and subtraction (+,-)
  
  

Next the comparison operators are evaluated. All comparison operators are have equal precedence so they are evaluated from left to right.

• Then the logical operators are evaluated in the following order:
  not
  and
  or
  xor
  eqv
  imp

See Listing 6.34 (comp06.asp) for an example of arithmetic precedence:

Listing 6.34. comp06.asp .

Which results in:

A + B / C * 12 = 18

Use () to group your statements so they are performed in the order you want and not in the order the machine wants.

Built-In Functions

VBScript contains both user-built functions, which we have already covered, and built-in functions. These built in functions cover several areas, including conversions, dates/times, math, array, string, and variant.

Conversions

As you have seen, in previous examples, working with variants can be confusing. Is it a string? Is it a number? What does the interpreter think it is? Well, conversion functions allow you to specify exactly what kind of variable the variant represents.

abs

This function converts its argument into the absolute value of the argument. Listing 6.35 (funct01.asp) contains an example:

Listing 6.35. funct01.asp .

asc, ascb and asc

All these functions return the first character of the argument string. asc returns this character as a string. ascb returns it as a byte. And, on 32-bit systems (Windows 95, Windows NT), ascw returns the first character as a unicode character (a double-byte character set that allows more complex languages to be represented).

These functions are demonstrated in Listing 6.36 (funct02.asp):

Listing 6.36. funct02.asp .

The result is 84 in all three cases. In a place as international as the Web, you will need the support for new character sets that ascb and ascw give you.

chr, chrb and chrw

This is the companion group of functions for asc. chr converts a number into its ASCII character. chrb converts one byte of the character to its ASCII character. And chrw provides the same function for unicode characters. Listing 6.37 (funct03.asp) is an example.

Listing 6.37. funct03.asp .

This example results in all functions returning an I. Again, remember the chrb and chrw functions, because the days of working locally are numbered. Think global.

cbool

cbool converts its argument (numeric or expression) into either TRUE or FALSE. If the argument evaluates to true or is not zero, cbool returns TRUE. If the argument evaluates to false or is zero, cbool returns FALSE. If the argument cannot be evaluated or is not a number, cbool causes a runtime error. Listing 6.38 (funct04.asp)shows how cbool works:

Listing 6.38. funct04.asp .

Note how the function evaluates, and how it is used in printing the results of cbool. This page displays:
Cbool(Num1 = Num1) is TRUE
Cbool(Num1) is TRUE
Cbool(0) is FALSE

Which is what you would expect.

cdate, cdbl, cint, clng, csng, cstr

These functions convert their argument into a specific type. cdate turns it argument into a date, cdbl into a double precision number, cint into an integer, clng into a long integer, csng into a single precision number, and cstr into a string (see Listing 6.39):

Listing 6.39. Conversion functions at work .

This page prints out:
Cdate(string2) is 5/15/55
Cdbl(string1) is 57.32
Cint(string1) is 57
Clng(string1) is 57
csng(string1) is 57.32
CStr(number1) is 15.78

The function datavalue can be directly substituted for cdate.

DateSerial

DateSerial takes three numbers, year, month, and day, and converts them into a date (see Listing 6.40).

Listing 6.40. funct06.asp .

returns:
DateSerial(1999, 6, 1) is 6/1/99

hex and oct

These two functions convert their numerical argument into a string representation of the argument in a different number system. hex shows what the number would look like in hexadecimal form, and oct shows the octal representations, as shown in Listing 6.41 (funct07.asp).

Listing 6.41. funct07.asp .

This shows the decimal number 256 as:
hex(number1) is 100
oct(number1) is 400

fix and int

fix and int can be used to isolate the integer parts of a number. The difference between the two is if the argument is negative, int returns the integer less than or equal to the argument, whereas fix returns the integer greater than or equal to the argument (as shown in Listing 6.42):

Listing 6.42. funct08.asp .

Notice the difference in rounding:
int(number1) is -26
fix(number1) is -25

sgn

The sgn function returns an integer that depends on the sign of its argument. If the argument is positive, sgn returns 1. If the argument is negative, sgn returns -1. And if the argument is 0, sgn returns 0.

Dates/Times

VBScript has many functions that allow you to manipulate time. (Actually they allow you to manipulate time and date values. Manipulating time itself is beyond the scope of this guide.)

date, time, now

These functions return all or part of the time and date information available from your systems hardware. date returns date information. time returns time information. And now return time and date information. Listing 6.43 shows how these functions work:

Listing 6.43. funct09.asp .

funct09.asp returns the following:
Date is 9/2/99
Time is 1:14:31 PM
Now is 9/2/99 1:14:31 PM

day, month, weekday, year, hour, minute, second

These functions all return a part of the time and date information available from the machine. The first four, day, month, weekday, and year, derive their information from a date string. The last three, hour, minute, and second, operate on time strings. They all take one argument except weekday, which has a second argument that tells it what day of the week the week starts (1 for Sunday, 2 for Monday, and so on). If you don't give weekday a number for the second argument, it defaults to Sunday being the first day of the week. Listing 6.44 (funct10.asp) shows how all these functions work.

Listing 6.44. funct10.asp .