ExcelマクロとVBA入門14：プロシージャの引数の使い方を解説

こんにちは、はやぶさです。

日々ExcelやPythonを使って、業務を効率化しています。

前回のExcelマクロとVBA入門シリーズでは、繰り返し処理を扱う「Do Loopステートメント」に焦点を当てて解説しました。

ExcelマクロとVBA入門⑬：Do Loopステートメントの使い方を解説この記事では、「Do Loopステートメント」の使い方を徹底解説します。Do Loopは、特定の条件下でコードを繰り返し実行することで、繰り返し処理の柔軟性を高めます。この記事では、Do WhileとDo Untilの基本的な使い方から実践的な例まで、コード例を交えて詳しく説明します。...

今回の続編では、「プロシージャの引数」を深く掘り下げ、その使い方や実践的な応用例を紹介します。

VBAにおけるプログラミングスキルをさらに向上させたい方々にとって、この記事が貴重な洞察と実用的な知識を提供し、作業のさらなる効率化に役立つことを願っています。

この記事で学べること

引数とは？
引数を定義する方法
引数を使用した呼び出し方法
- 位置による引数の指定
- 名前付き引数
引数の種類と特徴
まとめ
- キーポイント

引数とは？

引数(ひきすう)とは、プログラム実行中に他のプロシージャを実行する際に、プロシージャで使用される値です。

引数を用いることで、プロシージャはさまざまな計算や作業を柔軟に行えるようになります。

たとえば、足し算を行うプロシージャがある場合、実行時に「足す数」として引数を渡します。すると、その引数に基づいて異なる結果を返します。

引数を定義する方法

基本構文

引数は、プロシージャ宣言文のカッコ内に記述します。

Sub プロシージャ([引数1][As データ型], [引数2][As データ型])

1	Sub プロシージャ([引数1][As データ型], [引数2][As データ型])

[As データ型]は省略可能で、省略した場合にはデフォルトでVariant型が適用されます。

引数が複数ある場合、それぞれの引数はコンマで区切って列挙します。

例

以下の例は、2つの数値を受け取り、それらを足し算した結果をメッセージボックスで表示します。

Sub 足し算(数値1 As Long, 数値2 As Long)
    MsgBox 数値1 + 数値2
End Sub

Sub メインプロシージャ()
    Call 足し算(1, 2)
    Call 足し算(110, 520)
End Sub

Sub 足し算(数値1 As Long, 数値2 As Long)

MsgBox 数値1 + 数値2

End Sub

Sub メインプロシージャ()

Call 足し算(1, 2)

Call 足し算(110, 520)

End Sub

この例では、足し算サブプロシージャを呼び出す際、引数の値を変更することで、異なる結果を表示できます。

引数を使用した呼び出し方法

VBAにおけるプロシージャの呼び出しでは、引数の指定方法には「位置に基づく指定」と「名前付き引数を用いる方法」の2つがあります。

位置による引数の指定

位置に基づく引数の指定では、関数やプロシージャの定義に従い、引数を順序通りに提供します。

各引数は先頭から順に第1引数、第2引数、第3引数と呼ばれ、その位置がその意味を決定します。

Sub メッセージ表示(タイトル, メッセージ)
    MsgBox タイトル & ": " & メッセージ
End Sub

Sub メインプロシージャ()
    ' プロシージャの呼び出し
    Call メッセージ表示("警告", "低バッテリー")
End Sub

Sub メッセージ表示(タイトル, メッセージ)

MsgBox タイトル & ": " & メッセージ

End Sub

Sub メインプロシージャ()

' プロシージャの呼び出し

Call メッセージ表示("警告", "低バッテリー")

End Sub

この例では、メッセージ表示プロシージャに「警告」と「低バッテリー」を位置に基づいて渡しています。

第1引数がタイトル、第2引数がメッセージとして処理されます。

名前付き引数

引数が多くなると、位置に基づく指定は混乱を招くことがあります。

