函数执行结果。

如果函数执行成功，则返回FILE_CACHE_BOOST_SUCCESS。

如果因数据对象内存被释放，导致写入缓存对象任务无法执行则返回FILE_CACHE_BOOST_ERROR_IO_CANCELED。

其他错误详见FileCacheBoost_ErrCode。

[h2]DeserializeFunc

typedef FileCacheBoost_CbErrCode(*DeserializeFunc) (void **object, ReadFunc readFunc, struct CacheKey *key)

描述

反序列化函数，定义了系统执行反序列化操作时的回调接口。由开发者实现，用于将已序列化的数据恢复为原始数据。

起始版本： 6.1.0(23)

参数:

名称	描述
object	反序列化后生成的数据。
readFunc	从缓存中读取序列化数据的回调函数，参数类型可参见ReadFunc。
key	待反序列化对象的key。

返回：

类型	说明
FileCacheBoost_CbErrCode	函数执行结果。函数执行成功则返回FILE_CACHE_BOOST_CALLBACK_SUCCESS。函数执行失败则返回FILE_CACHE_BOOST_CALLBACK_FAILURE。其他错误详见FileCacheBoost_CbErrCode。

类型

说明

FileCacheBoost_CbErrCode

函数执行结果。

函数执行成功则返回FILE_CACHE_BOOST_CALLBACK_SUCCESS。

函数执行失败则返回FILE_CACHE_BOOST_CALLBACK_FAILURE。

其他错误详见FileCacheBoost_CbErrCode。

[h2]ReadFunc

typedef FileCacheBoost_ErrCode(*ReadFunc) (void *buffer, size_t *bufferLen, struct CacheKey *key)

描述

DeserializeFunc进行反序列化的过程中调用此函数，可从缓存读取数据到缓冲区。

起始版本： 6.1.0(23)

参数:

名称	描述
buffer	存储读取数据的缓冲区。
bufferLen	作为入参表示期望读取的数据长度，作为出参表示实际读取的数据长度。
key	当前正在读取的缓存对象。

返回：

类型	说明
FileCacheBoost_ErrCode	函数执行结果。如果函数执行成功，则返回FILE_CACHE_BOOST_SUCCESS。如果因数据对象内存被释放，导致读取缓存对象任务无法执行则返回FILE_CACHE_BOOST_ERROR_IO_CANCELED。其他错误详见FileCacheBoost_ErrCode。

类型

说明

函数执行结果。

如果函数执行成功，则返回FILE_CACHE_BOOST_SUCCESS。

如果因数据对象内存被释放，导致读取缓存对象任务无法执行则返回FILE_CACHE_BOOST_ERROR_IO_CANCELED。

其他错误详见FileCacheBoost_ErrCode。

枚举类型说明

[h2]OpenFileBoost_AppState

enum OpenFileBoost_AppState

描述

App状态，用于指示App当前是否允许系统推荐预加载文件。

起始版本： 5.0.3(15)

枚举值	描述
OPEN_FILE_BOOST_APP_STATE_ALLOW_PRELOAD = 0	当前允许推荐预加载文件。
OPEN_FILE_BOOST_APP_STATE_REJECT_PRELOAD = 1	当前不允许推荐预加载文件。
OPEN_FILE_BOOST_APP_STATE_FOREVER_REJECT_PRELOAD = 2	这次注册期间永远不允许推荐预加载文件。
OPEN_FILE_BOOST_APP_STATE_EXCEL_TRANSACTION = 3	应用程序正在执行与excel文件相关的独占任务。起始版本： 26.0.0

[h2]OpenFileBoost_CbErrCode

enum OpenFileBoost_CbErrCode

描述

回调函数HMS_OpenFileBoost_OnFilePreload的错误码定义，它用于App向系统返回回调函数执行结果。

起始版本： 5.0.3(15)

枚举值	描述
OPEN_FILE_BOOST_CALLBACK_SUCCESS = 0	回调函数执行成功。
OPEN_FILE_BOOST_CALLBACK_FAILURE = 1017210000	回调函数执行失败。

[h2]OpenFileBoost_ErrCode

enum OpenFileBoost_ErrCode

描述

文件打开加速的错误码定义。

起始版本： 5.0.3(15)

枚举值	描述
OPEN_FILE_BOOST_SUCCESS = 0	成功。
OPEN_FILE_BOOST_PERMISSION_NOT_GRANTED = 201	未授权。
OPEN_FILE_BOOST_INVALID_PARAM = 401	无效输入参数。
OPEN_FILE_BOOST_CAPABILITY_NOT_SUPPORTED = 801	该设备不支持此API。起始版本： 26.0.0
OPEN_FILE_BOOST_INTERNAL_ERROR = 1017200001	内部错误。
OPEN_FILE_BOOST_INSUFFICIENT_BUFFER = 1017200002	传入的缓冲区的长度不足。
OPEN_FILE_BOOST_SERVICE_UNAVAILABLE = 1017200003	服务不可用。
OPEN_FILE_BOOST_NO_MEMORY = 1017200004	内存不足。

[h2]FileScanBoost_CbErrCode

