harmony 鸿蒙ohprint.h

2025-06-12
浏览 (4)

ohprint.h

概述

声明用于发现和连接打印机、从打印机打印文件、查询已添加打印机的列表及其中的打印机信息等API。

库： libohprint.so \@kit BasicServicesKit

系统能力： SystemCapability.Print.PrintFramework

起始版本： 12

相关模块：OH_Print

汇总

结构体

名称	描述
struct Print_Margin	打印边距。
struct Print_PageSize	纸张大小信息。
struct Print_Range	打印范围。
struct Print_PrintAttributes	打印属性结构体。
struct Print_PrintDocCallback	打印文档任务回调结构体。

类型定义

名称	描述
typedef void(* Print_WriteResultCallback) (const char *jobId, uint32_t code)	文件回写回调。
typedef void(* Print_OnStartLayoutWrite) (const char jobId, uint32_t fd, const Print_PrintAttributes oldAttrs, const Print_PrintAttributes *newAttrs, Print_WriteResultCallback writeCallback)	文件开始回写回调函数。
typedef void(* Print_OnJobStateChanged) (const char *jobId, uint32_t state)	打印任务状态回调。

枚举

名称	描述
Print_ErrorCode { PRINT_ERROR_NONE = 0, PRINT_ERROR_NO_PERMISSION = 201, PRINT_ERROR_INVALID_PARAMETER = 401, PRINT_ERROR_GENERIC_FAILURE = 24300001, PRINT_ERROR_RPC_FAILURE = 24300002, 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_JobDocAdapterState { 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 }	打印文档任务的状态。

名称

描述

Print_ErrorCode {
PRINT_ERROR_NONE = 0, PRINT_ERROR_NO_PERMISSION = 201, PRINT_ERROR_INVALID_PARAMETER = 401, PRINT_ERROR_GENERIC_FAILURE = 24300001,
PRINT_ERROR_RPC_FAILURE = 24300002, 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_JobDocAdapterState {
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
}

打印文档任务的状态。

函数

名称	描述
Print_ErrorCode OH_Print_StartPrintByNative (const char printJobName, Print_PrintDocCallback printDocCallback, void context)	拉起打印预览界面接口。