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

UG_1x66B_046 73M1866B/73M1966B FXOAPI User Guide
Rev. 2.1 27
2.9 Country Default Parameter and Override APIs
2.9.1 M1x66_GetCountryParam
Description
This API reads the default country parameter. To retrieve the country parameter set the desired country
code in the field “cnum”. If the reading is successful the desired country parameter will be returned in the
country structure passed in.
Prototype
M1x66_RET M1x66_GetCountryParam (M1x66_HANDLE chanHandle,
M1966_CNTRY_STRUCT_t *pParam)
Parameters
Data Type Name Description
M1x66_HANDLE chanHandle Channel handle from FXO open channel.
M1966_CNTRY_STRUCT_t *pParam Pointer to structure returning the country parameter.
Return Values
Data Type Description
M1x66_RET M1x66_SUCCESS – Successful.
M1x66_FAILED – Failure.
2.9.2 M1x66_SetCountryParam
Description
The country parameters are set to their default value upon startup. This default country parameter can be
found in ref [1]. This API can be used to change the default parameter.
Prototype
M1x66_RET M1x66_SetCountryParam (M1x66_HANDLE chanHandle,
M1966_CNTRY_STRUCT_t *pParam)
Parameters
Data Type Name Description
M1x66_HANDLE chanHandle Channel handle from FXO open channel.
M1966_CNTRY_STRUCT_t *pParam Pointer to structure containing the new default country
parameters.
Return Values
Data Type Description
M1x66_RET M1x66_SUCCESS – Successful.
M1x66_FAILED – Failure.