3.1. Function Documentation

The Call Logging API functions are listed alphabetically in the remainder of this chapter. The format for each function description is as follows:

• Function header - Lists the function name and briefly states the purpose of the function.
  • Name - Defines the function name and function syntax using standard C language syntax.
  • Inputs - Lists all input parameters using standard C language syntax.
  • Returns - Lists all returns of the function.
  • Includes - Lists all include files required by the function.
  • Mode - Asynchronous or synchronous.
• Description paragraph - Provides a description of function operation, including parameter descriptions.
• Termination Event paragraph - Describes the event(s) returned to indicate the termination of the function. Termination events are returned by asynchronous functions only.
• Cautions paragraph - Provides warnings and reminders.
• Example paragraph - Provides C language coding example(s) showing how the function can be used in application code.
• Errors paragraph - Lists specific error codes for each function.
• See Also paragraph - Provides a list of related functions.

Click here to contact Dialogic Customer Engineering