名称	typedef关键字	描述
Print_StringList	Print_StringList	表示字符串列表。
Print_Property	Print_Property	表示打印机属性。
Print_PropertyList	Print_PropertyList	打印机属性列表。
Print_Resolution	Print_Resolution	表示以 dpi 为单位的打印分辨率。
Print_Margin	Print_Margin	表示打印边距。
Print_PageSize	Print_PageSize	表示纸张尺寸信息。
Print_PrinterCapability	Print_PrinterCapability	表示打印机能力。
Print_DefaultValue	Print_DefaultValue	表示当前属性。
Print_PrinterInfo	Print_PrinterInfo	表示打印机信息。
Print_PrintJob	Print_PrintJob	表示打印任务结构体。
Print_Range	Print_Range	表示打印范围结构体。
Print_PrintAttributes	Print_PrintAttributes	表示打印属性结构体。
Print_PrintDocCallback	Print_PrintDocCallback	表示打印文档状态回调结构体。

枚举

PhonePC/2in1Tablet

展开

名称	typedef关键字	描述
Print_ErrorCode	Print_ErrorCode	定义错误码。
Print_PrinterState	Print_PrinterState	表示打印机状态。
Print_DiscoveryEvent	Print_DiscoveryEvent	表示打印机发现事件。
Print_PrinterEvent	Print_PrinterEvent	表示打印机变更事件。
Print_DuplexMode	Print_DuplexMode	表示双面打印模式。
Print_ColorMode	Print_ColorMode	表示色彩模式。
Print_OrientationMode	Print_OrientationMode	表示方向模式。
Print_Quality	Print_Quality	表示打印质量。
Print_DocumentFormat	Print_DocumentFormat	表示文档的 MIME 媒体类型。
Print_JobDocAdapterState	Print_JobDocAdapterState	表示打印任务文档适配器状态。
OH_Print_JobState	OH_Print_JobState	表示打印任务状态。

函数

PhonePC/2in1Tablet

展开

名称	typedef关键字	描述
typedef void(Print_WriteResultCallback)(const char jobId, uint32_t code)	Print_WriteResultCallback	写文件结果回调。
typedef void(Print_OnStartLayoutWrite)(const char jobId, uint32_t fd, const Print_PrintAttributes oldAttrs, const Print_PrintAttributes newAttrs, Print_WriteResultCallback writeCallback)	Print_OnStartLayoutWrite	打印开始布局回调。
typedef void(Print_OnJobStateChanged)(const char jobId, uint32_t state)	Print_OnJobStateChanged	打印任务状态回调。
typedef void (Print_PrinterDiscoveryCallback)(Print_DiscoveryEvent event, const Print_PrinterInfo printerInfo)	Print_PrinterDiscoveryCallback	打印机发现回调。
typedef void (Print_PrinterChangeCallback)(Print_PrinterEvent event, const Print_PrinterInfo printerInfo)	Print_PrinterChangeCallback	打印机变更回调。
Print_ErrorCode OH_Print_Init()	-	此 API 检查并拉起打印服务，初始化打印客户端，并建立与打印服务的连接。
Print_ErrorCode OH_Print_Release()	-	此 API 关闭与打印服务的连接，解散先前的回调，并释放打印客户端资源。
Print_ErrorCode OH_Print_StartPrinterDiscovery(Print_PrinterDiscoveryCallback callback)	-	此 API 开始发现打印机。
Print_ErrorCode OH_Print_StopPrinterDiscovery()	-	此 API 停止发现打印机。
Print_ErrorCode OH_Print_ConnectPrinter(const char *printerId)	-	此 API 使用打印机 ID 连接打印机。
Print_ErrorCode OH_Print_StartPrintJob(const Print_PrintJob *printJob)	-	此 API 开始发起打印任务。
Print_ErrorCode OH_Print_RegisterPrinterChangeListener(Print_PrinterChangeCallback callback)	-	此 API 注册打印机变更回调。
void OH_Print_UnregisterPrinterChangeListener()	-	此 API 注销打印机变更回调。
Print_ErrorCode OH_Print_QueryPrinterList(Print_StringList *printerIdList)	-	此 API 查询已添加的打印机列表。
void OH_Print_ReleasePrinterList(Print_StringList *printerIdList)	-	此 API 释放用于查询的打印机列表内存。
Print_ErrorCode OH_Print_QueryPrinterInfo(const char printerId, Print_PrinterInfo *printerInfo)	-	此 API 根据打印机 ID 查询打印机信息。
void OH_Print_ReleasePrinterInfo(Print_PrinterInfo *printerInfo)	-	此 API 释放用于查询的打印机信息内存。
Print_ErrorCode OH_Print_LaunchPrinterManager()	-	此 API 启动系统的打印机管理窗口。
Print_ErrorCode OH_Print_QueryPrinterProperties(const char printerId, const Print_StringList propertyKeyList, Print_PropertyList *propertyList)	-	此 API 根据属性关键字列表查询对应的打印机属性值。
void OH_Print_ReleasePrinterProperties(Print_PropertyList *propertyList)	-	此 API 释放用于查询的属性列表内存。
Print_ErrorCode OH_Print_UpdatePrinterProperties(const char printerId, const Print_PropertyList propertyList)	-	此 API 根据属性键值对列表设置打印机属性。
Print_ErrorCode OH_Print_RestorePrinterProperties(const char printerId, const Print_StringList propertyKeyList)	-	此 API 根据属性关键字列表将打印机属性恢复为默认设置。
Print_ErrorCode OH_Print_StartPrintByNative(const char printJobName, Print_PrintDocCallback printDocCallback, void context)	-	此 API 提供启动打印对话框的能力。
typedef void(OH_Print_OnJobStateChanged)(const char jobId, OH_Print_JobState state)	-	打印任务状态回调。
Print_ErrorCode OH_Print_StartPrintWithJobStateCallback(const Print_PrintJob *printJob, OH_Print_OnJobStateChanged jobStateChangedCb)	-	此API下发打印任务，并附带任务状态变更回调功能。

