Programming Guide

Chapter 5 . Library Functions

This chapter contains descriptions of Panther library functions arranged alphabetically. Each function description tells what the function does, and where and how to use it. Information about each function is organized into the following sections:

Syntax lines that are patterned after C function declarations. A syntax line is given for each variant of this function. Syntax lines are preceded by include statements that are specific to the function.
Parameter descriptions.
Platforms on which the function is valid. If the function is available on all platforms, this section is omitted.
Return values, if any. If the function returns no meaningful value, this section is omitted.
Description of the function—typical usage, prerequisites, results, and potential side-effects.
An example that shows how to use the function.
Listing of related functions.

Note: Because all routines that call Panther library functions must include smdefs.h, syntax sections omit an include statement for this file. If the function requires inclusion of other header files, the syntax section contains include statements for them.