HarmonyOS API：HuksParamSetApi

版本：v3.1 Beta

HuksParamSetApi

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

概述

描述HUKS参数集的能力，支持HUKS密钥管理接口的使用，包括初始化参数集、添加参数、构造参数集、释放参数集等HUKS参数集生命周期管理函数， 还包括获取参数、复制参数集、查询参数集、检查是否有效等函数。

@syscap SystemCapability.Security.Huks

起始版本：

9

汇总

文件

函数

函数说明

OH_Huks_AddParams()

int32_t OH_Huks_AddParams (struct OH_Huks_ParamSet * paramSet, const struct OH_Huks_Param

描述:

添加参数到参数集里面。

参数:

返回:

返回​​OH_Huks_ErrCode#OH_HUKS_SUCCESS​​时表示添加成功，其他时为错误。

OH_Huks_BuildParamSet()

int32_t OH_Huks_BuildParamSet (struct OH_Huks_ParamSet

描述:

构造正式的参数集。

参数:

返回:

返回​​OH_Huks_ErrCode#OH_HUKS_SUCCESS​​时表示构建成功，其他时为错误。

OH_Huks_CheckParamMatch()

int32_t OH_Huks_CheckParamMatch (const struct OH_Huks_Param * baseParam, const struct OH_Huks_Param

描述:

比较两个参数是否相同

参数:

返回:

返回​​OH_Huks_ErrCode#OH_HUKS_SUCCESS​​时表示相同，其他时为不同或者错误。

OH_Huks_CopyParamSet()

int32_t OH_Huks_CopyParamSet (const struct OH_Huks_ParamSet * fromParamSet, uint32_t fromParamSetSize, struct OH_Huks_ParamSet

描述:

复制参数集（深拷贝）。

参数:

返回:

返回​​OH_Huks_ErrCode#OH_HUKS_SUCCESS​​时表示复制成功，其他时为错误。

OH_Huks_FreeParamSet()

void OH_Huks_FreeParamSet (struct OH_Huks_ParamSet ** paramSet)

描述:

销毁参数集。

参数:

OH_Huks_FreshParamSet()

int32_t OH_Huks_FreshParamSet (struct OH_Huks_ParamSet * paramSet, bool isCopy )

描述:

刷新（复制）参数集内Blob类型的数据到参数集内。

参数:

返回:

返回​​OH_Huks_ErrCode#OH_HUKS_SUCCESS​​时表示成功，其他时为错误。

OH_Huks_GetParam()

int32_t OH_Huks_GetParam (const struct OH_Huks_ParamSet * paramSet, uint32_t tag, struct OH_Huks_Param

描述:

从参数集中获取参数。

参数:

返回:

返回​​OH_Huks_ErrCode#OH_HUKS_SUCCESS​​时表示获取成功，其他时为错误。

OH_Huks_InitParamSet()

int32_t OH_Huks_InitParamSet (struct OH_Huks_ParamSet

描述:

初始化参数集。

参数:

返回:

返回​​OH_Huks_ErrCode#OH_HUKS_SUCCESS​​时表示初始化成功，其他时为错误。

OH_Huks_isParamSetTagValid()

int32_t OH_Huks_isParamSetTagValid (const struct OH_Huks_ParamSet

描述:

检查参数集中的参数是否有效、是否有重复。

参数:

返回:

返回​​OH_Huks_ErrCode#OH_HUKS_SUCCESS​​时表示有效，其他时为无效或者错误。

OH_Huks_isParamSetValid()

int32_t OH_Huks_isParamSetValid (const struct OH_Huks_ParamSet * paramSet, uint32_t size )

描述:

检查参数集大小是否有效。

参数:

返回:

返回​​OH_Huks_ErrCode#OH_HUKS_SUCCESS​​时表示有效，其他时为无效或者错误。

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/_huks_param_set_api-0000001497370409-V3?catalogVersion=V3​​