10.2 Headings used in the explanation of APIs

This section explains the headings used in the explanations of the APIs.

Format

Indicates the header file required for the API and the format of the API.

Description

Describes the API.

Arguments whose values are to be set by the UAP

Explains the arguments whose values are to be set by the UAP.

Arguments whose values are returned by HA Monitor

Explains the arguments whose values are returned by HA Monitor.

Return codes

Explains the return codes of the API.

Notes

Provides notes about using the API.