Maxim Integrated 73M1822/73M1922 Modem API - Manual (Page 8)

73M1822/73M1922 Modem API User Guide UG_1x22_055
8 Rev. 1.0
2.1 M1X22_MdmApiInit
Description
This API allocates and initializes required internal data structures; make necessary preparation before
other API members can be invoked. The M1X22_MdmApiInit() 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 M1X22_MdmApiRelease.
Prototype
M1X22_RET M1X22_MdmApiInit (void);
Parameters
Data Type Name Description
void void No parameter is required.
Return Values
Data Type Description
M1X22_RET M1X22_SUCCESS – Successful API initialization.
M1X22_FAILED – Failed.
2.2 M1X22_MdmApiRelease
Description
This API de-allocates the resources acquired during initialization – M1X22_MdmApiInit. It must be
called prior to application program termination, or when access to API is no longer needed. Any channels
or devices remaining open when this API is called will be closed.
Prototype
M1X22_RET M1X22_MdmApiRelease (void);
Parameters
Data Type Name Description
void void No parameter is required.
Return Values
Data Type Description
M1X22_RET M1X22_SUCCESS – Successful API termination.
M1X22_FAILED – Unsuccessful.