Maxim Integrated 73M1866B/73M1966B FXOAPI - Manual (Page 11)

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide
Rev. 2.1 11
2.2 FXO API Initialization and Termination
2.2.1 M1x66_FxoApiInit
Description
This API allocates and initializes required internal data structures; make necessary preparation before
other API members can be invoked. The FXO API Initialization and Termination
M1x66_FxoApiInit() must be called once during application program’s initialization, or prior to accessing
other API members. Upon exiting of the application program a reversed operation must be performed to
release resources using M1x66_FxoApiRelease.
Prototype
M1x66_RET M1x66_FxoApiInit (void);
Parameters
Data Type Name Description
void void No parameter is required.
Return Values
Data Type Description
M1x66_RET M1x66_SUCCESS – Successful FXO API initialization.
M1x66_FAILED – Failed.
2.2.2 M1x66_FxoApiRelease
Description
This API de-allocates the resources acquired during initialization - FXO API Initialization and Termination
M1x66_FxoApiInit. It must be called prior to application program termination, or when access to FXOAPI
is no longer needed. Any FXO channels or device remain open when this API is called will be closed.
Prototype
M1x66_RET M1x66_FxoApiRelease (void);
Parameters
Data Type Name Description
void void No parameter is required.
Return Values
Data Type Description
M1x66_RET M1x66_SUCCESS – Successful FXO API termination.
M1x66_FAILED – Unsuccessful.