diff --git a/install_param.h b/install_param.h index d9f8cf36e51e149b90387ca8d4574f3fdf048ef2..2a18c47d9f909ae37e03b09ee0d4c926189935e9 100755 --- a/install_param.h +++ b/install_param.h @@ -13,6 +13,32 @@ * limitations under the License. */ +/** + * @addtogroup BundleManager + * @{ + * + * @brief Provides structures and functions for managing application bundles and obtaining application information. + * + * You can use functions provided by this module to install, update, or uninstall an application, obtain + * {@link AbilityInfo} and {@link BundleInfo} about an application, and obtain the bundle name of an application + * based on the application's user ID (UID). + * + * @since 1.0 + * @version 1.0 + */ + +/** + * @file installParam.h + * + * @brief Declares the parameters that users can specify when they install, update, or uninstall an application. + * + * The parameters involve the application installation or update path and whether to retain particular data during + * application uninstallation. + * + * @since 1.0 + * @version 1.0 + */ + #ifndef OHOS_INSTALL_PARAM_H #define OHOS_INSTALL_PARAM_H @@ -20,14 +46,27 @@ #include -// when installLocation set 1, it means install dir is storage/app -const static int32_t INSTALL_LOCATION_INTERNAL_ONLY = 1; -// when installLocation set 2, it means install dir is sdcard/app -const static int32_t INSTALL_LOCATION_PREFER_EXTERNAL = 2; +enum InstallLocation { +/** + * The installation or update path is storage/app when {@link installLocation} is set to 1. + */ + INSTALL_LOCATION_INTERNAL_ONLY = 1, +/** + * The installation or update path is sdcard/app when {@link installLocation} is set to 2. + */ + INSTALL_LOCATION_PREFER_EXTERNAL = 2, +}; +/** +* @brief Defines parameters used for application installation, update, or uninstallation. +*/ typedef struct { + /** Installation or update path of the application */ int32_t installLocation; + + /** Whether to retain particular data during application uninstallation */ bool keepData; } InstallParam; -#endif // OHOS_INSTALL_PARAM_H \ No newline at end of file +#endif // OHOS_INSTALL_PARAM_H +/** @} */ \ No newline at end of file