可选参数 (Visual Basic)

可以指定过程参数是可选的,在调用过程时,无需为其提供任何参数。 可选参数Optional 过程定义中的关键字指示。 下列规则适用:

  • 过程定义中的每个可选参数都必须指定默认值。

  • 可选参数的默认值必须是常量表达式。

  • 过程定义中一个可选参数后面的每个参数也必须是可选的。

以下语法显示了具有可选参数的过程声明:

Sub name(ByVal parameter1 As datatype1, Optional ByVal parameter2 As datatype2 = defaultvalue)  

调用带可选参数的过程

使用可选参数调用过程时,可以选择是否提供参数。 如果不这样做,该过程将使用为该参数声明的默认值。

在参数列表中省略一个或多个可选参数时,可以使用连续逗号标记其位置。 以下示例调用提供第一个和第四个参数,但不提供第二个或第三个参数:

Sub name(argument 1, , , argument 4)  

以下示例对函数 MsgBox 进行多次调用。 MsgBox 具有一个必需参数和两个可选参数。

第一次调用 MsgBox 按定义参数的顺序提供所有三个 MsgBox 参数。 第二个调用仅提供所需的参数。 第三个和第四个调用提供第一个和第三个参数。 第三个调用按位置执行此作,第四个调用按名称执行此作。

MsgBox("Important message", MsgBoxStyle.Critical, "MsgBox Example")
MsgBox("Just display this message.")
MsgBox("Test message", , "Title bar text")
MsgBox(Title:="Title bar text", Prompt:="Test message")

确定可选自变量是否存在

在运行时,过程无法检测给定参数是否已省略,或者调用代码已显式提供默认值。 如果需要进行此区分,可以将不太可能的值设置为默认值。 以下过程定义可选参数 office,并测试其默认值, QJZ以查看是否已在调用中省略它:

Sub notify(ByVal company As String, Optional ByVal office As String = "QJZ")
    If office = "QJZ" Then
        Debug.WriteLine("office not supplied -- using Headquarters")
        office = "Headquarters"
    End If
    ' Insert code to notify headquarters or specified office.
End Sub

如果可选参数是引用类型(如 a String),则可以用作 Nothing 默认值,前提是这不是参数的预期值。

可选参数和重载

使用可选参数定义过程的另一种方法是使用重载。 如果有一个可选参数,则可以定义过程的两个重载版本,一个接受该参数,一个没有它。 随着可选参数数量的增加,此方法变得更加复杂。 但是,其优点是,可以绝对确定调用程序是否提供了每个可选参数。

另请参阅