そこで、引数に名前を付けて指定できる「名前付き引数」が役立ちます。

名前付き引数を使用することで、引数の順番を自由に変更したり、コードの可読性を向上させることが可能です。

名前付き引数を指定する際は、次のように記述します：

基本構文

名前付き引数名:=値

1	名前付き引数名:=値

例

Sub アラーム設定(時間, 分, メッセージ)
    MsgBox "アラーム設定: " & 時間 & "時" & 分 & "分 - " & メッセージ
End Sub

Sub メインプロシージャ()
    ' 名前付き引数を使ったプロシージャの呼び出し
    Call アラーム設定(メッセージ:="会議の時間です", 分:=30, 時間:=9)
End Sub

Sub アラーム設定(時間, 分, メッセージ)

MsgBox "アラーム設定: " & 時間 & "時" & 分 & "分 - " & メッセージ

End Sub

Sub メインプロシージャ()

' 名前付き引数を使ったプロシージャの呼び出し

Call アラーム設定(メッセージ:="会議の時間です", 分:=30, 時間:=9)

End Sub

この例では、アラーム設定プロシージャに対して、引数の順番に関係なく名前付き引数を使って値を渡しています。

これにより、引数の意味が明確になり、コードの可読性が向上します。

引数の数が少ない場合、名前付き引数を用いる利点はそれほど大きくありません。

しかし、多数の引数を持つプロシージャやメソッドでは、名前付き引数が非常に有効です。

引数が多いと、その順序を全て覚えることは困難なため、特にメンテナンス時に問題を引き起こすことがあります。

名前付き引数を使用することで、コードの可読性が向上し、プログラムの保守や改修が容易になります。

名前付き引数は、マクロVBAをより読みやすく、管理しやすいものにするための重要なツールです。

引数の種類と特徴

引数には複数の種類があり、それぞれに特徴と用途が存在します。主な引数の種類には「参照渡し(ByRef)」、「値渡し(ByVal)」、そして「省略可能(Optional)」があります。

参照渡し(ByRef)

参照渡しは、関数やプロシージャに変数そのものを渡す方法です。

この方式では、呼び出し元の変数に呼び出し先で行われた変更が反映されます。

これにより、データの不要なコピーを避けることで、メモリの消費を削減できます。

VBAでは、引数の指定方法を明示しない場合、デフォルトでByRefが設定されます。

例

以下は、ByRefキーワードを使用することで、呼び出し元の数値が影響を受ける例です。

Sub 数値更新(ByRef 数値 As Long)
    数値 = 100  ' 元の変数の値を更新
End Sub

Sub メインプロシージャ()
    Dim 元の数値 As Long
    元の数値 = 50
    Call 数値更新(元の数値)
    MsgBox "更新後の数値: " & 元の数値  ' 表示される値は100
End Sub

Sub 数値更新(ByRef 数値 As Long)

数値 = 100 ' 元の変数の値を更新

End Sub

Sub メインプロシージャ()

Dim 元の数値 As Long

元の数値 = 50

Call 数値更新(元の数値)

MsgBox "更新後の数値: " & 元の数値 ' 表示される値は100

End Sub

この例では、「元の数値」として渡された引数がプロシージャ内で直接更新され、その結果が呼び出し元にも反映されることを示しています。

値渡し(ByVal)

値渡しはデータのコピーを渡す方法で、この方式では呼び出し元の変数は変更されません。

つまり、関数やプロシージャ内で引数の値が変更されても、元のデータはそのまま保持されます。

これにより、関数内の操作が外部の変数に意図せず影響を与えるリスクを防ぐことができます。

値渡しは、基本的なデータ型（整数、実数、文字列など）を安全に扱う場合に特に有効です。

例

以下は、ByValキーワードを使用することで、呼び出し元の数値が影響を受けない例です。

Sub 数値加工(ByVal 数値 As Long)
    数値 = 数値 + 50  ' この変更は元の変数に影響しない
End Sub

