raw_file_manager.h

概述

提供资源管理rawfile相关功能，可以使用ResourceManager打开rawfile进行后续相关操作，像搜索和读取等。

引用文件： <rawfile/raw_file_manager.h>

库： librawfile.z.so

系统能力： SystemCapability.Global.ResourceManager

起始版本： 8

相关模块： rawfile

汇总

结构体

名称	typedef关键字	描述
NativeResourceManager	NativeResourceManager	代表native侧的ResourceManager。此类封装了JavaScript resource manager的native实现，ResourceManager指针可以通过调用OH_ResourceManager_InitNativeResourceManager方法获取。

函数

名称	描述
NativeResourceManager *OH_ResourceManager_InitNativeResourceManager(napi_env env, napi_value jsResMgr)	基于JavaScript侧的ResourceManager获取native侧的ResourceManager，用来完成rawfile相关功能。
void OH_ResourceManager_ReleaseNativeResourceManager(NativeResourceManager *resMgr)	释放native侧ResourceManager。
RawDir *OH_ResourceManager_OpenRawDir(const NativeResourceManager *mgr, const char *dirName)	打开rawfile目录，打开后可以遍历对应目录下的rawfile文件。
RawFile *OH_ResourceManager_OpenRawFile(const NativeResourceManager *mgr, const char *fileName)	打开rawfile文件，打开后可以读取它的数据。
RawFile64 *OH_ResourceManager_OpenRawFile64(const NativeResourceManager *mgr, const char *fileName)	打开较大的rawfile文件，打开后可以读取它的数据。
bool OH_ResourceManager_IsRawDir(const NativeResourceManager *mgr, const char *path)	判断路径是否是rawfile下的目录。

函数说明

OH_ResourceManager_InitNativeResourceManager()

NativeResourceManager *OH_ResourceManager_InitNativeResourceManager(napi_env env, napi_value jsResMgr)

描述

基于JavaScript侧的ResourceManager获取native侧的ResourceManager，用来完成rawfile相关功能。

起始版本： 8

参数：

参数项	描述
napi_env env	表示JavaScript Native Interface（napi）环境指针。
napi_value jsResMgr	表示JavaScript resource manager。

返回：

类型	说明
NativeResourceManager *	返回NativeResourceManager指针，如果失败返回空指针。

OH_ResourceManager_ReleaseNativeResourceManager()

void OH_ResourceManager_ReleaseNativeResourceManager(NativeResourceManager *resMgr)

描述

释放native侧ResourceManager。

起始版本： 8

参数：

参数项	描述
NativeResourceManager *resMgr	表示NativeResourceManager指针。

OH_ResourceManager_OpenRawDir()

RawDir *OH_ResourceManager_OpenRawDir(const NativeResourceManager *mgr, const char *dirName)

描述

打开rawfile目录，打开后可以遍历对应目录下的rawfile文件。

起始版本： 8

参数：

参数项	描述
const NativeResourceManager *mgr	表示指向NativeResourceManager的指针，此指针是通过调用OH_ResourceManager_InitNativeResourceManager方法获取的。
const char *dirName	表示要打开的rawfile目录名称，当传递一个空字符串时表示打开rawfile根目录。

返回：

类型	说明
RawDir *	返回RawDir指针。使用完此指针后，调用OH_ResourceManager_CloseRawDir释放。如果失败或者mgr为空时返回空指针。

参考：

OH_ResourceManager_InitNativeResourceManager

OH_ResourceManager_CloseRawDir

OH_ResourceManager_OpenRawFile()

RawFile *OH_ResourceManager_OpenRawFile(const NativeResourceManager *mgr, const char *fileName)

描述

打开rawfile文件，打开后可以读取它的数据。

起始版本： 8

参数：

参数项	描述
const NativeResourceManager *mgr	表示指向NativeResourceManager的指针，此指针通过调用OH_ResourceManager_InitNativeResourceManager方法获取。
const char *fileName	表示基于rawfile根目录的相对路径下的文件名称。

返回：

类型	说明
RawDir *	返回RawDir指针。当使用完此指针，调用OH_ResourceManager_CloseRawFile释放。如果失败或者mgr和fileName为空时返回空指针。

参考：

OH_ResourceManager_InitNativeResourceManager

OH_ResourceManager_CloseRawFile

OH_ResourceManager_OpenRawFile64()

RawFile64 *OH_ResourceManager_OpenRawFile64(const NativeResourceManager *mgr, const char *fileName)

描述

打开较大的rawfile文件，打开后可以读取它的数据。

起始版本： 11

参数：

参数项	描述
const NativeResourceManager *mgr	表示指向NativeResourceManager的指针，此指针通过调用OH_ResourceManager_InitNativeResourceManager方法获取。
const char *fileName	表示基于rawfile根目录的相对路径下的文件名称。

返回：

类型	说明
RawFile64 *	返回RawFile64指针。当使用完此指针，调用OH_ResourceManager_CloseRawFile64释放。如果失败或者mgr和fileName为空时返回空指针。

参考：

OH_ResourceManager_InitNativeResourceManager

OH_ResourceManager_CloseRawFile64

OH_ResourceManager_IsRawDir()

bool OH_ResourceManager_IsRawDir(const NativeResourceManager *mgr, const char *path)

描述

判断路径是否是rawfile下的目录。

起始版本： 12

参数：

参数项	描述
const NativeResourceManager *mgr	表示指向NativeResourceManager的指针，此指针通过调用OH_ResourceManager_InitNativeResourceManager方法获取。
const char *path	rawfile路径。

返回：

类型	说明
bool	返回true表示是rawfile下的目录，返回false表示不是rawfile下的目录。