Funcオブジェクト

提供: AutoHotkey Wiki
移動: 案内検索

このページの訳はかなり怪しいです。あまり信用しないように。
AHKL [v1.1.00+]: スクリプトで呼び出すことができるユーザー定義または組み込み関数を表す。 Funcオブジェクトへの参照は、関数参照と言われ、関数参照を取得するには次の例のようにはFunc関数を使用する。

fn := Func("Func")
MsgBox % fn.Name "() is " (fn.IsBuiltIn ? "built-in." : "user-defined.")

Call[編集]

関数を呼び出す。

Func.(Parameters)

パラメータと戻り値は、関数によって定義される。

This syntax is also valid if Func is a function name or a user-defined object which implements __Call.

Name[編集]

関数の名前を返す。

Func.Name

IsBuiltIn[編集]

組み込み関数の場合 true それ以外の場合は false を返す。

Func.IsBuiltIn

IsVariadic[編集]

関数が可変長の場合 true それ以外の場合は false を返す。

Func.IsVariadic

MinParams[編集]

必要なパラメータの数を返す。

Func.MinParams

MaxParams[編集]

ユーザー定義関数の正式に宣言されたパラメータまたは組み込み関数の最大パラメータの数を返す。

Func.MaxParams

関数が可変長である場合、戻り値は "variadic*"パラメータにオーバーフローすることなく関数が受け取ることができるパラメータの最大数を示す。

IsByRef()[編集]

パラメータが ByRef であるかどうかを判断する。

Func.IsByRef(ParamIndex)
ParamIndex オプション:パラメータの1から始まるインデックス。省略時は関数が任意のByRefパラメータを持っているかどうかを示す。
戻り値 空の文字列の場合、組み込み関数またはParamIndexは無効。それ以外の場合は、パラメーターは ByRef であるかどうかを示すブール値。

IsOptional()[編集]

パラメータがオプションかどうかを判断する。

Func.IsOptional(ParamIndex)
ParamIndex オプション:パラメータの1から始まるインデックス。省略時は関数が任意のオプションのパラメータがあるかどうかを示す。
戻り値 ParamIndexが無効である場合、空の文字列。それ以外の場合は、パラメーターは オプション であるかどうかを示すブール値。

パラメータは関数が可変長であれば正式に宣言する必要はない。組み込み関数がサポートされている。