harmony 鸿蒙ohscan.h

2025-06-12 浏览 (1)

ohscan.h

概述

向应用提供使用CAPI访问扫描仪设备的能力。

起始版本： 12

汇总

类型定义

名称描述
Scan_ScannerDevice扫描仪设备信息。
Scan_PictureScanProgress图片扫描进度。
Scan_ScannerOptions扫描仪选项。
Scan_ScannerDiscoveryCallback扫描仪发现回调函数。

枚举类型

名称描述
Scan_ErrorCode枚举错误码。

函数

名称描述
OH_Scan_Init用于拉起扫描服务，初始化客户端，并建立与扫描服务的连接。
OH_Scan_StartScannerDiscovery用于搜索扫描仪，注册一个回调函数来处理发现的扫描仪。
OH_Scan_OpenScanner用于连接扫描仪。
OH_Scan_CloseScanner用于断开与扫描仪的连接。
OH_Scan_GetScannerParameter用于获取扫描仪设置选项。
OH_Scan_SetScannerParameter用于设置扫描仪的选项参数。
OH_Scan_StartScan用于启动扫描仪。
OH_Scan_CancelScan用于取消扫描。
OH_Scan_GetPictureScanProgress用于查询图片扫描进度。
OH_Scan_Exit用于退出扫描服务，释放客户端内存。

类型定义说明

Scan_ScannerDevice

描述

扫描仪设备信息。

起始版本： 12

成员描述
scannerId扫描仪id。
manufacturer制造商。
model设备型号。
discoverMode发现模式。
serialNumber序列号。

Scan_PictureScanProgress

描述

图片扫描进度。

起始版本： 12

成员描述
progress图片扫描进度，范围0~100。
fd图片文件句柄。
isFinal是否有下一张图片。

Scan_ScannerOptions

描述

扫描仪选项。

起始版本： 12

成员描述
titles选项标题。
descriptions选项描述信息。
ranges选项范围。
optionCount选项个数。

Scan_ScannerDiscoveryCallback

描述

扫描仪发现回调函数。

起始版本： 12

参数描述
devices扫描仪设备。
deviceCount设备个数。

枚举类型说明

Scan_ErrorCode

描述

枚举错误码。

起始版本： 12

枚举值描述
SCAN_ERROR_NONE成功。
SCAN_ERROR_NO_PERMISSION没有权限。
SCAN_ERROR_INVALID_PARAMETER无效的参数。
SCAN_ERROR_GENERIC_FAILURE一般的内部错误。
SCAN_ERROR_RPC_FAILUREPRC通信错误。
SCAN_ERROR_SERVER_FAILURE服务端错误。
SCAN_ERROR_UNSUPPORTED不支持该操作。
SCAN_ERROR_CANCELED操作被取消。
SCAN_ERROR_DEVICE_BUSY设备忙碌。
SCAN_ERROR_INVALID无效操作。
SCAN_ERROR_JAMMED进纸器卡纸。
SCAN_ERROR_NO_DOCS没有纸。
SCAN_ERROR_COVER_OPEN扫描仪的盖子被打开。
SCAN_ERROR_IO_ERROR扫描仪IO过程中错误。
SCAN_ERROR_NO_MEMORY扫描仪没有内存。

函数说明

OH_Scan_Init()

int32_t OH_Scan_Init();

描述

这个接口用于拉起扫描服务，初始化客户端，并建立与扫描服务的连接。

系统能力： ohos.permission.PRINT

起始版本： 12

返回：

返回Scan_ERROR_NONE表示成功；

返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常。

OH_Scan_StartScannerDiscovery()

int32_t OH_Scan_StartScannerDiscovery(Scan_ScannerDiscoveryCallback callback);

描述

这个接口用于搜索扫描仪，注册一个回调函数来处理发现的扫描仪。

系统能力： ohos.permission.PRINT

起始版本： 12

参数:

名称描述
callback扫描仪发现事件的回调函数。

返回：

返回Scan_ERROR_NONE表示成功；

返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常。

OH_Scan_OpenScanner()

int32_t OH_Scan_OpenScanner(const char* scannerId);

描述

这个接口用于连接扫描仪。

系统能力： ohos.permission.PRINT

起始版本： 12

参数:

名称描述
scannerId扫描仪的id

返回：

返回Scan_ERROR_NONE表示成功；

返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常；

返回SCAN_ERROR_DEVICE_BUSY表示扫描仪忙碌；

返回SCAN_ERROR_INVALID_PARAMETER表示无效参数；

返回SCAN_ERROR_IO_ERROR表示扫描仪IO错误；

返回SCAN_ERROR_NO_MEMORY表示没有足够的内存。

OH_Scan_CloseScanner()

int32_t OH_Scan_CloseScanner(const char* scannerId);

描述

这个接口用于断开与扫描仪的连接。

