Примечания по использованию функций

Примечания по использованию функций

Многие функции содержат опциональные параметры (они могут быть опущены при вызове). Если необходимо указать опциональный параметр, то необходимо также указать все предшествующие параметры!
К примеру, функция Run ( "filename", ["workingdir" [, flag]] ).  Если при вызове указывается параметр flag, то необходимо также указать параметр workingdir.

Многие Win___ функции содержат опциональный параметр "text".  Этот параметр помогает отличать друг от друга разные окна с одинаковым заголовком.


Некоторые функции обозначают свою успешную (или не очень) работу, возвращая какое-либо значение; другие для этого устанавливают значение флага @error.  Некоторые делают и то, и другое...
@error = 0 ;всегда означает успешное выполнение
Возвращаемое значение = по разному, но обычно не нулевое значение обозначает успешное выполнение (для упрощения чтения кода)...

If _SomeUserFunc() Then  ;...функция сработала правильно
If Not _SomeUserFunc() Then  ;...функция сработала неправильно

$x = FileReadLine("C:\someFile.txt")
If @error = -1 Then ; достигнут конец файла


Если функция устанавливает значение флага @error, необходимо всегда проверять его перед использованием возвращённого значения - когда @error указывает на ошибку, значение, возвращённое функцией, чаще всего, не определено...

@error всегда устанавливается равным 0 при вызове функции.

Даже если в документации указано, что функция не возвращает значение, AutoIt всё равно возвращает значение (чтобы избежать ошибок). Чаще всего возвращается значение 1, но вы не должны на него ориентироваться.

Если необходимо указать какой либо опциональный параметр, то все предшествующие ему параметры должны быть указаны значениями по умолчанию. Это может быть "" (пустая строка) для строковых параметров или -1 для других типов. Некоторые функции, такие как StringInStr или StringReplace требуют 0. Смотрите соответствующее описание опциональных параметров.