凯视佳产品文档 产品文档与技术支持

CB_Device SDK · 布尔/字符串/枚举/寄存器参数

版本 1.0 · 更新于 2026-10-21 · 阅读 0

布尔、字符串、枚举型参数的读写，以及命令型参数的执行与寄存器读写。

CB_GetBoolParam

CB_RESULT CB_GetBoolParam(int32_t iDevIndex, const char* szParamName, _Bool *pbValue)

获取布尔类型参数的当前值。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
szParamName in 参数名称，必须是ParamType_Boolean类型的参数
pbValue out 用于接收结果的内存指针

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

CB_SetBoolParam

CB_RESULT CB_SetBoolParam(int32_t iDevIndex, const char* szParamName, _Bool bValue)

设置布尔类型参数。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
szParamName in 参数名称，必须是ParamType_Float类型的参数
bValue in 要设置的值

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

CB_GetStringParam

CB_RESULT CB_GetStringParam(int32_t iDevIndex, const char* szParamName, char* szStrBuf, int32_t* piBufSize)

获取字符串类型参数的字符串值。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
szParamName in 参数名称，必须是ParamType_String类型的参数
szStrBuf out 用于接收字符串的内存指针

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

说明

  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_SetStringParam

CB_RESULT CB_SetStringParam(int32_t iDevIndex, const char* szParamName, const char *szString)

设置字符串类型参数。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
szParamName in 参数名称，必须是ParamType_String类型的参数
szString in 要设置的字符串指针

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

CB_GetEnumParam

CB_RESULT CB_GetEnumParam(int32_t iDevIndex, const char* szParamName, int32_t *piValue)

获取枚举类型参数的当前枚举常量。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
szParamName in 参数名称，必须是ParamType_Enumeration类型的参数
piValue out 返回当前参数值，请参考CB_Enum.h中的枚举成员的常量值定义

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

CB_SetEnumParam

CB_RESULT CB_SetEnumParam(int32_t iDevIndex, const char* szParamName, int32_t iValue)

通过枚举成员常量值设置枚举类型参数。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
szParamName in 参数名称，必须是ParamType_Enumeration类型的参数
iValue in 枚举成员常量，参考CB_Enum.h中的枚举成员的常量值定义

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

CB_SetEnumParamByEntryIndex

CB_RESULT CB_SetEnumParamByEntryIndex(int32_t iDevIndex, const char* szParamName, int32_t iIndex)

通过枚举成员索引设置枚举类型参数。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
szParamName in 参数名称，必须是ParamType_Enumeration类型的参数
iIndex in 枚举成员索引，参考CB_Enum.h中的枚举成员的常量值定义

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

CB_SetEnumParamByEntryName

CB_RESULT CB_SetEnumParamByEntryName(int32_t iDevIndex, const char* szParamName, const char* szEntryName)

通过枚举成员名称设置枚举类型参数。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]
szParamName in 参数名称，必须是ParamType_Enumeration类型的参数
szEntryName in 枚举成员名称，参考CB_Enum.h中的枚举成员的常量值定义

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

CB_ExecuteCommandParam

CB_RESULT CB_ExecuteCommandParam(int32_t iDevIndex, const char* szParamName)

执行一个命令。

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

说明

  • 执行给定参数名称的命令。

CB_SetRegisterParam

CB_RESULT CB_SetRegisterParam(int32_t iDevIndex, const char* szParamName, const uint32_t iBytesNum, const uint8_t *pData)

设置寄存器类型参数的值

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

说明

  • 一次写入的字节数没有限制，SDK内部会根据实际情况进行分包传输

CB_GetRegisterParam

CB_RESULT CB_GetRegisterParam(int32_t iDevIndex, const char* szParamName, const uint32_t iBytesNum, uint8_t *pData)

读取寄存器类型参数的值

参数 方向 说明
iDevIndex in 设备索引，取值范围[0,(CB_EnumerateDevices()-1)]

返回：成功返回 CB_E_SUCCESS；失败返回错误码（见错误码章节）

说明

  • 一次读取的字节数没有限制，SDK内部会根据实际情况进行分包传输