枚举类型说明

PhonePC/2in1Tablet

Print_ErrorCode

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_ErrorCode

描述

定义错误码。

起始版本： 12

展开

枚举项	描述
PRINT_ERROR_NONE = 0	操作成功。
PRINT_ERROR_NO_PERMISSION = 201	权限校验失败。
PRINT_ERROR_INVALID_PARAMETER = 401	参数无效。
PRINT_ERROR_GENERIC_FAILURE = 24300001	通用内部错误。
PRINT_ERROR_RPC_FAILURE = 24300002	RPC 通信错误。
PRINT_ERROR_SERVER_FAILURE = 24300003	服务端错误。
PRINT_ERROR_INVALID_EXTENSION = 24300004	无效的扩展。
PRINT_ERROR_INVALID_PRINTER = 24300005	无效的打印机。
PRINT_ERROR_INVALID_PRINT_JOB = 24300006	无效的打印任务。
PRINT_ERROR_FILE_IO = 24300007	读写文件失败。
PRINT_ERROR_UNKNOWN = 24300255	未知错误。

Print_PrinterState

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_PrinterState

描述

表示打印机状态。

起始版本： 12

展开

枚举项	描述
PRINTER_IDLE	打印机空闲。
PRINTER_BUSY	打印机忙。
PRINTER_UNAVAILABLE	打印机不可用。

Print_DiscoveryEvent

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_DiscoveryEvent

描述

表示打印机发现事件。

起始版本： 12

展开

枚举项	描述
PRINTER_DISCOVERED = 0	发现打印机。
PRINTER_LOST = 1	丢失打印机。
PRINTER_CONNECTING = 2	正在连接打印机。
PRINTER_CONNECTED = 3	打印机已连接。

Print_PrinterEvent

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_PrinterEvent

描述

表示打印机变更事件。

起始版本： 12

展开

枚举项	描述
PRINTER_ADDED = 0	打印机已添加。
PRINTER_DELETED = 1	打印机已删除。
PRINTER_STATE_CHANGED = 2	打印机状态已变更。
PRINTER_INFO_CHANGED = 3	打印机信息已变更。

Print_DuplexMode

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_DuplexMode

描述

表示双面打印模式。

起始版本： 12

展开

