Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
08557cfa
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
08557cfa
编写于
1月 13, 2023
作者:
Z
zengyawen
提交者:
Gitee
1月 13, 2023
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add huks api
Signed-off-by:
N
zengyawen
<
zengyawen1@huawei.com
>
上级
f1d98d18
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
245 addition
and
0 deletion
+245
-0
zh-cn/application-dev/reference/native-apis/_huks_param_set_api.md
...lication-dev/reference/native-apis/_huks_param_set_api.md
+245
-0
未找到文件。
zh-cn/application-dev/reference/native-apis/_huks_param_set_api.md
0 → 100644
浏览文件 @
08557cfa
# HuksParamSetApi
## 概述
描述HUKS参数集的能力,支持HUKS密钥管理接口的使用,包括初始化参数集、添加参数、构造参数集、释放参数集等HUKS参数集生命周期管理函数, 还包括获取参数、复制参数集、查询参数集、检查是否有效等函数。
\@
syscap SystemCapability.Security.Huks
**起始版本:**
9
## 汇总
### 文件
| 名称 | 描述 |
| -------- | -------- |
|
[
native_huks_param.h
](
native__huks__param_8h.md
)
| 提供参数集构造、使用和销毁的API。 |
### 函数
| 名称 | 描述 |
| -------- | -------- |
|
[
OH_Huks_InitParamSet
](
#oh_huks_initparamset
)
(
struct
[
OH_Huks_ParamSet
]
(_o_h___huks___param_set.md)
\*\*
paramSet) | int32_t
<br/>
初始化参数集。 |
|
[
OH_Huks_AddParams
](
#oh_huks_addparams
)
(
struct
[
OH_Huks_ParamSet
]
(_o_h___huks___param_set.md)
\*
paramSet, const struct
[
OH_Huks_Param
](
_o_h___huks___param.md
)
\*
params, uint32_t paramCnt) | int32_t
<br/>
添加参数到参数集里面。 |
|
[
OH_Huks_BuildParamSet
](
#oh_huks_buildparamset
)
(
struct
[
OH_Huks_ParamSet
]
(_o_h___huks___param_set.md)
\*\*
paramSet) | int32_t
<br/>
构造正式的参数集。 |
|
[
OH_Huks_FreeParamSet
](
#oh_huks_freeparamset
)
(
struct
[
OH_Huks_ParamSet
]
(_o_h___huks___param_set.md)
\*\*
paramSet) | void
<br/>
销毁参数集。 |
|
[
OH_Huks_CopyParamSet
](
#oh_huks_copyparamset
)
(
const
struct
[
OH_Huks_ParamSet
](
_o_h___huks___param_set.md
)
\*
fromParamSet, uint32_t fromParamSetSize, struct
[
OH_Huks_ParamSet
](
_o_h___huks___param_set.md
)
\*\*
paramSet) | int32_t
<br/>
复制参数集(深拷贝)。 |
|
[
OH_Huks_GetParam
](
#oh_huks_getparam
)
(
const
struct
[
OH_Huks_ParamSet
](
_o_h___huks___param_set.md
)
\*
paramSet, uint32_t tag, struct
[
OH_Huks_Param
](
_o_h___huks___param.md
)
\*\*
param) | int32_t
<br/>
从参数集中获取参数。 |
|
[
OH_Huks_FreshParamSet
](
#oh_huks_freshparamset
)
(
struct
[
OH_Huks_ParamSet
]
(_o_h___huks___param_set.md)
\*
paramSet, bool isCopy) | int32_t
<br/>
刷新(复制)参数集内Blob类型的数据到参数集内。 |
|
[
OH_Huks_isParamSetTagValid
](
#oh_huks_isparamsettagvalid
)
(
const
struct
[
OH_Huks_ParamSet
](
_o_h___huks___param_set.md
)
\*
paramSet) | int32_t
<br/>
检查参数集中的参数是否有效、是否有重复。 |
|
[
OH_Huks_isParamSetValid
](
#oh_huks_isparamsetvalid
)
(
const
struct
[
OH_Huks_ParamSet
](
_o_h___huks___param_set.md
)
\*
paramSet, uint32_t size) | int32_t
<br/>
检查参数集大小是否有效。 |
|
[
OH_Huks_CheckParamMatch
](
#oh_huks_checkparammatch
)
(
const
struct
[
OH_Huks_Param
](
_o_h___huks___param.md
)
\*
baseParam, const struct
[
OH_Huks_Param
](
_o_h___huks___param.md
)
\*
param) | int32_t
<br/>
比较两个参数是否相同 |
## 函数说明
### OH_Huks_AddParams()
```
int32_t OH_Huks_AddParams (struct OH_Huks_ParamSet * paramSet, const struct OH_Huks_Param * params, uint32_t paramCnt )
```
**描述:**
添加参数到参数集里面。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| paramSet | 指向要被添加参数的参数集的指针。 |
| params | 指向要添加的参数数组的指针。 |
| paramCnt | 待添加参数数组的参数个数。 |
**返回:**
返回
[
OH_Huks_ErrCode#OH_HUKS_SUCCESS
](
_huks_type_api.md
)
时表示添加成功,其他时为错误。
### OH_Huks_BuildParamSet()
```
int32_t OH_Huks_BuildParamSet (struct OH_Huks_ParamSet ** paramSet)
```
**描述:**
构造正式的参数集。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| paramSet | 指向要被正式构造的参数集的指针地址。 |
**返回:**
返回
[
OH_Huks_ErrCode#OH_HUKS_SUCCESS
](
_huks_type_api.md
)
时表示构建成功,其他时为错误。
### OH_Huks_CheckParamMatch()
```
int32_t OH_Huks_CheckParamMatch (const struct OH_Huks_Param * baseParam, const struct OH_Huks_Param * param )
```
**描述:**
比较两个参数是否相同
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| baseParam | 指向被比较的参数的指针。 |
| param | 指向比较的参数的指针。 |
**返回:**
返回
[
OH_Huks_ErrCode#OH_HUKS_SUCCESS
](
_huks_type_api.md
)
时表示相同,其他时为不同或者错误。
### OH_Huks_CopyParamSet()
```
int32_t OH_Huks_CopyParamSet (const struct OH_Huks_ParamSet * fromParamSet, uint32_t fromParamSetSize, struct OH_Huks_ParamSet ** paramSet )
```
**描述:**
复制参数集(深拷贝)。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| fromParamSet | 指向要被复制的参数集的指针。 |
| fromParamSetSize | 被复制的参数集占用内存的大小。 |
| paramSet | 指向生成新的参数集的指针地址。 |
**返回:**
返回
[
OH_Huks_ErrCode#OH_HUKS_SUCCESS
](
_huks_type_api.md
)
时表示复制成功,其他时为错误。
### OH_Huks_FreeParamSet()
```
void OH_Huks_FreeParamSet (struct OH_Huks_ParamSet ** paramSet)
```
**描述:**
销毁参数集。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| paramSet | 指向要被销毁的参数集的指针地址。 |
### OH_Huks_FreshParamSet()
```
int32_t OH_Huks_FreshParamSet (struct OH_Huks_ParamSet * paramSet, bool isCopy )
```
**描述:**
刷新(复制)参数集内Blob类型的数据到参数集内。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| paramSet | 指向参数集的指针。 |
| isCopy | 是否要刷新参数集内存中的struct HksBlob型的参数数据。 |
**返回:**
返回
[
OH_Huks_ErrCode#OH_HUKS_SUCCESS
](
_huks_type_api.md
)
时表示成功,其他时为错误。
### OH_Huks_GetParam()
```
int32_t OH_Huks_GetParam (const struct OH_Huks_ParamSet * paramSet, uint32_t tag, struct OH_Huks_Param ** param )
```
**描述:**
从参数集中获取参数。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| paramSet | 指向参数集的指针。 |
| tag | 要获取的对应参数的值。 |
| param | 指向获取到的参数的指针地址。 |
**返回:**
返回
[
OH_Huks_ErrCode#OH_HUKS_SUCCESS
](
_huks_type_api.md
)
时表示获取成功,其他时为错误。
### OH_Huks_InitParamSet()
```
int32_t OH_Huks_InitParamSet (struct OH_Huks_ParamSet ** paramSet)
```
**描述:**
初始化参数集。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| paramSet | 指向要初始化的参数集的指针地址。 |
**返回:**
返回
[
OH_Huks_ErrCode#OH_HUKS_SUCCESS
](
_huks_type_api.md
)
时表示初始化成功,其他时为错误。
### OH_Huks_isParamSetTagValid()
```
int32_t OH_Huks_isParamSetTagValid (const struct OH_Huks_ParamSet * paramSet)
```
**描述:**
检查参数集中的参数是否有效、是否有重复。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| paramSet | 指向参数集的指针。 |
**返回:**
返回
[
OH_Huks_ErrCode#OH_HUKS_SUCCESS
](
_huks_type_api.md
)
时表示有效,其他时为无效或者错误。
### OH_Huks_isParamSetValid()
```
int32_t OH_Huks_isParamSetValid (const struct OH_Huks_ParamSet * paramSet, uint32_t size )
```
**描述:**
检查参数集大小是否有效。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| paramSet | 指向参数集的指针。 |
| size | 参数集占用的内存大小。 |
**返回:**
返回
[
OH_Huks_ErrCode#OH_HUKS_SUCCESS
](
_huks_type_api.md
)
时表示有效,其他时为无效或者错误。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录