GetParam
Function Usage
Obtains the parameter values of a module.
Restrictions
N/A
Prototype
VmiErrCode GetParam(VmiDataType module, VmiCmd cmd, uint8_t *param, uint32_t size)
Parameter Description
Field Name |
Input/Output |
Field Type |
Description |
|---|---|---|---|
module |
Input |
VmiDataType |
Module data type. |
cmd |
Input |
VmiCmd |
Operation instruction for obtaining the parameter values. |
param |
Input |
uint8_t* |
Pointer to the output parameter data. |
size |
Input |
uint32_t |
Size of the output data. |
Return Value Description
Data type: enum VmiErrCode: int32_t
The value can be any of the following:
- OK (0): The parameter values are obtained successfully.
- Negative error code: Failed to obtain parameter values.
Parent topic: Functional APIs