VBA関数のCVErr関数

CVErr関数は、VBA関数の中で配列・エラー関数に分類される関数です。

目次

• CVErr関数とは
• CVErr関数のサンプルコード
  • 実行結果
  • 解説

CVErr関数とは

CVErr関数は、ユーザーが指定した数値 (エラー番号) を、バリアント型 (Variant) の内部処理形式であるエラー値に変換した値を返す変換関数です。

CVErr 関数を使用して、作成したプロシージャ内でユーザー定義のエラーを作成できます。たとえば、複数の引数を受け取り、1 つの文字列を返す関数を作成したときに、入力された引数の値が許容範囲内にあるかどうかを評価することができます。引数が許容範囲内にない場合、作成した関数は予期する値を返しません。このような場合、CVErr 関数を使用することにより、どのような動作が行われたのかを知らせるエラー番号を返すことができます。
エラー番号のデータ型を暗黙的に変換することはできません。たとえば、CVErr 関数の戻り値をバリアント型以外の変数に直接代入することはできません。ただし、CVErr 関数の戻り値を明示的に変換 (CInt 関数、CDbl 関数などを使用して変換) することにより、適切なデータ型の変数に代入することができます。

CVErr関数のサンプルコード

次の例は、CVErr 関数を使って、バリアント型 (Variant) のエラー値 (VarType 10) を返します。ユーザー定義の Function プロシージャ CalculateDouble は、数値以外の引数を渡されるとエラー値を返します。CVErr 関数は、ユーザー定義のプロシージャからユーザー定義のエラー番号を返すため、あるいは、実行時エラーの処理を延期するために使います。値がエラー値であるかを調べるときは、IsError 関数を使用してください。

' エラーが発生する値 (ここでは、文字列) を引数として指定し、Function プロシージャ CalculateDouble を呼び出します。
Sub Test()
    Debug.Print CalculateDouble("345.45robert")
End Sub
' Function プロシージャ CalculateDouble を定義します。
Function CalculateDouble(Number)
    If IsNumeric(Number) Then        ' 受け取った値が数値であれば、
        CalculateDouble = Number * 2    ' 結果を返します。
    Else                            ' 数値以外のときは、
        CalculateDouble = CVErr(2001)    ' ユーザー定義のエラー値を返します。
    End If
End Function

実行結果

解説

配列・エラー関数一覧