enum FileScanBoost_CbErrCode

描述

文件扫描回调特定错误码的枚举。

起始版本： 26.0.0

枚举值	描述
FILE_SCAN_BOOST_CALLBACK_SUCCESS = 0	回调成功完成。
FILE_SCAN_BOOST_CALLBACK_ERROR_INTERNAL = 1017240001	回调内部错误。
FILE_SCAN_BOOST_CALLBACK_ERROR_FORMAT_NOT_SUPPORTED = 1017240002	不支持扫描此文件类型。

[h2]FileScanBoost_ErrCode

enum FileScanBoost_ErrCode

描述

文件扫描加速功能返回的所有错误码的枚举。

起始版本： 26.0.0

枚举值	描述
FILE_SCAN_BOOST_SUCCESS = 0	操作成功完成。
FILE_SCAN_BOOST_ERROR_PERMISSION_NOT_GRANTED = 201	未授予文件预加载权限。
FILE_SCAN_BOOST_ERROR_INVALID_PARAM = 401	提供的参数无效。
FILE_SCAN_BOOST_ERROR_CAPABILITY_NOT_SUPPORTED = 801	该设备不支持此API。
FILE_SCAN_BOOST_ERROR_INTERNAL = 1017230001	内部系统错误。
FILE_SCAN_BOOST_ERROR_NOT_REGISTERED = 1017230002	未注册扫描能力回调。
FILE_SCAN_BOOST_ERROR_ALREADY_REGISTERED = 1017230003	扫描能力回调已注册。
FILE_SCAN_BOOST_ERROR_SERVICE_UNAVAILABLE = 1017230004	服务不可用。
FILE_SCAN_BOOST_ERROR_FORMAT_NOT_SUPPORTED = 1017230005	文件格式不支持。

[h2]FileScanBoost_ScanState

enum FileScanBoost_ScanState

描述

文件扫描后，扫描成功状态、扫描进程错误状态、扫描文件错误状态的枚举。

起始版本： 26.0.0

枚举值	描述
FILE_SCAN_BOOST_SCAN_STATE_SUCCESS = 0	扫描成功完成。
FILE_SCAN_BOOST_SCAN_STATE_PROCESS_ERROR = 1	扫描操作发生错误。
FILE_SCAN_BOOST_SCAN_STATE_FILE_ERROR = 2	文件无法预加载。

[h2]FileCacheBoost_CbErrCode

enum FileCacheBoost_CbErrCode

描述

回调函数DeserializeFunc和SerializeFunc的错误码定义，应用程序将回调函数的执行结果返回给系统。

起始版本： 6.1.0(23)

枚举值	描述
FILE_CACHE_BOOST_CALLBACK_SUCCESS = 0	回调函数执行成功。
FILE_CACHE_BOOST_CALLBACK_FAILURE = 1017221001	回调函数执行失败。
FILE_CACHE_BOOST_CALLBACK_IO_CANCELED = 1017221002	I/O取消错误。

[h2]FileCacheBoost_ErrCode

enum FileCacheBoost_ErrCode

描述

文件缓存加速相关的错误码定义。

起始版本： 6.1.0(23)

枚举值	描述
FILE_CACHE_BOOST_SUCCESS = 0	成功。
FILE_CACHE_BOOST_ERROR_INVALID_PARAM = 401	无效输入参数。
FILE_CACHE_BOOST_ERROR_NOT_SUPPORTED = 801	该设备不支持此API。
FILE_CACHE_BOOST_ERROR_NOMEM = 1017220001	内存不足。
FILE_CACHE_BOOST_ERROR_INTERNAL_ERROR = 1017220002	内部错误。
FILE_CACHE_BOOST_ERROR_KEY_NOT_FOUND = 1017220003	缓存key不存在。
FILE_CACHE_BOOST_ERROR_KEY_EXIST = 1017220004	缓存key已存在。
FILE_CACHE_BOOST_ERROR_NOT_DIR = 1017220005	路径初始化错误。
FILE_CACHE_BOOST_ERROR_IO = 1017220006	I/O读写错误。
FILE_CACHE_BOOST_ERROR_IO_CANCELED = 1017220007	I/O 被取消。
FILE_CACHE_BOOST_ERROR_NOT_INITIALIZED = 1017220008	未初始化。
FILE_CACHE_BOOST_ERROR_EXCEED_LIMIT = 1017220009	单个缓存大小超出限制。
FILE_CACHE_BOOST_ERROR_IO_CANCEL_FAILED = 1017220010	I/O 取消失败。

函数说明

[h2]HMS_Preview_FileBoost_IsSupported()

bool HMS_Preview_FileBoost_IsSupported (void)

描述

查询当前设备是否支持文件打开加速功能。建议使用本接口检查，确认设备支持文件打开加速功能后，再使用其他文件打开加速接口如HMS_OpenFileBoost_RegisterFilePreload、HMS_Preview_FileScanBoost_RegisterFileScan等。

起始版本： 26.0.0

返回：

如果当前设备支持文件打开加速功能，则返回true；否则返回false。

[h2]HMS_OpenFileBoost_GetFdFromPreloadFileInfo()

