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

CB_Device SDK · SDK 信息与日志

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

查询 SDK 版本、各类枚举常量对应的可读字符串，以及日志路径/级别/开关配置。这些函数大多可在 CB_Initial 之前调用。

CB_GetSDKVersion

CB_RESULT CB_GetSDKVersion(CB_UVersion *pSdkVersion)

获取SDK版本

参数 方向 说明
pSdkVersion out 返回SDK版本号

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。

CB_GetHelpStringErrorCode

CB_RESULT CB_GetHelpStringErrorCode(CB_RESULT ErrorCode, char *szStrBuf, int32_t *piBufSize)

获取错误代码的字符描述

参数 方向 说明
ErrorCode in 错误代码
szStrBuf out 接收字符串的内存指针
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。
  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_GetHelpStringLogLevel

CB_RESULT CB_GetHelpStringLogLevel(CB_ELogLevel eLogLevel, char *szStrBuf, int32_t *piBufSize)

获取日志等级枚举成员常量值对应的描述字符串

参数 方向 说明
eLogLevel in 日志等级枚举值
szStrBuf out 接收字符串的内存指针
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。
  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_GetHelpStringCategoryType

CB_RESULT CB_GetHelpStringCategoryType(CB_CategoryType_e eCatType, char *szStrBuf, int32_t *piBufSize)

获取参数类别枚举成员常量值对应的描述字符串

参数 方向 说明
eCatType in 参数类别枚举值
szStrBuf out 用于接收字符串的内存指针
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。
  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_GetHelpStringUnit

CB_RESULT CB_GetHelpStringUnit(CB_Unit_e eUnit, char *szStrBuf, int32_t *piBufSize)

获取单位枚举成员常量值对应的描述字符串

参数 方向 说明
eUnit in 参数单位枚举值
szStrBuf out 用于接收字符串的内存指针
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。
  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_GetHelpStringParamType

CB_RESULT CB_GetHelpStringParamType(CB_ParamType_e eParamType, char* szStrBuf, int32_t* piBufSize)

获取参数类型枚举成员常量值对应的描述字符串

参数 方向 说明
eParamType in 参数类型枚举值
szStrBuf out 用于接收字符串的内存指针
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。
  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_GetHelpStringIntegerType

CB_RESULT CB_GetHelpStringIntegerType(CB_IntegerType_e eIntegerType, char* szStrBuf, int32_t* piBufSize)

获取整型类型枚举成员常量值对应的描述字符串

参数 方向 说明
eIntegerType in 整型类型枚举值
szStrBuf out 用于接收字符串的内存指针
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。
  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_GetHelpStringRepresentationType

CB_RESULT CB_GetHelpStringRepresentationType(CB_RepresentationType_e eRepresentationType, char* szStrBuf, int32_t* piBufSize)

获取表现类型枚举成员常量值对应的描述字符串

参数 方向 说明
eRepresentationType in 表现类型枚举值
szStrBuf out 用于接收字符串的内存指针
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。 piBufSize可以设置为NULL，表示不对内存大小进行检查，调用者需保证szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。
  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_GetHelpStringAccessMode

CB_RESULT CB_GetHelpStringAccessMode(CB_AccessMode_e eAccessMode, char* szStrBuf, int32_t* piBufSize)

获取访问模式枚举成员常量值对应的描述字符串

参数 方向 说明
eAccessMode in 访问模式枚举值
szStrBuf out 用于接收字符串的内存指针
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。
  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_GetHelpStringIncMode

CB_RESULT CB_GetHelpStringIncMode(CB_IncMode_e eIncMode, char* szStrBuf, int32_t* piBufSize)

获取增量模式枚举成员常量值对应的描述字符串

参数 方向 说明
eIncMode in 增量模式枚举值
szStrBuf out 用于接收字符串的内存指针
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。
  • szStrBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_SetLogPath

CB_RESULT CB_SetLogPath(const char *pszLogPath)

设置日志存储文件夹路径

参数 方向 说明
pszLogPath in 指向日志存储文件夹路径字符串

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。如果当前日志处于使能状态，在下一次使能时有效。
  • pszLogPath字符串最后一个字符可以有'\'也可以没有'\'。

CB_GetLogPath

CB_RESULT CB_GetLogPath(char *szLogPathBuf, int32_t *piBufSize)

获取日志存储路径

参数 方向 说明
szLogPathBuf out 用于接收当前日志所在文件夹路径
piBufSize inout 接收内存字节大小

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。
  • szLogPathBuf指向的内存必须足够大（包括字符串终止符'\0'）以接收完整字符串。

CB_SetLogEnable

CB_RESULT CB_SetLogEnable(_Bool bEnable)

日志文件是否使能输出

参数 方向 说明
bEnable in 日志是否使能

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。如果要记录SDK完整日志，请在所有API函数接口之前使能日志输出。

CB_GetLogEnable

CB_RESULT CB_GetLogEnable(_Bool *pbEnable)

获取日志文件是否使能输出。

参数 方向 说明
pbEnable out 当前日志是否使能。

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。

CB_SetLogLevel

CB_RESULT CB_SetLogLevel(CB_ELogLevel eLogLevel)

设置日志输出等级。

参数 方向 说明
eLogLevel in 设置日志等级。

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。如果当前日志输出使能，会影响当前日志输出等级。

CB_GetLogLevel

CB_RESULT CB_GetLogLevel(CB_ELogLevel *peLogLevel)

获取当前日志输出等级。

参数 方向 说明
peLogLevel out 获取当前的日志等级

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

说明

  • @note 可在任何时刻调用，可在CB_Initial之前调用。