User Defined Function Notes

AutoIt3標準関数によって作られているファイルをいくつか添付しました。これらのファイルはUser Defined Functions(訳註:ユーザー定義関数)と呼ばれます。
UDF'sはAutoIt3で書かれた関数/スクリプト群で、あなた自身のスクリプトに#includeすることで必要な際に自分自身でプログラムしたり、毎回コピー&ペーストしたりせずに使用することができます。

例:

#include <date.au3>
MsgBox(0,"Today","Today's date is " & _Now())

このスクリプトは あなたのPCのロング形式でフォーマットされた今日の日付けを表示します。例えば"Sunday, December 18, 2004"といった具合です。

 

多くのUDF'sは省略できるオプションパラメータを持ちます。オプションパラメータを指定する場合はそれ以前の全てのパラメータを指定する必要があります!
_ArraySort( ByRef $a_Array [, $i_Descending [, $i_Base=0 [, $i_Ubound=0 [, $i_Dim=1 [, $i_SortIndex=0 ]]]]] )を例に考えて見ましょう。
パラメータの前にByrefがつく場合、関数がその変数を新しい値に更新することを意味しています。 それらのパラメータは変数($xyz)でなければならず、定数であってはなりません。

ほとんどのUDF'sは成功/失敗を返し値で通知し、他のものは@errorフラグを設定することで通知します。一部は両方をおこないます...
@error = 0は常に成功を表します。
返し値はコードを読みやすくするために通常は非ゼロが成功を表します...

関数が@errorフラグを設定する場合、返し値を使用する前に常に@errorを調べた方が良いでしょう。@errorがエラーを示している場合、一般に関数の返し値は未定義です...