X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSysSystemInfo.h;h=5458ed9b826ff0592c1535bbbefad833d9004835;hb=102d9124a6981de495cb23e8bd98c2de322960fb;hp=6490d2ed9e471b8aa8988f16f85cc0bba2957445;hpb=4af0bbe287ef2fce8ca9949790fdab94bf9040d5;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FSysSystemInfo.h b/inc/FSysSystemInfo.h index 6490d2e..5458ed9 100644 --- a/inc/FSysSystemInfo.h +++ b/inc/FSysSystemInfo.h @@ -1,5 +1,4 @@ // -// Open Service Platform // Copyright (c) 2012 Samsung Electronics Co., Ltd. // // Licensed under the Apache License, Version 2.0 (the License); @@ -61,7 +60,7 @@ enum SystemInfoValueType * * The %SystemInfo class provides system information, such as the API and platform versions, supported device features, * and screen dimensions. - * To get the information, you must provide the SystemInfo key. + * To get the system information, you must provide the SystemInfo key. * * For more information on the class features, see System Information. * @@ -99,195 +98,195 @@ class _OSP_EXPORT_ SystemInfo public: /** - * Gets the specific Tizen::Base::String type system information based on the specified designators (key). + * Gets the Tizen::Base::String type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information @n + * @return An error code + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The system information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. + * @param[out] value The system information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value); /** - * Gets the specific integer type system information based on the specified designators (key). + * Gets the integer type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information @n + * @return An error code + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The integer type system information - * @exception E_SUCCESS The method is successful. + * @param[out] value The integer type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, int& value); /** - * Gets the specific double type system information based on the specified designators (key). + * Gets the @c double type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information - * @param[out] value The @c double type system information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the system information + * @param[out] value The @c double type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, double& value); /** - * Gets the specific UuId type system information based on the specified designators (key). + * Gets the UuId type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information - * @param[out] value The UuId type system information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the system information + * @param[out] value The UuId type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value); /** - * Gets the specific system information based on the specified key and data type of the information. + * Gets the system information based on the specified key and data type of the information. * - * @since 2.0 + * @since 2.0 * - * @return A system information list - * @param[in] key The key name of the system information @n + * @return The system information list + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated @n * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[in] type The data type of the information - * @exception E_SUCCESS The method is successful. + * @param[in] type The data type of the information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::Collection::IList* GetValuesN(const Tizen::Base::String& key, SystemInfoValueType type); /** - * Gets the specific boolean type system information based on the specified designators (key). + * Gets the @c bool type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information @n + * @return An error code + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The @c bool type system information - * @exception E_SUCCESS The method is successful. + * @param[out] value The @c bool type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, bool& value); /** * Gets the platform version in the "[Major].[Minor].[Patch Version]" format. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code + * @return An error code * @param[out] platformVersion The platform version - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetPlatformVersion(Tizen::Base::String& platformVersion); /** - * Gets the Native API version in the "[Major].[Minor]" format. + * Gets the native API version in the "[Major].[Minor]" format. * * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code - * @param[out] nativeApiVersion The Native API version - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @param[out] nativeApiVersion The native API version + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetNativeApiVersion(Tizen::Base::String& nativeApiVersion); /** * Gets the WEB API version in the "[Major].[Minor]" format. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code + * @return An error code * @param[out] webApiVersion The %Tizen API version - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetWebApiVersion(Tizen::Base::String& webApiVersion); /** * Gets the platform build information. * - * @since 2.1 + * @since 2.1 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code - * @param[out] buildInfo The %Tizen build information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[out] buildInfo The %Tizen build information + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetBuildInfo(Tizen::Base::String& buildInfo); /** * Gets the International Mobile Equipment Identity (IMEI) of the device. * - * @since 2.0 + * @since 2.0 * * @privlevel partner * @privilege %http://tizen.org/privilege/systemmanager @n - * (%http://tizen.org/privilege/useridentity is deprecated.) + * (%http://tizen.org/privilege/useridentity is deprecated.) * - * @return An error code - * @param[out] imei The IMEI of the device - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[out] imei The IMEI of the device + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetImei(Tizen::Base::String& imei);