ACC2000: How to Pass an Array as an Argument to a Procedure (210368)



The information in this article applies to:

  • Microsoft Access 2000

This article was previously published under Q210368
Moderate: Requires basic macro, coding, and interoperability skills.

This article applies to a Microsoft Access database (.mdb) and to a Microsoft Access project (.adp).

SUMMARY

In order for a procedure to accept an array as an argument, the procedure must declare the array argument with opening and closing parentheses after the argument name. Additionally, when passing the array to the procedure, you must include parentheses after the array name, unless you are using Visual Basic. Otherwise, you may receive the error message "Parameter type mismatch" or "Duplicate definition."

Microsoft provides programming examples for illustration only, without warranty either expressed or implied. This includes, but is not limited to, the implied warranties of merchantability or fitness for a particular purpose. This article assumes that you are familiar with the programming language that is being demonstrated and with the tools that are used to create and to 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 requirements.

MORE INFORMATION

The following example demonstrates the correct syntax for procedure declarations with an array:
Function YourFunctionName (InArray() As String) As Integer
				
Sub YourSubName (InArray() As String)
				
The following example demonstrates the correct syntax for procedure calls with an array:
Result = YourFunctionName(YourArrayName())
				
YourSubName YourArrayName()
				
NOTE: When calling procedures in Visual Basic for Applications, you do not have to include the opening and closing parentheses after "YourArrayName" in the above example.

Example

The following example demonstrates a sample user-defined function that loads an array with string values:
  1. Create a module and type the following line in the Declarations section if it is not already there:
    Option Explicit
    					
  2. Type the following procedures:
    '---------------------------------------------------------------
    'The function LoadArray() loads an array called MyArray
    'with string values. After loading the array, the function
    'calls a procedure that outputs each array element
    'to the Immediate window.
    '---------------------------------------------------------------
    
    Function LoadArray()
       Dim i as Integer
       ReDim MyArray(10) As String
       For i = 1 to 10
          MyArray(i) = "Test Value: " & i
       Next i
       DisplayArray MyArray()
    End Function
    
    '---------------------------------------------------------------
    'LoadArray() Sub Procedure
    '---------------------------------------------------------------
    
    Sub DisplayArray (InArray() As String)
       Dim i as Integer
       For i = 1 to UBound(InArray)
          Debug.Print InArray(i)
       Next i
    End Sub
    					
  3. To test this function, type the following line in the Immediate window, and then press ENTER:
    ? LoadArray()
    						
    Note that the following list appears the Immediate window:
       Test Value: 1
       Test Value: 2
       Test Value: 3
       Test Value: 4
       Test Value: 5
       Test Value: 6
       Test Value: 7
       Test Value: 8
       Test Value: 9
       Test Value: 10
    					

REFERENCES

For more information about arrays, in the Visual Basic Editor, click Microsoft Visual Basic Help on the Help menu, type using arrays in the Office Assistant or the Answer Wizard, and then click Search to view the topic.

Modification Type:MinorLast Reviewed:10/11/2006
Keywords:kbinfo kbProgramming KB210368