Sub メインプロシージャ()
    Dim 元の数値 As Long
    元の数値 = 50
    Call 数値加工(元の数値)
    MsgBox "元の数値: " & 元の数値  ' 表示される値は50のまま
End Sub

Sub 数値加工(ByVal 数値 As Long)

数値 = 数値 + 50 ' この変更は元の変数に影響しない

End Sub

Sub メインプロシージャ()

Dim 元の数値 As Long

元の数値 = 50

Call 数値加工(元の数値)

MsgBox "元の数値: " & 元の数値 ' 表示される値は50のまま

End Sub

この例では、「元の数値」として渡された引数は値渡しであるため、プロシージャ内で加えられた変更が呼び出し元の変数には影響を与えません。

その結果、「元の数値」は変更されずに保持されます。

省略可能(Optional)

省略可能な引数は、関数やサブプロシージャの呼び出し時に指定しなくても良い引数で、通常デフォルト値を持ちます。

VBAでは、Optionalキーワードを用いてこれらの引数を定義します。引数が省略された場合、設定されたデフォルト値が自動的に使用されます。

基本構文

Sub プロシージャ(Optional 引数1 [As データ型] [= デフォルト値])

1	Sub プロシージャ(Optional 引数1 [As データ型] [= デフォルト値])

例

省略可能な引数は、関数に柔軟性を与え、複数の異なるシナリオで同一の関数を使いやすくします。

例えば、ユーザーによる入力がオプショナルな場合や、特定の設定に対してデフォルトの挙動を提供したい場合に便利です。

以下は、VBAで省略可能な引数を使用したサブプロシージャの例です。

Sub メッセージ表示(Optional タイトル As String = "未定義", Optional メッセージ As String = "詳細なし")
    MsgBox タイトル & ": " & メッセージ
End Sub

Sub メインプロシージャ()
    Call メッセージ表示
    Call メッセージ表示("警告")
    Call メッセージ表示("警告", "低バッテリー")
End Sub

Sub メッセージ表示(Optional タイトル As String = "未定義", Optional メッセージ As String = "詳細なし")

MsgBox タイトル & ": " & メッセージ

End Sub

Sub メインプロシージャ()

Call メッセージ表示

Call メッセージ表示("警告")

Call メッセージ表示("警告", "低バッテリー")

End Sub

この例では、メッセージ表示サブプロシージャが二つの省略可能な引数を持っています。

プロシージャを呼び出す際に、引数を一つも指定しない場合、一つだけ指定する場合、または両方指定する場合の三つの異なる方法でプロシージャを呼び出しています。

省略可能な引数を使用する場合、プログラムの読み手がその関数の動作を完全に理解していないと、引数の省略が意図しない結果を引き起こす可能性があります。

そのため、省略可能な引数を使用する関数やサブプロシージャを設計する際には、その挙動を明確にドキュメント化することが非常に重要です。

まとめ

この記事では、プロシージャの引数の重要性とその使用方法について詳しく解説しました。

引数を活用することで、プロシージャは単に固定的な操作を行うだけでなく、より動的で適応性の高いツールへと変化します。

これにより、プログラマーは一度のプロシージャ定義で様々なシナリオや条件に応じた処理を実行できるようになります。

キーポイント

引数とは: プロシージャ実行時に他のプロシージャから値を受け取るための変数です。
引数を定義する方法: プロシージャ宣言のカッコ内に引数をリスト形式で記述します。
引数を使用した呼び出し方法:
- 位置による引数の指定: 定義に従って引数を順序どおり提供します。
- 名前付き引数: 引数の名前を指定して順序を自由に変更することが可能で、可読性が向上します。
引数の種類と特徴:
- 参照渡し(ByRef): 呼び出し元の変数に呼び出し先の変更が反映される方法です。VBAではデフォルト設定です。
- 値渡し(ByVal): 呼び出し元の変数に影響を与えずに、データのコピーを渡します。
- 省略可能(Optional): 指定しなくても機能する引数で、通常デフォルト値が設定されています。