KSJAPI SDK · 错误码
RET_* 全部返回码含义与常见排查方向。
所有导出函数均返回 int,RET_SUCCESS 的值为 1,负数为错误码。
注意:条码解码模块
KSJBR_*是例外 —— 其成功返回码为0(RET_SUCCESS在该模块中为 0)。
| 常量 | 值 | 说明 | 排查方向 |
|---|---|---|---|
RET_SUCCESS |
1 | 函数返回成功 | 判断成功须用 == RET_SUCCESS |
RET_PARAMERROR |
-1 | 输入参数错误 | 核对参数范围 / 句柄是否有效 |
RET_MALLOCFAIL |
-2 | 内存分配错误 | 系统内存不足 |
RET_NOTSUPPORT |
-3 | 该功能不支持 | 确认相机型号是否支持(先用 KSJ_QueryFunction 查询) |
RET_DEVICENOTEXIST |
-4 | 相机不存在 | 检查连接、网段与 KSJ_DeviceGetCount |
RET_DEVICENOTINIT |
-5 | 相机没有初始化 | 先 KSJ_Init 并 KSJ_DeviceOpen |
RET_VIOLATION |
-6 | 操作冲突 | 如采集中修改了不可改参数,需先停止 |
RET_NOPRIVILEGE |
-7 | 权限错误 | 以管理员权限运行,或设备被其他进程占用 |
RET_FAIL |
-8 | 失败(原因未知) | 开启 KSJ_LogSet 查看日志 |
RET_WRONG |
-9 | 失败(原因未知) | 开启 KSJ_LogSet 查看日志 |
RET_RECOVERY_SUCCESS |
-10 | 相机恢复成功 | — |
RET_RECOVERY_FAIL |
-11 | 相机恢复失败 | 检查供电、线缆与连接 |
RET_BADFRAME |
-12 | 帧错误 | 检查触发与线缆质量 |
RET_INVALIDFRAME |
-13 | 无效帧(数据传到一半被中断) | 检查触发配置与曝光 |
RET_ZEROFRAME |
-14 | 帧存相机返回:采集图像数据 0 字节的错误帧 | 检查光条 / 曝光;或此前误调用过 KSJ_SendPktEnd |
RET_VERSION_ERROR |
-15 | 版本错误 | SDK 与固件 / 驱动版本不匹配 |
RET_TIMEOUT |
-16 | 读取超时且不恢复时,采集函数返回此值 | 加大超时时间或检查触发信号 |
RET_DEVICECLOSED |
-17 | 相机已经关闭 | 重新打开设备 |
RET_BUSNOTINIT |
-18 | 总线没有初始化 | 检查驱动与 KSJ_Init 调用 |
RET_CAM_NOT_CREATED |
-19 | 相机无法创建,通常因缺少对应类型的相机库文件 | 确认 SDK 库文件与位数(32/64)匹配 |
RET_INVALID_HANDLE |
-20 | 非法的句柄 | 核对句柄与相机索引 |
RET_STREAMNOSTART |
-21 | 流模式没有打开 | 先 KSJ_StreamStart |
RET_3DNOTINIT |
-22 | 相机 3D 功能没有初始化 | 3D 相关接口专用 |
RET_3DNOTSUPPORT |
-23 | 相机不支持 3D 功能 | 确认相机型号 |
RET_STOPSTREAMFIRST |
-24 | 需要先停止流模式 | 先 KSJ_StreamStop |
RET_DATAIO_ERROR |
-25 | 数据 IO 错误,通常是数据传输有问题 | 检查线缆与供电 |
RET_3DINIT_ERROR |
-26 | 相机 3D 功能初始化错误 | 3D 相关接口专用 |
RET_INVALID_DEVICE |
-27 | 无效相机 | 重新枚举相机 |
RET_3DWATERMARK_ERROR |
-28 | 3D 数据水印异常 | 3D 相关接口专用 |
RET_3DFRAME_RESTART |
-29 | 当前 3D 帧未达轮廓数,收到下一 3D 帧开始信号 | 3D 相关接口专用 |
RET_3DFRAME_FULL |
-30 | 正常完成一个 3D 帧 | 3D 相关接口专用 |
RET_NOBRMODULE |
-31 | 不支持解码功能,缺少解码模组 | 确认是否购买解码授权 |
RET_BR_INITFAIL |
-32 | 解码模组初始化失败 | 检查解码模组 / 授权 |
RET_BR_NOTINIT |
-33 | 解码模组未初始化 | 先完成解码模组初始化 |
RET_BR_LICENSEERROR |
-34 | 解码序列号错误 | 核对解码授权序列号 |
RET_BR_SETTINGFAIL |
-35 | 解码模组设置失败 | 检查配置文件 |
通用排查顺序
- 初始化顺序:相机是否在
KSJ_Init前连接;是否已KSJ_DeviceOpen(多进程场景)。 - 调用顺序:预览是否先
KSJ_PreviewSetPos再KSJ_PreviewStart;设置视场是否有返回后回读实际生效值。 - 参数范围:设置前先读对应的
*Range/GetRange,避免越界(→RET_PARAMERROR)。 - 功能查询:调用前用
KSJ_QueryFunction确认相机是否支持(→RET_NOTSUPPORT)。 - 开启日志:
KSJ_LogSet(true, NULL)后复现,日志默认落在库目录下KSJApiLog/。
这份文档对您有帮助吗?
发现错误、表述不清或缺少内容?请告诉我们,我们会尽快补充。
您可以通过以下方式反馈: 发送邮件至 service@catchbest.com