//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* Initializes this instance of %FileUnzipper with the specified filepath. @n
- * This method opens a zip file in the read mode.
+ * The %Construct() method opens a zip file in the read mode.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @endif
*
* @return An error code
- * @param [in] filePath The path of the file to open or create
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @param [in] filePath The path of the file to open or create
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified file path is inaccessible as per the %Tizen platform policy.
+ * @exception E_ILLEGAL_ACCESS The specified @c filePath is inaccessible as per the Tizen platform policy.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_IO An unexpected device failure has occurred.
+ * @exception E_IO An unexpected device failure has occurred.
* @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
* @see Tizen::Io::File
*/
* Unzips a zip file at the specified path or destination.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @endif
*
* @return An error code
- * @param [in] dirPath A directory path to unzip
+ * @param [in] dirPath The directory path to unzip
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or
- * access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The specified path is not permitted.
+ * - The access is denied due to insufficient permission.
* @exception E_IO An unexpected device failure has occurred.
- * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
- * @remarks This operation consumes a lot of time if the zip-archive contains large number of files or
- * directories.
- * In such cases, it is recommended to call this method in a separate thread.
+ * @remarks
+ * - The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
+ * - This operation consumes a lot of time if the zip-archive contains large number of files or
+ * directories. @n
+ * In such cases, it is recommended to call this method in a separate thread.
* @see Tizen::Io::File
*/
result UnzipTo(const String& dirPath) const;
* Unzips a zip entry from a zip-archive to the specified path.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @endif
*
* @return An error code
- * @param [in] dirPath A directory path to unzip
- * @param [in] zipEntryName A zip entry name that could be a file or directory name
+ * @param [in] dirPath The directory path to unzip
+ * @param [in] zipEntryName The zip entry name that could be a file or a directory name
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations. @n
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
- * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or
- * access is denied due to insufficient permission.
+ * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred:
+ * - The specified path is not permitted.
+ * - The access is denied due to insufficient permission.
* @exception E_FILE_NOT_FOUND The entry of the specified file or path cannot be found in the archive.
* @exception E_IO An unexpected device failure has occurred.
- * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
- * @remarks If the value of @c zipEntryName is a directory name present in the archive, this method
+ * @remarks
+ * - The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported.
+ * - If the value of @c zipEntryName is a directory name present in the archive, this method
* creates an empty directory. @n
* For example, UnzipTo(Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/", L"/someDir/") will create @b '[AppDataPath]/Test/someDir'
- * directory only, and the files or subdirectories under @b 'someDir' will not be extracted.
+ * directory only, and the files or subdirectories under @b 'someDir' are not extracted.
* @see Tizen::Io::File
*/
result UnzipTo(const String& dirPath, const String& zipEntryName) const;
int GetDirectoryCount(void) const;
/**
- * Gets a zip entry associated with the file or directory name passed as parameter.
+ * Gets a zip entry associated with the file or directory name passed as a parameter.
*
* @since 2.0
*
* @return An error code
- * @param [in] zipEntryName A zip entry name that could be a file or directory name
+ * @param [in] zipEntryName The zip entry name that could be a file or directory name
* @param [out] entry A reference to the ZipEntry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The length of the specified path is @c 0 or exceeds system limitations. @n
- * - The specified path contains prohibited character(s). @n
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The length of the specified path is either @c 0 or exceeds system limitations.
+ * - The specified path contains prohibited character(s).
* - The specified path is invalid.
* @exception E_FILE_NOT_FOUND The entry of the specified file or path cannot be found in the archive.
* @exception E_IO An unexpected device failure has occurred.
- * @remarks If the value of @c zipEntryName is a directory name, it must have a suffix '/'.
- * For example, @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/" or @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/DATA/".
+ * @remarks If the value of @c zipEntryName is a directory name, it must have a suffix '/'. @n
+ * For example, @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/" or @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/DATA/".
*/
result GetEntry(const String& zipEntryName, ZipEntry& entry) const;
* @since 2.0
*
* @return An error code
- * @param [in] index An index of the zip entry to access @n
+ * @param [in] index The index of the zip entry to access @n
* The index starts from @c 0.
* @param [out] entry A reference to the ZipEntry
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified index is out of range, or an invalid index is passed.
+ * @exception E_INVALID_ARG The specified index is either invalid or out of the valid range.
* @exception E_IO An unexpected device failure has occurred.
*/
result GetEntry(int index, ZipEntry& entry) const;