This chapter provides a general description of each of the API function categories. It describes the syntax of each API function, the operations the function performs, and the data structures and header files the function uses.
The chapter is divided into sections according to API function category. The following function categories are described in this chapter:
Each category begins with an overview that explains how the API functions in that category interrelate and work with Advanced Server. Data structures common to several or all of the functions are described.
The category sections and the entries within them are arranged alphabetically.
Detailed descriptions of every API function in manual-page format are available on-line at the server console. To display an API function, type the following command:
man <api>
For example, to display detailed specifications for the NetGroupAdd API function, you would type the following command at the system console:
man NetGroupAdd
Every on-line manual page includes the security privilege level required to execute the function successfully, syntax of the function, and a detailed description of each parameter. The most common error codes returned by each function also are listed.
The information presented on-line for each API function includes the following:
This section names and succinctly describes the function.
This section specifies the group and/or local group membership required to execute the function successfully.
This section illustrates the declaration of the function, including necessary header files.
This section describes the function and its parameters.
This section consists of a table showing error messages that can be returned, their value, and a brief description of their meaning.
This section is used to describe any exceptions, caveats, or usage suggestions pertaining to the function.
This section refers you to additional information related to the use of the function.