Func 对象

AutoHotkey

Func对象[v1.1.00+]

表示可以被脚本调用的自定义或内置的函数.

到 Func 对象的引用也被称为 函数引用. 要获取函数引用, 请使用 Func 函数, 例如:

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

Call

调用函数.

Func.(Parameters)

参数和返回值由函数定义.

如果 Func 是实现了 __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 无效则返回空字符串; 否则返回布尔值表示此参数是否可选.

如果此函数是可变参数的, 那么参数可以不进行正式声明. 支持内置函数.