1"use strict";(self.webpackChunkelectronjs=self.webpackChunkelectronjs||[]).push([["15651"],{99733(e,n,t){t.r(n),t.d(n,{metadata:()=>r,default:()=>d,frontMatter:()=>o,contentTitle:()=>a,toc:()=>c,assets:()=>l});var r=JSON.parse('{"id":"latest/api/structures/printer-info","title":"PrinterInfo Object","description":"","source":"@site/docs/latest/api/structures/printer-info.md","sourceDirName":"latest/api/structures","slug":"/latest/api/structures/printer-info","permalink":"/docs/latest/api/structures/printer-info","draft":false,"unlisted":false,"editUrl":"https://github.com/electron/electron/edit/main/docs/api/structures/printer-info.md","tags":[],"version":"current","frontMatter":{"title":"PrinterInfo Object","description":"","slug":"printer-info","hide_title":false},"sidebar":"api","previous":{"title":"PrintToPDFOptions Object","permalink":"/docs/latest/api/structures/print-to-pdf-options"},"next":{"title":"ProcessMemoryInfo Object","permalink":"/docs/latest/api/structures/process-memory-info"}}'),i=t(74848),s=t(28453);let o={title:"PrinterInfo Object",description:"",slug:"printer-info",hide_title:!1},a="PrinterInfo Object",l={},c=[{value:"Example",id:"example",level:2}];function p(e){let n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"printerinfo-object",children:"PrinterInfo Object"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"name"})," string - the name of the printer as understood by the OS."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"displayName"})," string - the name of the printer as shown in Print Preview."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"description"})," string - a longer description of the printer's type."]}),"\n",(0,i.jsxs)(n.li,{className:"electron-api-options-list",children:[(0,i.jsx)(n.code,{children:"options"}
1)," Object - an object containing a variable number of platform-specific printer information."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The number represented by ",(0,i.jsx)(n.code,{children:"status"})," means different things on different platforms: on Windows its potential values can be found ",(0,i.jsx)(n.a,{href:"https://learn.microsoft.com/en-us/windows/win32/printdocs/printer-info-2",children:"here"}),", and on Linux and macOS they can be found ",(0,i.jsx)(n.a,{href:"https://www.cups.org/doc/cupspm.html",children:"here"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(n.p,{children:"Below is an example of some of the additional options that may be set which\nmay be different on each platform."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json5",children:"{\n name: 'Austin_4th_Floor_Printer___C02XK13BJHD4',\n displayName: 'Austin 4th Floor Printer @ C02XK13BJHD4',\n description: 'TOSHIBA ColorMFP',\n options: {\n copies: '1',\n 'device-uri': 'dnssd://Austin%204th%20Floor%20Printer%20%40%20C02XK13BJHD4._ipps._tcp.local./?uuid=71687f1e-1147-3274-6674-22de61b110bd',\n finishings: '3',\n 'job-cancel-after': '10800',\n 'job-hold-until': 'no-hold',\n 'job-priority': '50',\n 'job-sheets': 'none,none',\n 'marker-change-time': '0',\n 'number-up': '1',\n 'printer-commands': 'ReportLevels,PrintSelfTestPage,com.toshiba.ColourProfiles.update,com.toshiba.EFiling.update,com.toshiba.EFiling.checkPassword',\n 'printer-info': 'Austin 4th Floor Printer @ C02XK13BJHD4',\n 'printer-is-accepting-jobs': 'true',\n 'printer-is-shared': 'false',\n 'printer-is-temporary': 'false',\n 'printer-location': '',\n 'printer-make-and-model': 'TOSHIBA ColorMFP',\n 'printer-state': '3',\n 'printer-state-change-time': '1573472937',\n 'printer-state-reasons': 'offline-report,com.toshiba.snmp.failed',\n 'printer-type': '10531038',\n 'printer-uri-supported': 'ipp://localhost/printers/Austin_4th_Floor_Printer___C02XK13BJHD4',\n system_driverinfo: 'T'\n }\n}\n"})})]})}function d(e={}){let{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},28453(e,n,t){t.d(n,{R:()=>o,x:()=>a});var r=t(96540);let i={},s=r.createContext(i);function o(e){let n=r.useContext(s);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.