1# raw_file_manager.h 2 3## 概述 4 5提供资源管理rawfile相关功能，可以使用ResourceManager打开rawfile进行后续相关操作，像搜索和读取等。 6 7**引用文件：** <rawfile/raw_file_manager.h> 8 9**库：** librawfile.z.so 10 11**系统能力：** SystemCapability.Global.ResourceManager 12 13**起始版本：** 8 14 15**相关模块：** [rawfile](capi-rawfile.md) 16 17## 汇总 18 19### 结构体 20 21| 名称 | typedef关键字 | 描述 | 22| -- | -- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23| [NativeResourceManager](capi-rawfile-nativeresourcemanager.md) | NativeResourceManager | 代表native侧的ResourceManager。此类封装了JavaScript resource manager的native实现，<b>ResourceManager</b>指针可以通过调用[OH_ResourceManager_InitNativeResourceManager](#oh_resourcemanager_initnativeresourcemanager)方法获取。 | 24 25### 函数 26 27| 名称 | 描述 | 28| -- | -- | 29| [NativeResourceManager *OH_ResourceManager_InitNativeResourceManager(napi_env env, napi_value jsResMgr)](#oh_resourcemanager_initnativeresourcemanager) | 基于JavaScript侧的ResourceManager获取native侧的ResourceManager，用来完成rawfile相关功能。 | 30| [void OH_ResourceManager_ReleaseNativeResourceManager(NativeResourceManager *resMgr)](#oh_resourcemanager_releasenativeresourcemanager) | 释放native侧ResourceManager。 | 31| [RawDir *OH_ResourceManager_OpenRawDir(const NativeResourceManager *mgr, const char *dirName)](#oh_resourcemanager_openrawdir) | 打开rawfile目录，打开后可以遍历对应目录下的rawfile文件。 | 32| [RawFile *OH_ResourceManager_OpenRawFile(const NativeResourceManager *mgr, const char *fileName)](#oh_resourcemanager_openrawfile) | 打开rawfile文件，打开后可以读取它的数据。 | 33| [RawFile64 *OH_ResourceManager_OpenRawFile64(const NativeResourceManager *mgr, const char *fileName)](#oh_resourcemanager_openrawfile64) | 打开较大的rawfile文件，打开后可以读取它的数据。 | 34| [bool OH_ResourceManager_IsRawDir(const NativeResourceManager *mgr, const char *path)](#oh_resourcemanager_israwdir) | 判断路径是否是rawfile下的目录。 | 35 36## 函数说明 37 38### OH_ResourceManager_InitNativeResourceManager() 39 40``` 41NativeResourceManager *OH_ResourceManager_InitNativeResourceManager(napi_env env, napi_value jsResMgr) 42``` 43 44**描述** 45 46基于JavaScript侧的ResourceManager获取native侧的ResourceManager，用来完成rawfile相关功能。 47 48**起始版本：** 8 49 50 51**参数：** 52 53| 参数项 | 描述 | 54| -- | -- | 55| napi_env env | 表示JavaScript Native Interface（napi）环境指针。 | 56| napi_value jsResMgr | 表示JavaScript resource manager。 | 57 58**返回：** 59 60| 类型 | 说明 | 61|-----------------------------| -- | 62| [NativeResourceManager](capi-rawfile-nativeresourcemanager.md) * | 返回[NativeResourceManager](capi-rawfile-nativeresourcemanager.md)指针，如果失败返回空指针。 | 63 64### OH_ResourceManager_ReleaseNativeResourceManager() 65 66``` 67void OH_ResourceManager_ReleaseNativeResourceManager(NativeResourceManager *resMgr) 68``` 69 70**描述** 71 72释放native侧ResourceManager。 73 74**起始版本：** 8 75 76 77**参数：** 78 79| 参数项 | 描述 | 80| -- | -- | 81| [NativeResourceManager](capi-rawfile-nativeresourcemanager.md) *resMgr | 表示[NativeResourceManager](capi-rawfile-nativeresourcemanager.md)指针。 | 82 83### OH_ResourceManager_OpenRawDir() 84 85``` 86RawDir *OH_ResourceManager_OpenRawDir(const NativeResourceManager *mgr, const char *dirName) 87``` 88 89**描述** 90 91打开rawfile目录，打开后可以遍历对应目录下的rawfile文件。 92 93**起始版本：** 8 94 95 96**参数：** 97 98| 参数项 | 描述 | 99| -- | -- | 100| const [NativeResourceManager](capi-rawfile-nativeresourcemanager.md) *mgr | 表示指向[NativeResourceManager](capi-rawfile-nativeresourcemanager.md)的指针，此指针是通过调用[OH_ResourceManager_InitNativeResourceManager](capi-raw-file-manager-h.md#oh_resourcemanager_initnativeresourcemanager)方法获取的。 | 101| const char *dirName | 表示要打开的rawfile目录名称，当传递一个空字符串时表示打开rawfile根目录。 | 102 103**返回：** 104 105| 类型 | 说明 | 106|--------------| -- | 107| [RawDir](capi-rawfile-rawdir.md) * | 返回[RawDir](capi-rawfile-rawdir.md)指针。使用完此指针后，调用[OH_ResourceManager_CloseRawDir](capi-raw-dir-h.md#oh_resourcemanager_closerawdir)释放。如果失败或者mgr为空时返回空指针。 | 108 109**参考：** 110 111[OH_ResourceManager_InitNativeResourceManager](capi-raw-file-manager-h.md#oh_resourcemanager_initnativeresourcemanager) 112 113[OH_ResourceManager_CloseRawDir](capi-raw-dir-h.md#oh_resourcemanager_closerawdir) 114### OH_ResourceManager_OpenRawFile() 115 116``` 117RawFile *OH_ResourceManager_OpenRawFile(const NativeResourceManager *mgr, const char *fileName) 118``` 119 120**描述** 121 122打开rawfile文件，打开后可以读取它的数据。 123 124**起始版本：** 8 125 126 127**参数：** 128 129| 参数项 | 描述 | 130| -- | -- | 131| const [NativeResourceManager](capi-rawfile-nativeresourcemanager.md) *mgr | 表示指向[NativeResourceManager](capi-rawfile-nativeresourcemanager.md)的指针，此指针通过调用[OH_ResourceManager_InitNativeResourceManager](capi-raw-file-manager-h.md#oh_resourcemanager_initnativeresourcemanager)方法获取。 | 132| const char *fileName | 表示基于rawfile根目录的相对路径下的文件名称。 | 133 134**返回：** 135 136| 类型 | 说明 | 137| -- | -- | 138| [RawDir](capi-rawfile-rawdir.md) * | 返回[RawDir](capi-rawfile-rawdir.md)指针。当使用完此指针，调用[OH_ResourceManager_CloseRawFile](capi-raw-file-h.md#oh_resourcemanager_closerawfile)释放。如果失败或者mgr和fileName为空时返回空指针。 | 139 140**参考：** 141 142[OH_ResourceManager_InitNativeResourceManager](capi-raw-file-manager-h.md#oh_resourcemanager_initnativeresourcemanager) 143 144[OH_ResourceManager_CloseRawFile](capi-raw-file-h.md#oh_resourcemanager_closerawfile) 145 146### OH_ResourceManager_OpenRawFile64() 147 148``` 149RawFile64 *OH_ResourceManager_OpenRawFile64(const NativeResourceManager *mgr, const char *fileName) 150``` 151 152**描述** 153 154打开较大的rawfile文件，打开后可以读取它的数据。 155 156**起始版本：** 11 157 158 159**参数：** 160 161| 参数项 | 描述 | 162| -- | -- | 163| const [NativeResourceManager](capi-rawfile-nativeresourcemanager.md) *mgr | 表示指向[NativeResourceManager](capi-rawfile-nativeresourcemanager.md)的指针，此指针通过调用[OH_ResourceManager_InitNativeResourceManager](capi-raw-file-manager-h.md#oh_resourcemanager_initnativeresourcemanager)方法获取。 | 164| const char *fileName | 表示基于rawfile根目录的相对路径下的文件名称。 | 165 166**返回：** 167 168| 类型 | 说明 | 169|-----------------| -- | 170| [RawFile64](capi-rawfile-rawfile64.md) * | 返回[RawFile64](capi-rawfile-rawfile64.md)指针。当使用完此指针，调用[OH_ResourceManager_CloseRawFile64](capi-raw-file-h.md#oh_resourcemanager_closerawfile64)释放。如果失败或者mgr和fileName为空时返回空指针。 | 171 172**参考：** 173 174[OH_ResourceManager_InitNativeResourceManager](capi-raw-file-manager-h.md#oh_resourcemanager_initnativeresourcemanager) 175 176[OH_ResourceManager_CloseRawFile](capi-raw-file-h.md#oh_resourcemanager_closerawfile)64 177 178### OH_ResourceManager_IsRawDir() 179 180``` 181bool OH_ResourceManager_IsRawDir(const NativeResourceManager *mgr, const char *path) 182``` 183 184**描述** 185 186判断路径是否是rawfile下的目录。 187 188**起始版本：** 12 189 190 191**参数：** 192 193| 参数项 | 描述 | 194| -- | -- | 195| const [NativeResourceManager](capi-rawfile-nativeresourcemanager.md) *mgr | 表示指向[NativeResourceManager](capi-rawfile-nativeresourcemanager.md)的指针，此指针通过调用[OH_ResourceManager_InitNativeResourceManager](capi-raw-file-manager-h.md#oh_resourcemanager_initnativeresourcemanager)方法获取。 | 196| const char *path | rawfile路径。 | 197 198**返回：** 199 200| 类型 | 说明 | 201| -- | -- | 202| bool | 返回true表示是rawfile下的目录，返回false表示不是rawfile下的目录。 | 203 204 205