About the Run-Time Reference

The following pages describe, in alphabetical order, the more than 550 functions and macros in the Microsoft run-time library. In some cases, related routines are clustered in the same description. For example, the based, near, and far versions of _heapwalk are in the same discussion, as are the regular and long double versions of the math functions, such as acos and atan. Differences are noted where appropriate. Refer to Chapter 2, “Run-Time Routines by Category,” or to the index to locate any function that does not appear in the expected position within the alphabetical reference.

The discussion of each function (or group of functions) is divided into the following sections:

Description. Summarizes the routine's effect, names the include file(s) containing its declaration, illustrates the syntax, and briefly describes the arguments.

Remarks. Gives a more detailed description of the routine and how it is used.

Return Value. Describes the value returned by the routine.

Compatibility. Tells whether the routine is compatible with ANSI C, UNIX, DOS, QuickWin, Windows, and the DOS Extender (DOS32X).

See Also. Names related routines.

Example. Gives a complete program showing the use of the routine.

Output. Shows the output from the example program.