extern "C" {
#endif
+
/**
- * @file storage.h
- * @ingroup FRAMEWORK/SYSTEM
- * @brief This file contains the API for the status of devices.
- * @author TIZEN
- * @date 2013-02-15
- * @version 0.1
+ * @file storage.h
+ * @ingroup CAPI_SYSTEM_STORAGE_MODULE
+ * @brief This file contains the API for the status of devices.
+ * @author TIZEN
+ * @date 2013-02-15
+ * @version 0.1
*/
+
/**
* @addtogroup CAPI_SYSTEM_STORAGE_MODULE
* @{
*/
+
#include <sys/statvfs.h>
-#include "storage-expand.h"
+#include <storage-expand.h>
+
/**
- * @fn int storage_get_internal_memory_size(struct statvfs *buf)
- * @brief This generic API is used to get the internal memory size.
- *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
+ * @brief Gets the internal memory size.
+ * @since_tizen 2.3
* @param[out] buf A pointer to a statvfs structure
* @return @c 0 on success,
* otherwise a negative error value on failure
- * @see
+ * @retval #STORAGE_ERROR_NONE Successful
+ * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #STORAGE_ERROR_OPERATION_FAILED Operation failed
* @par Example:
* @code
- * ...
+ * ...
* struct statvfs s;
- * if (storage_get_internal_memory_size(&s) < 0)
- * dlog_print(DLOG_DEBUG, LOG_TAG, "Fail to get internal memory size");
- * else
- * dlog_print(DLOG_DEBUG, LOG_TAG, "Total mem : %lf, Avail mem : %lf",
+ * if (storage_get_internal_memory_size(&s) < 0)
+ * dlog_print(DLOG_DEBUG, LOG_TAG, "Fail to get internal memory size");
+ * else
+ * dlog_print(DLOG_DEBUG, LOG_TAG, "Total mem : %lf, Avail mem : %lf",
* (double)s.f_frsize*s.f_blocks, (double)s.f_bsize*s.f_bavail);
- * ...
+ * ...
* @endcode
*/
-#ifndef __USE_FILE_OFFSET64
-extern int storage_get_internal_memory_size(struct statvfs *buf);
-#else
-# define storage_get_internal_memory_size storage_get_internal_memory_size64
-#endif
-
#ifdef __USE_FILE_OFFSET64
+#define storage_get_internal_memory_size storage_get_internal_memory_size64
extern int storage_get_internal_memory_size64(struct statvfs *buf);
+#else
+extern int storage_get_internal_memory_size(struct statvfs *buf);
#endif
+
/**
- * @fn int storage_get_external_memory_size(struct statvfs *buf)
- * @brief This generic API is used to get the external memory size.
- *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
+ * @brief Gets the external memory size.
+ * @since_tizen 2.3
* @param[out] buf A pointer to a statvfs structure
* @return @c 0 on success,
* otherwise a negative error value on failure
- * @see
+ * @retval #STORAGE_ERROR_NONE Successful
+ * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #STORAGE_ERROR_OPERATION_FAILED Operation failed
* @par Example:
* @code
- * ...
+ * ...
* struct statvfs s;
- * if (storage_get_external_memory_size(&s) < 0)
- * dlog_print(DLOG_DEBUG, LOG_TAG, "Fail to get external memory size");
- * else
- * dlog_print(DLOG_DEBUG, LOG_TAG, "Total mem : %lf, Avail mem : %lf",
+ * if (storage_get_external_memory_size(&s) < 0)
+ * dlog_print(DLOG_DEBUG, LOG_TAG, "Fail to get external memory size");
+ * else
+ * dlog_print(DLOG_DEBUG, LOG_TAG, "Total mem : %lf, Avail mem : %lf",
* (double)s.f_frsize*s.f_blocks, (double)s.f_bsize*s.f_bavail);
- * ...
+ * ...
* @endcode
*/
-#ifndef __USE_FILE_OFFSET64
-extern int storage_get_external_memory_size(struct statvfs *buf);
-#else
-# ifdef __REDIRECT_NTH
+#ifdef __USE_FILE_OFFSET64
+#ifdef __REDIRECT_NTH
extern int __REDIRECT_NTH(storage_get_external_memory_size,
(struct statvfs *buf), storage_get_external_memory_size64)
__nonnull((1));
-# else
-# define storage_get_external_memory_size storage_get_external_memory_size64
-# endif
+#else
+#define storage_get_external_memory_size storage_get_external_memory_size64
#endif
-
-#ifdef __USE_FILE_OFFSET64
extern int storage_get_external_memory_size64(struct statvfs *buf);
+#else
+extern int storage_get_external_memory_size(struct statvfs *buf);
#endif
+
/**
* @}
*/