CBXS3D SDK · 初始化与设备管理

本组对应头文件 @defgroup Base 基本功能。设备必须先枚举再创建句柄，句柄用完必须销毁。

CBXS_SetLog

int CBXS_SetLog(bool bEnable, const char* pszFolder = 0, int nLevel = 2)

设置 Log 日志是否输出、输出目录与日志等级。

返回：成功返回 CBXS_RET_SUCCESS

说明

• 可在任意时刻调用，建议在 CBXS_Initial() 之前调用。
• pszFolder 为 NULL 时，日志自动输出到程序目录下的 ApiLogs 目录。
• 不支持使能后修改日志等级；需改等级时先禁用再重新使能。

CBXS_Initial

int CBXS_Initial()

初始化 SDK。

返回：成功返回 CBXS_RET_SUCCESS

说明

• 每次 Initial 会重新枚举可连接的设备。

CBXS_UnInitial

int CBXS_UnInitial()

反初始化 SDK，释放资源。

返回：成功返回 CBXS_RET_SUCCESS；失败返回错误码

CBXS_GetSDKVersion

unsigned int CBXS_GetSDKVersion()

获取 SDK 版本号，返回 4 字节版本号。

返回：返回 4 字节版本号（非错误码）

说明

• 字节排列为 |主 8bits|次 8bits|修正 8bits|测试 8bits|。
• 例：返回 0x01000001 表示 SDK 版本 V1.0.0.1。

CBXS_EnumDevices

int CBXS_EnumDevices(CBXS_DEVICE_INFO_LIST* pstDevInfoList)

枚举当前可连接的设备，结果写入设备列表。

返回：成功返回 CBXS_RET_SUCCESS

说明

• 设备列表内每台设备信息的内存由 SDK 内部管理，建议避免多线程同时枚举。
• 每次调用都会重新枚举可连接的设备。

CBXS_SetDeviceInfo

int CBXS_SetDeviceInfo(int nIndex, CBXS_DEVICE_INFO* pstDevInfo)

设置设备信息（IP 地址、UserDefinedName 等）。

返回：成功返回 CBXS_RET_SUCCESS

说明

• 做法：先从 CBXS_DEVICE_INFO_LIST 复制一份设备信息，改完要修改的字段（IP / UserDefinedName 等）再传入。

CBXS_CreateDeviceHandle

int CBXS_CreateDeviceHandle(void** phandle, CBXS_DEVICE_INFO* pstDevInfo)

根据设备信息创建设备句柄。

返回：成功返回 CBXS_RET_SUCCESS；失败返回错误码

CBXS_OpenDevice

int CBXS_OpenDevice(void* handle)

打开（占用）设备。

返回：成功返回 CBXS_RET_SUCCESS

说明

• 打开后设备被独占，其他进程将无法再打开。

CBXS_CloseDevice

int CBXS_CloseDevice(void* handle)

关闭设备，释放独占，允许其他进程使用。

返回：成功返回 CBXS_RET_SUCCESS；失败返回错误码

CBXS_DestroyDeviceHandle

int CBXS_DestroyDeviceHandle(void* handle)

销毁设备句柄，释放资源。

返回：成功返回 CBXS_RET_SUCCESS

说明

• 销毁前应先 CBXS_CloseDevice。

CBXS_HelperSaveToBmp

int CBXS_HelperSaveToBmp(unsigned char* pData, int nWidth, int nHeight, int nBitCount, const char* pszFileName)

保存图像到位图文件。

返回：成功返回 CBXS_RET_SUCCESS

说明

• 数据格式设为 CBXS_DF_IMAGE / CBXS_DF_IMAGE_PI 取到的 pImage 可直接传入。