枚举项	描述
DUPLEX_MODE_ONE_SIDED = 0	单面模式。
DUPLEX_MODE_TWO_SIDED_LONG_EDGE = 1	长边翻转双面模式。
DUPLEX_MODE_TWO_SIDED_SHORT_EDGE = 2	短边翻转双面模式。

Print_ColorMode

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_ColorMode

描述

表示色彩模式。

起始版本： 12

展开

枚举项	描述
COLOR_MODE_MONOCHROME = 0	黑白模式。
COLOR_MODE_COLOR = 1	彩色模式。
COLOR_MODE_AUTO = 2	自动模式。

Print_OrientationMode

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_OrientationMode

描述

表示方向模式。

起始版本： 12

展开

枚举项	描述
ORIENTATION_MODE_PORTRAIT = 0	纵向模式。
ORIENTATION_MODE_LANDSCAPE = 1	横向模式。
ORIENTATION_MODE_REVERSE_LANDSCAPE = 2	反向横向模式。
ORIENTATION_MODE_REVERSE_PORTRAIT = 3	反向纵向模式。
ORIENTATION_MODE_NONE = 4	未指定。

Print_Quality

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_Quality

描述

表示打印质量。

起始版本： 12

展开

枚举项	描述
PRINT_QUALITY_DRAFT = 3	草稿质量模式
PRINT_QUALITY_NORMAL = 4	正常质量模式
PRINT_QUALITY_HIGH = 5	高质量模式

Print_DocumentFormat

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_DocumentFormat

描述

表示文档的 MIME 媒体类型。

起始版本： 12

展开

枚举项	描述
DOCUMENT_FORMAT_AUTO	MIME 类型：application/octet-stream。
DOCUMENT_FORMAT_JPEG	MIME 类型：image/jpeg。
DOCUMENT_FORMAT_PDF	MIME 类型：application/pdf。
DOCUMENT_FORMAT_POSTSCRIPT	MIME 类型：application/postscript。
DOCUMENT_FORMAT_TEXT	MIME 类型：text/plain。

Print_JobDocAdapterState

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum Print_JobDocAdapterState

描述

表示打印任务文档适配器状态。

起始版本： 13

展开

枚举项	描述
PRINT_DOC_ADAPTER_PREVIEW_ABILITY_DESTROY = 0	打印任务预览能力销毁。
PRINT_DOC_ADAPTER_PRINT_TASK_SUCCEED = 1	打印任务成功。
PRINT_DOC_ADAPTER_PRINT_TASK_FAIL = 2	打印任务失败。
PRINT_DOC_ADAPTER_PRINT_TASK_CANCEL = 3	打印任务取消。
PRINT_DOC_ADAPTER_PRINT_TASK_BLOCK = 4	打印任务阻塞。
PRINT_DOC_ADAPTER_PREVIEW_ABILITY_DESTROY_FOR_CANCELED = 5	因取消导致的打印任务预览能力销毁。
PRINT_DOC_ADAPTER_PREVIEW_ABILITY_DESTROY_FOR_STARTED = 6	因启动导致的打印任务预览能力销毁。

OH_Print_JobState

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
enum OH_Print_JobState

描述

表示打印任务状态。

起始版本： 24

展开

名称	说明
OH_PRINT_JOB_SUCCEED = 0	打印任务成功。
OH_PRINT_JOB_FAIL = 1	打印任务失败。
OH_PRINT_JOB_CANCEL = 2	打印任务取消。
OH_PRINT_JOB_BLOCK = 3	打印任务阻塞。

函数说明

PhonePC/2in1Tablet

Print_WriteResultCallback()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
typedef void(*Print_WriteResultCallback)(const char *jobId, uint32_t code)

描述

写文件结果回调。

起始版本： 13

参数：

展开

参数项	描述
const char *jobId	打印任务的 ID。
uint32_t code	写文件的结果。

Print_OnStartLayoutWrite()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
typedef void(*Print_OnStartLayoutWrite)(const char *jobId, uint32_t fd, const Print_PrintAttributes *oldAttrs, const Print_PrintAttributes *newAttrs, Print_WriteResultCallback writeCallback)

描述

打印开始布局回调。

起始版本： 13

参数：

展开

