Conventions Used in Method Descriptions

The documentation of each function contains these sections:

Syntax

The method syntax describes the C-language calling syntax of the function and gives a brief description.

Programming Note
The methods in this book are spelled in mixed-case for readability but are known to the system as uppercase character strings. For example, the function "WinCreateObject" is actually the external name "WINCREATEOBJECT".

If you are using a compiler that generates a mixed-case external name, you should code the functions in uppercase.

Parameters
Each parameter is listed with its C-language data type, parameter type, and a brief description.

• All data types are written in uppercase to match the header files. A data type of "Pxxxxxxx" implicitly defines a pointer to the data type "xxxxxxx".

  The term NULL applied to a parameter indicates the presence of the parameter, with no value.

  Refer to Data Types for a complete list of all data types and their descriptions.

• There are three parameter types:

  Input

  Specified by the programmer.
  Output
  Returned by the method.
  Input/Output
  Specified by the programmer and modified by the method.
  
  A brief description is provided with each parameter. Where appropriate, restrictions are also included. In some cases, the parameter points to a structure.
  Returns
  A list of possible return codes is included in this section.
  Remarks
  This section contains additional information about the method, when required.
  Related Methods
  This list shows the methods (if any) that are related to the method being described.
  Usage
  This section describes any restrictions for using the method.
  Override
  This section describes when the method can be overridden.

  ---

  [Back: Notation Conventions]
  [Next: Error Severities]