Hitachi

JP1 Version 12 JP1/IT Desktop Management 2 Distribution Function Administration Guide


Format of API function explanations

The API functions are described in the following format. The API functions are sorted in alphabetical order.

Organization of this page

Description

This describes the functionality of the API function.

Format

This provides the coding format of the API function.

The parameters enclosed with [] are optional. If you omit such a parameter, the default is used. Optional parameters are shown at the end of the parameter list. You can omit only the last parameter(s).

Example 1:
bool AIT_SelectListItem ( strCaption, nCtrlType, strItemText [, fTimeOut] );

For the format of the above API function, you do not need to specify fTimeOut when calling the function.

Example 2:
AIT_SelectListItem ( "Countries" LISTBOX_CTRL, "Japan" );
integer AIT_MessageBox ( strMessage, strTitle [, nIconType] [, nMsgBoxType] );

For the format of the above API function, you can call the following function with both nIconType and nMsgBoxType omitted:

AIT_MessageBox( "Hello World","Error");

If you specify nMsgBoxType but do not want to specify nIconType, the default of nIconType will be used.

AIT_MessageBox( "Hello World","Error", MB_ICONEXCLAMATION );

Parameters

This provides the parameters you can specify in the API function. There are input and output parameters. Some of the parameters are optional.

Return value

This describes the return values of the API function.

Each API has its error code returned if the API fails during processing. In an AIT file, if you need to code special error handling for special processing, you first check return codes to see whether API functions were successfully executed.

If a run-time error has occurred, the script coded in the ERROR section of the AIT file is executed automatically.

Note

This provides points you should note when executing the API function.