参数项	描述
const char *jobId	打印任务的 ID。
uint32_t fd	待写入的文件描述符。
const Print_PrintAttributes *oldAttrs	上一次的属性。
const Print_PrintAttributes *newAttrs	当前的属性。
Print_WriteResultCallback writeCallback	写文件结果回调。

Print_OnJobStateChanged()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
typedef void(*Print_OnJobStateChanged)(const char *jobId, uint32_t state)

描述

打印任务状态回调。

起始版本： 13

参数：

展开

参数项	描述
const char *jobId	打印任务的 ID。
uint32_t state	当前打印任务的状态。

Print_PrinterDiscoveryCallback()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
typedef void (*Print_PrinterDiscoveryCallback)(Print_DiscoveryEvent event, const Print_PrinterInfo *printerInfo)

描述

打印机发现回调。

起始版本： 12

参数：

展开

参数项	描述
Print_DiscoveryEvent event	打印机发现过程中的发现事件。
const Print_PrinterInfo *printerInfo	发现事件发生时的打印机信息。

Print_PrinterChangeCallback()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
typedef void (*Print_PrinterChangeCallback)(Print_PrinterEvent event, const Print_PrinterInfo *printerInfo)

描述

打印机变更回调。

起始版本： 12

参数：

展开

参数项	描述
Print_PrinterEvent event	打印服务运行期间的打印机变更事件。
const Print_PrinterInfo *printerInfo	变更事件发生时的打印机信息。

OH_Print_Init()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_Init()

描述

此 API 检查并拉起打印服务，初始化打印客户端，并建立与打印服务的连接。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。 PRINT_ERROR_SERVER_FAILURE cups 服务无法启动。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

PRINT_ERROR_SERVER_FAILURE cups 服务无法启动。

OH_Print_Release()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_Release()

描述

此 API 关闭与打印服务的连接，解散先前的回调，并释放打印客户端资源。

系统能力： SystemCapability.Print.PrintFramework

起始版本： 12

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。当前不会返回其他错误码。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

当前不会返回其他错误码。

OH_Print_StartPrinterDiscovery()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_StartPrinterDiscovery(Print_PrinterDiscoveryCallback callback)

描述

此 API 开始发现打印机。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

参数：

展开

参数项	描述
Print_PrinterDiscoveryCallback callback	打印机发现事件的 Print_PrinterDiscoveryCallback。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。 PRINT_ERROR_SERVER_FAILURE 从 BMS 查询打印扩展列表失败。 PRINT_ERROR_INVALID_EXTENSION 未找到可用的打印扩展。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

PRINT_ERROR_SERVER_FAILURE 从 BMS 查询打印扩展列表失败。

PRINT_ERROR_INVALID_EXTENSION 未找到可用的打印扩展。

OH_Print_StopPrinterDiscovery()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_StopPrinterDiscovery()

描述

此 API 停止发现打印机。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

OH_Print_ConnectPrinter()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_ConnectPrinter(const char *printerId)

描述

此 API 使用打印机 ID 连接打印机。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

参数：

展开

参数项	描述
const char *printerId	待连接的打印机 ID。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。 PRINT_ERROR_INVALID_PRINTER 打印机应在已发现的打印机列表中。 PRINT_ERROR_SERVER_FAILURE 无法找到负责该打印机的扩展。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

PRINT_ERROR_INVALID_PRINTER 打印机应在已发现的打印机列表中。

PRINT_ERROR_SERVER_FAILURE 无法找到负责该打印机的扩展。

OH_Print_StartPrintJob()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_StartPrintJob(const Print_PrintJob *printJob)

描述

此 API 开始发起打印任务。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

参数：

展开

参数项	描述
const Print_PrintJob *printJob	指向指定打印任务信息的 Print_PrintJob 实例的指针。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。 PRINT_ERROR_INVALID_PRINTER 打印机应在已连接的打印机列表中。 PRINT_ERROR_SERVER_FAILURE 无法在打印服务中创建打印任务。 PRINT_ERROR_INVALID_PRINT_JOB 无法在任务队列中找到该任务。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

PRINT_ERROR_INVALID_PRINTER 打印机应在已连接的打印机列表中。

