VBAのFunctionプロシージャとは

Functionプロシージャとは

前回は、プロシージャについて詳しく解説しました。引数の参照渡しと値渡しで結果が異なりますので、しっかり理解しましょう。今回は、Functionプロシージャと戻り値について解説します。

プロシージャの戻り値

プロシージャには、実行後に実行結果の値を返す「戻り値」を取得できるものがあります。プロシージャの戻り値は「=(イコール)」の代入演算子を利用して変数やプロパティに代入することも可能です。

尚、戻り値取得する場合は、Functionプロシージャを利用します。関数のような動作をするため、ユーザー定義関数とも言われます。ですので、Functionプロシージャは自分で好きな関数を作ることができます。

Functionプロシージャとは

これまでSubプロシージャを利用して解説してきましたが、Subプロシージャは戻り値を返すことができません。そこで、利用されるのがFunctionプロシージャです。Functionプロシージャは、戻り値を返すプロシージャです。

利用する場合は、以下の書式に則って記述します。ほとんどSubプロシージャの記述と変わりませんが、戻り値を設定する場合は、functionステートメントの最後に戻り値のデータ型を設定します。また、Functionプロシージャ内の最後に「プロシージャ名 = 戻り値」を設定します。

Function プロシージャ名(引数名1 As データ型, 引数名2 As データ型・・・) As 戻り値のデータ型
　処理に内容
　プロシージャ名 = 戻り値
End Function

値を返すFunctionプロシージャ

以下は、値を返すFunctionプロシージャの事例です。


Sub sample()

    Dim n As Integer
    
    n = 5
    
    MsgBox "戻り値：" & addition(n)

End Sub

Function addition(n As Integer) As Integer

    addition = n + 10
    
End Function

※ドラッグ(スワイプ)すると全体を確認できます。

実行結果

解説

呼び出し先sampleプロシージャには引数の設定していませんが、呼び出し元additionプロシージャのFunctionステートメントには、変数nが整数型(Integer)で設定されています。次に、Dimステートメントを利用して変数nに整数型(Integer)を宣言し、変数nには「5」を代入します。

そして、additionプロシージャを呼び出し、引数nに「5」を設定し実行しています。additionプロシージャにn=5を参照渡しすると、変数additionは5+10で「15」となるため、こちらが戻り値として返されます。戻り値を取得したら、MsgBox関数でメッセージボックスを表示させます。

オブジェクトを返すFunctionプロシージャ

先ほどは値を戻り値として返しましたが、Functionプロシージャはオブジェクトを返すこともできます。以下はオブジェクトを戻り値に設定する場合の記述方法になります。

戻り値の型にはオブジェクト型を設定します。また、戻り値の設定はオブジェクト型の宣言のようにSetステートメントを利用して代入します。

Function プロシージャ名(引数名1 As データ型, 引数名2 As データ型・・・) As 戻り値のオブジェクト型
　処理に内容
　Set プロシージャ名 = オブジェクト
End Function

以下は、オブジェクトを返すFunctionプロシージャの事例です。


Sub sample()

    Dim rangeName As String
    Dim rangeA1 As Range
    
    rangeName = "A1"
    
    Set rangeA1 = objRange(rangeName)
    
    rangeA1.Value = "VBA"

End Sub

Function objRange(rangeName As String) As Range

    Set objRange = Range(rangeName)
    
End Function

※ドラッグ(スワイプ)すると全体を確認できます。