OpenFileBoost_ErrCode HMS_OpenFileBoost_GetFdFromPreloadFileInfo (void * fileInfo, int32_t * fd)

描述

获取文件描述符信息。使用示例详见文件打开加速（C/C++）。

起始版本： 5.0.3(15)

参数:

名称	描述
fileInfo	系统向App推荐的预加载文件信息。
fd	输出参数，预加载文件的文件描述符信息。

返回：

类型	说明
OpenFileBoost_ErrCode	函数执行结果。如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。如果失败将返回具体错误码。详见OpenFileBoost_ErrCode。

类型

说明

函数执行结果。

如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。

如果失败将返回具体错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_OpenFileBoost_GetSandboxPathFromPreloadFileInfo()

OpenFileBoost_ErrCode HMS_OpenFileBoost_GetSandboxPathFromPreloadFileInfo (void * fileInfo, char * sandboxPath, int32_t pathLen)

描述

获取沙箱路径信息。使用示例详见文件打开加速（C/C++）。

起始版本： 5.0.3(15)

参数:

名称	描述
fileInfo	系统向App推荐的预加载文件信息。
sandboxPath	输出参数，预加载文件的沙箱路径信息，App应该传递一个指向一块有效内存区域的指针，系统将向其中填充沙箱路径信息。
pathLen	用于填充沙箱路径的内存区域的长度。

返回：

类型	说明
OpenFileBoost_ErrCode	函数执行结果。如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。如果传入的内存缓冲区太小，系统将返回OPEN_FILE_BOOST_INSUFFICIENT_BUFFER。其他错误详见OpenFileBoost_ErrCode。

类型

说明

函数执行结果。

如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。

如果传入的内存缓冲区太小，系统将返回OPEN_FILE_BOOST_INSUFFICIENT_BUFFER。

其他错误详见OpenFileBoost_ErrCode。

[h2]HMS_OpenFileBoost_NotifyPreloadHit()

OpenFileBoost_ErrCode HMS_OpenFileBoost_NotifyPreloadHit (int32_t fd, char * sandboxPath, int32_t pathLen)

描述

当用户打开预加载文件时，App调用该接口通知系统预加载命中，这将有助于提高预加载文件预测的准确性。使用示例详见文件打开加速（C/C++）。

起始版本： 5.0.3(15)

参数:

名称	描述
fd	命中文件的文件描述符信息。
sandboxPath	命中文件的沙箱路径。
pathLen	沙箱路径的长度。

返回：

类型	说明
OpenFileBoost_ErrCode	函数执行结果。如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。如果失败将返回具体错误码。详见OpenFileBoost_ErrCode。

类型

说明

函数执行结果。

如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。

如果失败将返回具体错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_OpenFileBoost_RegisterFilePreload()

OpenFileBoost_ErrCode HMS_OpenFileBoost_RegisterFilePreload (HMS_OpenFileBoost_QueryAppState queryAppState, HMS_OpenFileBoost_OnFilePreload filePreload, HMS_OpenFileBoost_OnFilePreload cancelFilePreload)

描述

应用使用本接口向系统注册文件预加载回调。

后续，系统预测用户可能打开的文件时，先调用queryAppState来向应用查询当前是否可以推荐预加载的文件。如果应用通过queryAppState返回允许推荐，则系统通过调用filePreload推荐一个文件，供应用进行预加载操作。

在某些特定情况下，例如系统可用内存不足、有其他文件更有可能被用户打开、或其他不适合文件保持预加载状态的条件发生，系统会通过调用cancelFilePreload来取消部分文件的预加载。使用示例详见文件打开加速（C/C++）。

起始版本： 5.0.3(15)

参数:

名称	描述
queryAppState	App状态查询回调函数，在通知预加载之前先调用该回调函数查询当前是否允许推荐预加载文件。
filePreload	文件预加载回调，系统预测用户可能打开的文件，并通过该回调函数通知调用者。
cancelFilePreload	取消文件预加载回调，比如系统可用内存不足时系统会通知调用方取消文件的预加载。

返回：

类型	说明
OpenFileBoost_ErrCode	函数执行结果。如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。如果失败将返回具体错误码。详见OpenFileBoost_ErrCode。

类型

说明

函数执行结果。

如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。

如果失败将返回具体错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_OpenFileBoost_UnregisterFilePreload()

OpenFileBoost_ErrCode HMS_OpenFileBoost_UnregisterFilePreload (void)

描述

取消注册预加载回调。使用示例详见文件打开加速（C/C++）。

起始版本： 5.0.3(15)

返回：

类型	说明
OpenFileBoost_ErrCode	函数执行结果。如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。如果失败将返回具体错误码。详见OpenFileBoost_ErrCode。

类型

说明

函数执行结果。

如果执行成功则返回OPEN_FILE_BOOST_SUCCESS。

如果失败将返回具体错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_FileScanBoost_RegisterFileScan()

FileScanBoost_ErrCode HMS_Preview_FileScanBoost_RegisterFileScan (HMS_Preview_FileScanBoost_OnFileScan fileScanCb, FileScanBoost_ScanOption *option)

