Creating Simpler Statements with Named Arguments
For many built-in functions, statements, and methods, Visual Basic provides the option of using named arguments as a shortcut for typing argument values. With named arguments, you can provide any or all of the arguments, in any order, by assigning a value to the named argument. You do this by typing the argument name plus a colon followed by an equal sign and the value ( MyArgument:= "SomeValue") and placing that assignment in any sequence delimited by commas. Notice that the arguments in the following example are in the reverse order of the expected arguments:
Function ListText(strName As String, Optional strAddress As String)
Private Sub Command1_Click()
ListText strAddress:=”12345”, strName:="Your Name"
This is especially useful if your procedures have several optional arguments that you do not always need to specify.
Determining Support for Named Arguments
To determine which functions, statements, and methods support named arguments, use the AutoQuickInfo feature in the Code window, check the Object Browser, or see the Language Reference. Consider the following when working with named arguments:
Named arguments are not supported by methods on objects in the Visual Basic (VB
) object library. They are supported by all language keywords in the Visual Basic for applications (VBA
) object library.
In syntax, named arguments are shown as bold and italic. All other arguments are shown in italic only.
Important You cannot use named arguments to avoid entering required arguments. You can omit only the optional arguments. For Visual Basic (VB
) and Visual Basic for applications (VBA
) object libraries, the Object Browser encloses optional arguments with square brackets [ ].