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

UG_1x22_055 73M1822/73M1922 Modem API User Guide
Rev. 1.0 25
4 Enumerator Reference
This section contains the detail description of the enumerated data reference used in this API subsystem.
Table 3 contains the summary of the enumerated data reference.
Table 3: Enumerator Overview
Name Description
M1X22_RET Return status code from API.
M1X22_EVENT_ID Event identification.
M1X22_COUNTRY_CODE List of country code supported.
M1X22_HOOK_SWITCH On and off hook.
M1X22_REG_TYPE List of 1x22 device H/W register.
M1X22_DEBUG_TRACE_MASK List of debug trace mask.
4.1 M1X22_RET
Description
API function return code. All APIs, expect the open device and open channel, return with M1X22_RET
code. For additional error information when an API returns M1X22_FAILED the application program can
issue a get last error – M1X22_GetLastError.
Prototype
/*
**************************************************************************
** Function return code
*************************************************************************/
typedef enum {
M1X22_SUCCESS = 0,
M1X22_FAILED = (-1),
}
M1X22_RET;
Name Value Description
M1X22_SUCCESS 0 Successful.
M1X22_FAILED -1 Failed.