harmony 鸿蒙HuksParamSetApi

  • 2023-06-24
  • 浏览 (598)

HuksParamSetApi

Overview

Defines HUKS parameter set management capabilities, including HUKS parameter set lifecycle management such as initializing a parameter set, adding parameters, building a parameter set, and freeing a parameter set, as well as functions such as obtaining parameters, copying a parameter set, querying a parameter set, and checking the validity of a parameter set.

\@syscap SystemCapability.Security.Huks

Since: 9

Summary

Files

Name Description
native_huks_param.h Provides APIs for constructing, using, and destroying parameter sets.
File to include:
Library: libhuks_ndk.z.so

Functions

Name Description
OH_Huks_InitParamSet (struct OH_Huks_ParamSet **paramSet) Initializes a parameter set.
OH_Huks_AddParams (struct OH_Huks_ParamSet *paramSet, const struct OH_Huks_Param *params, uint32_t paramCnt) Adds parameters to a parameter set.
OH_Huks_BuildParamSet (struct OH_Huks_ParamSet **paramSet) Builds a parameter set.
OH_Huks_FreeParamSet (struct OH_Huks_ParamSet **paramSet) Frees a parameter set.
OH_Huks_CopyParamSet (const struct OH_Huks_ParamSet *fromParamSet, uint32_t fromParamSetSize, struct OH_Huks_ParamSet **paramSet) Copies a parameter set (deep copy).
OH_Huks_GetParam (const struct OH_Huks_ParamSet *paramSet, uint32_t tag, struct OH_Huks_Param **param) Obtains a parameter from a parameter set.
OH_Huks_FreshParamSet (struct OH_Huks_ParamSet *paramSet, bool isCopy) Refreshes data of the Blob type in a parameter set.
OH_Huks_isParamSetTagValid (const struct OH_Huks_ParamSet *paramSet) Checks whether the parameters in a parameter set are valid.
OH_Huks_isParamSetValid (const struct OH_Huks_ParamSet *paramSet, uint32_t size) Checks whether a parameter set is of the valid size.
OH_Huks_CheckParamMatch (const struct OH_Huks_Param *baseParam, const struct OH_Huks_Param *param) Checks whether two parameters are the same.

Function Description

OH_Huks_AddParams()

int32_t OH_Huks_AddParams (struct OH_Huks_ParamSet * paramSet, const struct OH_Huks_Param * params, uint32_t paramCnt )

Description

Adds parameters to a parameter set.

Parameters

Name Description
paramSet Indicates the pointer to the parameter set to which parameters are to be added.
params Indicates the pointer to an array of parameters to add.
paramCnt Indicates the number of parameters to add.

Returns

Returns OH_Huks_ErrCode#OH_HUKS_SUCCESS if the operation is successful; returns an error code otherwise.

OH_Huks_BuildParamSet()

int32_t OH_Huks_BuildParamSet (struct OH_Huks_ParamSet ** paramSet)

Description

Builds a parameter set.

Parameters

Name Description
paramSet Indicates the double pointer to the parameter set to build.

Returns

Returns OH_Huks_ErrCode#OH_HUKS_SUCCESS if the operation is successful; returns an error code otherwise.

OH_Huks_CheckParamMatch()

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

Description

Checks whether two parameters are the same.

Parameters

Name Description
baseParam Indicates the pointer to the first parameter to compare.
param Indicates the pointer to the second parameter to compare.

Returns

Returns OH_Huks_ErrCode#OH_HUKS_SUCCESS if the two parameters are the same; returns an error code otherwise.

OH_Huks_CopyParamSet()

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

Description

Copies a parameter set (deep copy).

Parameters

Name Description
fromParamSet Indicates the pointer to the parameter set to copy.
fromParamSetSize Indicates the size of the memory occupied by the copied parameter set.
paramSet Indicates the double pointer to the new parameter set generated.

Returns

Returns OH_Huks_ErrCode#OH_HUKS_SUCCESS if the operation is successful; returns an error code otherwise.

OH_Huks_FreeParamSet()

void OH_Huks_FreeParamSet (struct OH_Huks_ParamSet ** paramSet)

Description

Frees a parameter set.

Parameters

Name Description
paramSet Indicates the pointer to the parameter set to free.

OH_Huks_FreshParamSet()

int32_t OH_Huks_FreshParamSet (struct OH_Huks_ParamSet * paramSet, bool isCopy )

Description

Refreshes data of the Blob type in a parameter set.

Parameters

Name Description
paramSet Indicates the pointer to the target parameter set.
isCopy Specifies whether to copy the data of the HksBlob type to the parameter set.

Returns

Returns OH_Huks_ErrCode#OH_HUKS_SUCCESS if the operation is successful; returns an error code otherwise.

OH_Huks_GetParam()

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

Description

Obtains a parameter from a parameter set.

Parameters

Name Description
paramSet Indicates the pointer to the target parameter set.
tag Indicates the name of the parameter to obtain.
param Indicates the double pointer to the obtained parameter.

Returns

Returns OH_Huks_ErrCode#OH_HUKS_SUCCESS if the operation is successful; returns an error code otherwise.

OH_Huks_InitParamSet()

int32_t OH_Huks_InitParamSet (struct OH_Huks_ParamSet ** paramSet)

Description

Initializes a parameter set.

Parameters

Name Description
paramSet Indicates the pointer to the parameter set to initialize.

Returns

Returns OH_Huks_ErrCode#OH_HUKS_SUCCESS if the operation is successful; returns an error code otherwise.

OH_Huks_isParamSetTagValid()

int32_t OH_Huks_isParamSetTagValid (const struct OH_Huks_ParamSet * paramSet)

Description

Checks whether the parameters in a parameter set are valid.

Parameters

Name Description
paramSet Indicates the pointer to the parameter set to check.

Returns

Returns OH_Huks_ErrCode#OH_HUKS_SUCCESS if the parameters in the parameter set are valid; returns an error code otherwise.

OH_Huks_isParamSetValid()

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

Description

Checks whether a parameter set is of the valid size.

Parameters

Name Description
paramSet Indicates the pointer to the parameter set to check.
size Indicates the memory size occupied by the parameter set.

Returns

Returns OH_Huks_ErrCode#OH_HUKS_SUCCESS if the size of the parameter set is valid; returns an error code otherwise.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Native APIs

harmony 鸿蒙AVCapability

harmony 鸿蒙AVDemuxer

harmony 鸿蒙AVMuxer

harmony 鸿蒙AVScreenCapture

harmony 鸿蒙AVSource

harmony 鸿蒙AudioDecoder

harmony 鸿蒙AudioEncoder

harmony 鸿蒙CodecBase

harmony 鸿蒙Core

0  赞