Sub ステートメント (LotusScript 言語)

サブルーチンを定義します。

構文

[ Static ] [ Public | Private ] Sub subName [ ( [ argList ] ) ]

[ statements ]

End Sub

要素

Static

オプション。サブルーチンのローカル変数の値を、サブルーチンの呼び出し間で保存するように指定します。

Public | Private

オプション。Public は、そのモジュールがロードされている限り、そのスコープ (モジュールまたはクラス) の外からサブルーチンを参照できることを示します。Private は、サブルーチンが現在のスコープ内でのみ参照できることを示します。

既定では、モジュールスコープでのサブルーチンは Private です。クラススコープでのサブルーチンの既定は Public です。

subName

サブルーチンの名前。Delete、Initialize、New、Terminate というサブルーチン名は特殊です。この 4 つの名前は Sub DeleteSub InitializeSub NewSub Terminate の各トピックで説明する用途にのみ使用します。

argList

オプション。呼び出すときにサブルーチンに渡す引数の宣言をカンマで区切ったリストです。

各引数の宣言の構文は次のとおりです。

ByVal argument [ ( ) | List ] [ As dataType ]

ByVal は、argument が値渡しされることを意味します。argument に代入された値は、元の値への参照ではなく、サブルーチンの呼び出しで指定される値のコピーです。

argument () は引数の変数です。argument Listargument をリスト変数として識別します。それ以外の場合、argument には LotusScript® でサポートされるどの型の変数でも指定できます。

As dataType は変数のデータ型を指定します。この節を省略し、データ型の接尾辞を使用して、変数をスカラーデータ型の 1 つとして宣言できます。この節を省略し、argument の終わりにデータ型の接尾辞を追加しなければ (同時に、既存の Deftype ステートメントで処理されていなければ)、Variant データ型が代入されます。

引数宣言のリスト全体をカッコで囲みます。

使用法

Public キーワードは、クラスのメンバを宣言するときを除いて、アプリケーションオブジェクトのスクリプトに直接記述したり、アプリケーションオブジェクトスクリプトの %Include ファイル内で使用することはできません。Public 宣言は (Globals) で使用してください。

配列、リスト、型のインスタンス、オブジェクトは、引数として値渡しできません。参照渡ししてください。

サブルーチンは値を返しません。

サブルーチンは次の 2 つの方法で呼び出すことができます。

subName arg1, arg2, ...

Call subName (arg1, arg2, ...)

サブルーチンの定義では、別のプロシージャ (関数、サブルーチン、プロパティ) を定義できません。

クラスのサブルーチンのメンバは Static として宣言できません。

サブルーチンから抜け出るには Exit Sub ステートメントを使用します。

IBM® ソフトウェアアプリケーションには、スクリプト内で使用できるように特別な名前のサブルーチンが用意されていることがあります。詳しくは、製品のマニュアルを参照してください。