描述

使用扩展名过滤方式注册多文件类型的回调函数。在上一次注册结果注销之前，请勿重复注册。重复注册将返回错误码FILE_SCAN_BOOST_ERROR_ALREADY_REGISTERED，且仅首次注册的信息生效。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
fileScanCb	要注册的回调函数。
option	指向包含支持文件类型的扫描选项实例的指针。

返回：

类型	说明
FileScanBoost_ErrCode	函数执行结果。如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

类型

说明

函数执行结果。

如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。

如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

[h2]HMS_Preview_FileScanBoost_ReportScanResult()

FileScanBoost_ErrCode HMS_Preview_FileScanBoost_ReportScanResult (const char *path, uint32_t pathLen, FileScanBoost_ScanResult *result)

描述

完成扫描后，报告文件扫描操作的扫描结果。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
path	被扫描的文件路径。
pathLen	文件路径字符串的长度。最大路径长度为PATH_MAX。
result	指向包含状态和指标的扫描结果实例的指针。

返回：

类型	说明
FileScanBoost_ErrCode	函数执行结果。如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

类型

说明

函数执行结果。

如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。

如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

[h2]HMS_Preview_FileScanBoost_ScanOptionAddSupportFile()

FileScanBoost_ErrCode HMS_Preview_FileScanBoost_ScanOptionAddSupportFile (FileScanBoost_ScanOption *option, const char *suffix, uint32_t suffixLen)

描述

在注册扫描接口的扫描选项参数中添加支持的文件类型。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
option	指向扫描选项实例的指针。
suffix	文件扩展名，例如 "xlsx"。
suffixLen	文件扩展名的长度。

返回：

类型	说明
FileScanBoost_ErrCode	函数执行结果。如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

类型

说明

函数执行结果。

如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。

如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

[h2]HMS_Preview_FileScanBoost_ScanOptionCreate()

FileScanBoost_ErrCode HMS_Preview_FileScanBoost_ScanOptionCreate (FileScanBoost_ScanOption **outOption)

描述

创建FileScanBoost_ScanOption实例。应用使用完毕后必须调用HMS_Preview_FileScanBoost_ScanOptionDestroy来释放该实例。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
outOption	指向接收所创建选项实例的指针。可参见FileScanBoost_ScanOption。

返回：

类型	说明
FileScanBoost_ErrCode	函数执行结果。如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

类型

说明

函数执行结果。

如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。

如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

[h2]HMS_Preview_FileScanBoost_ScanOptionDestroy()

void HMS_Preview_FileScanBoost_ScanOptionDestroy (FileScanBoost_ScanOption *option)

描述

销毁FileScanBoost_ScanOption实例。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
option	指向要销毁的选项实例的指针。可参见FileScanBoost_ScanOption。

[h2]HMS_Preview_FileScanBoost_ScanResultCreate()

FileScanBoost_ErrCode HMS_Preview_FileScanBoost_ScanResultCreate (FileScanBoost_ScanResult **outResult)

描述

创建FileScanBoost_ScanResult实例。应用使用完毕后必须调用HMS_Preview_FileScanBoost_ScanResultDestroy来释放该实例。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
outResult	指向接收所创建结果实例的指针。

返回：

类型	说明
FileScanBoost_ErrCode	函数执行结果。如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。如果函数执行失败，返回具体错误码。请参见FileScanBoost_ErrCode。

类型

说明

函数执行结果。

如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。

如果函数执行失败，返回具体错误码。请参见FileScanBoost_ErrCode。

[h2]HMS_Preview_FileScanBoost_ScanResultDestroy()

void HMS_Preview_FileScanBoost_ScanResultDestroy (FileScanBoost_ScanResult *result)

描述

销毁FileScanBoost_ScanResult实例。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
result	指向要销毁的结果实例的指针。

[h2]HMS_Preview_FileScanBoost_ScanResultSetMaxAtomicTime()

FileScanBoost_ErrCode HMS_Preview_FileScanBoost_ScanResultSetMaxAtomicTime (FileScanBoost_ScanResult *result, int64_t maxAtomicTime)

描述

在文件扫描结果中设置最大原子时间，单位为ms。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
result	指向扫描结果实例的指针。
maxAtomicTime	扫描该文件的最大原子时间，单位为ms。

返回：

类型	说明
FileScanBoost_ErrCode	函数执行结果。如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

类型

说明

函数执行结果。

如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。

如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

[h2]HMS_Preview_FileScanBoost_ScanResultSetMemSize()

FileScanBoost_ErrCode HMS_Preview_FileScanBoost_ScanResultSetMemSize (FileScanBoost_ScanResult *result, int64_t memSize)

描述

在文件扫描结果中设置内存大小，单位为MB。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
result	指向扫描结果实例的指针。
memSize	扫描该文件消耗的内存，单位为MB。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。

如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

[h2]HMS_Preview_FileScanBoost_ScanResultSetState()

FileScanBoost_ErrCode HMS_Preview_FileScanBoost_ScanResultSetState (FileScanBoost_ScanResult *result, FileScanBoost_ScanState state)

描述

