m2mb API docs  25.30.003
m2mb API sets documentation
m2mb_atp_profile.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
22 #ifndef M2M_M2MB_ATP_PROFILE_API_H
23 #define M2M_M2MB_ATP_PROFILE_API_H
24 
25 
26 /* Global declarations ==========================================================================*/
27 
28 #define M2MB_ATP_PROFILE_PARAM_REGISTER(paramString, paramFlags, paramDefault, paramType) \
29 m2mb_atp_profile_param_register((CHAR*)paramString, (UINT16)paramFlags, (void*)paramDefault, (UINT16)(sizeof(paramType)))
30 #define M2MB_ATP_PROFILE_PARAM_SET(h, instanceNum, paramString, paramValue, paramType) \
31  m2mb_atp_profile_param_set((M2MB_ATP_HANDLE)h, (UINT16)instanceNum, (CHAR*)paramString, (void*)paramValue, (UINT16)(sizeof(paramType)))
32 #define M2MB_ATP_PROFILE_PARAM_GET(h, instanceNum, paramString, paramValue, paramType) \
33  m2mb_atp_profile_param_get((M2MB_ATP_HANDLE)h, (UINT16)instanceNum, (CHAR*)paramString, (void*)paramValue, (UINT16)(sizeof(paramType)))
34 
35 #define M2MB_ATP_BASE_PROFILE_FLAG 0x80
36 
37 typedef enum
38 {
39  M2MB_ATP_PI_FIRST = 0,
40  M2MB_ATP_PI_SECOND,
41  M2MB_ATP_PI_MAX,
42  M2MB_ATP_PI_BASE_FIRST = (M2MB_ATP_BASE_PROFILE_FLAG | M2MB_ATP_PI_FIRST),
43  M2MB_ATP_PI_BASE_SECOND,
44  M2MB_ATP_PI_BASE_MAX
45 } M2MB_ATP_PROFILE_INDEX_E;
46 
47 typedef enum
48 {
49  M2MB_ATP_COMMON_PROFILE = 0,
50  M2MB_ATP_INSTANCE_PROFILE
51 } M2MB_ATP_PROFILE_TYPE_E;
52 
53 /* Global functions =============================================================================*/
54 /*-----------------------------------------------------------------------------------------------*/
98 /*-----------------------------------------------------------------------------------------------*/
99 M2MB_RESULT_E m2mb_atp_profile_param_register( M2MB_ATP_HANDLE h, CHAR *paramString, M2MB_ATP_PROFILE_TYPE_E paramFlags, void *paramDefault, UINT16 paramSize );
100 
101 /*-----------------------------------------------------------------------------------------------*/
174 /*-----------------------------------------------------------------------------------------------*/
175 M2MB_RESULT_E m2mb_atp_profile_param_set( M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, void *paramValue, UINT16 paramSize );
176 
177 /*-----------------------------------------------------------------------------------------------*/
250 /*-----------------------------------------------------------------------------------------------*/
251 M2MB_RESULT_E m2mb_atp_profile_param_get( M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, void *paramValue, UINT16 paramSize );
252 
253 /*-----------------------------------------------------------------------------------------------*/
324 /*-----------------------------------------------------------------------------------------------*/
325 M2MB_RESULT_E m2mb_atp_profile_param_restore( M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString );
326 
327 /*-----------------------------------------------------------------------------------------------*/
398 /*-----------------------------------------------------------------------------------------------*/
399 M2MB_RESULT_E m2mb_atp_profile_set_active_profile( M2MB_ATP_HANDLE h, UINT16 instanceNum, M2MB_ATP_PROFILE_INDEX_E profileID );
400 
401 /*-----------------------------------------------------------------------------------------------*/
472 /*-----------------------------------------------------------------------------------------------*/
473 M2MB_RESULT_E m2mb_atp_profile_get_active_profile( M2MB_ATP_HANDLE h, UINT16 instanceNum, M2MB_ATP_PROFILE_INDEX_E *profileID );
474 
475 /*-----------------------------------------------------------------------------------------------*/
547 /*-----------------------------------------------------------------------------------------------*/
548 M2MB_RESULT_E m2mb_atp_profile_param_store( M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, M2MB_ATP_PROFILE_INDEX_E profileID );
549 
550 
551 
552 #endif
553 
m2mb_atp_profile_param_set
M2MB_RESULT_E m2mb_atp_profile_param_set(M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, void *paramValue, UINT16 paramSize)
m2mb_atp_profile_param_set sets value for a registered command parameter.
m2mb_atp_profile_param_restore
M2MB_RESULT_E m2mb_atp_profile_param_restore(M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString)
m2mb_atp_profile_param_restore resets all registered command parameters to their default value.
m2mb_atp_profile_param_store
M2MB_RESULT_E m2mb_atp_profile_param_store(M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, M2MB_ATP_PROFILE_INDEX_E profileID)
m2mb_atp_profile_param_store stores current value of a command parameter in a permanent (not volatile...
m2mb_atp_profile_param_register
M2MB_RESULT_E m2mb_atp_profile_param_register(M2MB_ATP_HANDLE h, CHAR *paramString, M2MB_ATP_PROFILE_TYPE_E paramFlags, void *paramDefault, UINT16 paramSize)
m2mb_atp_profile_param_register registers a command parameter.
m2mb_atp_profile_get_active_profile
M2MB_RESULT_E m2mb_atp_profile_get_active_profile(M2MB_ATP_HANDLE h, UINT16 instanceNum, M2MB_ATP_PROFILE_INDEX_E *profileID)
m2mb_atp_profile_get_active_profile gets active profile.
m2mb_atp_profile_set_active_profile
M2MB_RESULT_E m2mb_atp_profile_set_active_profile(M2MB_ATP_HANDLE h, UINT16 instanceNum, M2MB_ATP_PROFILE_INDEX_E profileID)
m2mb_atp_profile_set_active_profile sets active profile.
m2mb_atp_profile_param_get
M2MB_RESULT_E m2mb_atp_profile_param_get(M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, void *paramValue, UINT16 paramSize)
m2mb_atp_profile_param_get gets value for a registered command parameter.