Functionプロシージャー｜ExcelマクロVBA入門

最終更新日：2019-07-23

第106回.Functionプロシージャー

プログラム（マクロVBA）内で特定の作業を実行し値を返すプロシージャです。
つまり、Functionプロシージャで独自の関数をつくれるということです。

Subプロシードャーとの違いは、値を返すか返さないかの違いです。
Functionプロシージャは、値を返します
Subプロシージャは、値を返さない

Functionプロシージャは、Functionステートメントで始まり、End Functionステートメントで終わります。

Functionステートメントの構文


  
    
      [Public | Private | Friend] [Static] Function name [(arglist)] [As type]

      　　・・・

      　　[name = expression] '戻り値の設定

      　　・・・

      　　　　[Exit Function] 'プロシージャーを抜ける

      　　・・・

　　[name = expression] '戻り値の設定

　　・・・

End Function

スコープ（[Public,Private,Friend）は後々説明します。
第108回.変数の適用範囲（スコープ,Private,Public）

変数には、その変数をVBA内で使う事ができる範囲が決められています。マクロVBAでは変数の使える範囲を、適用範囲（スコープ）と言います。適用範囲とは、宣言した変数を使う事のできる範囲です。変数を宣言した場所と宣言方法によって、その変数を使える場所が違ってきます。

ここでは、使用例を通して、全体の雰囲気をとらえて下さい。

Exit Functionについては、
以下の使用例では使っていませんが、Exit Subと同様の使い方になります。
Functionプロシージャを直ちに終了します。

Functionでの処理が終了した後のプログラムの実行は、
そのFunctionプロシージャを呼び出したステートメントの次のステートメントから継続されます。

Functionで値を戻す場合は、Functionのnameに対して値を代入します。
nameは指定したデータ型で初期化されるので、
nameに対して何も代入せずにプロシージャーを抜けると、初期化された値を戻すことになります。

Functionステートメント使用例


  
    
      Sub sample1()

      　　Dim vrt1

      　　vrt1 = func1

      　　MsgBox vrt1

      End Sub


      Function func1()

      　　func1 = "func1の回答"

      End Function

Functionの戻り型は省略しています。
上記のsample1を実行すると、"func1の回答"がメッセージ表示されます。
また、上記sample1は、
MsgBox func1
と１行で書く事ができます。
上記では、動作を理解しやすいように一度変数に入れています。


  
    
      Sub sample2()

      　　MsgBox func2("Functionの", "サンプルです")

      End Sub


      Function func2(arg1, arg2) As String

      　　func2 = arg1 & arg2

      End Function

Functionの戻り型をStringで指定しています。
上記のsample2を実行すると、"Functionのサンプルです"とメッセージ表示されます。


  
    
      Sub sample3()

      　　MsgBox func3(100, 200)

      End Sub


      Function func3(arg1 As Long, arg2 As Long) As Long

      　　func3 = arg1 + arg2

      End Function

Functionの戻り型をLong、引数の型もLongで指定しています。
上記のsample3を実行すると、"300"とメッセージ表示されます。

引数の使い方については、次回の、
第107回.プロシージャーの引数

SubプロシージャーFunctionプロシージャーにおける引数リストの指定について説明します。引数は呼び出し先のプロシージャーに渡すデータを指定するものです。Callステートメントでプロシージャーを呼び出すときに指定する引数を呼び出される側のプロシージャーで受け取る記述についてのVBA記述の説明になります。

こちらで解説しています。