Conventions and terminology used in this document

Typographical conventions

The following table explains the typographical conventions used in this document.

Table 1. Typographical conventions
Typeface Indicates Example
bold Commands, executable names, compiler options and pragma directives. Use the -qmkshrobj compiler option to create a shared object from the generated object files.
italics Parameters or variables whose actual names or values are to be supplied by the user. Italics are also used to introduce new terms. Make sure that you update the size parameter if you return more than the size requested.
monospace Programming keywords and library functions, compiler built-in functions, file and directory names, examples of program code, command strings, or user-defined names. If one or two cases of a switch statement are typically executed much more frequently than other cases, break out those cases by handling them separately before the switch statement.

Icons

All features described in this document apply to both C and C++ languages. Where a feature is exclusive to one language, or where functionality differs between languages, the following icons are used:

C only
The text describes a feature that is supported in the C language only; or describes behavior that is specific to the C language.
C++ only
The text describes a feature that is supported in the C++ language only; or describes behavior that is specific to the C++ language.

In general, this guide documents XL C/C++ functionality as it has been implemented on the AIX platform. However, where issues are discussed that affect portability to other platforms or systems, the following icons are used:

AIX
The text describes the functionality supported on the AIX(R) platform.
Linux
The text describes the functionality supported on the Linux(R) platform.

How to read syntax diagrams

The following syntax diagram example shows the syntax for the #pragma comment directive.

 1   2    3    4         5         6                               9  10 
 >>-#--pragma--comment--(-------compiler---------------------------)-><
                          |                                     |
                          +-----date----------------------------+
                          |                                     |
                          +-----timestamp-----------------------+
                          |                                     |
                          +--+--copyright--+--+-----------------+
                             |             |  |                 |
                             |             |  |                 |
                             +--user-------+  +--,-"characters"-+

                                                 7  8 

The following examples of the #pragma comment directive are syntactically correct according to the diagram shown above:

   #pragma
   comment(date)
   #pragma comment(user)
   #pragma comment(copyright,"This text will appear in the module")
   

Examples

The examples in this document, except where otherwise noted, are coded in a simple style that does not try to conserve storage, check for errors, achieve fast performance, or demonstrate all possible methods to achieve a specific result.