APIの説明形式
APIは、基本的には次に示す形式で説明しています。各APIは、API名のアルファベット順に並んでいます。
機能
APIの機能を示しています。
形式
APIの記述形式を示しています。
[ ]で囲まれた引数は省略できます。省略した場合は、デフォルト値が設定されます。これらの引数は常にAPIの最後の引数となります。
- （例1）
bool AIT_SelectListItem ( strCaption, nCtrlType, strItemText [, fTimeOut] );
上記のAPIでは、fTimeOutは関数呼び出し時に指定する必要はありません。
- （例2）
AIT_SelectListItem ( "Countries" LISTBOX_CTRL, "Japan" ); integer AIT_MessageBox ( strMessage, strTitle [, nIconType] [, nMsgBoxType] );
上記のAPIでは、nIconTypeとnMsgBoxTypeの両方を省略して次のように呼び出せます。
AIT_MessageBox( "Hello World","Error");
nMsgBoxTypeを指定してnIconTypeを指定したくない場合、nIconTypeのデフォルト値が設定されます。
AIT_MessageBox( "Hello World","Error", MB_ICONEXCLAMATION );
引数
APIで指定できる引数を示しています。入力用の引数の場合は（入力用）、出力用の引数の場合は（出力用）、入力用で省略できる場合は（入力用、省略可）と示しています。
戻り値
APIの戻り値を示しています。
APIが実行中に処理を失敗した場合のためにエラーコードが設定されています。このエラーコードはAIT_GetLastErrorというAPIを使用して取得できます。ユーザが特殊なコードのために特殊なエラー処理を必要とする場合は、APIが正常に実行されたか失敗したかをチェックしたあとで、AITファイルによって適切に扱うことになります。
ランタイムエラーが発生した場合、AITファイル内のERRORセクションが自動的に実行されます。
注意事項
API実行時の注意事項がある場合に記載しています。