Using the H.324M function reference

This section provides an alphabetical reference to the H.324M functions. A typical function includes:

Prototype

The prototype is followed by a list of the function's arguments. All of the H.324M functions have the DWORD (16-bit unsigned) data type.

If a function uses an H.324M structure, the structure is listed as an argument.

Return values

A return value of SUCCESS (0) indicates the function was initiated; subsequent events indicate the status of the operation. Other possible return values are listed in the description of each individual call.

For a list of the errors returned by H.324M functions, refer to the Alphabetical error summary.

Events

H.3234M events are returned in the application's event buffer. Additional information such as reason codes and return values, appear in the value field of the event.

For detailed information about H.324M events, refer to the Alphabetical event summary.

Example

Example functions are taken from sample application programs shipped with the product.

The notation /* ... */ indicates additional code that is not shown.

Note: In this reference, the H324_BOOL data type is equivalent to the Boolean data type.