HarmonyOS API：Rawfile

版本：v3.1 Beta

Rawfile

更新时间: 2023-02-17 09:19

提供操作rawfile目录和rawfile文件的功能。

功能包括遍历、打开、搜索、读取和关闭rawfile。

起始版本：

8

汇总

文件

结构体

类型定义

函数

详细描述

类型定义说明

NativeResourceManager

typedef struct NativeResourceManager NativeResourceManager

描述：

代表resource manager。

此类封装了JavaScript resource manager的native实现 ResourceManager指针可以通过调用​​OH_ResourceManager_InitNativeResourceManager​​方法获取

起始版本：

8

RawDir

typedef struct RawDir RawDir

描述：

提供对rawfile目录的访问。

起始版本：

8

RawFile

typedef struct RawFile RawFile

描述：

提供对rawfile的访问功能。

起始版本：

8

函数说明

OH_ResourceManager_CloseRawDir()

void OH_ResourceManager_CloseRawDir (RawDir * rawDir)

描述：

关闭已打开的​​RawDir​​并释放所有相关联资源。

参数：

参见：

​​OH_ResourceManager_OpenRawDir​​

起始版本：

8

OH_ResourceManager_CloseRawFile()

void OH_ResourceManager_CloseRawFile (RawFile * rawFile)

描述：

关闭已打开的​​RawFile​​ 以及释放所有相关联资源。

参数：

参见：

​​OH_ResourceManager_OpenRawFile​​

起始版本：

8

OH_ResourceManager_GetRawFileCount()

int OH_ResourceManager_GetRawFileCount (RawDir * rawDir)

描述：

获取​​RawDir​​中的rawfile数量。

通过此方法可以获取​​OH_ResourceManager_GetRawFileName​​中可用的索引。

参数：

参见：

​​OH_ResourceManager_GetRawFileName​​

起始版本：

8

OH_ResourceManager_GetRawFileDescriptor()

bool OH_ResourceManager_GetRawFileDescriptor (const RawFile * rawFile, RawFileDescriptor & descriptor )

描述：

基于offset(单位为int32_t)和文件长度打开rawfile，并获取rawfile文件描述符。

打开的文件描述符被用于读取rawfile。

参数：

返回：

返回true表示打开rawfile文件描述符成功，返回false表示rawfile不允许被访问。

起始版本：

8

OH_ResourceManager_GetRawFileName()

const char* OH_ResourceManager_GetRawFileName (RawDir * rawDir, int index )

描述：

通过索引获取rawfile文件名称。

可以使用此方法遍历rawfile目录。

参数：

返回：

通过索引返回文件名称，此返回值可以作为​​OH_ResourceManager_OpenRawFile​​的输入参数， 如果遍历完所有文件仍未找到，则返回NULL。

参见：

​​OH_ResourceManager_OpenRawFile​​

起始版本：

8

OH_ResourceManager_GetRawFileOffset()

long OH_ResourceManager_GetRawFileOffset (const RawFile * rawFile)

描述：

获取rawfile当前的offset，单位为int32_t。

rawfile当前的offset。

参数：

返回：

返回rawfile当前的offset。

起始版本：

8

OH_ResourceManager_GetRawFileSize()

long OH_ResourceManager_GetRawFileSize (RawFile * rawFile)

描述：

获取rawfile长度，单位为int32_t。

参数：

返回：

Returns rawfile整体长度。

起始版本：

8

OH_ResourceManager_InitNativeResourceManager()

NativeResourceManager* OH_ResourceManager_InitNativeResourceManager (napi_env env, napi_value jsResMgr )

描述：

基于JavaScript resource manager获取native resource manager。

通过获取resource manager来完成rawfile相关功能。

参数：

返回：

返回​​NativeResourceManager​​指针。

起始版本：

8

OH_ResourceManager_OpenRawDir()

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

描述：

打开rawfile目录。

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

参数：

返回：

返回​​RawDir​​​指针。使用完此指针后，调用​​OH_ResourceManager_CloseRawDir​​释放。

参见：

​​OH_ResourceManager_InitNativeResourceManager​​

​​OH_ResourceManager_CloseRawDir​​

起始版本：

8

OH_ResourceManager_OpenRawFile()

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

描述：

打开rawfile文件。

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

参数：

返回：

返回​​RawFile​​​指针。当使用完此指针，调用​​OH_ResourceManager_CloseRawFile​​释放。

参见：

​​OH_ResourceManager_InitNativeResourceManager​​

​​OH_ResourceManager_CloseRawFile​​

起始版本：

8

OH_ResourceManager_ReadRawFile()

int OH_ResourceManager_ReadRawFile (const RawFile * rawFile, void * buf, size_t length )

描述：

读取rawfile。

从当前位置读取指定长度的数据。

参数：

返回：

返回读取的字节数，如果读取长度超过文件末尾长度，则返回0。

起始版本：

8

OH_ResourceManager_ReleaseNativeResourceManager()

void OH_ResourceManager_ReleaseNativeResourceManager (NativeResourceManager * resMgr)

描述：

释放native resource manager。

参数：

起始版本：

8

OH_ResourceManager_ReleaseRawFileDescriptor()

bool OH_ResourceManager_ReleaseRawFileDescriptor (const RawFileDescriptor & descriptor)

描述：

关闭rawfile文件描述符。

已打开的文件描述符在使用完以后必须释放，防止文件描述符泄露。

参数：

返回：

返回true表示关闭文件描述符成功，返回false表示关闭文件描述符失败。

起始版本：

8

OH_ResourceManager_SeekRawFile()

int OH_ResourceManager_SeekRawFile (const RawFile * rawFile, long offset, int whence )

描述：

基于指定的offset，在rawfile文件内搜索读写数据的位置。

参数：

返回：

如果搜索成功返回新的读写位置，如果发生错误返回 (long) -1。

起始版本：

8

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/rawfile-0000001497210889-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001497210889__汇总​​