ChatGPT解决这个技术问题 Extra ChatGPT

How to return a result from a VBA function

How do I return a result from a function?

For example:

Public Function test() As Integer
    return 1
End Function

This gives a compile error.

How do I make this function return an integer?


S
Siddharth Rout

For non-object return types, you have to assign the value to the name of your function, like this:

Public Function test() As Integer
    test = 1
End Function

Example usage:

Dim i As Integer
i = test()

If the function returns an Object type, then you must use the Set keyword like this:

Public Function testRange() As Range
    Set testRange = Range("A1")
End Function

Example usage:

Dim r As Range
Set r = testRange()

Note that assigning a return value to the function name does not terminate the execution of your function. If you want to exit the function, then you need to explicitly say Exit Function. For example:

Function test(ByVal justReturnOne As Boolean) As Integer
    If justReturnOne Then
        test = 1
        Exit Function
    End If
    'more code...
    test = 2
End Function

Documentation: Function Statement


For completeness it should be noted that when you are returning an object (like a Range for example), you need to use Set just like you would if setting an object variable in a regular method. So if, for example, "test" were a function that returned a Range the return statement would look like this set test = Range("A1").
Why is that @JayCarr?
@PsychoData - Simply because that's how you set an object variable in general, and doing it without set can lead to problems. I've had issues doing it without, but if I use set I don't :).
I think it is also worth mentioning that the behaviour of the function differs when you call it from a spreadsheet, compared with calling it from another VBA function or Sub.
When called within VBA the function will return a range object, but when called from a worksheet it will return just the value, so set test = Range("A1") is exactly equivalent to test = Range("A1").Value, where "test" is defined as a Variant, rather than a Range.
J
Jean-François Corbett

VBA functions treat the function name itself as a sort of variable. So instead of using a "return" statement, you would just say:

test = 1

Notice, though, that this does not break out of the function. Any code after this statement will also be executed. Thus, you can have many assignment statements that assign different values to test, and whatever the value is when you reach the end of the function will be the value returned.


Actually you answered the question more clearly with extra information (which could potentialy lead to another question from new to VBA guy). Keep up the good work
Sorry, It seemed like you just answered the same thing as my answer, which I had first, but just adding the fact that it doesn't break out of the function. It is a nice addition, I just thought it'd be more appropriate as a comment. I'm not sure what the proper etiquette is, I guess it was a bit rude to downvote for just that, because it is a good answer, but it won't let me undo it.
G
Greedo

Just setting the return value to the function name is still not exactly the same as the Java (or other) return statement, because in java, return exits the function, like this:

public int test(int x) {
    if (x == 1) {
        return 1; // exits immediately
    }

    // still here? return 0 as default.
    return 0;
}

In VB, the exact equivalent takes two lines if you are not setting the return value at the end of your function. So, in VB the exact corollary would look like this:

Public Function test(ByVal x As Integer) As Integer
    If x = 1 Then
        test = 1 ' does not exit immediately. You must manually terminate...
        Exit Function ' to exit
    End If

    ' Still here? return 0 as default.
    test = 0
    ' no need for an Exit Function because we're about to exit anyway.
End Function 

Since this is the case, it's also nice to know that you can use the return variable like any other variable in the method. Like this:

Public Function test(ByVal x As Integer) As Integer

    test = x ' <-- set the return value

    If test <> 1 Then ' Test the currently set return value
        test = 0 ' Reset the return value to a *new* value
    End If

End Function 

Or, the extreme example of how the return variable works (but not necessarily a good example of how you should actually code)—the one that will keep you up at night:

Public Function test(ByVal x As Integer) As Integer

    test = x ' <-- set the return value

    If test > 0 Then

        ' RECURSIVE CALL...WITH THE RETURN VALUE AS AN ARGUMENT,
        ' AND THE RESULT RESETTING THE RETURN VALUE.
        test = test(test - 1)

    End If

End Function

"it's also nice to know that you can use the return variable like any other variable in the method" is mostly true -- but e.g. if the return type is Variant and your goal is to return an array then something like ReDim test(1 to 100) will trigger an error. Also, even though it is possible to treat basic type like Integers like that it is considered somewhat unidiomatic. It makes the code harder to read. VBA programmers scan for lines which assign to the function name to understand what a function does. Using the function name as a regular variable needlessly obscures this.
@JohnColeman, totally agree on both points. By no means should the last example be one of recommended methodology. But, the topic question is regarding How to return a variable, and so this is just an attempt at a full explanation of VB's return result, and by extension how they work. Certainly the last case is not a recommendation. (I certainly would not code that as more than an example.) So, your points are well taken, and good additions. Thank you.
It is useful for smallish functions, and is something that any VBA programmer should know about, so I had no problem with you mentioning it. I just thought that a warning should be included.
@Gene I don't follow. It isn't necessary to declare a variable as an array to ReDim it. Dim test As Variant followed by ReDim test(1 to 100) is unproblematic. That you can't do this with the name of a variant function in the body of the function shows that it isn't true that you can use the return variable like any other variable in the body of the function, which is exactly the point that I was making. By the way, your use of exclamation marks seems over-the-top. In an internet context it seems vaguely troll-like, although there is nothing troll-like about your comment.
@Gene you are right only by accident. Your reasons are wrong.
R
RBT

The below code stores the return value in to the variable retVal and then MsgBox can be used to display the value:

Dim retVal As Integer
retVal = test()
Msgbox retVal

This is not a function or a sub.