openharmony/interface_sdk_c
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk_c synced 2024-11-23 14:50:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

修改capi注释

Browse Source 
Change-Id: Ic4103657a366d87a39f7cd69270297b59d011ed4
Signed-off-by: xiezhiyu <xiezhiyu2@huawei.com>
This commit is contained in:
xiezhiyu 2024-06-06 19:38:05 +08:00
parent 41faca372b
commit 6e74c42974
1 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
global/resource_management/include/resourcemanager/ohresmgr.h
View File

@ -54,7 +54,7 @@ extern "C" {
* @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid. Possible causes:
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid. Possible causes:
* 1.Incorrect parameter types; 2.Parameter verification failed.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -77,7 +77,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaBase64(const NativeResource
* @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid. Possible causes:
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid. Possible causes:
* 1.Incorrect parameter types; 2.Parameter verification failed.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -100,7 +100,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaBase64ByName(const NativeRe
* @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid. Possible causes:
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid. Possible causes:
* 1.Incorrect parameter types; 2.Parameter verification failed.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -123,7 +123,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMedia(const NativeResourceManage
* @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid. Possible causes:
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid. Possible causes:
* 1.Incorrect parameter types; 2.Parameter verification failed.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -146,7 +146,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaByName(const NativeResource
* @param type The optional parameter means the media type, 0 means the normal media, 1 means the the theme style media.
* @param drawableDescriptor the result write to drawableDescriptor.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid. Possible causes:
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid. Possible causes:
* 1.Incorrect parameter types; 2.Parameter verification failed.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -168,7 +168,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetDrawableDescriptor(const NativeR
* 2 means the theme dynamic media.
* @param drawableDescriptor the result write to drawableDescriptor.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid. Possible causes:
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid. Possible causes:
* 1.Incorrect parameter types; 2.Parameter verification failed.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -187,7 +187,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetDrawableDescriptorByName(const N
* @param resId Indicates the resource ID.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -207,7 +207,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetSymbol(const NativeResourceManag
* @param resName Indicates the resource name.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -229,7 +229,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetSymbolByName(const NativeResourc
* @param includeSystem the parameter controls whether to include system resources,
* the default value is false, it has no effect when only system resources query the locales list.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
* {@link ERROR_CODE_OUT_OF_MEMORY} 9001100 - Out of memory.
* @since 12
@ -247,7 +247,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetLocales(const NativeResourceMana
* {@link OH_ResourceManager_InitNativeResourceManager}.
* @param configuration the result write to ResourceManager_Configuration.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_SYSTEM_RES_MANAGER_GET_FAILED} 9001009 - If failed to access the system resource.
{@link ERROR_CODE_OUT_OF_MEMORY} 9001100 - Out of memory.
@ -260,7 +260,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetConfiguration(const NativeResour
* @brief Release the device configuration.
* @param configuration the object need to release.
* @return {@link SUCCESS} 0 - Success.
{@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
{@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
* @since 12
*/
@ -281,7 +281,7 @@ ResourceManager_ErrorCode OH_ResourceManager_ReleaseConfiguration(ResourceManage
* @param resultValue the result write to resultValue.
* @param { const char* | int | float } args - Indicates the formatting string resource parameters.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -307,7 +307,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetString(const NativeResourceManag
* @param resultValue the result write to resultValue.
* @param { const char* | int | float } args - Indicates the formatting string resource parameters.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -330,7 +330,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetStringByName(const NativeResourc
* @param resultValue the result write to resultValue.
* @param resultLen the StringArray length write to resultLen.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -353,7 +353,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetStringArray(const NativeResource
* @param resultValue the result write to resultValue.
* @param resultLen the StringArray length write to resultLen.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -369,7 +369,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetStringArrayByName(const NativeRe
* @param resValue the array of character strings corresponding to the specified resource name.
* @param len the length of array.
* @return {@link SUCCESS} 0 - Success.
{@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
{@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
* @since 12
*/
@ -387,7 +387,7 @@ ResourceManager_ErrorCode OH_ResourceManager_ReleaseStringArray(char ***resValue
* @param num - Indicates the number.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -410,7 +410,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetPluralString(const NativeResourc
* @param num - Indicates the number.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -431,7 +431,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetPluralStringByName(const NativeR
* @param resId Indicates the resource ID.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -451,7 +451,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetColor(const NativeResourceManage
* @param resName Indicates the resource name.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -471,7 +471,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetColorByName(const NativeResource
* @param resId Indicates the resource ID.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -491,7 +491,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetInt(const NativeResourceManager
* @param resName Indicates the resource name.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -511,7 +511,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetIntByName(const NativeResourceMa
* @param resId Indicates the resource ID.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -531,7 +531,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetFloat(const NativeResourceManage
* @param resName Indicates the resource name.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -551,7 +551,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetFloatByName(const NativeResource
* @param resId Indicates the resource ID.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_ID_NOT_FOUND} 9001001 - Invalid resource ID.
{@link ERROR_CODE_RES_NOT_FOUND_BY_ID} 9001002 - No matching resource is found based on the resource ID.
@ -571,7 +571,7 @@ ResourceManager_ErrorCode OH_ResourceManager_GetBool(const NativeResourceManager
* @param resName Indicates the resource name.
* @param resultValue the result write to resultValue.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_RES_NAME_NOT_FOUND} 9001003 - Invalid resource name.
{@link ERROR_CODE_RES_NOT_FOUND_BY_NAME} 9001004 - No matching resource is found based on the resource name.
@ -584,10 +584,10 @@ ResourceManager_ErrorCode OH_ResourceManager_GetBoolByName(const NativeResourceM
/**
* @brief Add overlay resources during application runtime.
* @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}.
* {@link OH_ResourceManager_InitNativeResourceManager}.
* @param path Indicates the application overlay path.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_OVERLAY_RES_PATH_INVALID} 9001010 - Invalid overlay path.
* @since 12
@ -600,7 +600,7 @@ ResourceManager_ErrorCode OH_ResourceManager_AddResource(const NativeResourceMan
* {@link OH_ResourceManager_InitNativeResourceManager}.
* @param path Indicates the application overlay path.
* @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - If the input parameter invalid.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - The input parameter invalid.
Possible causes: Incorrect parameter types.
{@link ERROR_CODE_OVERLAY_RES_PATH_INVALID} 9001010 - Invalid overlay path.
* @since 12