系统能力： ohos.permission.PRINT

起始版本： 12

参数:

名称描述
scannerId扫描仪的id

返回：

返回Scan_ERROR_NONE表示成功；

返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常；

返回SCAN_ERROR_INVALID_PARAMETER表示无效参数。

OH_Scan_GetScannerParameter()

Scan_ScannerOptions* OH_Scan_GetScannerParameter(const char* scannerId, int32_t* errorCode);

描述

这个接口用于获取扫描仪设置选项，返回的结构体指针在OH_Scan_Exit时自动释放内存，每个型号的扫描仪在内存中只存储一个副本。

系统能力： ohos.permission.PRINT

起始版本： 12

参数:

名称描述
scannerId扫描仪的id
errorCode错误码

返回：

返回Scan_ERROR_NONE表示成功；

返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常。

OH_Scan_SetScannerParameter()

int32_t OH_Scan_SetScannerParameter(const char* scannerId, const int32_t option, const char* value);

描述

这个接口用于设置扫描仪的选项参数，选项值的返回通过OH_Scan_GetScannerParameter接口获得。

系统能力： ohos.permission.PRINT

起始版本： 12

参数:

名称描述
scannerId扫描仪的id
option选项编号
value选项值

返回：

返回Scan_ERROR_NONE表示成功；

返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常；

返回SCAN_ERROR_INVALID_PARAMETER表示无效参数。

OH_Scan_StartScan()

int32_t OH_Scan_StartScan(const char* scannerId, bool batchMode);

描述

这个接口用于启动扫描仪。

系统能力： ohos.permission.PRINT

起始版本： 12

参数:

名称描述
scannerId扫描仪的id
batchMode批处理模式

返回：

返回Scan_ERROR_NONE表示成功； 返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常；

返回SCAN_ERROR_INVALID_PARAMETER表示无效参数；

返回SCAN_ERROR_JAMMED表示扫描仪卡纸；

返回SCAN_ERROR_NO_DOCS表示没有纸；

返回SCAN_ERROR_COVER_OPEN表示扫描仪的盖子被打开；

返回SCAN_ERROR_IO_ERROR表示扫描仪IO异常；

返回SCAN_ERROR_NO_MEMORY表示没有足够的内存；

返回SCAN_ERROR_DEVICE_BUSY表示扫描仪忙碌。

OH_Scan_CancelScan()

int32_t OH_Scan_CancelScan(const char* scannerId);

描述

这个接口用于取消扫描。

系统能力： ohos.permission.PRINT

起始版本： 12

参数:

名称描述
scannerId扫描仪的id

返回：

返回Scan_ERROR_NONE表示成功；

返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常；

返回SCAN_ERROR_INVALID_PARAMETER表示无效参数。

OH_Scan_GetPictureScanProgress()

int32_t OH_Scan_GetPictureScanProgress(const char* scannerId, Scan_PictureScanProgress* prog);

描述

这个接口用于查询图片扫描进度。

系统能力： ohos.permission.PRINT

起始版本： 12

参数:

名称描述
scannerId扫描仪的id
prog图片扫描进度

返回：

返回Scan_ERROR_NONE表示成功；

返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常；

返回SCAN_ERROR_INVALID_PARAMETER表示无效参数；

返回SCAN_ERROR_JAMMED表示扫描仪卡纸；

返回SCAN_ERROR_NO_DOCS表示没有纸；

返回SCAN_ERROR_COVER_OPEN表示扫描仪的盖子被打开；

返回SCAN_ERROR_IO_ERROR表示扫描仪IO异常；

返回SCAN_ERROR_NO_MEMORY表示没有足够的内存；

返回SCAN_ERROR_DEVICE_BUSY表示扫描仪忙碌。

OH_Scan_Exit()

int32_t OH_Scan_Exit();

描述

这个接口用于退出扫描服务，清除客户端内存，取消注册的扫描回调函数。

系统能力： ohos.permission.PRINT

起始版本： 12

返回：

返回Scan_ERROR_NONE表示成功；

返回SCAN_ERROR_NO_PERMISSION表示没有权限；

返回SCAN_ERROR_RPC_FAILURE表示RPC通信错误；

返回SCAN_ERROR_SERVER_FAILURE表示服务端出现异常；

返回SCAN_ERROR_INVALID_PARAMETER表示无效参数。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Basic Services Kit（基础服务）

harmony 鸿蒙DeviceInfo

harmony 鸿蒙OH_Print

harmony 鸿蒙Print_Margin

harmony 鸿蒙Print_PageSize

harmony 鸿蒙Print_PrintAttributes

harmony 鸿蒙Print_PrintDocCallback

harmony 鸿蒙Print_Range

harmony 鸿蒙TimeService

harmony 鸿蒙CommonEvent

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/aOEk0z