9. Fax Library Function Reference

• Reference Header Information
• Description
• Details
• Cautions
• Example
• Source Code
• See Also
  

FAX Library Overview

This chapter provides an alphabetical reference to the functions in the fax main library (libfaxmt.lib) as well as the fax convenience functions (faxconv.c).

The following information is included to describe the fax function:

• Reference header information
• Description
• Details (when applicable)
• Cautions
• Example
• Source Code (when applicable)
• See Also (list of related functions, when applicable)

Reference Header Information

The function reference header contains the following information at the beginning of each fax function description:

Name:	The function name (with parameters).
Inputs:	The function parameter input types with a brief description of each parameter.
Returns:	The returns for the function.
Includes:	The include files required as displayed in the function example.
Category:	The group in which the function belongs.
Mode:	The mode of operation for the function (synchronous or asynchronous), if applicable.

Description

The function reference description provides the following information:

• A brief description of the purpose and operation of the function
• The function parameters and values
• A detailed description of the function to include, where applicable, how associated fax features apply to the function

Details

Where applicable, the chapter provides a detailed description of the fax function.

Cautions

The function reference cautions provide important information regarding restrictions on the use of the fax function.

Example

An example is provided to show how the function is used in a fax application. The specific fax function and parameters are printed in bold type. When applicable, the examples are commented to explain how each function is used in the example.

Source Code

Where applicable, the source code for the function is provided as part of the function reference.

See Also

Where applicable, a list of related functions is provided at the end of each function reference.

Click here to contact Dialogic Customer Engineering