PRINT_ERROR_SERVER_FAILURE 无法在打印服务中创建打印任务。

PRINT_ERROR_INVALID_PRINT_JOB 无法在任务队列中找到该任务。

OH_Print_RegisterPrinterChangeListener()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_RegisterPrinterChangeListener(Print_PrinterChangeCallback callback)

描述

此 API 注册打印机变更回调。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

参数：

展开

参数项	描述
Print_PrinterChangeCallback callback	待注册的 Print_PrinterChangeCallback。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

OH_Print_UnregisterPrinterChangeListener()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
void OH_Print_UnregisterPrinterChangeListener()

描述

此 API 注销打印机变更回调。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

OH_Print_QueryPrinterList()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_QueryPrinterList(Print_StringList *printerIdList)

描述

此 API 查询已添加的打印机列表。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

参数：

展开

参数项	描述
Print_StringList *printerIdList	用于存储查询到的打印机 ID 列表的 Print_StringList 实例指针。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_INVALID_PARAMETER printerIdList 为 NULL。 PRINT_ERROR_INVALID_PRINTER 无法查询任何已连接的打印机。 PRINT_ERROR_GENERIC_FAILURE 无法复制打印机 ID 列表。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_INVALID_PARAMETER printerIdList 为 NULL。

PRINT_ERROR_INVALID_PRINTER 无法查询任何已连接的打印机。

PRINT_ERROR_GENERIC_FAILURE 无法复制打印机 ID 列表。

OH_Print_ReleasePrinterList()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
void OH_Print_ReleasePrinterList(Print_StringList *printerIdList)

描述

此 API 释放用于查询的打印机列表内存。

系统能力： SystemCapability.Print.PrintFramework

起始版本： 12

参数：

展开

参数项	描述
Print_StringList *printerIdList	待释放的已查询打印机 ID 列表。

OH_Print_QueryPrinterInfo()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_QueryPrinterInfo(const char *printerId, Print_PrinterInfo **printerInfo)

描述

此 API 根据打印机 ID 查询打印机信息。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

参数：

展开

参数项	描述
const char *printerId	待查询的打印机 ID。
Print_PrinterInfo **printerInfo	用于存储打印机信息的 Print_PrinterInfo 指针的指针。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。 PRINT_ERROR_INVALID_PARAMETER printerId 为 NULL 或 printerInfo 为 NULL。 PRINT_ERROR_INVALID_PRINTER 无法在已连接的打印机列表中找到该打印机。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

PRINT_ERROR_INVALID_PARAMETER printerId 为 NULL 或 printerInfo 为 NULL。

PRINT_ERROR_INVALID_PRINTER 无法在已连接的打印机列表中找到该打印机。

OH_Print_ReleasePrinterInfo()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
void OH_Print_ReleasePrinterInfo(Print_PrinterInfo *printerInfo)

描述

此 API 释放用于查询的打印机信息内存。

系统能力： SystemCapability.Print.PrintFramework

起始版本： 12

参数：

展开

参数项	描述
Print_PrinterInfo *printerInfo	待释放的已查询打印机信息指针。

OH_Print_LaunchPrinterManager()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_LaunchPrinterManager()

描述

此 API 启动系统的打印机管理窗口。

系统能力： SystemCapability.Print.PrintFramework

起始版本： 12

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_GENERIC_FAILURE 无法启动打印机管理窗口。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_GENERIC_FAILURE 无法启动打印机管理窗口。

OH_Print_QueryPrinterProperties()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_QueryPrinterProperties(const char *printerId, const Print_StringList *propertyKeyList, Print_PropertyList *propertyList)

描述

此 API 根据属性关键字列表查询对应的打印机属性值。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

参数：

展开

参数项	描述
const char *printerId	待查询的打印机 ID。
const Print_StringList *propertyKeyList	待查询的属性关键字列表。
Print_PropertyList *propertyList	查询到的打印机属性值列表。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_INVALID_PARAMETER 参数之一为 NULL 或关键字列表为空。 PRINT_ERROR_INVALID_PRINTER 无法找到指定打印机的属性。 PRINT_ERROR_GENERIC_FAILURE 无法复制打印机属性。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_INVALID_PARAMETER 参数之一为 NULL 或关键字列表为空。

