m2mb_info.h File Reference

Header file for m2mb_info APIs. More...

Go to the source code of this file.

Typedefs
typedef HANDLE	M2MB_INFO_HANDLE

Enumerations
enum	M2MB_INFO_E {   M2MB_INFO_GET_SERIAL_NUM, M2MB_INFO_GET_FW_VERSION, M2MB_INFO_GET_SW_VERSION, M2MB_INFO_GET_MANUFACTURER,   M2MB_INFO_GET_MODEL, M2MB_INFO_GET_HW_VERSION, M2MB_INFO_GET_MSISDN, M2MB_INFO_GET_IMSI,   M2MB_INFO_GET_SVN, M2MB_INFO_GET_AZL_VERSION, M2MB_INFO_GET_SMSS, M2MB_INFO_GET_TID,   M2MB_INFO_GET_ICCID, M2MB_INFO_GET_SERIAL_NUM_FACTORY, M2MB_INFO_GET_PKG_VERSION, M2MB_INFO_NUM }

Functions
M2MB_RESULT_E	m2mb_info_init (M2MB_INFO_HANDLE *h)
	m2mb_info_init initializes the INFO service. More...
M2MB_RESULT_E	m2mb_info_deinit (M2MB_INFO_HANDLE h)
	m2mb_info_deinit deinitializes the INFO service. More...
M2MB_RESULT_E	m2mb_info_get (M2MB_INFO_HANDLE h, M2MB_INFO_E info, CHAR **data)
	m2mb_info_get provides information about device/SIM card in use. More...

Detailed Description

Header file for m2mb_info APIs.

m2m/m2m_common/m2mb_inc/m2mb_info.h

m2mb_info APIs provide general information about device in use (FW version, SW version, etc...)

@notes

Author

S. Passiu

Date

21/02/2017

Enumeration Type Documentation

M2MB_INFO_E

enum M2MB_INFO_E

Enumerator
M2MB_INFO_GET_PKG_VERSION	entry for retrieving the package version

Function Documentation

m2mb_info_deinit()

M2MB_RESULT_E m2mb_info_deinit

(

M2MB_INFO_HANDLE

h

)

m2mb_info_deinit deinitializes the INFO service.

m2mb_info_deinit deinitialize INFO service for current client freeing the handle passed as first parameter. Calling the m2mb_info_deinit is useful after using the INFO service in order to free memory space.

Parameters

[in]

h

first parameter is the handle to the INFO service, that will be deinitialized by the function.

Returns

returns M2MB_RESULT_SUCCESS on success, a different value on error.

Note

m2mb_info_deinit(&h);

M2MB_RESULT_E retVal = M2MB_RESULT_SUCCESS;
M2MB_INFO_HANDLE h;
retVal = m2mb_info_init(&h);
 
//... use INFO APIs ...
 
retVal = m2mb_info_deinit(h);
if ( retVal == M2MB_RESULT_SUCCESS )
  printf( "m2mb_info_deinit succeeded");

m2mb_info_get()

M2MB_RESULT_E m2mb_info_get	(	M2MB_INFO_HANDLE	h,
		M2MB_INFO_E	info,
		CHAR **	data
	)

m2mb_info_get provides information about device/SIM card in use.

m2mb_info_get function provides, depending on the second parameter value, one of the following information about the device/SIM card in use: MSISDN, device Serial Number (IMSI), device firmware version, device manufacturer name, device model name, device hardware version.

Parameters

[in]	h	first parameter is the handle to the INFO service, previously initialized by the m2mb_info_init function.
[in]	info	one of the items of type M2MB_INFO_E, according to the information required.
[in]	**data	pointer to a char pointer where the required string value will be created. On success: the variable contains the requested string. On failure: no modifications are done to the content of the variable. NOTE: do not alloc memory for this variable, it must be declared as simple CHAR pointer before be passed to the m2mb_info_get function (see source code example below).

Returns

returns M2MB_RESULT_SUCCESS on success, a different value on error.

Note

m2mb_info_get(h, M2MB_INFO_GET_SERIAL_NUM, &data);

CHAR *data;
M2MB_RESULT_E retVal = M2MB_RESULT_SUCCESS;
M2MB_INFO_HANDLE h;
retVal = m2mb_info_init(&h);
//...
 
retVal = m2mb_info_get(h, M2MB_INFO_GET_SERIAL_NUM, &data);
if ( retVal == M2MB_RESULT_SUCCESS )
  printf( "Device IMSI is %s", data);
 
//...

m2mb_info_init()

M2MB_RESULT_E m2mb_info_init

(

M2MB_INFO_HANDLE *

h

)

m2mb_info_init initializes the INFO service.

m2mb_info_init initialize SMS INFO for current client returning the handle that must be passed as first parameter for all INFO actions. Calling the m2mb_info_init is mandatory before using the INFO service.

Parameters

[in]

*h

first parameter is the handle to the INFO service, that will be initialized by the function.

Returns

returns M2MB_RESULT_SUCCESS on success, a different value on error.

Note

m2mb_info_init(&h);

M2MB_RESULT_E retVal = M2MB_RESULT_SUCCESS;
M2MB_INFO_HANDLE h;
retVal = m2mb_info_init(&h);
if ( retVal == M2MB_RESULT_SUCCESS )
  printf( "m2mb_info_init succeeded");