在结果中设置扫描状态。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
result	指向扫描结果实例的指针。
state	扫描完成状态。扫描状态请参见FileScanBoost_ScanState。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。

如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

[h2]HMS_Preview_FileScanBoost_UnregisterFileScan()

FileScanBoost_ErrCode HMS_Preview_FileScanBoost_UnregisterFileScan (void)

描述

移除已注册的文件扫描回调函数。注销文件扫描后，该应用程序所有未报告扫描结果的扫描任务均失效。同时，在发起注销之前，应用程序需要清理未完成的扫描任务。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回FILE_SCAN_BOOST_SUCCESS。

如果函数执行失败，返回具体错误码。详见FileScanBoost_ErrCode。

[h2]HMS_Preview_OpenFileBoost_FileOperationInfoCreate()

OpenFileBoost_ErrCode HMS_Preview_OpenFileBoost_FileOperationInfoCreate (const char *path, uint32_t pathLen, const char *operation, uint32_t operationLen, OpenFileBoost_FileOperationInfo **outFileOperationInfo)

描述

创建OpenFileBoost_FileOperationInfo。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
path	文件路径。
pathLen	文件路径的长度。最大长度限制为PATH_MAX。
operation	文件操作信息。
operationLen	文件操作信息的长度。最大长度限制为NAME_MAX。
outFileOperationInfo	用于接收创建的OpenFileBoost_FileOperationInfo的指针。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回OPEN_FILE_BOOST_SUCCESS。

如果函数执行失败，返回特定的错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_OpenFileBoost_FileOperationInfoDestroy()

OpenFileBoost_ErrCode HMS_Preview_OpenFileBoost_FileOperationInfoDestroy (OpenFileBoost_FileOperationInfo *fileOperationInfo)

描述

销毁OpenFileBoost_FileOperationInfo。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
fileOperationInfo	指向要销毁的OpenFileBoost_FileOperationInfo的指针。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回OPEN_FILE_BOOST_SUCCESS。

如果函数执行失败，返回特定的错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_OpenFileBoost_IsEnabled()

bool HMS_Preview_OpenFileBoost_IsEnabled (void)

描述

查询应用加速特性是否可用。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

返回：

类型	说明
bool	如果加速特性可用，则返回true；否则返回false。

[h2]HMS_Preview_OpenFileBoost_NotifyFileOperation()

OpenFileBoost_ErrCode HMS_Preview_OpenFileBoost_NotifyFileOperation (OpenFileBoost_FileOperationInfo *fileOperationInfo)

描述

当用户对文件进行操作时，App调用该接口通知系统文件操作类型，这将有助于提高预加载文件预测的准确性。

起始版本： 26.0.0

参数:

名称	描述
fileOperationInfo	应用向系统传递的文件操作信息。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回OPEN_FILE_BOOST_SUCCESS。

如果函数执行失败，返回特定的错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_OpenFileBoost_OptionsAddSupportFile()

OpenFileBoost_ErrCode HMS_Preview_OpenFileBoost_OptionsAddSupportFile (OpenFileBoost_Options *options, const OpenFileBoost_SupportFile *supportFile)

描述

向OpenFileBoost_Options添加支持预加载的文件类型列表。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
options	指向OpenFileBoost_Options的指针。
supportFile	指向要添加的OpenFileBoost_SupportFile的指针。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回OPEN_FILE_BOOST_SUCCESS。

如果函数执行失败，返回特定的错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_OpenFileBoost_OptionsCreate()

OpenFileBoost_ErrCode HMS_Preview_OpenFileBoost_OptionsCreate (OpenFileBoost_Options **outOptions)

描述

创建一个空的OpenFileBoost_Options, 再使用HMS_Preview_OpenFileBoost_OptionsAddSupportFile添加支持的文件类型。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
outOptions	用于接收创建的OpenFileBoost_Options的指针。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回OPEN_FILE_BOOST_SUCCESS。

如果函数执行失败，返回特定的错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_OpenFileBoost_OptionsDestroy()

OpenFileBoost_ErrCode HMS_Preview_OpenFileBoost_OptionsDestroy (OpenFileBoost_Options *options)

描述

销毁OpenFileBoost_Options。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
options	指向要销毁的OpenFileBoost_Options的指针。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回OPEN_FILE_BOOST_SUCCESS。

如果函数执行失败，返回特定的错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_OpenFileBoost_RegisterFilePreloadWithOption()

OpenFileBoost_ErrCode HMS_Preview_OpenFileBoost_RegisterFilePreloadWithOption (HMS_OpenFileBoost_QueryAppState queryAppState, HMS_OpenFileBoost_OnFilePreload filePreload, HMS_OpenFileBoost_OnFilePreload cancelFilePreload, OpenFileBoost_Options *options)

描述

注册预加载回调，允许应用传入支持预加载的文件信息。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
queryAppState	App状态查询回调函数，在通知预加载之前先调用该回调函数查询当前是否允许推荐预加载文件。
filePreload	文件预加载回调，系统预测用户可能打开的文件，并通过该回调函数通知应用。
cancelFilePreload	取消文件预加载回调，比如系统可用内存不足时系统会通知调用方取消文件的预加载。
options	预加载支持文件配置选项，用于定义哪些类型的文件可以被预加载。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回OPEN_FILE_BOOST_SUCCESS。