PRINT_ERROR_INVALID_PRINTER 无法找到指定打印机的属性。

PRINT_ERROR_GENERIC_FAILURE 无法复制打印机属性。

OH_Print_ReleasePrinterProperties()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
void OH_Print_ReleasePrinterProperties(Print_PropertyList *propertyList)

描述

此 API 释放用于查询的属性列表内存。

系统能力： SystemCapability.Print.PrintFramework

起始版本： 12

参数：

展开

参数项	描述
Print_PropertyList *propertyList	待释放的已查询打印机属性值指针。

OH_Print_UpdatePrinterProperties()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_UpdatePrinterProperties(const char *printerId, const Print_PropertyList *propertyList)

描述

此 API 根据属性键值对列表设置打印机属性。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

参数：

展开

参数项	描述
const char *printerId	待设置的打印机 ID。
const Print_PropertyList *propertyList	待设置的打印机属性值列表。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

OH_Print_RestorePrinterProperties()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_RestorePrinterProperties(const char *printerId, const Print_StringList *propertyKeyList)

描述

此 API 根据属性关键字列表将打印机属性恢复为默认设置。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 12

参数：

展开

参数项	描述
const char *printerId	待恢复的打印机 ID。
const Print_StringList *propertyKeyList	待恢复的属性关键字列表。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

OH_Print_StartPrintByNative()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_StartPrintByNative(const char *printJobName, Print_PrintDocCallback printDocCallback, void *context)

描述

此 API 提供启动打印对话框的能力。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 13

参数：

展开

参数项	描述
const char *printJobName	此打印任务的名称。
Print_PrintDocCallback printDocCallback	打印文档状态回调。
void *context	调用方应用的上下文。

返回：

展开

类型	说明
Print_ErrorCode	返回 PRINT_ERROR_NONE 表示执行成功。 PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。 PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

类型

说明

Print_ErrorCode

返回 PRINT_ERROR_NONE 表示执行成功。

PRINT_ERROR_NO_PERMISSION 需要 ohos.permission.PRINT 权限。

PRINT_ERROR_RPC_FAILURE 无法连接到打印服务。

OH_Print_OnJobStateChanged()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
typedef void(*OH_Print_OnJobStateChanged)(const char *jobId, OH_Print_JobState state)

描述

打印任务状态回调。

起始版本： 24

参数：

展开

参数项	描述
const char *jobId	打印任务的ID。
OH_Print_JobState state	当前打印任务的状态。

OH_Print_StartPrintWithJobStateCallback()

PhonePC/2in1Tablet

收起
自动换行
深色代码主题
复制
Print_ErrorCode OH_Print_StartPrintWithJobStateCallback(const Print_PrintJob *printJob, OH_Print_OnJobStateChanged jobStateChangedCb)

描述

此API下发打印任务，并附带任务状态变更回调功能。

系统能力： SystemCapability.Print.PrintFramework

需要权限： ohos.permission.PRINT

起始版本： 24

参数：

展开

参数项	描述
const Print_PrintJob *printJob	打印任务结构体。
OH_Print_OnJobStateChanged jobStateChangedCb	打印任务状态回调。

返回：

展开

名称	值	说明
PRINT_ERROR_NONE	0	执行成功。
PRINT_ERROR_NO_PERMISSION	201	需要 ohos.permission.PRINT 权限。
PRINT_ERROR_INVALID_PARAMETER	401	参数之一为NULL或关键字列表为空。
PRINT_ERROR_GENERIC_FAILURE	24300001	无法复制回调函数。
PRINT_ERROR_RPC_FAILURE	24300002	无法连接到打印服务。
PRINT_ERROR_SERVER_FAILURE	24300003	打印服务中无法创建打印任务结构体。
PRINT_ERROR_INVALID_PRINTER	24300005	无法找到指定打印机的属性。
PRINT_ERROR_INVALID_PRINT_JOB	24300006	无法在任务队列中找到该任务。

os_account_common.h

ohscan.h

意见反馈

以上内容对您是否有帮助？

意见反馈

如果您有其他疑问，您也可以通过开发者社区问答频道来和我们联系探讨。

社区提问智能客服提问