エクセルVBA 関数名＝False と書く意味

Question

エクセルVBAで関数を定義する際、以下のような書き方をよく見かけます。
・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・
Function 関数名（引数名　As データ型）As　Boolean
関数名　＝　False
処理内容
関数名　＝　True
・・・・・・・・・・・・・・・・・・・・・・・・・・・・・・

関数名　＝　False
関数名　＝　True　　と記載する意味が分かりません。

「関数はブール型で用意するもので、ブール型だから真偽を戻り値とする。」
というような何となくの理解なのですが、記載しなくても処理はできるし、、、
意味が分かっていません。明確な理由や必要性をご教示ください。

以下は
私が標準モジュールに作成した、リストボックスの値を全選択するというプログラムです。
関数名　＝　False
関数名　＝　True
を書いても書かなくても、見かけ上同様の処理が行われます。

Public Function allselect(ListBoxZ As msForms.ListBox) As Boolean
    Dim i As Integer
    
    allselect = False
    
    For i = 0 To ListBoxZ.ListCount - 1
        ListBoxZ.Selected(i) = True
    Next i

    allselect = True

End Function

Comments

[Zuishin]

このサンプルコードはクオリティが低すぎて説明する意味がありません。質問の本意である戻り値のみに注目する場合、最終行以外はすべて削除できます。実際に見たコードを URL とともに引用してください。

[tosi]

>関数名　＝　False　
>関数名　＝　True　　と記載する意味が分かりません。
私も8割程は入れていると思います。
(残りの2割は単純なプロシージャでエラーの可能性が低いものです)
基本、単純なプログラムはどちらでも構わないと思います。
私の場合、呼び出し元に対して結果を通知する為に使用しています。
(例)
①if 呼び出しFunction　→②if 呼び出しFunction　→③ if allselect･･･
と言う様に階層に渡って関数を呼ぶ場合に効果を発揮します。
上の例では、①はCALL先のプログラムが正常動作したか、エラー終了かを、関数＝False/関数＝Trueの記述方法によって①は知ることが出来ます。
質問者のサンプルにはエラー処理が入っていませんが、エラー処理を入れた場合には下記の様になると思います。
------------------------------------------------------------------
Public Function allselect(････
On Error GoTo Err_処理
allselect=False
　・
　・
　・
allselect=true
Exit Function
'
Err_処理:
MsgBox "Error = " & Err.Description
End Function
------------------------------------------------------------------
この様にエラー処理を入れてVBAを作成した場合、エラー発生の場合allselect=trueを通過しませんので、Call先でエラーが発生した事を、CAll元はFalse受け取りで知ることができます。
(エラー処理を入れなくとも、CALL元で状態を取得する事は可能ですが、VBA自体が落ちる場合もあり、確実に動かす為に入れます)
プログラムが大きくなると、実行するプロシジャーとエラーメッセージを表示させたいプロシジャーも違ってきます。
エラーが発生した場所でどこでも出してしまうと、見難くなり保守性が落ちます。また、エラーの内容でスキップする物、停止させる物、警告させる物等が運用により違ってきます。
この様なエラー時の処理を柔軟に行う為に、呼び出し先の実行結果を知る必要があり、この記述方法を取ります。
これは、プログラムが複雑になると非常に強力な効果を発揮します。

Answer 1

解決してしまっていますが。。。

関数の戻り値は、関数内の処理云々ではなく、関数の呼び出し元での判断材料にするものです。
関数が正常終了したから処理は継続するとか、失敗したから以降の処理は中断するとか。
ご提示のコードはリストボックスの全項目を選択するだけの処理なので、正常か異常かを返す必要性が感じられません。
よってこの関数の場合は、FunctionではなくSubとして、戻り値を返す必要はないと思います。

またよく見かける処理の場合の意味ですが、条件によっては途中で関数を抜けていないでしょうか？
戻り値の初期値をFalse（失敗）としておき、関数内を最後まで到達できた場合のみTrue（成功）とする書き方はよくあります（その逆の場合もあります）
他の回答にある慣習とは異なり、明確な意図を持った書き方です。

Comments

[riko]

ご回答ありがとうございます。
とても勉強になりました。

Answer 2

「関数はブール型で用意するもので、ブール型だから真偽を戻り値とする。」

ブール型以外の戻り値も定義できますし、戻り値が無い場合はsubプロシージャで定義します。

質問の内容の様に単に処理を実行するだけであれば、subプロシージャが妥当ですけど、関数の定義を先に決めて、利用側がすでに実装済みの場合は、取りあえずTrueを返却するというような、質問の内容になるかもしれません。

関数名　＝　False
関数名　＝　True　　と記載する意味が分かりません。

初期値を設定するのは、早期リターンの場合が多いですね。
設定の際にelseが不要になり、処理が簡潔になります。

Answer 3

初期値を冒頭に書く慣習のようなものではないでしょうか。
何かしらで最後に書くのを忘れてビルドエラーになるのを防ぐ役割もあると思います。

追記：
ただし、Functionの返り値は「呼び元にどういう情報を返すのか」によって決まるもので、必ずboolであるとは限りません。
今回のFunctionがどのような機能を持ち、呼び元でどのように使われるのかは分かりませんが（提示されてないので）、Functionだけを見るのではなく、処理全体の流れを見て考えた方が今後同じように迷わなくて済むと思います。

Comments

[riko]

ご回答ありがとうございました。

[m.ts10806]

他の回答も参照してください。

[Zuishin]

慣習というか、その次にループが入っているのを見て思ったんですが、単にフラグを寝かせているだけかと。サンプルコードがひど過ぎて推測にしかなりませんが。

[m.ts10806]

そうですね。Function だけ見ても判断できないところもあります。

[m.ts10806]

簡単ですが追記してみました。

[riko]

丁寧な回答ありがとうございます。
未熟な点が多々ありご迷惑をおかけしました。

Answer 4

それがVBAの戻り値の書き方です。
下記でも同じようなことが出来ます。

Function 関数名（引数名　As データ型）As　Long
    関数名　＝　0

Comments

[m.ts10806]

さすがに全角スペースと「＝」まじってるのはマズいのでは。
あと、勘違いしてるかもしれませんが、質問と型が違うだけの話では？
何を説明したいのでしょうか。

→失礼。Boolだけだと思ってる質問者への指摘でしたね。