如果函数执行失败，返回特定的错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_OpenFileBoost_SupportFileCreate()

OpenFileBoost_ErrCode HMS_Preview_OpenFileBoost_SupportFileCreate (const char *suffix, uint32_t suffixLen, uint64_t lowerLimitKb, uint64_t upperLimitKb, OpenFileBoost_SupportFile **outSupportFile)

描述

创建OpenFileBoost_SupportFile。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
suffix	文件后缀名。
suffixLen	文件后缀名的长度。
lowerLimitKb	文件大小下限(KB)。
upperLimitKb	文件大小上限(KB)。
outSupportFile	用于接收创建的OpenFileBoost_SupportFile的指针。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回OPEN_FILE_BOOST_SUCCESS。

如果函数执行失败，返回特定的错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_OpenFileBoost_SupportFileDestroy()

OpenFileBoost_ErrCode HMS_Preview_OpenFileBoost_SupportFileDestroy (OpenFileBoost_SupportFile *supportFile)

描述

销毁OpenFileBoost_SupportFile。使用示例详见文件打开加速（C/C++）。

起始版本： 26.0.0

参数:

名称	描述
supportFile	指向要销毁的OpenFileBoost_SupportFile的指针。

返回：

类型

说明

函数执行结果。

如果函数执行成功，返回OPEN_FILE_BOOST_SUCCESS。

如果函数执行失败，返回特定的错误码。详见OpenFileBoost_ErrCode。

[h2]HMS_Preview_FileCacheBoost_IsSupported()

bool HMS_Preview_FileCacheBoost_IsSupported (void)

描述

查询当前设备是否支持文件缓存加速功能。建议使用本接口检查，确认设备支持文件缓存加速功能后，再使用其他文件缓存加速接口如HMS_FileCacheBoost_Init等。

起始版本： 26.0.0

返回：

如果当前设备支持文件缓存加速功能，则返回true；否则返回false。

[h2]HMS_FileCacheBoost_Init()

FileCacheBoost_ErrCode HMS_FileCacheBoost_Init (const char * path, size_t pathLen, uint32_t cacheUpperLimitMb, const char * dbName, size_t dbNameLen)

描述

初始化缓存路径、缓存容量上限和数据库名称。该函数用于配置缓存文件的存储目录以及缓存最大容量。当系统检测到缓存总量超出设定上限后，将根据缓存淘汰策略进行容量管控，删除相应的缓存以释放空间。使用示例详见通用文件缓存加速（C/C++）。

起始版本： 6.1.0(23)

参数:

名称	描述
path	存储缓存文件的路径。开发者传入相对路径即可，系统会创建完整路径，传入的路径须有效。
pathLen	缓存路径的缓冲区长度。
cacheUpperLimitMb	缓存容量上限值（单位为MB）。若缓存使用量超过该限制，系统将触发缓存淘汰机制。若用户设置的缓存容量大于系统预设的默认上限，则系统将使用默认上限为作为缓存容量上限值。
dbName	数据库文件名，该数据库用于缓存元数据管理。系统保证了线程并发安全控制，如需支持多进程并发场景，建议各进程使用不同的数据库文件名以保证访问安全性。
dbNameLen	数据库名称的缓冲区长度。

返回：

类型

说明

函数执行结果。

FILE_CACHE_BOOST_SUCCESS：执行成功。

FILE_CACHE_BOOST_ERROR_NOT_DIR：传入的路径无效，系统无法创建。

FILE_CACHE_BOOST_ERROR_INVALID_PARAM：传入的参数无效。

其他错误详见FileCacheBoost_ErrCode。

[h2]HMS_FileCacheBoost_AddObjectByKey()

FileCacheBoost_ErrCode HMS_FileCacheBoost_AddObjectByKey (const uint8_t * key, size_t keyLen, const uint8_t * data, size_t dataLen, uint32_t weight)

描述

创建并添加一个缓存对象至文件缓存。该函数通过指定的唯一标识符 (key) 将数据缓存至文件缓存系统中，便于后续快速访问。

建议开发者合理设计和管理key值，确保其在不同上下文中的唯一性和准确性。当缓存不再需要时，推荐开发者主动调用HMS_FileCacheBoost_RemoveObjectByKey删除对应的缓存项，以避免资源浪费。若不主动删除，系统将在缓存容量不足时，依据系统策略进行清除。

开发者若想要对key对应的缓存内容做修改，需要先调用HMS_FileCacheBoost_RemoveObjectByKey删除之前的key，再重新创建和添加。使用示例详见通用文件缓存加速（C/C++）。

起始版本： 6.1.0(23)

参数:

名称	描述
key	缓存对象的唯一标识符。该值通常可由文件的特征值生成，例如图片的SHA-256 、MD4哈希值等。当图片内容未发生变化时，再次打开可获取到对应缓存。当图片内容发生变化时，key值应同步更新，原缓存内容失效。
keyLen	key的缓冲区长度。
data	待缓存数据。
dataLen	缓存数据的缓冲区长度。
weight	缓存对象的权重值，用于反映其重要性或优先级。若开发者希望某个缓存对象优先保留，应为其分配较高的权重。有效取值范围为0-10000，如果输入的权重超过10000，系统会将其设置为10000。例如开发者可传入数据解码耗时作为权重，当缓存空间达到上限时，系统将参考该权重计算缓存的淘汰顺序。

返回：

类型

说明

函数执行结果。

FILE_CACHE_BOOST_SUCCESS：执行成功。

FILE_CACHE_BOOST_ERROR_KEY_EXIST：key值已经存在。

FILE_CACHE_BOOST_ERROR_IO：发生I/O读写错误。

FILE_CACHE_BOOST_ERROR_IO_CANCELED：因数据对象内存缓存被释放，导致创建缓存对象任务无法执行。

FILE_CACHE_BOOST_ERROR_NOT_INITIALIZED：未初始化。

FILE_CACHE_BOOST_ERROR_EXCEED_LIMIT：添加的缓存大小大于缓存容量上限。

FILE_CACHE_BOOST_ERROR_INVALID_PARAM：传入的参数无效。

其他错误详见FileCacheBoost_ErrCode。

[h2]HMS_FileCacheBoost_GetObjectByKey()

FileCacheBoost_ErrCode HMS_FileCacheBoost_GetObjectByKey (const uint8_t * key, size_t keyLen, uint8_t ** data, size_t * dataLen )

描述

根据指定的key查询缓存对象，若存在，则从磁盘中加载缓存对象的内容。调用该函数系统会分配一段内存用于存储缓存数据，作为出参返回给开发者，开发者需在使用完毕后调用HMS_FileCacheBoost_FreeObject显式释放该内存。使用示例详见通用文件缓存加速（C/C++）。

起始版本： 6.1.0(23)

参数:

名称	描述
key	缓存对象的key。
keyLen	key的缓冲区长度。
data	出参，缓存对象的内容。开发者需确保传入参数非空。
dataLen	缓存对象内容的长度。

返回：

类型

说明

函数执行结果。

FILE_CACHE_BOOST_SUCCESS：执行成功。

FILE_CACHE_BOOST_ERROR_KEY_NOT_FOUND：key值不存在。

FILE_CACHE_BOOST_ERROR_IO：发生I/O读写错误。

FILE_CACHE_BOOST_ERROR_NOT_INITIALIZED：未初始化。

FILE_CACHE_BOOST_ERROR_IO_CANCELED：因数据对象内存被释放，导致获取缓存对象任务无法执行。

FILE_CACHE_BOOST_ERROR_INVALID_PARAM：传入的参数无效。

其他错误详见FileCacheBoost_ErrCode。

[h2]HMS_FileCacheBoost_FreeObject()

void HMS_FileCacheBoost_FreeObject (uint8_t * data)

描述

释放调用HMS_FileCacheBoost_GetObjectByKey或HMS_FileCacheBoost_GetSerialObjectByKey分配的内存，建议开发者不再使用该内存时，及时调用此函数进行释放，避免造成内存泄漏。使用示例详见通用文件缓存加速（C/C++）。

起始版本： 6.1.0(23)

参数:

名称	描述
data	需要释放的内存数据。

[h2]HMS_FileCacheBoost_AddSerialObjectByKey()

FileCacheBoost_ErrCode HMS_FileCacheBoost_AddSerialObjectByKey (const uint8_t * key, size_t keyLen, SerializeFunc func, const void * object, uint32_t weight )

描述

创建一个复杂类型对象的缓存项，通过传入自定义的序列化函数SerializeFunc对该象进行序列化处理，以便将该对象存储至磁盘并支持后续恢复。

例如图像数据需要同时保存其元数据和像素数据，才能实现完整的缓存与读取过程。序列化和反序列化会占用内存，请开发者控制object大小，降低内存压力。使用示例详见通用文件缓存加速（C/C++）。

起始版本： 6.1.0(23)

参数:

名称	描述
key	缓存对象的key。
keyLen	key的长度。
func	开发者实现的序列化函数，用于将复杂类型数据进行序列化处理。
object	待缓存的复杂类型对象。
weight	缓存对象的权重值，用于反映其重要性或优先级，有效取值范围为0-10000，如果输入的权重超过10000，系统会将其设置为10000。例如开发者可传入数据解码耗时作为权重，当缓存空间达到上限时，系统将参考该权重计算缓存的淘汰顺序。若开发者希望某个缓存对象优先保留，应为其分配较高的权重。

返回：

类型

说明

函数执行结果。

FILE_CACHE_BOOST_SUCCESS：执行成功。

FILE_CACHE_BOOST_ERROR_KEY_EXIST：key值已经存在。

FILE_CACHE_BOOST_ERROR_IO：发生I/O读写错误。

FILE_CACHE_BOOST_ERROR_IO_CANCELED：因数据对象内存缓存被释放，导致创建缓存对象任务无法执行。

FILE_CACHE_BOOST_ERROR_NOT_INITIALIZED：未初始化。

