XL: Returning Multiple Values from a Custom Function

• Microsoft Excel for Windows, versions 5.0, 5.0c
• Microsoft Excel for Windows NT, version 5.0
• Microsoft Excel for Windows 95, version 7.0
• Microsoft Excel 97 for Windows
• Microsoft Excel for the Macintosh, versions 5.0, 5.0a
• Microsoft Excel 98 Macintosh Edition

SUMMARY

In the versions of Microsoft Excel listed at the beginning of this article, there are two different methods of returning multiple values from a custom function: one for returning a variable-sized array and one for returning a fixed-size array.

This article contains sample Microsoft Visual Basic for Applications procedures that demonstrate each of these methods.

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. Microsoft support engineers can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific needs. If you have limited programming experience, you may want to contact the Microsoft fee-based consulting line at (800) 936-5200. For more information about the support options available from Microsoft, please see the following page on the World Wide Web:

   http://www.microsoft.com/support/supportnet/refguide/default.asp

Method to Return a Variable-Size Result Array

This method returns an array of values based on an argument range. The size of the resulting array fluctuates depending on the number of elements in the argument array. For example, assume that you want to create a function that multiplies each value in a range by 100. The following custom function accepts an array (a range of values) as its argument:

   Function Multiply_Range(myrange As Object) As Variant
      Dim temp As Variant
      Dim i As Integer, j As Integer
      temp = myrange.Value 'creates a copy of the values in myrange
      ' if more than one element then loop through both dimensions of
      ' the array and multiply each element by 100.
      ' if not more than one element then temp is multiplied by 100.
      If IsArray(temp) Then
         For i = 1 To UBound(temp, 1)
            For j = 1 To UBound(temp, 2)
               temp(i, j) = temp(i, j) * 100
            Next j
         Next i
      Else
         temp = temp * 100
      End If
      Multiply_Range = temp
   End Function

   A1:     5
   A2:     3
   A3:     1
   A4:     2

   =Multiply_Range(A1:A4)

The result will be:

   A1:     5       B1:     500
   A2:     3       B2:     300
   A3:     1       B3:     100
   A4:     2       B4:     200

Method to Return Array Result of a Fixed Size

This method for returning multiple values from a custom function assumes that you have a fixed number of elements in the resulting array.

The following custom function accepts a starting time and an ending time and returns the number of hours, minutes, and seconds between them in a 3- row by 1-column array.

   Function Elapsed_Time(start, finish As Date) As Variant
      Dim hours, minutes, seconds As Integer
      hours = Hour(finish - start)
      minutes = Minute(finish - start)
      seconds = Second(finish - start)
      Elapsed_Time = Application.Transpose(Array(hours, minutes, seconds))
   End Function

   A1:     1:00:00
   A2:     6:49:34

   =Elapsed_Time(A1,A2)

The result will appear as follows:

   A1:     1:00:00
   A2:     6:49:34
   A3:     5
   A4:     49
   A5:     34

   Elapsed_Time = Array(hours, minutes, seconds)

REFERENCES

"Visual Basic User's Guide," version 5.0, Chapter 3

For additional information about getting help with Visual Basic for Applications, please see the following article in the Microsoft Knowledge Base:

   ARTICLE-ID: Q163435
   TITLE     : VBA: Programming Resources for Visual Basic for
               Applications