Flush app registry before releasing file lock
[platform/framework/native/appfw.git] / inc / FSysRuntimeInfo.h
index 822140d..8aeeb85 100644 (file)
@@ -42,7 +42,8 @@ class IRuntimeInfoGetLonglongAsyncResultListener;
  *
  * @final      This class is not intended for extension.
  *
- * The %RuntimeInfo class provides runtime information, such as the allocated memory used by the application storage, memory, and CPU utilization. To get the information, you must provide the <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">RuntimeInfo key</a>.
+ * The %RuntimeInfo class provides runtime information, such as the allocated memory used by the application storage, memory, and CPU utilization. 
+ * To get the information, you must provide the <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">RuntimeInfo key</a>.
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">Runtime Information</a>.
  *
@@ -80,49 +81,46 @@ class _OSP_EXPORT_ RuntimeInfo
 
 public:
        /**
-        * Gets the specific Tizen::Base::String type runtime information based on the specified
-        * designators (key).
+        * Gets the Tizen::Base::String type runtime information based on the specified designators (key).
         *
-        * @since       2.0
+        * @since               2.0
         *
-        * @return      An error code
-        * @param[in]   key     The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
-        * @param[out]  value                   The runtime information of type Tizen::Base::String
-        * @exception   E_SUCCESS               The method is successful.
+        * @return              An error code
+        * @param[in]   key             The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+        * @param[out]  value                           The runtime 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 runtime information based on the specified
-        * designators (key).
+        * Gets the integer type runtime information based on the specified designators (key).
         *
-        * @since       2.0
+        * @since               2.0
         *
-        * @return      An error code
-        * @param[in]   key     The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information @n
+        * @return              An error code
+        * @param[in]   key             The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information @n
         * @if OSPCOMPAT
         *                      The following key values are updated: @n
         *                      - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">here</a>.
         *                      - @b Deprecated All the key values provided prior to %Tizen are deprecated. For more detailed information, refer 
         *                       <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info_deprecated.htm">here</a>.
         * @endif
-        * @param[out]  value                   The integer type runtime information
-        * @exception   E_SUCCESS               The method is successful.
+        * @param[out]  value                           The integer type runtime 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 @c long @c long type runtime information based on the specified
-        * designators (key).
+        * Gets the @c long @c long type runtime information based on the specified designators (key).
         *
-        * @since       2.0
+        * @since               2.0
         *
-        * @return      An error code
-        * @param[in]   key     The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information @n
+        * @return              An error code
+        * @param[in]   key             The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information @n
         * @if OSPCOMPAT
         *                      The following key values are updated: @n
         *                      - Since Tizen, refer <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">here</a>.
@@ -130,83 +128,80 @@ public:
         *                       <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info_deprecated.htm">here</a>.
         *                       @xmlonly <pcheck kind="value" since="1.0" deprecated="yes"> @endxmlonly MaxAllocatableMemory, AvailableVideoMemory @xmlonly </pcheck> @endxmlonly
         * @endif
-        * @param[out]  value                   The @c long @c long type runtime information
-        * @exception   E_SUCCESS               The method is successful.
+        * @param[out]  value                           The @c long @c long type runtime 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, long long& value);
 
        /**
-        * Gets the specific double type runtime information based on the specified
-        * designators (key).
+        * Gets the double type runtime information based on the specified designators (key).
         *
         * @since       2.0
         *
-        * @return      An error code
-        * @param[in]   key     The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
-        * @param[out]  value                   The @c double type runtime information
-        * @exception   E_SUCCESS               The method is successful.
+        * @return              An error code
+        * @param[in]   key             The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+        * @param[out]  value                           The @c double type runtime 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 @c bool type runtime information based on the specified
-        * designators (key).
+        * Gets the @c bool type runtime information based on the specified designators (key).
         *
-        * @since       2.0
+        * @since               2.0
         *
-        * @return      An error code
-        * @param[in]   key     The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
-        * @param[out]  value                   The @c bool type runtime information
-        * @exception   E_SUCCESS               The method is successful.
+        * @return              An error code
+        * @param[in]   key             The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+        * @param[out]  value                           The @c bool type runtime 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 specific UuId type runtime information based on the specified
-        * designators (key).
+        * Gets the UuId type runtime information based on the specified designators (key).
         *
-        * @since       2.0
+        * @since               2.0
         *
-        * @return      An error code
-        * @param[in]   key     The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
-        * @param[out]  value                   The UuId type runtime information
-        * @exception   E_SUCCESS               The method is successful.
+        * @return              An error code
+        * @param[in]   key             The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+        * @param[out]  value                           The UuId type runtime 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 @c long @c long type runtime information based on specified designators (key) asynchronously.
+        * Gets the @c long @c long type runtime information based on specified designators (key) asynchronously.
         *
-        * @since       2.0
+        * @since               2.0
         *
-        * @return      An error code
-        * @param[in]   key     The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
-        * @param[in]   listener        The result listener
-        * @exception   E_SUCCESS       The method is successful.
+        * @return              An error code
+        * @param[in]   key             The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+        * @param[in]   listener                The result listener
+        * @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 GetValueAsync(const Tizen::Base::String& key, IRuntimeInfoGetLonglongAsyncResultListener* listener);
 
        /**
-        * Gets the specific @c int type runtime information based on specified designators (key) asynchronously.
+        * Gets the @c int type runtime information based on specified designators (key) asynchronously.
         *
-        * @since       2.0
+        * @since               2.0
         *
-        * @return      An error code
-        * @param[in]   key     The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
-        * @param[in]   listener        The result listener
-        * @exception   E_SUCCESS       The method is successful.
+        * @return              An error code
+        * @param[in]   key             The <a href="../org.tizen.native.appprogramming/html/guide/system/runtime_info.htm">key name</a> of the runtime information
+        * @param[in]   listener                The result listener
+        * @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 GetValueAsync(const Tizen::Base::String& key, IRuntimeInfoGetIntAsyncResultListener* listener);