openharmony/interface_sdk_c
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk_c synced 2024-11-27 08:51:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

!1704 【master】资源管理API Link整改

Browse Source 
Merge pull request !1704 from 冉召宇/master
This commit is contained in:
openharmony_ci 2024-11-15 09:10:57 +00:00 committed by Gitee
commit e9f3681169
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
4 changed files with 29 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
global/resource_management/include/rawfile/raw_dir.h
View File

@ -31,6 +31,9 @@
* @brief Declares native functions related to raw file directories. * @brief Declares native functions related to raw file directories.
* *
* For example, you can use the functions to traverse and close a raw file directory, and reset its index. * For example, you can use the functions to traverse and close a raw file directory, and reset its index.
*
* @syscap SystemCapability.Global.ResourceManager
* @library librawfile.z.so
* @kit LocalizationKit * @kit LocalizationKit
* @since 8 * @since 8
* @version 1.0 * @version 1.0

3
global/resource_management/include/rawfile/raw_file.h
View File

@ -31,6 +31,9 @@
* @brief Declares native functions related to raw file. * @brief Declares native functions related to raw file.
* *
* For example, you can use the functions to search for, read, and close raw files. * For example, you can use the functions to search for, read, and close raw files.
*
* @syscap SystemCapability.Global.ResourceManager
* @library librawfile.z.so
* @kit LocalizationKit * @kit LocalizationKit
* @since 8 * @since 8
* @version 1.0 * @version 1.0

3
global/resource_management/include/rawfile/raw_file_manager.h
View File

@ -31,6 +31,9 @@
* @brief Declares native functions for the resource manager. * @brief Declares native functions for the resource manager.
* *
* You can use the resource manager to open raw files for subsequent operations, such as seeking and reading. * You can use the resource manager to open raw files for subsequent operations, such as seeking and reading.
*
* @syscap SystemCapability.Global.ResourceManager
* @library librawfile.z.so
* @kit LocalizationKit * @kit LocalizationKit
* @since 8 * @since 8
* @version 1.0 * @version 1.0

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

@ -50,10 +50,10 @@ extern "C" {
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resId Indicates the resource ID. * @param resId Indicates the resource ID.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi.
* @param resultValue the result write to resultValue. * @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen. * @param resultLen the media length write to resultLen.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -73,10 +73,10 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaBase64(const NativeResource
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resId Indicates the resource ID. * @param resId Indicates the resource ID.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @param resultValue the result write to resultValue. * @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen. * @param resultLen the media length write to resultLen.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -96,10 +96,10 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaBase64Data(const NativeReso
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resName Indicates the resource name. * @param resName Indicates the resource name.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi.
* @param resultValue the result write to resultValue. * @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen. * @param resultLen the media length write to resultLen.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -119,10 +119,10 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaBase64ByName(const NativeRe
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resName Indicates the resource name. * @param resName Indicates the resource name.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @param resultValue the result write to resultValue. * @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen. * @param resultLen the media length write to resultLen.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -142,10 +142,10 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaBase64DataByName(const Nati
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resId Indicates the resource ID. * @param resId Indicates the resource ID.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi.
* @param resultValue the result write to resultValue. * @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen. * @param resultLen the media length write to resultLen.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -165,10 +165,10 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMedia(const NativeResourceManage
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resId Indicates the resource ID. * @param resId Indicates the resource ID.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @param resultValue the result write to resultValue. * @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen. * @param resultLen the media length write to resultLen.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -188,10 +188,10 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaData(const NativeResourceMa
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resName Indicates the resource name. * @param resName Indicates the resource name.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi.
* @param resultValue the result write to resultValue. * @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen. * @param resultLen the media length write to resultLen.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -211,10 +211,10 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaByName(const NativeResource
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resName Indicates the resource name. * @param resName Indicates the resource name.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @param resultValue the result write to resultValue. * @param resultValue the result write to resultValue.
* @param resultLen the media length write to resultLen. * @param resultLen the media length write to resultLen.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -234,10 +234,10 @@ ResourceManager_ErrorCode OH_ResourceManager_GetMediaDataByName(const NativeReso
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resId Indicates the resource ID. * @param resId Indicates the resource ID.
* @param drawableDescriptor the result write to drawableDescriptor.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means * @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. * to use the density of current system dpi.
* @param type The optional parameter means the media type, 0 means the normal media, 1 means the the theme style media. * @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. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -256,11 +256,11 @@ ResourceManager_ErrorCode OH_ResourceManager_GetDrawableDescriptor(const NativeR
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resId Indicates the resource ID. * @param resId Indicates the resource ID.
* @param drawableDescriptor the result write to drawableDescriptor.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means * @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0. * to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @param type The optional parameter means the media type, 0 means the normal media, 1 means the the theme style media. * @param type The optional parameter means the media type, 0 means the normal media, 1 means the the theme style media.
* If this attribute is not required, set this parameter to 0. * If this attribute is not required, set this parameter to 0.
* @param drawableDescriptor the result write to drawableDescriptor.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -278,11 +278,11 @@ ResourceManager_ErrorCode OH_ResourceManager_GetDrawableDescriptorData(const Nat
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resName Indicates the resource name. * @param resName Indicates the resource name.
* @param drawableDescriptor the result write to drawableDescriptor.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means * @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. * to use the density of current system dpi.
* @param type The optional parameter means the media type, 0 means the normal media, 1 means the the theme style media, * @param type The optional parameter means the media type, 0 means the normal media, 1 means the the theme style media,
* 2 means the theme dynamic media. * 2 means the theme dynamic media.
* @param drawableDescriptor the result write to drawableDescriptor.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.
@ -300,11 +300,11 @@ ResourceManager_ErrorCode OH_ResourceManager_GetDrawableDescriptorByName(const N
* @param mgr Indicates the pointer to {@link NativeResourceManager} * @param mgr Indicates the pointer to {@link NativeResourceManager}
* {@link OH_ResourceManager_InitNativeResourceManager}. * {@link OH_ResourceManager_InitNativeResourceManager}.
* @param resName Indicates the resource name. * @param resName Indicates the resource name.
* @param drawableDescriptor the result write to drawableDescriptor.
* @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means * @param density The optional parameter ScreenDensity{@link ScreenDensity}, A value of 0 means
* to use the density of current system dpi. If this attribute is not required, set this parameter to 0. * to use the density of current system dpi. If this attribute is not required, set this parameter to 0.
* @param type The optional parameter means the media type, 0 means the normal media, 1 means the the theme style media, * @param type The optional parameter means the media type, 0 means the normal media, 1 means the the theme style media,
* 2 means the theme dynamic media. If this attribute is not required, set this parameter to 0. * 2 means the theme dynamic media. If this attribute is not required, set this parameter to 0.
* @param drawableDescriptor the result write to drawableDescriptor.
* @return {@link SUCCESS} 0 - Success. * @return {@link SUCCESS} 0 - Success.
* {@link ERROR_CODE_INVALID_INPUT_PARAMETER} 401 - 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. * 1.Incorrect parameter types; 2.Parameter verification failed.