diff --git a/interfaces/kits/c/vibrator.h b/interfaces/kits/c/vibrator.h index e01fe0e8a159247a9b85d2e97fc37a2b631deb96..dc9a162ced45a36a1de18a3fdf1e23ba39b0e8d5 100644 --- a/interfaces/kits/c/vibrator.h +++ b/interfaces/kits/c/vibrator.h @@ -44,8 +44,13 @@ extern "C" { * * @param duration - Vibration duration, in milliseconds. * @param attribute - Vibration attribute. For details, see {@link Vibrator_Attribute}. - * @return Returns 0 if the operation is successful; returns a non-zero value otherwise. - * For details, see {@link Vibrator_ErrorCode}. + * @return Returns 0 if the operation is successful; returns the following error code otherwise. + * {@link PERMISSION_DENIED} Permission verification failed.\n + * {@link PARAMETER_ERROR} Parameter check failed. For example, a mandatory parameter is not passed in, + * or the parameter type passed in is incorrect.\n + * {@link UNSUPPORTED} The API is not supported on the device. The device supports the corresponding SysCap, + * but does not support certain APIs in this SysCap.\n + * {@link DEVICE_OPERATION_FAILED} The operation on the device failed.\n * @permission ohos.permission.VIBRATE * * @since 11 @@ -58,8 +63,13 @@ int32_t OH_Vibrator_PlayVibration(int32_t duration, Vibrator_Attribute attribute * @param fileDescription - File descriptor of the custom vibration effect. * For details, see {@link Vibrator_FileDescription}. * @param vibrateAttribute - Vibration attribute. For details, see {@link Vibrator_Attribute}. - * @return Returns 0 if the operation is successful; returns a non-zero value otherwise. - * For details, see {@link Vibrator_ErrorCode}. + * @return Returns 0 if the operation is successful; returns the following error code otherwise. + * {@link PERMISSION_DENIED} Permission verification failed.\n + * {@link PARAMETER_ERROR} Parameter check failed. For example, a mandatory parameter is not passed in, + * or the parameter type passed in is incorrect.\n + * {@link UNSUPPORTED} The API is not supported on the device. The device supports the corresponding SysCap, + * but does not support certain APIs in this SysCap.\n + * {@link DEVICE_OPERATION_FAILED} The operation on the device failed.\n * @permission ohos.permission.VIBRATE * * @since 11 @@ -71,8 +81,13 @@ int32_t OH_Vibrator_PlayVibrationCustom(Vibrator_FileDescription fileDescription * @brief Stop the motor vibration according to the input mode. * * @permission ohos.permission.VIBRATE - * @return Returns 0 if the operation is successful; returns a non-zero value otherwise. - * For details, see {@link Vibrator_ErrorCode}. + * @return Returns 0 if the operation is successful; returns the following error code otherwise. + * {@link PERMISSION_DENIED} Permission verification failed.\n + * {@link PARAMETER_ERROR} Parameter check failed. For example, a mandatory parameter is not passed in, + * or the parameter type passed in is incorrect.\n + * {@link UNSUPPORTED} The API is not supported on the device. The device supports the corresponding SysCap, + * but does not support certain APIs in this SysCap.\n + * {@link DEVICE_OPERATION_FAILED} The operation on the device failed.\n * @permission ohos.permission.VIBRATE * * @since 11 diff --git a/interfaces/kits/c/vibrator_type.h b/interfaces/kits/c/vibrator_type.h index 93b7b8b2c42eaa36e4418ab71e833a00a567bc13..2ba5601a2d39303f994754f2106400f547501c11 100644 --- a/interfaces/kits/c/vibrator_type.h +++ b/interfaces/kits/c/vibrator_type.h @@ -28,15 +28,15 @@ extern "C" { * @since 11 */ typedef enum Vibrator_ErrorCode : int32_t { - /**< Permission verification failed. */ + /**< @error Permission verification failed. */ PERMISSION_DENIED = 201, - /**< Parameter check failed. For example, a mandatory parameter is not passed in, + /**< @error Parameter check failed. For example, a mandatory parameter is not passed in, * or the parameter type passed in is incorrect. */ PARAMETER_ERROR = 401, - /**< The API is not supported on the device. The device supports the corresponding SysCap, + /**< @error The API is not supported on the device. The device supports the corresponding SysCap, * but does not support certain APIs in this SysCap. */ UNSUPPORTED = 801, - /**< The operation on the device failed. */ + /**< @error The operation on the device failed. */ DEVICE_OPERATION_FAILED = 14600101, } Vibrator_ErrorCode;