{
#endif
+
/**
* @addtogroup CAPI_SYSTEM_SYSTEM_INFO_MODULE
* @{
*/
+
/**
- * @brief Gets the boolean value of the @a platform feature.
+ * @brief Gets the boolean value of the @a platform feature.
* @since_tizen 2.3
* @param[in] key The name of the platform feature to get
* @param[out] value The value of the given platform feature
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #SYSTEM_INFO_ERROR_NONE Successful
- * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
*/
int system_info_get_platform_bool(const char *key, bool *value);
+
/**
- * @brief Gets the integer value of the @a platform feature.
+ * @brief Gets the integer value of the @a platform feature.
* @since_tizen 2.3
* @param[in] key The name of the platform feature to get
* @param[out] value The value of the given platform feature
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #SYSTEM_INFO_ERROR_NONE Successful
- * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
*/
int system_info_get_platform_int(const char *key, int *value);
+
/**
- * @brief Gets the double value of the @a platform feature.
+ * @brief Gets the double value of the @a platform feature.
* @since_tizen 2.3
* @param[in] key The name of the platform feature to get
* @param[out] value The value of the given platform feature
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #SYSTEM_INFO_ERROR_NONE Successful
- * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
*/
int system_info_get_platform_double(const char *key, double *value);
+
/**
- * @brief Gets the string value of the @a platform feature.
+ * @brief Gets the string value of the @a platform feature.
* @since_tizen 2.3
* @remarks You must release the @a value using free().
* @param[in] key The name of the platform feature to get
* @param[out] value The value of the given platform feature
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #SYSTEM_INFO_ERROR_NONE Successful
- * @retval #SYSTEM_INFO_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
*/
int system_info_get_platform_string(const char *key, char **value);
/**
- * @brief Gets the boolean value of the @a custom feature.
+ * @brief Gets the boolean value of the @a custom feature.
* @since_tizen 2.3
* @param[in] key The name of the custom feature to get. NOTE: This custom function uses a custom key which is provided by OEM's
* @param[out] value The value of the given custom feature
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #SYSTEM_INFO_ERROR_NONE Successful
- * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
*/
int system_info_get_custom_bool(const char *key, bool *value);
+
/**
- * @brief Gets the integer value of the @a custom feature.
+ * @brief Gets the integer value of the @a custom feature.
* @since_tizen 2.3
* @param[in] key The name of the custom feature to get. NOTE: This custom function uses a custom key which is provided by OEM's
* @param[out] value The value of the given custom feature
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #SYSTEM_INFO_ERROR_NONE Successful
- * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot the find @a key in the model config file
- * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot the find @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
*/
int system_info_get_custom_int(const char *key, int *value);
+
/**
- * @brief Gets the double value of the @a custom feature.
+ * @brief Gets the double value of the @a custom feature.
* @since_tizen 2.3
* @param[in] key The name of the custom feature to get. NOTE: This custom function uses a custom key which is provided by OEM's
* @param[out] value The value of the given custom feature
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #SYSTEM_INFO_ERROR_NONE Successful
- * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
*/
int system_info_get_custom_double(const char *key, double *value);
+
/**
- * @brief Gets the string value of the @a custom feature.
+ * @brief Gets the string value of the @a custom feature.
* @since_tizen 2.3
* @remarks You must release the @a value using free().
* @param[in] key The name of the custom feature to get. NOTE: This custom function uses a custom key which is provided by OEM's
* @param[out] value The value of the given custom feature
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #SYSTEM_INFO_ERROR_NONE Successful
- * @retval #SYSTEM_INFO_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
- * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
- * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #SYSTEM_INFO_ERROR_NONE Successful
+ * @retval #SYSTEM_INFO_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #SYSTEM_INFO_ERROR_INVALID_PARAMETER Cannot find the @a key in the model config file
+ * @retval #SYSTEM_INFO_ERROR_IO_ERROR An input/output error occurred while reading the @a value from the model config file
+ * @retval #SYSTEM_INFO_ERROR_PERMISSION_DENIED No permission to use the API
*/
int system_info_get_custom_string(const char *key, char **value);
+
/**
* @internal
- * @brief Do not use it. It will be removed
+ * @brief Do not use it. It will be removed.
*/
int system_info_get_value_int(system_info_key_e key, int *value);
+
/**
* @internal
- * @brief Do not use it. It will be removed
+ * @brief Do not use it. It will be removed.
*/
int system_info_get_value_bool(system_info_key_e key, bool *value);
+
/**
* @internal
- * @brief Do not use it. It will be removed
+ * @brief Do not use it. It will be removed.
*/
int system_info_get_value_double(system_info_key_e key, double *value);
+
/**
* @internal
- * @brief Do not use it. It will be removed
+ * @brief Do not use it. It will be removed.
*/
int system_info_get_value_string(system_info_key_e key, char **value);
-/**
- * @internal
- * @brief It is not decided if it should be opened to public
- */
-typedef enum {
- SYSTEM_INFO_BOOL,
- SYSTEM_INFO_INT,
- SYSTEM_INFO_DOUBLE,
- SYSTEM_INFO_STRING,
-} system_info_type_e;
/**
* @internal
- * @brief It is not decided if it should be opened to public
+ * @brief It is not decided if it should be opened to public.
*/
int system_info_get_platform_type(const char *key, system_info_type_e *type);
+
/**
* @internal
- * @brief It is not decided if it should be opened to public
+ * @brief It is not decided if it should be opened to public.
*/
int system_info_get_custom_type(const char *key, system_info_type_e *type);
+
/**
* @}
*/
projects / platform / core / api / system-info.git / blobdiff