Understanding VBA Functions

You already know that you can use subroutines in your macros. VBA allows you to define functions that can be used in your macros. The difference between functions and subroutines is that functions can return values, whereas subroutines cannot. Consider the following macro:

Sub Macro1()
    TooMany = TestFunc
    If TooMany Then StatusBar = "Too many pages"
End Sub

Function TestFunc()
    TestFunc = False
    If Selection.Inforamtion(wdNumberOfPagesInDocument) > 10 Then
       TestFunc = True
    End If
End Function

This function returns either the value False or True, depending on a test it performs. The main program then acts upon the value returned. Notice that the function name can appear on the right side of an equal sign. This makes functions very powerful and an important part of any program. Within the function the result is assigned to TestFunc, which is the name of the function itself; this is the value returned by the function.

As with subroutines, you can also pass parameters to your functions. This is illustrated in the following macro:

Sub Macro1()
    A = 12.3456
    Status.Bar = A & "     " & Round(A)
End Sub

Function Round(X)
    Round = Int(X + 0.5)
End Function

This simple macro defines a number, and then prints it and the result of passing the number to the Round function; the output is 12.3456 and 12. Notice that the parameter should be passed to the function within parentheses. Also notice that the function does not use the same variable name as it was passed. This is because VBA reassigns the value of x (what the function needs) so it matches the value of A (what the program is passing to the function). The important thing to remember in passing parameters to functions is that your program must pass the same number of parameters as the function expects, and the parameters must be of matching types and in the proper order.