FILE_CACHE_BOOST_ERROR_EXCEED_LIMIT：添加的缓存大小大于缓存容量上限。

FILE_CACHE_BOOST_ERROR_INVALID_PARAM：传入的参数无效。

其他错误详见FileCacheBoost_ErrCode。

[h2]HMS_FileCacheBoost_GetSerialObjectByKey()

FileCacheBoost_ErrCode HMS_FileCacheBoost_GetSerialObjectByKey (const uint8_t * key, size_t keyLen, DeserializeFunc func, void ** object )

描述

根据指定的key值获取复杂类型缓存对象，并通过传入的反序列化函数DeserializeFunc将其还原为原始数据，从而获得完整的对象内容。调用该函数系统会分配一段内存用于存储缓存数据，作为出参返回给开发者，开发者需在使用完毕后调用HMS_FileCacheBoost_FreeObject显式释放该内存。使用示例详见通用文件缓存加速（C/C++）。

起始版本： 6.1.0(23)

参数:

名称	描述
key	缓存对象的key。
keyLen	key的缓冲区长度。
func	开发者实现的反序列化函数，于将已序列化的数据恢复为原始对象。
object	出参，缓存对象的内容。开发者需确保传入参数非空。

返回：

类型

说明

函数执行结果。

FILE_CACHE_BOOST_SUCCESS：执行成功。

FILE_CACHE_BOOST_ERROR_KEY_NOT_FOUND：key值不存在。

FILE_CACHE_BOOST_ERROR_IO：发生I/O读写错误。

FILE_CACHE_BOOST_ERROR_NOT_INITIALIZED：未初始化。

FILE_CACHE_BOOST_ERROR_IO_CANCELED：因数据对象内存缓存被释放，导致获取缓存对象任务无法执行。

FILE_CACHE_BOOST_ERROR_INVALID_PARAM：传入的参数无效。

其他错误详见FileCacheBoost_ErrCode。

[h2]HMS_FileCacheBoost_CancelOngoingIOByKey()

FileCacheBoost_ErrCode HMS_FileCacheBoost_CancelOngoingIOByKey (const uint8_t * key, size_t keyLen )

描述

取消key对应的缓存对象当前正在进行的I/O操作。当开发者需要释放数据对象时，应调用本函数，防止有其他线程对该数据对象进行添加缓存对象或者获取缓存对象的操作。若该对象正处于缓存过程中，则操作将被中止；若已缓存完成，则此函数不做任何处理。

当该函数返回 FILE_CACHE_BOOST_SUCCESS，开发者可以立即释放数据对象；当返回FILE_CACHE_BOOST_ERROR_IO_CANCEL_FAILED，表示当前没有正在执行的 key 需要被取消，开发者需要确认该 key 对应的动作执行完成或无需执行后再释放数据对象。

例如当一个线程尝试删除数据对象的同时，有其他线程对其进行HMS_FileCacheBoost_AddObjectByKey操作，调用本函数可确保缓存对象的安全性，避免引发数据竞争问题。使用示例详见通用文件缓存加速（C/C++）。

起始版本： 6.1.0(23)

参数:

名称	描述
key	缓存对象的key。
keyLen	key的缓冲区长度。

返回：

类型

说明

函数执行结果。

FILE_CACHE_BOOST_SUCCESS：缓存完成和I/O取消成功，开发者可以立即释放数据对象。

FILE_CACHE_BOOST_ERROR_IO_CANCEL_FAILED：I/O取消失败，表示当前没有正在执行的key需要被取消，开发者需要确认该key对应的动作执行完成或无需执行后再释放数据对象。

FILE_CACHE_BOOST_ERROR_INVALID_PARAM：传入的参数无效。

其他错误详见FileCacheBoost_ErrCode。

[h2]HMS_FileCacheBoost_RemoveObjectByKey()

FileCacheBoost_ErrCode HMS_FileCacheBoost_RemoveObjectByKey (const uint8_t * key, size_t keyLen )

描述

根据指定的key删除对应的缓存对象。使用示例详见通用文件缓存加速（C/C++）。

起始版本： 6.1.0(23)

参数:

名称	描述
key	缓存对象的key。
keyLen	key的缓冲区长度。

返回：

类型

说明

函数执行结果。

FILE_CACHE_BOOST_SUCCESS：执行成功。

FILE_CACHE_BOOST_ERROR_KEY_NOT_FOUND：key值不存在。

FILE_CACHE_BOOST_ERROR_NOT_INITIALIZED：未初始化。

FILE_CACHE_BOOST_ERROR_INVALID_PARAM：传入参数无效。

其他错误详见FileCacheBoost_ErrCode。

[h2]HMS_FileCacheBoost_ClearAllCache()

FileCacheBoost_ErrCode HMS_FileCacheBoost_ClearAllCache (void )

描述

清理所有的缓存对象。该函数会释放通过HMS_FileCacheBoost_AddObjectByKey和HMS_FileCacheBoost_AddSerialObjectByKey创建的所有缓存对象。使用示例详见通用文件缓存加速（C/C++）。

起始版本： 6.1.0(23)

返回：

类型

说明