include/telephony_modem.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __CAPI_TELEPHONY_MODEM_H__
  18 #define __CAPI_TELEPHONY_MODEM_H__
  19
  20 /**
  21  * @file telephony_modem.h
  22  * @brief This file contains modem APIs.
  23  */
  24
  25 #include "telephony_common.h"
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /**
  32  * @addtogroup CAPI_TELEPHONY_INFORMATION_MODEM
  33  * @{
  34  */
  35
  36 /**
  37  * @brief Gets the IMEI (International Mobile Station Equipment Identity) of a mobile phone.
  38  * @details The IMEI number is used by a GSM network to identify valid devices
  39  *          and therefore can be used for stopping a stolen phone from accessing that network.
  40  *
  41  * @since_tizen 2.3
  42  * @privlevel public
  43  * @privilege %http://tizen.org/privilege/telephony
  44  *
  45  * @remarks You must release @c imei using free().
  46  *
  47  * @param[in] handle The handle from telephony_init()
  48  * @param[out] imei The International Mobile Station Equipment Identity
  49  *
  50  * @return @c 0 on success,
  51  *         otherwise a negative error value
  52  *
  53  * @retval #TELEPHONY_ERROR_NONE              Successful
  54  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  55  * @retval #TELEPHONY_ERROR_PERMISSION_DENIED Permission denied
  56  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  57  * @retval #TELEPHONY_ERROR_OPERATION_FAILED  Operation failed
  58  */
  59 int telephony_modem_get_imei(telephony_h handle, char **imei);
  60
  61 /**
  62  * @}
  63  */
  64
  65 #ifdef __cplusplus
  66 }
  67 #endif
  68
  69 #endif // __CAPI_TELEPHONY_MODEM_H__