---
name: "kysdk_Print"
section: "3"
platform: "linux"
package: "libkysdk-system"
version: "3.0.1.4-1"
release: "Arch Linux 2026-11-07"
platforms: ["linux"]
url: "https://carta.tech/man/kysdk_Print"
---

# kysdk\_Print(3)

获取打印信息 主要用来生成本地的所有打印机(包含可用打印机和不可用打印机)、获取本地的所有可用打印机(打印机处于idle状态)、 设置打印参数，每次设置会清除之前设置打印参数,这个设置是全局设置，设置了之后所有打印机都会用这个参数进行打印、 下载网络文件、打印本地文件、清除某个打印机的所有打印队列、获取当前打印机状态(状态不是实时更新)、 获取当前打印任务状态（发送打印任务之后下需要等待一会再获取状态,状态不是实时更新）、获取url内的文件名

## NAME

kysdk.Print - 获取打印信息 主要用来生成本地的所有打印机(包含可用打印机和不可用打印机)、获取本地的所有可用打印机(打印机处于idle状态)、 设置打印参数，每次设置会清除之前设置打印参数,这个设置是全局设置，设置了之后所有打印机都会用这个参数进行打印、 下载网络文件、打印本地文件、清除某个打印机的所有打印队列、获取当前打印机状态(状态不是实时更新)、 获取当前打印任务状态（发送打印任务之后下需要等待一会再获取状态,状态不是实时更新）、获取url内的文件名

## SYNOPSIS

Inherits **kysdk.Base**.

### Public Member Functions

def **\_\_init\_\_** (self)\
 def **getPrinterList** (self)\
 获取本地的所有打印机(包含可用打印机和不可用打印机)  def **getPrinterAvailableList** (self)\
 获取本地的所有可用打印机(打印机处于idle状态)  def **setPrinterOptions** (self, num, paper\_type, cups, option)\
 设置打印参数，每次设置会清除之前设置打印参数,这个设置是全局设置，设置了之后所有打印机都会用这个参数进行打印  def **getPrinterPrintLocalFile** (self, print\_name, file\_path)\
 打印本地文件  def **getPrinterCancelAllJobs** (self, print\_name)\
 清除某个打印机的所有打印队列  def **getPrinterStatus** (self, print\_name)\
 获取当前打印机状态(状态不是实时更新)  def **getPrinterFilename** (self, url)\
 获取url内的文件名  def **getPrinterJobStatus** (self, print\_name, jobid)\
 获取当前打印任务状态（发送打印任务之后下需要等待一会再获取状态,状态不是实时更新）  def **getPrinterDownloadRemoteFile** (self, url, path)\
 下载网络文件

### Additional Inherited Members

## Detailed Description

获取打印信息 主要用来生成本地的所有打印机(包含可用打印机和不可用打印机)、获取本地的所有可用打印机(打印机处于idle状态)、 设置打印参数，每次设置会清除之前设置打印参数,这个设置是全局设置，设置了之后所有打印机都会用这个参数进行打印、 下载网络文件、打印本地文件、清除某个打印机的所有打印队列、获取当前打印机状态(状态不是实时更新)、 获取当前打印任务状态（发送打印任务之后下需要等待一会再获取状态,状态不是实时更新）、获取url内的文件名

## Member Function Documentation

### def kysdk.Print.getPrinterAvailableList ( self)

获取本地的所有可用打印机(打印机处于idle状态)

**Returns**

本地的所有可用打印机名称列表

References kysdk.SessionBase.interface, and kysdk.Base.interface.

### def kysdk.Print.getPrinterCancelAllJobs ( self, print\_name)

清除某个打印机的所有打印队列

**Parameters**

*print\_name* 打印机名

**Returns**

成功返回0,失败返回-1

References kysdk.SessionBase.interface, and kysdk.Base.interface.

### def kysdk.Print.getPrinterDownloadRemoteFile ( self, url, path)

下载网络文件

**Parameters**

*url* 要打印的url \
 *path* 保存的文件路径

**Returns**

打印作业的id

References kysdk.SessionBase.interface, and kysdk.Base.interface.

### def kysdk.Print.getPrinterFilename ( self, url)

获取url内的文件名

**Parameters**

*url* 路径

**Returns**

解析出来的函数名

References kysdk.SessionBase.interface, and kysdk.Base.interface.

### def kysdk.Print.getPrinterJobStatus ( self, print\_name, jobid)

获取当前打印任务状态（发送打印任务之后下需要等待一会再获取状态,状态不是实时更新）

**Parameters**

*print\_name* 打印机名 \
 *jobid* 打印作业的id

**Returns**

状态码

References kysdk.SessionBase.interface, and kysdk.Base.interface.

### def kysdk.Print.getPrinterList ( self)

获取本地的所有打印机(包含可用打印机和不可用打印机)

**Returns**

地的所有打印机名称列表

References kysdk.SessionBase.interface, and kysdk.Base.interface.

### def kysdk.Print.getPrinterPrintLocalFile ( self, print\_name, file\_path)

打印本地文件

**Parameters**

*print\_name* 打印机名 \
 *file\_path* 文件绝对路径

**Returns**

打印作业的id

@notice 虽然支持多种格式的打印，但是打印除pdf之外的格式打印的效果都不够好，建议打印pdf格式的文件 打印机处于stop状态函数返回0 格式不对的文件可以成功创建打印任务，但是打印不出来。什么叫格式不对，举个例子，比如当前要打印日志文件a.log, 然后把a.log改名叫a.pdf,这个时候a.pdf就变成了格式不对的文件，打印不出来了

References kysdk.SessionBase.interface, and kysdk.Base.interface.

### def kysdk.Print.getPrinterStatus ( self, print\_name)

获取当前打印机状态(状态不是实时更新)

**Parameters**

*print\_name* 打印机名

**Returns**

状态码

References kysdk.SessionBase.interface, and kysdk.Base.interface.

### def kysdk.Print.setPrinterOptions ( self, num, paper\_type, cups, option)

设置打印参数，每次设置会清除之前设置打印参数,这个设置是全局设置，设置了之后所有打印机都会用这个参数进行打印

**Parameters**

*num* cups属性，一张纸打印几页，如2 4等 \
 *paper\_type* cups属性，纸张类型，如A4 \
 *cups* cups属性，如lrtb \
 *option* cups属性，单面如one-sided，双面如two-sided-long-edge(长边翻转),two-sided-short-edge(短边翻转)

References kysdk.SessionBase.interface, and kysdk.Base.interface.

## Author

Generated automatically by Doxygen for kysdk.py from the source code.
