doc/help/api-ppd.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <!-- SECTION: Programming -->
   4 <head>
   5         <title>PPD API  </title>
   6         <meta name="keywords" content="Programming">
   7         <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
   8         <meta name="creator" content="Mini-XML v2.7">
   9 <style type="text/css"><!--
  10 BODY {
  11   font-family: lucida grande, geneva, helvetica, arial, sans-serif;
  12 }
  13
  14 H1, H2, H3, H4, H5, H6, P, TD, TH {
  15   font-family: lucida grande, geneva, helvetica, arial, sans-serif;
  16 }
  17
  18 KBD {
  19   font-family: monaco, courier, monospace;
  20   font-weight: bold;
  21 }
  22
  23 PRE {
  24   font-family: monaco, courier, monospace;
  25 }
  26
  27 PRE.command {
  28   border: dotted thin #7f7f7f;
  29   margin-left: 36pt;
  30   padding: 10px;
  31 }
  32
  33 P.compact {
  34   margin: 0;
  35 }
  36
  37 P.example {
  38   font-style: italic;
  39   margin-left: 36pt;
  40 }
  41
  42 PRE.example {
  43   background: #eeeeee;
  44   border: dotted thin #999999;
  45   margin-left: 36pt;
  46   padding: 10pt;
  47 }
  48
  49 PRE.command EM, PRE.example EM {
  50   font-family: lucida grande, geneva, helvetica, arial, sans-serif;
  51 }
  52
  53 P.command {
  54   font-family: monaco, courier, monospace;
  55   margin-left: 36pt;
  56 }
  57
  58 P.formula {
  59   font-style: italic;
  60   margin-left: 36pt;
  61 }
  62
  63 BLOCKQUOTE {
  64   background: #eeeeee;
  65   border: solid thin #999999;
  66   padding: 10pt;
  67 }
  68
  69 A IMG {
  70   border: none;
  71 }
  72
  73 A:link:hover IMG {
  74   background: #f0f0f0;
  75   border-radius: 10px;
  76   -moz-border-radius: 10px;
  77 }
  78
  79 A:link, A:visited {
  80   font-weight: normal;
  81   text-decoration: none;
  82 }
  83
  84 A:link:hover, A:visited:hover, A:active {
  85   text-decoration: underline;
  86 }
  87
  88 SUB, SUP {
  89   font-size: 50%;
  90 }
  91
  92 TR.data, TD.data, TR.data TD {
  93   margin-top: 10pt;
  94   padding: 5pt;
  95   border-bottom: solid 1pt #999999;
  96 }
  97
  98 TR.data TH {
  99   border-bottom: solid 1pt #999999;
 100   padding-top: 10pt;
 101   padding-left: 5pt;
 102   text-align: left;
 103 }
 104
 105 DIV.table TABLE {
 106   border: solid thin #999999;
 107   border-collapse: collapse;
 108   border-spacing: 0;
 109   margin-left: auto;
 110   margin-right: auto;
 111 }
 112
 113 DIV.table CAPTION {
 114   caption-side: top;
 115   font-size: 120%;
 116   font-style: italic;
 117   font-weight: bold;
 118   margin-left: auto;
 119   margin-right: auto;
 120 }
 121
 122 DIV.table TABLE TD {
 123   border: solid thin #cccccc;
 124   padding-top: 5pt;
 125 }
 126
 127 DIV.table TABLE TH {
 128   background: #cccccc;
 129   border: none;
 130   border-bottom: solid thin #999999;
 131 }
 132
 133 DIV.figure TABLE {
 134   margin-left: auto;
 135   margin-right: auto;
 136 }
 137
 138 DIV.figure CAPTION {
 139   caption-side: bottom;
 140   font-size: 120%;
 141   font-style: italic;
 142   font-weight: bold;
 143   margin-left: auto;
 144   margin-right: auto;
 145 }
 146
 147 TH.label {
 148   text-align: right;
 149   vertical-align: top;
 150 }
 151
 152 TH.sublabel {
 153   text-align: right;
 154   font-weight: normal;
 155 }
 156
 157 HR {
 158   border: solid thin;
 159 }
 160
 161 SPAN.info {
 162   background: black;
 163   border: thin solid black;
 164   color: white;
 165   font-size: 80%;
 166   font-style: italic;
 167   font-weight: bold;
 168   white-space: nowrap;
 169 }
 170
 171 H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
 172   float: right;
 173   font-size: 100%;
 174 }
 175
 176 H1.title {
 177 }
 178
 179 H2.title, H3.title {
 180   border-bottom: solid 2pt #000000;
 181 }
 182
 183 DIV.indent, TABLE.indent {
 184   margin-top: 2em;
 185   margin-left: auto;
 186   margin-right: auto;
 187   width: 90%;
 188 }
 189
 190 TABLE.indent {
 191   border-collapse: collapse;
 192 }
 193
 194 TABLE.indent TD, TABLE.indent TH {
 195   padding: 0;
 196 }
 197
 198 TABLE.list {
 199   border-collapse: collapse;
 200   margin-left: auto;
 201   margin-right: auto;
 202   width: 90%;
 203 }
 204
 205 TABLE.list TH {
 206   background: white;
 207   border-bottom: solid thin #cccccc;
 208   color: #444444;
 209   padding-top: 10pt;
 210   padding-left: 5pt;
 211   text-align: left;
 212   vertical-align: bottom;
 213   white-space: nowrap;
 214 }
 215
 216 TABLE.list TH A {
 217   color: #4444cc;
 218 }
 219
 220 TABLE.list TD {
 221   border-bottom: solid thin #eeeeee;
 222   padding-top: 5pt;
 223   padding-left: 5pt;
 224 }
 225
 226 TABLE.list TR:nth-child(even) {
 227   background: #f8f8f8;
 228 }
 229
 230 TABLE.list TR:nth-child(odd) {
 231   background: #f4f4f4;
 232 }
 233
 234 DT {
 235   margin-left: 36pt;
 236   margin-top: 12pt;
 237 }
 238
 239 DD {
 240   margin-left: 54pt;
 241 }
 242
 243 DL.category DT {
 244   font-weight: bold;
 245 }
 246
 247 P.summary {
 248   margin-left: 36pt;
 249   font-family: monaco, courier, monospace;
 250 }
 251
 252 DIV.summary TABLE {
 253   border: solid thin #999999;
 254   border-collapse: collapse;
 255   border-spacing: 0;
 256   margin: 10px;
 257 }
 258
 259 DIV.summary TABLE TD, DIV.summary TABLE TH {
 260   border: solid thin #999999;
 261   padding: 5px;
 262   text-align: left;
 263   vertical-align: top;
 264 }
 265
 266 DIV.summary TABLE THEAD TH {
 267   background: #eeeeee;
 268 }
 269
 270 /* API documentation styles... */
 271 div.body h1 {
 272   margin: 0;
 273 }
 274 div.body h2 {
 275   margin-top: 1.5em;
 276 }
 277 div.body h3, div.body h4, div.body h5 {
 278   margin-bottom: 0.5em;
 279   margin-top: 1.5em;
 280 }
 281 .class, .enumeration, .function, .struct, .typedef, .union {
 282   border-bottom: solid thin #999999;
 283   margin-bottom: 0;
 284   margin-top: 2em;
 285 }
 286 .description {
 287   margin-top: 0.5em;
 288 }
 289 code, p.code, pre, ul.code li {
 290   font-family: monaco, courier, monospace;
 291   font-size: 90%;
 292 }
 293 ul.code, ul.contents, ul.subcontents {
 294   list-style-type: none;
 295   margin: 0;
 296   padding-left: 0;
 297 }
 298 ul.code li {
 299   margin: 0;
 300 }
 301 ul.contents > li {
 302   margin-top: 1em;
 303 }
 304 ul.contents li ul.code, ul.contents li ul.subcontents {
 305   padding-left: 2em;
 306 }
 307 div.body dl {
 308   margin-left: 0;
 309   margin-top: 0;
 310 }
 311 div.body dt {
 312   font-style: italic;
 313   margin-left: 0;
 314   margin-top: 0;
 315 }
 316 div.body dd {
 317   margin-bottom: 0.5em;
 318 }
 319
 320 /* This is just for the HTML files generated with the framedhelp target */
 321 div.contents {
 322   background: #e8e8e8;
 323   border: solid thin black;
 324   padding: 10px;
 325 }
 326 div.contents h1 {
 327   font-size: 110%;
 328 }
 329 div.contents h2 {
 330   font-size: 100%;
 331 }
 332 div.contents ul.contents {
 333   font-size: 80%;
 334 }
 335 div.contents ul.subcontents li {
 336   margin-left: 1em;
 337   text-indent: -1em;
 338 }
 339 --></style>
 340 </head>
 341 <body>
 342 <div class='body'>
 343 <!--
 344   "$Id$"
 345
 346   PPD API header for CUPS.
 347
 348   Copyright 2008-2011 by Apple Inc.
 349
 350   These coded instructions, statements, and computer programs are the
 351   property of Apple Inc. and are protected by Federal copyright
 352   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 353   which should have been included with this file.  If this file is
 354   file is missing or damaged, see the license at "http://www.cups.org/".
 355 -->
 356
 357 <h1 class='title'>PPD API</h1>
 358
 359 <div class='summary'><table summary='General Information'>
 360 <thead>
 361 <tr>
 362         <th>Header</th>
 363         <th>cups/ppd.h</th>
 364 </tr>
 365 </thead>
 366 <tbody>
 367 <tr>
 368         <th>Library</th>
 369         <td>-lcups</td>
 370 </tr>
 371 <tr>
 372         <th>See Also</th>
 373         <td>Programming: <a href='api-overview.html' target='_top'>Introduction to CUPS Programming</a><br>
 374         Programming: <a href='api-cups.html' target='_top'>CUPS API</a><br>
 375         Specifications: <a href='spec-ppd.html' target='_top'>CUPS PPD Extensions</a></td>
 376 </tr>
 377 </tbody>
 378 </table></div>
 379 <h2 class="title">Contents</h2>
 380 <ul class="contents">
 381 <li><a href="#OVERVIEW">Overview</a><ul class="subcontents">
 382         <li><a href="#LOADING">Loading a PPD File</a></li>
 383         <li><a href="#OPTIONS_AND_GROUPS">Options and Groups</a></li>
 384         <li><a href="#CONSTRAINTS">Constraints</a></li>
 385         <li><a href="#PAGE_SIZES">Page Sizes</a></li>
 386         <li><a href="#ATTRIBUTES">Attributes</a></li>
 387 </ul></li>
 388 <li><a href="#FUNCTIONS">Functions</a><ul class="code">
 389         <li><a href="#cupsGetConflicts" title="Get a list of conflicting options in a marked PPD.">cupsGetConflicts</a></li>
 390         <li><a href="#cupsMarkOptions" title="Mark command-line options in a PPD file.">cupsMarkOptions</a></li>
 391         <li><a href="#cupsResolveConflicts" title="Resolve conflicts in a marked PPD.">cupsResolveConflicts</a></li>
 392         <li><a href="#ppdClose" title="Free all memory used by the PPD file.">ppdClose</a></li>
 393         <li><a href="#ppdCollect" title="Collect all marked options that reside in the specified
 394 section.">ppdCollect</a></li>
 395         <li><a href="#ppdCollect2" title="Collect all marked options that reside in the
 396 specified section and minimum order.">ppdCollect2</a></li>
 397         <li><a href="#ppdConflicts" title="Check to see if there are any conflicts among the
 398 marked option choices.">ppdConflicts</a></li>
 399         <li><a href="#ppdEmit" title="Emit code for marked options to a file.">ppdEmit</a></li>
 400         <li><a href="#ppdEmitAfterOrder" title="Emit a subset of the code for marked options to a file.">ppdEmitAfterOrder</a></li>
 401         <li><a href="#ppdEmitFd" title="Emit code for marked options to a file.">ppdEmitFd</a></li>
 402         <li><a href="#ppdEmitJCL" title="Emit code for JCL options to a file.">ppdEmitJCL</a></li>
 403         <li><a href="#ppdEmitJCLEnd" title="Emit JCLEnd code to a file.">ppdEmitJCLEnd</a></li>
 404         <li><a href="#ppdEmitString" title="Get a string containing the code for marked options.">ppdEmitString</a></li>
 405         <li><a href="#ppdErrorString" title="Returns the text assocated with a status.">ppdErrorString</a></li>
 406         <li><a href="#ppdFindAttr" title="Find the first matching attribute.">ppdFindAttr</a></li>
 407         <li><a href="#ppdFindChoice" title="Return a pointer to an option choice.">ppdFindChoice</a></li>
 408         <li><a href="#ppdFindCustomOption" title="Find a custom option.">ppdFindCustomOption</a></li>
 409         <li><a href="#ppdFindCustomParam" title="Find a parameter for a custom option.">ppdFindCustomParam</a></li>
 410         <li><a href="#ppdFindMarkedChoice" title="Return the marked choice for the specified option.">ppdFindMarkedChoice</a></li>
 411         <li><a href="#ppdFindNextAttr" title="Find the next matching attribute.">ppdFindNextAttr</a></li>
 412         <li><a href="#ppdFindOption" title="Return a pointer to the specified option.">ppdFindOption</a></li>
 413         <li><a href="#ppdFirstCustomParam" title="Return the first parameter for a custom option.">ppdFirstCustomParam</a></li>
 414         <li><a href="#ppdFirstOption" title="Return the first option in the PPD file.">ppdFirstOption</a></li>
 415         <li><a href="#ppdInstallableConflict" title="Test whether an option choice conflicts with
 416 an installable option.">ppdInstallableConflict</a></li>
 417         <li><a href="#ppdIsMarked" title="Check to see if an option is marked.">ppdIsMarked</a></li>
 418         <li><a href="#ppdLastError" title="Return the status from the last ppdOpen*().">ppdLastError</a></li>
 419         <li><a href="#ppdLocalize" title="Localize the PPD file to the current locale.">ppdLocalize</a></li>
 420         <li><a href="#ppdLocalizeAttr" title="Localize an attribute.">ppdLocalizeAttr</a></li>
 421         <li><a href="#ppdLocalizeIPPReason" title="Get the localized version of a cupsIPPReason
 422 attribute.">ppdLocalizeIPPReason</a></li>
 423         <li><a href="#ppdLocalizeMarkerName" title="Get the localized version of a marker-names
 424 attribute value.">ppdLocalizeMarkerName</a></li>
 425         <li><a href="#ppdMarkDefaults" title="Mark all default options in the PPD file.">ppdMarkDefaults</a></li>
 426         <li><a href="#ppdMarkOption" title="Mark an option in a PPD file and return the number of
 427 conflicts.">ppdMarkOption</a></li>
 428         <li><a href="#ppdNextCustomParam" title="Return the next parameter for a custom option.">ppdNextCustomParam</a></li>
 429         <li><a href="#ppdNextOption" title="Return the next option in the PPD file.">ppdNextOption</a></li>
 430         <li><a href="#ppdOpen" title="Read a PPD file into memory.">ppdOpen</a></li>
 431         <li><a href="#ppdOpen2" title="Read a PPD file into memory.">ppdOpen2</a></li>
 432         <li><a href="#ppdOpenFd" title="Read a PPD file into memory.">ppdOpenFd</a></li>
 433         <li><a href="#ppdOpenFile" title="Read a PPD file into memory.">ppdOpenFile</a></li>
 434         <li><a href="#ppdPageLength" title="Get the page length for the given size.">ppdPageLength</a></li>
 435         <li><a href="#ppdPageSize" title="Get the page size record for the given size.">ppdPageSize</a></li>
 436         <li><a href="#ppdPageSizeLimits" title="Return the custom page size limits.">ppdPageSizeLimits</a></li>
 437         <li><a href="#ppdPageWidth" title="Get the page width for the given size.">ppdPageWidth</a></li>
 438         <li><a href="#ppdSetConformance" title="Set the conformance level for PPD files.">ppdSetConformance</a></li>
 439 </ul></li>
 440 <li><a href="#TYPES">Data Types</a><ul class="code">
 441         <li><a href="#ppd_attr_t" title="PPD Attribute Structure ">ppd_attr_t</a></li>
 442         <li><a href="#ppd_choice_t" title="Option choices">ppd_choice_t</a></li>
 443         <li><a href="#ppd_conform_t" title="Conformance Levels ">ppd_conform_t</a></li>
 444         <li><a href="#ppd_const_t" title="Constraints">ppd_const_t</a></li>
 445         <li><a href="#ppd_coption_t" title="Custom Option ">ppd_coption_t</a></li>
 446         <li><a href="#ppd_cparam_t" title="Custom Parameter ">ppd_cparam_t</a></li>
 447         <li><a href="#ppd_cplimit_t" title="Custom Parameter Limit ">ppd_cplimit_t</a></li>
 448         <li><a href="#ppd_cptype_t" title="Custom Parameter Type ">ppd_cptype_t</a></li>
 449         <li><a href="#ppd_cpvalue_t" title="Custom Parameter Value ">ppd_cpvalue_t</a></li>
 450         <li><a href="#ppd_cs_t" title="Colorspaces">ppd_cs_t</a></li>
 451         <li><a href="#ppd_emul_t" title="Emulators">ppd_emul_t</a></li>
 452         <li><a href="#ppd_file_t" title="PPD File">ppd_file_t</a></li>
 453         <li><a href="#ppd_group_t" title="Groups">ppd_group_t</a></li>
 454         <li><a href="#ppd_option_t" title="Options">ppd_option_t</a></li>
 455         <li><a href="#ppd_profile_t" title="sRGB Color Profiles">ppd_profile_t</a></li>
 456         <li><a href="#ppd_section_t" title="Order dependency sections">ppd_section_t</a></li>
 457         <li><a href="#ppd_size_t" title="Page Sizes">ppd_size_t</a></li>
 458         <li><a href="#ppd_status_t" title="Status Codes ">ppd_status_t</a></li>
 459         <li><a href="#ppd_ui_t" title="UI Types">ppd_ui_t</a></li>
 460 </ul></li>
 461 <li><a href="#STRUCTURES">Structures</a><ul class="code">
 462         <li><a href="#ppd_attr_s" title="PPD Attribute Structure ">ppd_attr_s</a></li>
 463         <li><a href="#ppd_choice_s" title="Option choices">ppd_choice_s</a></li>
 464         <li><a href="#ppd_const_s" title="Constraints">ppd_const_s</a></li>
 465         <li><a href="#ppd_coption_s" title="Custom Option ">ppd_coption_s</a></li>
 466         <li><a href="#ppd_cparam_s" title="Custom Parameter ">ppd_cparam_s</a></li>
 467         <li><a href="#ppd_emul_s" title="Emulators">ppd_emul_s</a></li>
 468         <li><a href="#ppd_file_s" title="PPD File">ppd_file_s</a></li>
 469         <li><a href="#ppd_group_s" title="Groups">ppd_group_s</a></li>
 470         <li><a href="#ppd_option_s" title="Options">ppd_option_s</a></li>
 471         <li><a href="#ppd_profile_s" title="sRGB Color Profiles">ppd_profile_s</a></li>
 472         <li><a href="#ppd_size_s" title="Page Sizes">ppd_size_s</a></li>
 473 </ul></li>
 474 <li><a href="#UNIONS">Unions</a><ul class="code">
 475         <li><a href="#ppd_cplimit_u" title="Custom Parameter Limit ">ppd_cplimit_u</a></li>
 476         <li><a href="#ppd_cpvalue_u" title="Custom Parameter Value ">ppd_cpvalue_u</a></li>
 477 </ul></li>
 478 <li><a href="#ENUMERATIONS">Constants</a><ul class="code">
 479         <li><a href="#ppd_conform_e" title="Conformance Levels ">ppd_conform_e</a></li>
 480         <li><a href="#ppd_cs_e" title="Colorspaces">ppd_cs_e</a></li>
 481         <li><a href="#ppd_section_e" title="Order dependency sections">ppd_section_e</a></li>
 482         <li><a href="#ppd_status_e" title="Status Codes ">ppd_status_e</a></li>
 483         <li><a href="#ppd_ui_e" title="UI Types">ppd_ui_e</a></li>
 484 </ul></li>
 485 </ul>
 486 <!--
 487   "$Id$"
 488
 489   PPD API introduction for CUPS.
 490
 491   Copyright 2007-2011 by Apple Inc.
 492   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 493
 494   These coded instructions, statements, and computer programs are the
 495   property of Apple Inc. and are protected by Federal copyright
 496   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 497   which should have been included with this file.  If this file is
 498   file is missing or damaged, see the license at "http://www.cups.org/".
 499 -->
 500
 501 <h2 class='title'><a name='OVERVIEW'>Overview</a></h2>
 502
 503 <p>The CUPS PPD API provides read-only access the data in PostScript Printer
 504 Description ("PPD") files which are used for all printers with a driver. With
 505 it you can obtain the data necessary to display printer options to users, mark
 506 option choices and check for conflicting choices, and output marked choices in
 507 PostScript output. The <a href="#ppd_file_t"><code>ppd_file_t</code></a>
 508 structure contains all of the information in a PPD file.</p>
 509
 510 <blockquote><b>Note:</b>
 511
 512 <p>The CUPS PPD API uses the terms "option" and "choice" instead of the Adobe
 513 terms "MainKeyword" and "OptionKeyword" to refer to specific printer options and
 514 features. CUPS also treats option ("MainKeyword") and choice ("OptionKeyword")
 515 values as case-insensitive strings, so option "InputSlot" and choice "Upper"
 516 are equivalent to "inputslot" and "upper", respectively.</p>
 517 </blockquote>
 518
 519 <h3><a name="LOADING">Loading a PPD File</a></h3>
 520
 521 <p>The <a href="#ppdOpenFile"><code>ppdOpenFile</code></a> function "opens" a
 522 PPD file and loads it into memory. For example, the following code opens the
 523 current printer's PPD file in a CUPS filter:</p>
 524
 525 <pre class="example">
 526 #include &lt;cups/ppd.h&gt;
 527
 528 <a href="#ppd_file_t">ppd_file_t</a> *ppd = <a href="#ppdOpenFile">ppdOpenFile</a>(getenv("PPD"));
 529 </pre>
 530
 531 <p>The return value is a pointer to a new
 532 <a href="#ppd_file_t"><code>ppd_file_t</code></a> structure or <code>NULL</code>
 533 if the PPD file does not exist or cannot be loaded. The
 534 <a href="#ppdClose"><code>ppdClose</code></a> function frees the memory used
 535 by the structure:</p>
 536
 537 <pre class="example">
 538 #include &lt;cups/ppd.h&gt;
 539
 540 <a href="#ppd_file_t">ppd_file_t</a> *ppd;
 541
 542 <a href="#ppdClose">ppdClose</a>(ppd);
 543 </pre>
 544
 545 <p>Once closed, pointers to the <a href="#ppd_file_t"><code>ppd_file_t</code></a>
 546 structure and any data in it will no longer be valid.</p>
 547
 548 <h3><a name="OPTIONS_AND_GROUPS">Options and Groups</a></h3>
 549
 550 <p>PPD files support multiple options, which are stored in arrays of
 551 <a href="#ppd_option_t"><code>ppd_option_t</code></a> and
 552 <a href="#ppd_choice_t"><code>ppd_choice_t</code></a> structures.</p>
 553
 554 <p>Each option in turn is associated with a group stored in a
 555 <a href="#ppd_group_t"><code>ppd_group_t</code></a> structure. Groups can be
 556 specified in the PPD file; if an option is not associated with a group
 557 then it is put in an automatically-generated "General" group. Groups can also
 558 have sub-groups, however CUPS currently ignores sub-groups because of past
 559 abuses of this functionality.</p>
 560
 561 <p>Option choices are selected by marking them using one of three functions. The
 562 first is <a href="#ppdMarkDefaults"><code>ppdMarkDefaults</code></a> which
 563 selects all of the default options in the PPD file:</p>
 564
 565 <pre class="example">
 566 #include &lt;cups/ppd.h&gt;
 567
 568 <a href="#ppd_file_t">ppd_file_t</a> *ppd;
 569
 570 <a href="#ppdMarkDefaults">ppdMarkDefaults</a>(ppd);
 571 </pre>
 572
 573 <p>The second is <a href="#ppdMarkOption"><code>ppdMarkOption</code></a>
 574 which selects a single option choice in the PPD file. For example, the following
 575 code selects the upper paper tray:</p>
 576
 577 <pre class="example">
 578 #include &lt;cups/ppd.h&gt;
 579
 580 <a href="#ppd_file_t">ppd_file_t</a> *ppd;
 581
 582 <a href="#ppdMarkOption">ppdMarkOption</a>(ppd, "InputSlot", "Upper");
 583 </pre>
 584
 585 <p>The last function is
 586 <a href="#cupsMarkOptions"><code>cupsMarkOptions</code></a> which selects
 587 multiple option choices in the PPD file from an array of CUPS options, mapping
 588 IPP attributes like "media" and "sides" to their corresponding PPD options. You
 589 typically use this function in a print filter with
 590 <code>cupsParseOptions</code> and
 591 <a href="#ppdMarkDefaults"><code>ppdMarkDefaults</code></a> to select all of
 592 the option choices needed for the job, for example:</p>
 593
 594 <pre class="example">
 595 #include &lt;cups/ppd.h&gt;
 596
 597 <a href="#ppd_file_t">ppd_file_t</a> *ppd = <a href="#ppdOpenFile">ppdOpenFile</a>(getenv("PPD"));
 598 cups_option_t *options = NULL;
 599 int num_options = cupsParseOptions(argv[5], 0, &amp;options);
 600
 601 <a href="#ppdMarkDefaults">ppdMarkDefaults</a>(ppd);
 602 <a href="#cupsMarkOptions">cupsMarkOptions</a>(ppd, num_options, options);
 603 cupsFreeOptions(num_options, options);
 604 </pre>
 605
 606 <h3><a name="CONSTRAINTS">Constraints</a></h3>
 607
 608 <p>PPD files support specification of conflict conditions, called
 609 constraints, between different options. Constraints are stored in an array of
 610 <a href="#ppd_const_t"><code>ppd_const_t</code></a> structures which specify
 611 the options and choices that conflict with each other. The
 612 <a href="#ppdConflicts"><code>ppdConflicts</code></a> function tells you
 613 how many of the selected options are incompatible. Since constraints are
 614 normally specified in pairs, the returned value is typically an even number.</p>
 615
 616 <h3><a name="PAGE_SIZES">Page Sizes</a></h3>
 617
 618 <p>Page sizes are special options which have physical dimensions and margins
 619 associated with them. The size information is stored in
 620 <a href="#ppd_size_t"><code>ppd_size_t</code></a> structures and is available
 621 by looking up the named size with the
 622 <a href="#ppdPageSize"><code>ppdPageSize</code></a> function. The page size and
 623 margins are returned in units called points; there are 72 points per inch. If
 624 you pass <code>NULL</code> for the size, the currently selected size is
 625 returned:</p>
 626
 627 <pre class="example">
 628 #include &lt;cups/ppd.h&gt;
 629
 630 <a href="#ppd_file_t">ppd_file_t</a> *ppd;
 631 <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, NULL);
 632 </pre>
 633
 634 <p>Besides the standard page sizes listed in a PPD file, some printers
 635 support variable or custom page sizes. Custom page sizes are supported if the
 636 <code>variables_sizes</code> member of the
 637 <a href="#ppd_file_t"><code>ppd_file_t</code></a> structure is non-zero.
 638 The <code>custom_min</code>, <code>custom_max</code>, and
 639 <code>custom_margins</code> members of the
 640 <a href="#ppd_file_t"><code>ppd_file_t</code></a> structure define the limits
 641 of the printable area. To get the resulting media size, use a page size string
 642 of the form "Custom.<I>width</I>x<I>length</I>", where "width" and "length" are
 643 in points. Custom page size names can also be specified in inches
 644 ("Custom.<i>width</i>x<i>height</i>in"), centimeters
 645 ("Custom.<i>width</i>x<i>height</i>cm"), or millimeters
 646 ("Custom.<i>width</i>x<i>height</i>mm"):</p>
 647
 648 <pre class="example">
 649 #include &lt;cups/ppd.h&gt;
 650
 651 <a href="#ppd_file_t">ppd_file_t</a> *ppd;
 652
 653 /* Get an 576x720 point custom page size */
 654 <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, "Custom.576x720");
 655
 656 /* Get an 8x10 inch custom page size */
 657 <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, "Custom.8x10in");
 658
 659 /* Get a 100x200 millimeter custom page size */
 660 <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, "Custom.100x200mm");
 661
 662 /* Get a 12.7x34.5 centimeter custom page size */
 663 <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, "Custom.12.7x34.5cm");
 664 </pre>
 665
 666 <p>If the PPD does not support variable page sizes, the
 667 <a href="#ppdPageSize"><code>ppdPageSize</code></a> function will return
 668 <code>NULL</code>.</p>
 669
 670 <h3><a name="ATTRIBUTES">Attributes</a></h3>
 671
 672 <p>Every PPD file is composed of one or more attributes. Most of these
 673 attributes are used to define groups, options, choices, and page sizes,
 674 however several informational attributes may be present which you can access
 675 in your program or filter. Attributes normally look like one of the following
 676 examples in a PPD file:</p>
 677
 678 <pre class="example">
 679 *name: "value"
 680 *name spec: "value"
 681 *name spec/text: "value"
 682 </pre>
 683
 684 <p>The <a href="#ppdFindAttr"><code>ppdFindAttr</code></a> and
 685 <a href="#ppdFindNextAttr"><code>ppdFindNextAttr</code></a> functions find the
 686 first and next instances, respectively, of the named attribute with the given
 687 "spec" string and return a <a href="#ppd_attr_t"><code>ppd_attr_t</code></a>
 688 structure. If you provide a NULL specifier string, all attributes with the
 689 given name will be returned. For example, the following code lists all of the
 690 <code>Product</code> attributes in a PPD file:</p>
 691
 692 <pre class="example">
 693 #include &lt;cups/ppd.h&gt;
 694
 695 <a href="#ppd_file_t">ppd_file_t</a> *ppd;
 696 <a href="#ppd_attr_t">ppd_attr_t</a> *attr;
 697
 698 for (attr = <a href="#ppdFindAttr">ppdFindAttr</a>(ppd, "Product", NULL);
 699      attr != NULL;
 700      attr = <a href="#ppdFindNextAttr">ppdFindNextAttr</a>(ppd, "Product", NULL))
 701   puts(attr->value);
 702 </pre>
 703 <h2 class="title"><a name="FUNCTIONS">Functions</a></h2>
 704 <h3 class="function"><span class="info">&nbsp;CUPS 1.4/Mac OS X 10.6&nbsp;</span><a name="cupsGetConflicts">cupsGetConflicts</a></h3>
 705 <p class="description">Get a list of conflicting options in a marked PPD.</p>
 706 <p class="code">
 707 int cupsGetConflicts (<br>
 708 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 709 &nbsp;&nbsp;&nbsp;&nbsp;const char *option,<br>
 710 &nbsp;&nbsp;&nbsp;&nbsp;const char *choice,<br>
 711 &nbsp;&nbsp;&nbsp;&nbsp;cups_option_t **options<br>
 712 );</p>
 713 <h4 class="parameters">Parameters</h4>
 714 <dl>
 715 <dt>ppd</dt>
 716 <dd class="description">PPD file</dd>
 717 <dt>option</dt>
 718 <dd class="description">Option to test</dd>
 719 <dt>choice</dt>
 720 <dd class="description">Choice to test</dd>
 721 <dt>options</dt>
 722 <dd class="description">Conflicting options</dd>
 723 </dl>
 724 <h4 class="returnvalue">Return Value</h4>
 725 <p class="description">Number of conflicting options</p>
 726 <h4 class="discussion">Discussion</h4>
 727 <p class="discussion">This function gets a list of options that would conflict if &quot;option&quot; and
 728 &quot;choice&quot; were marked in the PPD.  You would typically call this function
 729 after marking the currently selected options in the PPD in order to
 730 determine whether a new option selection would cause a conflict.<br>
 731 <br>
 732 The number of conflicting options are returned with &quot;options&quot; pointing to
 733 the conflicting options.  The returned option array must be freed using
 734 <a href="#cupsFreeOptions"><code>cupsFreeOptions</code></a>.
 735
 736 </p>
 737 <h3 class="function"><a name="cupsMarkOptions">cupsMarkOptions</a></h3>
 738 <p class="description">Mark command-line options in a PPD file.</p>
 739 <p class="code">
 740 int cupsMarkOptions (<br>
 741 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 742 &nbsp;&nbsp;&nbsp;&nbsp;int num_options,<br>
 743 &nbsp;&nbsp;&nbsp;&nbsp;cups_option_t *options<br>
 744 );</p>
 745 <h4 class="parameters">Parameters</h4>
 746 <dl>
 747 <dt>ppd</dt>
 748 <dd class="description">PPD file</dd>
 749 <dt>num_options</dt>
 750 <dd class="description">Number of options</dd>
 751 <dt>options</dt>
 752 <dd class="description">Options</dd>
 753 </dl>
 754 <h4 class="returnvalue">Return Value</h4>
 755 <p class="description">1 if conflicts exist, 0 otherwise</p>
 756 <h4 class="discussion">Discussion</h4>
 757 <p class="discussion">This function maps the IPP &quot;finishings&quot;, &quot;media&quot;, &quot;mirror&quot;,
 758 &quot;multiple-document-handling&quot;, &quot;output-bin&quot;, &quot;print-color-mode&quot;,
 759 &quot;print-quality&quot;, &quot;printer-resolution&quot;, and &quot;sides&quot; attributes to their
 760 corresponding PPD options and choices.</p>
 761 <h3 class="function"><span class="info">&nbsp;CUPS 1.4/Mac OS X 10.6&nbsp;</span><a name="cupsResolveConflicts">cupsResolveConflicts</a></h3>
 762 <p class="description">Resolve conflicts in a marked PPD.</p>
 763 <p class="code">
 764 int cupsResolveConflicts (<br>
 765 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 766 &nbsp;&nbsp;&nbsp;&nbsp;const char *option,<br>
 767 &nbsp;&nbsp;&nbsp;&nbsp;const char *choice,<br>
 768 &nbsp;&nbsp;&nbsp;&nbsp;int *num_options,<br>
 769 &nbsp;&nbsp;&nbsp;&nbsp;cups_option_t **options<br>
 770 );</p>
 771 <h4 class="parameters">Parameters</h4>
 772 <dl>
 773 <dt>ppd</dt>
 774 <dd class="description">PPD file</dd>
 775 <dt>option</dt>
 776 <dd class="description">Newly selected option or <code>NULL</code> for none</dd>
 777 <dt>choice</dt>
 778 <dd class="description">Newly selected choice or <code>NULL</code> for none</dd>
 779 <dt>num_options</dt>
 780 <dd class="description">Number of additional selected options</dd>
 781 <dt>options</dt>
 782 <dd class="description">Additional selected options</dd>
 783 </dl>
 784 <h4 class="returnvalue">Return Value</h4>
 785 <p class="description">1 on success, 0 on failure</p>
 786 <h4 class="discussion">Discussion</h4>
 787 <p class="discussion">This function attempts to resolve any conflicts in a marked PPD, returning
 788 a list of option changes that are required to resolve them.  On input,
 789 &quot;num_options&quot; and &quot;options&quot; contain any pending option changes that have
 790 not yet been marked, while &quot;option&quot; and &quot;choice&quot; contain the most recent
 791 selection which may or may not be in &quot;num_options&quot; or &quot;options&quot;.<br>
 792 <br>
 793 On successful return, &quot;num_options&quot; and &quot;options&quot; are updated to contain
 794 &quot;option&quot; and &quot;choice&quot; along with any changes required to resolve conflicts
 795 specified in the PPD file and 1 is returned.<br>
 796 <br>
 797 If option conflicts cannot be resolved, &quot;num_options&quot; and &quot;options&quot; are not
 798 changed and 0 is returned.<br>
 799 <br>
 800 When resolving conflicts, <code>cupsResolveConflicts</code> does not consider
 801 changes to the current page size (<code>media</code>, <code>PageSize</code>, and
 802 <code>PageRegion</code>) or to the most recent option specified in &quot;option&quot;.
 803 Thus, if the only way to resolve a conflict is to change the page size
 804 or the option the user most recently changed, <code>cupsResolveConflicts</code>
 805 will return 0 to indicate it was unable to resolve the conflicts.<br>
 806 <br>
 807 The <code>cupsResolveConflicts</code> function uses one of two sources of option
 808 constraint information.  The preferred constraint information is defined by
 809 <code>cupsUIConstraints</code> and <code>cupsUIResolver</code> attributes - in this
 810 case, the PPD file provides constraint resolution actions.<br>
 811 <br>
 812 The backup constraint information is defined by the
 813 <code>UIConstraints</code> and <code>NonUIConstraints</code> attributes.  These
 814 constraints are resolved algorithmically by first selecting the default
 815 choice for the conflicting option, then iterating over all possible choices
 816 until a non-conflicting option choice is found.
 817
 818 </p>
 819 <h3 class="function"><a name="ppdClose">ppdClose</a></h3>
 820 <p class="description">Free all memory used by the PPD file.</p>
 821 <p class="code">
 822 void ppdClose (<br>
 823 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd<br>
 824 );</p>
 825 <h4 class="parameters">Parameters</h4>
 826 <dl>
 827 <dt>ppd</dt>
 828 <dd class="description">PPD file record</dd>
 829 </dl>
 830 <h3 class="function"><a name="ppdCollect">ppdCollect</a></h3>
 831 <p class="description">Collect all marked options that reside in the specified
 832 section.</p>
 833 <p class="code">
 834 int ppdCollect (<br>
 835 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 836 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_section_t">ppd_section_t</a> section,<br>
 837 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_choice_t">ppd_choice_t</a> ***choices<br>
 838 );</p>
 839 <h4 class="parameters">Parameters</h4>
 840 <dl>
 841 <dt>ppd</dt>
 842 <dd class="description">PPD file data</dd>
 843 <dt>section</dt>
 844 <dd class="description">Section to collect</dd>
 845 <dt>choices</dt>
 846 <dd class="description">Pointers to choices</dd>
 847 </dl>
 848 <h4 class="returnvalue">Return Value</h4>
 849 <p class="description">Number of options marked</p>
 850 <h4 class="discussion">Discussion</h4>
 851 <p class="discussion">The choices array should be freed using <code>free</code> when you are
 852 finished with it.</p>
 853 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdCollect2">ppdCollect2</a></h3>
 854 <p class="description">Collect all marked options that reside in the
 855 specified section and minimum order.</p>
 856 <p class="code">
 857 int ppdCollect2 (<br>
 858 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 859 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_section_t">ppd_section_t</a> section,<br>
 860 &nbsp;&nbsp;&nbsp;&nbsp;float min_order,<br>
 861 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_choice_t">ppd_choice_t</a> ***choices<br>
 862 );</p>
 863 <h4 class="parameters">Parameters</h4>
 864 <dl>
 865 <dt>ppd</dt>
 866 <dd class="description">PPD file data</dd>
 867 <dt>section</dt>
 868 <dd class="description">Section to collect</dd>
 869 <dt>min_order</dt>
 870 <dd class="description">Minimum OrderDependency value</dd>
 871 <dt>choices</dt>
 872 <dd class="description">Pointers to choices</dd>
 873 </dl>
 874 <h4 class="returnvalue">Return Value</h4>
 875 <p class="description">Number of options marked</p>
 876 <h4 class="discussion">Discussion</h4>
 877 <p class="discussion">The choices array should be freed using <code>free</code> when you are
 878 finished with it.
 879
 880 </p>
 881 <h3 class="function"><a name="ppdConflicts">ppdConflicts</a></h3>
 882 <p class="description">Check to see if there are any conflicts among the
 883 marked option choices.</p>
 884 <p class="code">
 885 int ppdConflicts (<br>
 886 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd<br>
 887 );</p>
 888 <h4 class="parameters">Parameters</h4>
 889 <dl>
 890 <dt>ppd</dt>
 891 <dd class="description">PPD to check</dd>
 892 </dl>
 893 <h4 class="returnvalue">Return Value</h4>
 894 <p class="description">Number of conflicts found</p>
 895 <h4 class="discussion">Discussion</h4>
 896 <p class="discussion">The returned value is the same as returned by <a href="#ppdMarkOption"><code>ppdMarkOption</code></a>.</p>
 897 <h3 class="function"><a name="ppdEmit">ppdEmit</a></h3>
 898 <p class="description">Emit code for marked options to a file.</p>
 899 <p class="code">
 900 int ppdEmit (<br>
 901 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 902 &nbsp;&nbsp;&nbsp;&nbsp;FILE *fp,<br>
 903 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_section_t">ppd_section_t</a> section<br>
 904 );</p>
 905 <h4 class="parameters">Parameters</h4>
 906 <dl>
 907 <dt>ppd</dt>
 908 <dd class="description">PPD file record</dd>
 909 <dt>fp</dt>
 910 <dd class="description">File to write to</dd>
 911 <dt>section</dt>
 912 <dd class="description">Section to write</dd>
 913 </dl>
 914 <h4 class="returnvalue">Return Value</h4>
 915 <p class="description">0 on success, -1 on failure</p>
 916 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdEmitAfterOrder">ppdEmitAfterOrder</a></h3>
 917 <p class="description">Emit a subset of the code for marked options to a file.</p>
 918 <p class="code">
 919 int ppdEmitAfterOrder (<br>
 920 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 921 &nbsp;&nbsp;&nbsp;&nbsp;FILE *fp,<br>
 922 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_section_t">ppd_section_t</a> section,<br>
 923 &nbsp;&nbsp;&nbsp;&nbsp;int limit,<br>
 924 &nbsp;&nbsp;&nbsp;&nbsp;float min_order<br>
 925 );</p>
 926 <h4 class="parameters">Parameters</h4>
 927 <dl>
 928 <dt>ppd</dt>
 929 <dd class="description">PPD file record</dd>
 930 <dt>fp</dt>
 931 <dd class="description">File to write to</dd>
 932 <dt>section</dt>
 933 <dd class="description">Section to write</dd>
 934 <dt>limit</dt>
 935 <dd class="description">Non-zero to use min_order</dd>
 936 <dt>min_order</dt>
 937 <dd class="description">Lowest OrderDependency</dd>
 938 </dl>
 939 <h4 class="returnvalue">Return Value</h4>
 940 <p class="description">0 on success, -1 on failure</p>
 941 <h4 class="discussion">Discussion</h4>
 942 <p class="discussion">When &quot;limit&quot; is non-zero, this function only emits options whose
 943 OrderDependency value is greater than or equal to &quot;min_order&quot;.<br>
 944 <br>
 945 When &quot;limit&quot; is zero, this function is identical to ppdEmit().
 946
 947 </p>
 948 <h3 class="function"><a name="ppdEmitFd">ppdEmitFd</a></h3>
 949 <p class="description">Emit code for marked options to a file.</p>
 950 <p class="code">
 951 int ppdEmitFd (<br>
 952 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 953 &nbsp;&nbsp;&nbsp;&nbsp;int fd,<br>
 954 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_section_t">ppd_section_t</a> section<br>
 955 );</p>
 956 <h4 class="parameters">Parameters</h4>
 957 <dl>
 958 <dt>ppd</dt>
 959 <dd class="description">PPD file record</dd>
 960 <dt>fd</dt>
 961 <dd class="description">File to write to</dd>
 962 <dt>section</dt>
 963 <dd class="description">Section to write</dd>
 964 </dl>
 965 <h4 class="returnvalue">Return Value</h4>
 966 <p class="description">0 on success, -1 on failure</p>
 967 <h3 class="function"><a name="ppdEmitJCL">ppdEmitJCL</a></h3>
 968 <p class="description">Emit code for JCL options to a file.</p>
 969 <p class="code">
 970 int ppdEmitJCL (<br>
 971 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 972 &nbsp;&nbsp;&nbsp;&nbsp;FILE *fp,<br>
 973 &nbsp;&nbsp;&nbsp;&nbsp;int job_id,<br>
 974 &nbsp;&nbsp;&nbsp;&nbsp;const char *user,<br>
 975 &nbsp;&nbsp;&nbsp;&nbsp;const char *title<br>
 976 );</p>
 977 <h4 class="parameters">Parameters</h4>
 978 <dl>
 979 <dt>ppd</dt>
 980 <dd class="description">PPD file record</dd>
 981 <dt>fp</dt>
 982 <dd class="description">File to write to</dd>
 983 <dt>job_id</dt>
 984 <dd class="description">Job ID</dd>
 985 <dt>user</dt>
 986 <dd class="description">Username</dd>
 987 <dt>title</dt>
 988 <dd class="description">Title</dd>
 989 </dl>
 990 <h4 class="returnvalue">Return Value</h4>
 991 <p class="description">0 on success, -1 on failure</p>
 992 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdEmitJCLEnd">ppdEmitJCLEnd</a></h3>
 993 <p class="description">Emit JCLEnd code to a file.</p>
 994 <p class="code">
 995 int ppdEmitJCLEnd (<br>
 996 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
 997 &nbsp;&nbsp;&nbsp;&nbsp;FILE *fp<br>
 998 );</p>
 999 <h4 class="parameters">Parameters</h4>
1000 <dl>
1001 <dt>ppd</dt>
1002 <dd class="description">PPD file record</dd>
1003 <dt>fp</dt>
1004 <dd class="description">File to write to</dd>
1005 </dl>
1006 <h4 class="returnvalue">Return Value</h4>
1007 <p class="description">0 on success, -1 on failure</p>
1008 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdEmitString">ppdEmitString</a></h3>
1009 <p class="description">Get a string containing the code for marked options.</p>
1010 <p class="code">
1011 char *ppdEmitString (<br>
1012 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1013 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_section_t">ppd_section_t</a> section,<br>
1014 &nbsp;&nbsp;&nbsp;&nbsp;float min_order<br>
1015 );</p>
1016 <h4 class="parameters">Parameters</h4>
1017 <dl>
1018 <dt>ppd</dt>
1019 <dd class="description">PPD file record</dd>
1020 <dt>section</dt>
1021 <dd class="description">Section to write</dd>
1022 <dt>min_order</dt>
1023 <dd class="description">Lowest OrderDependency</dd>
1024 </dl>
1025 <h4 class="returnvalue">Return Value</h4>
1026 <p class="description">String containing option code or <code>NULL</code> if there is no option code</p>
1027 <h4 class="discussion">Discussion</h4>
1028 <p class="discussion">When &quot;min_order&quot; is greater than zero, this function only includes options
1029 whose OrderDependency value is greater than or equal to &quot;min_order&quot;.
1030 Otherwise, all options in the specified section are included in the
1031 returned string.<br>
1032 <br>
1033 The return string is allocated on the heap and should be freed using
1034 <code>free</code> when you are done with it.
1035
1036 </p>
1037 <h3 class="function"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppdErrorString">ppdErrorString</a></h3>
1038 <p class="description">Returns the text assocated with a status.</p>
1039 <p class="code">
1040 const char *ppdErrorString (<br>
1041 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_status_t">ppd_status_t</a> status<br>
1042 );</p>
1043 <h4 class="parameters">Parameters</h4>
1044 <dl>
1045 <dt>status</dt>
1046 <dd class="description">PPD status</dd>
1047 </dl>
1048 <h4 class="returnvalue">Return Value</h4>
1049 <p class="description">Status string</p>
1050 <h3 class="function"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppdFindAttr">ppdFindAttr</a></h3>
1051 <p class="description">Find the first matching attribute.</p>
1052 <p class="code">
1053 <a href="#ppd_attr_t">ppd_attr_t</a> *ppdFindAttr (<br>
1054 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1055 &nbsp;&nbsp;&nbsp;&nbsp;const char *name,<br>
1056 &nbsp;&nbsp;&nbsp;&nbsp;const char *spec<br>
1057 );</p>
1058 <h4 class="parameters">Parameters</h4>
1059 <dl>
1060 <dt>ppd</dt>
1061 <dd class="description">PPD file data</dd>
1062 <dt>name</dt>
1063 <dd class="description">Attribute name</dd>
1064 <dt>spec</dt>
1065 <dd class="description">Specifier string or <code>NULL</code></dd>
1066 </dl>
1067 <h4 class="returnvalue">Return Value</h4>
1068 <p class="description">Attribute or <code>NULL</code> if not found</p>
1069 <h3 class="function"><a name="ppdFindChoice">ppdFindChoice</a></h3>
1070 <p class="description">Return a pointer to an option choice.</p>
1071 <p class="code">
1072 <a href="#ppd_choice_t">ppd_choice_t</a> *ppdFindChoice (<br>
1073 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_option_t">ppd_option_t</a> *o,<br>
1074 &nbsp;&nbsp;&nbsp;&nbsp;const char *choice<br>
1075 );</p>
1076 <h4 class="parameters">Parameters</h4>
1077 <dl>
1078 <dt>o</dt>
1079 <dd class="description">Pointer to option</dd>
1080 <dt>choice</dt>
1081 <dd class="description">Name of choice</dd>
1082 </dl>
1083 <h4 class="returnvalue">Return Value</h4>
1084 <p class="description">Choice pointer or <code>NULL</code></p>
1085 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdFindCustomOption">ppdFindCustomOption</a></h3>
1086 <p class="description">Find a custom option.</p>
1087 <p class="code">
1088 <a href="#ppd_coption_t">ppd_coption_t</a> *ppdFindCustomOption (<br>
1089 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1090 &nbsp;&nbsp;&nbsp;&nbsp;const char *keyword<br>
1091 );</p>
1092 <h4 class="parameters">Parameters</h4>
1093 <dl>
1094 <dt>ppd</dt>
1095 <dd class="description">PPD file</dd>
1096 <dt>keyword</dt>
1097 <dd class="description">Custom option name</dd>
1098 </dl>
1099 <h4 class="returnvalue">Return Value</h4>
1100 <p class="description">Custom option or NULL</p>
1101 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdFindCustomParam">ppdFindCustomParam</a></h3>
1102 <p class="description">Find a parameter for a custom option.</p>
1103 <p class="code">
1104 <a href="#ppd_cparam_t">ppd_cparam_t</a> *ppdFindCustomParam (<br>
1105 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_coption_t">ppd_coption_t</a> *opt,<br>
1106 &nbsp;&nbsp;&nbsp;&nbsp;const char *name<br>
1107 );</p>
1108 <h4 class="parameters">Parameters</h4>
1109 <dl>
1110 <dt>opt</dt>
1111 <dd class="description">Custom option</dd>
1112 <dt>name</dt>
1113 <dd class="description">Parameter name</dd>
1114 </dl>
1115 <h4 class="returnvalue">Return Value</h4>
1116 <p class="description">Custom parameter or NULL</p>
1117 <h3 class="function"><a name="ppdFindMarkedChoice">ppdFindMarkedChoice</a></h3>
1118 <p class="description">Return the marked choice for the specified option.</p>
1119 <p class="code">
1120 <a href="#ppd_choice_t">ppd_choice_t</a> *ppdFindMarkedChoice (<br>
1121 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1122 &nbsp;&nbsp;&nbsp;&nbsp;const char *option<br>
1123 );</p>
1124 <h4 class="parameters">Parameters</h4>
1125 <dl>
1126 <dt>ppd</dt>
1127 <dd class="description">PPD file</dd>
1128 <dt>option</dt>
1129 <dd class="description">Keyword/option name</dd>
1130 </dl>
1131 <h4 class="returnvalue">Return Value</h4>
1132 <p class="description">Pointer to choice or <code>NULL</code></p>
1133 <h3 class="function"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppdFindNextAttr">ppdFindNextAttr</a></h3>
1134 <p class="description">Find the next matching attribute.</p>
1135 <p class="code">
1136 <a href="#ppd_attr_t">ppd_attr_t</a> *ppdFindNextAttr (<br>
1137 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1138 &nbsp;&nbsp;&nbsp;&nbsp;const char *name,<br>
1139 &nbsp;&nbsp;&nbsp;&nbsp;const char *spec<br>
1140 );</p>
1141 <h4 class="parameters">Parameters</h4>
1142 <dl>
1143 <dt>ppd</dt>
1144 <dd class="description">PPD file data</dd>
1145 <dt>name</dt>
1146 <dd class="description">Attribute name</dd>
1147 <dt>spec</dt>
1148 <dd class="description">Specifier string or <code>NULL</code></dd>
1149 </dl>
1150 <h4 class="returnvalue">Return Value</h4>
1151 <p class="description">Attribute or <code>NULL</code> if not found</p>
1152 <h3 class="function"><a name="ppdFindOption">ppdFindOption</a></h3>
1153 <p class="description">Return a pointer to the specified option.</p>
1154 <p class="code">
1155 <a href="#ppd_option_t">ppd_option_t</a> *ppdFindOption (<br>
1156 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1157 &nbsp;&nbsp;&nbsp;&nbsp;const char *option<br>
1158 );</p>
1159 <h4 class="parameters">Parameters</h4>
1160 <dl>
1161 <dt>ppd</dt>
1162 <dd class="description">PPD file data</dd>
1163 <dt>option</dt>
1164 <dd class="description">Option/Keyword name</dd>
1165 </dl>
1166 <h4 class="returnvalue">Return Value</h4>
1167 <p class="description">Pointer to option or <code>NULL</code></p>
1168 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdFirstCustomParam">ppdFirstCustomParam</a></h3>
1169 <p class="description">Return the first parameter for a custom option.</p>
1170 <p class="code">
1171 <a href="#ppd_cparam_t">ppd_cparam_t</a> *ppdFirstCustomParam (<br>
1172 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_coption_t">ppd_coption_t</a> *opt<br>
1173 );</p>
1174 <h4 class="parameters">Parameters</h4>
1175 <dl>
1176 <dt>opt</dt>
1177 <dd class="description">Custom option</dd>
1178 </dl>
1179 <h4 class="returnvalue">Return Value</h4>
1180 <p class="description">Custom parameter or NULL</p>
1181 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdFirstOption">ppdFirstOption</a></h3>
1182 <p class="description">Return the first option in the PPD file.</p>
1183 <p class="code">
1184 <a href="#ppd_option_t">ppd_option_t</a> *ppdFirstOption (<br>
1185 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd<br>
1186 );</p>
1187 <h4 class="parameters">Parameters</h4>
1188 <dl>
1189 <dt>ppd</dt>
1190 <dd class="description">PPD file</dd>
1191 </dl>
1192 <h4 class="returnvalue">Return Value</h4>
1193 <p class="description">First option or <code>NULL</code></p>
1194 <h4 class="discussion">Discussion</h4>
1195 <p class="discussion">Options are returned from all groups in ascending alphanumeric order.
1196
1197 </p>
1198 <h3 class="function"><span class="info">&nbsp;CUPS 1.4/Mac OS X 10.6&nbsp;</span><a name="ppdInstallableConflict">ppdInstallableConflict</a></h3>
1199 <p class="description">Test whether an option choice conflicts with
1200 an installable option.</p>
1201 <p class="code">
1202 int ppdInstallableConflict (<br>
1203 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1204 &nbsp;&nbsp;&nbsp;&nbsp;const char *option,<br>
1205 &nbsp;&nbsp;&nbsp;&nbsp;const char *choice<br>
1206 );</p>
1207 <h4 class="parameters">Parameters</h4>
1208 <dl>
1209 <dt>ppd</dt>
1210 <dd class="description">PPD file</dd>
1211 <dt>option</dt>
1212 <dd class="description">Option</dd>
1213 <dt>choice</dt>
1214 <dd class="description">Choice</dd>
1215 </dl>
1216 <h4 class="returnvalue">Return Value</h4>
1217 <p class="description">1 if conflicting, 0 if not conflicting</p>
1218 <h4 class="discussion">Discussion</h4>
1219 <p class="discussion">This function tests whether a particular option choice is available based
1220 on constraints against options in the &quot;InstallableOptions&quot; group.
1221
1222 </p>
1223 <h3 class="function"><a name="ppdIsMarked">ppdIsMarked</a></h3>
1224 <p class="description">Check to see if an option is marked.</p>
1225 <p class="code">
1226 int ppdIsMarked (<br>
1227 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1228 &nbsp;&nbsp;&nbsp;&nbsp;const char *option,<br>
1229 &nbsp;&nbsp;&nbsp;&nbsp;const char *choice<br>
1230 );</p>
1231 <h4 class="parameters">Parameters</h4>
1232 <dl>
1233 <dt>ppd</dt>
1234 <dd class="description">PPD file data</dd>
1235 <dt>option</dt>
1236 <dd class="description">Option/Keyword name</dd>
1237 <dt>choice</dt>
1238 <dd class="description">Choice name</dd>
1239 </dl>
1240 <h4 class="returnvalue">Return Value</h4>
1241 <p class="description">Non-zero if option is marked</p>
1242 <h3 class="function"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppdLastError">ppdLastError</a></h3>
1243 <p class="description">Return the status from the last ppdOpen*().</p>
1244 <p class="code">
1245 <a href="#ppd_status_t">ppd_status_t</a> ppdLastError (<br>
1246 &nbsp;&nbsp;&nbsp;&nbsp;int *line<br>
1247 );</p>
1248 <h4 class="parameters">Parameters</h4>
1249 <dl>
1250 <dt>line</dt>
1251 <dd class="description">Line number</dd>
1252 </dl>
1253 <h4 class="returnvalue">Return Value</h4>
1254 <p class="description">Status code</p>
1255 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdLocalize">ppdLocalize</a></h3>
1256 <p class="description">Localize the PPD file to the current locale.</p>
1257 <p class="code">
1258 int ppdLocalize (<br>
1259 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd<br>
1260 );</p>
1261 <h4 class="parameters">Parameters</h4>
1262 <dl>
1263 <dt>ppd</dt>
1264 <dd class="description">PPD file</dd>
1265 </dl>
1266 <h4 class="returnvalue">Return Value</h4>
1267 <p class="description">0 on success, -1 on error</p>
1268 <h4 class="discussion">Discussion</h4>
1269 <p class="discussion">All groups, options, and choices are localized, as are ICC profile
1270 descriptions, printer presets, and custom option parameters.  Each
1271 localized string uses the UTF-8 character encoding.
1272
1273 </p>
1274 <h3 class="function"><a name="ppdLocalizeAttr">ppdLocalizeAttr</a></h3>
1275 <p class="description">Localize an attribute.</p>
1276 <p class="code">
1277 <a href="#ppd_attr_t">ppd_attr_t</a> *ppdLocalizeAttr (<br>
1278 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1279 &nbsp;&nbsp;&nbsp;&nbsp;const char *keyword,<br>
1280 &nbsp;&nbsp;&nbsp;&nbsp;const char *spec<br>
1281 );</p>
1282 <h4 class="parameters">Parameters</h4>
1283 <dl>
1284 <dt>ppd</dt>
1285 <dd class="description">PPD file</dd>
1286 <dt>keyword</dt>
1287 <dd class="description">Main keyword</dd>
1288 <dt>spec</dt>
1289 <dd class="description">Option keyword or <code>NULL</code> for none</dd>
1290 </dl>
1291 <h4 class="returnvalue">Return Value</h4>
1292 <p class="description">Localized attribute or <code>NULL</code> if none exists</p>
1293 <h4 class="discussion">Discussion</h4>
1294 <p class="discussion">This function uses the current locale to find the localized attribute for
1295 the given main and option keywords.  If no localized version of the
1296 attribute exists for the current locale, the unlocalized version is returned.</p>
1297 <h3 class="function"><span class="info">&nbsp;CUPS 1.3/Mac OS X 10.5&nbsp;</span><a name="ppdLocalizeIPPReason">ppdLocalizeIPPReason</a></h3>
1298 <p class="description">Get the localized version of a cupsIPPReason
1299 attribute.</p>
1300 <p class="code">
1301 const char *ppdLocalizeIPPReason (<br>
1302 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1303 &nbsp;&nbsp;&nbsp;&nbsp;const char *reason,<br>
1304 &nbsp;&nbsp;&nbsp;&nbsp;const char *scheme,<br>
1305 &nbsp;&nbsp;&nbsp;&nbsp;char *buffer,<br>
1306 &nbsp;&nbsp;&nbsp;&nbsp;size_t bufsize<br>
1307 );</p>
1308 <h4 class="parameters">Parameters</h4>
1309 <dl>
1310 <dt>ppd</dt>
1311 <dd class="description">PPD file</dd>
1312 <dt>reason</dt>
1313 <dd class="description">IPP reason keyword to look up</dd>
1314 <dt>scheme</dt>
1315 <dd class="description">URI scheme or NULL for text</dd>
1316 <dt>buffer</dt>
1317 <dd class="description">Value buffer</dd>
1318 <dt>bufsize</dt>
1319 <dd class="description">Size of value buffer</dd>
1320 </dl>
1321 <h4 class="returnvalue">Return Value</h4>
1322 <p class="description">Value or NULL if not found</p>
1323 <h4 class="discussion">Discussion</h4>
1324 <p class="discussion">This function uses the current locale to find the corresponding reason
1325 text or URI from the attribute value. If &quot;scheme&quot; is NULL or &quot;text&quot;,
1326 the returned value contains human-readable (UTF-8) text from the translation
1327 string or attribute value. Otherwise the corresponding URI is returned.<br>
1328 <br>
1329 If no value of the requested scheme can be found, NULL is returned.
1330
1331 </p>
1332 <h3 class="function"><span class="info">&nbsp;CUPS 1.4/Mac OS X 10.6&nbsp;</span><a name="ppdLocalizeMarkerName">ppdLocalizeMarkerName</a></h3>
1333 <p class="description">Get the localized version of a marker-names
1334 attribute value.</p>
1335 <p class="code">
1336 const char *ppdLocalizeMarkerName (<br>
1337 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1338 &nbsp;&nbsp;&nbsp;&nbsp;const char *name<br>
1339 );</p>
1340 <h4 class="parameters">Parameters</h4>
1341 <dl>
1342 <dt>ppd</dt>
1343 <dd class="description">PPD file</dd>
1344 <dt>name</dt>
1345 <dd class="description">Marker name to look up</dd>
1346 </dl>
1347 <h4 class="returnvalue">Return Value</h4>
1348 <p class="description">Value or <code>NULL</code> if not found</p>
1349 <h4 class="discussion">Discussion</h4>
1350 <p class="discussion">This function uses the current locale to find the corresponding name
1351 text from the attribute value. If no localized text for the requested
1352 name can be found, <code>NULL</code> is returned.
1353
1354 </p>
1355 <h3 class="function"><a name="ppdMarkDefaults">ppdMarkDefaults</a></h3>
1356 <p class="description">Mark all default options in the PPD file.</p>
1357 <p class="code">
1358 void ppdMarkDefaults (<br>
1359 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd<br>
1360 );</p>
1361 <h4 class="parameters">Parameters</h4>
1362 <dl>
1363 <dt>ppd</dt>
1364 <dd class="description">PPD file record</dd>
1365 </dl>
1366 <h3 class="function"><a name="ppdMarkOption">ppdMarkOption</a></h3>
1367 <p class="description">Mark an option in a PPD file and return the number of
1368 conflicts.</p>
1369 <p class="code">
1370 int ppdMarkOption (<br>
1371 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1372 &nbsp;&nbsp;&nbsp;&nbsp;const char *option,<br>
1373 &nbsp;&nbsp;&nbsp;&nbsp;const char *choice<br>
1374 );</p>
1375 <h4 class="parameters">Parameters</h4>
1376 <dl>
1377 <dt>ppd</dt>
1378 <dd class="description">PPD file record</dd>
1379 <dt>option</dt>
1380 <dd class="description">Keyword</dd>
1381 <dt>choice</dt>
1382 <dd class="description">Option name</dd>
1383 </dl>
1384 <h4 class="returnvalue">Return Value</h4>
1385 <p class="description">Number of conflicts</p>
1386 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdNextCustomParam">ppdNextCustomParam</a></h3>
1387 <p class="description">Return the next parameter for a custom option.</p>
1388 <p class="code">
1389 <a href="#ppd_cparam_t">ppd_cparam_t</a> *ppdNextCustomParam (<br>
1390 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_coption_t">ppd_coption_t</a> *opt<br>
1391 );</p>
1392 <h4 class="parameters">Parameters</h4>
1393 <dl>
1394 <dt>opt</dt>
1395 <dd class="description">Custom option</dd>
1396 </dl>
1397 <h4 class="returnvalue">Return Value</h4>
1398 <p class="description">Custom parameter or NULL</p>
1399 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdNextOption">ppdNextOption</a></h3>
1400 <p class="description">Return the next option in the PPD file.</p>
1401 <p class="code">
1402 <a href="#ppd_option_t">ppd_option_t</a> *ppdNextOption (<br>
1403 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd<br>
1404 );</p>
1405 <h4 class="parameters">Parameters</h4>
1406 <dl>
1407 <dt>ppd</dt>
1408 <dd class="description">PPD file</dd>
1409 </dl>
1410 <h4 class="returnvalue">Return Value</h4>
1411 <p class="description">Next option or <code>NULL</code></p>
1412 <h4 class="discussion">Discussion</h4>
1413 <p class="discussion">Options are returned from all groups in ascending alphanumeric order.
1414
1415 </p>
1416 <h3 class="function"><a name="ppdOpen">ppdOpen</a></h3>
1417 <p class="description">Read a PPD file into memory.</p>
1418 <p class="code">
1419 <a href="#ppd_file_t">ppd_file_t</a> *ppdOpen (<br>
1420 &nbsp;&nbsp;&nbsp;&nbsp;FILE *fp<br>
1421 );</p>
1422 <h4 class="parameters">Parameters</h4>
1423 <dl>
1424 <dt>fp</dt>
1425 <dd class="description">File to read from</dd>
1426 </dl>
1427 <h4 class="returnvalue">Return Value</h4>
1428 <p class="description">PPD file record</p>
1429 <h3 class="function"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppdOpen2">ppdOpen2</a></h3>
1430 <p class="description">Read a PPD file into memory.</p>
1431 <p class="code">
1432 <a href="#ppd_file_t">ppd_file_t</a> *ppdOpen2 (<br>
1433 &nbsp;&nbsp;&nbsp;&nbsp;cups_file_t *fp<br>
1434 );</p>
1435 <h4 class="parameters">Parameters</h4>
1436 <dl>
1437 <dt>fp</dt>
1438 <dd class="description">File to read from</dd>
1439 </dl>
1440 <h4 class="returnvalue">Return Value</h4>
1441 <p class="description">PPD file record or <code>NULL</code> if the PPD file could not be opened.</p>
1442 <h3 class="function"><a name="ppdOpenFd">ppdOpenFd</a></h3>
1443 <p class="description">Read a PPD file into memory.</p>
1444 <p class="code">
1445 <a href="#ppd_file_t">ppd_file_t</a> *ppdOpenFd (<br>
1446 &nbsp;&nbsp;&nbsp;&nbsp;int fd<br>
1447 );</p>
1448 <h4 class="parameters">Parameters</h4>
1449 <dl>
1450 <dt>fd</dt>
1451 <dd class="description">File to read from</dd>
1452 </dl>
1453 <h4 class="returnvalue">Return Value</h4>
1454 <p class="description">PPD file record or <code>NULL</code> if the PPD file could not be opened.</p>
1455 <h3 class="function"><a name="ppdOpenFile">ppdOpenFile</a></h3>
1456 <p class="description">Read a PPD file into memory.</p>
1457 <p class="code">
1458 <a href="#ppd_file_t">ppd_file_t</a> *ppdOpenFile (<br>
1459 &nbsp;&nbsp;&nbsp;&nbsp;const char *filename<br>
1460 );</p>
1461 <h4 class="parameters">Parameters</h4>
1462 <dl>
1463 <dt>filename</dt>
1464 <dd class="description">File to read from</dd>
1465 </dl>
1466 <h4 class="returnvalue">Return Value</h4>
1467 <p class="description">PPD file record or <code>NULL</code> if the PPD file could not be opened.</p>
1468 <h3 class="function"><a name="ppdPageLength">ppdPageLength</a></h3>
1469 <p class="description">Get the page length for the given size.</p>
1470 <p class="code">
1471 float ppdPageLength (<br>
1472 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1473 &nbsp;&nbsp;&nbsp;&nbsp;const char *name<br>
1474 );</p>
1475 <h4 class="parameters">Parameters</h4>
1476 <dl>
1477 <dt>ppd</dt>
1478 <dd class="description">PPD file</dd>
1479 <dt>name</dt>
1480 <dd class="description">Size name</dd>
1481 </dl>
1482 <h4 class="returnvalue">Return Value</h4>
1483 <p class="description">Length of page in points or 0.0</p>
1484 <h3 class="function"><a name="ppdPageSize">ppdPageSize</a></h3>
1485 <p class="description">Get the page size record for the given size.</p>
1486 <p class="code">
1487 <a href="#ppd_size_t">ppd_size_t</a> *ppdPageSize (<br>
1488 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1489 &nbsp;&nbsp;&nbsp;&nbsp;const char *name<br>
1490 );</p>
1491 <h4 class="parameters">Parameters</h4>
1492 <dl>
1493 <dt>ppd</dt>
1494 <dd class="description">PPD file record</dd>
1495 <dt>name</dt>
1496 <dd class="description">Size name</dd>
1497 </dl>
1498 <h4 class="returnvalue">Return Value</h4>
1499 <p class="description">Size record for page or NULL</p>
1500 <h3 class="function"><span class="info">&nbsp;CUPS 1.4/Mac OS X 10.6&nbsp;</span><a name="ppdPageSizeLimits">ppdPageSizeLimits</a></h3>
1501 <p class="description">Return the custom page size limits.</p>
1502 <p class="code">
1503 int ppdPageSizeLimits (<br>
1504 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1505 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_size_t">ppd_size_t</a> *minimum,<br>
1506 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_size_t">ppd_size_t</a> *maximum<br>
1507 );</p>
1508 <h4 class="parameters">Parameters</h4>
1509 <dl>
1510 <dt>ppd</dt>
1511 <dd class="description">PPD file record</dd>
1512 <dt>minimum</dt>
1513 <dd class="description">Minimum custom size</dd>
1514 <dt>maximum</dt>
1515 <dd class="description">Maximum custom size</dd>
1516 </dl>
1517 <h4 class="returnvalue">Return Value</h4>
1518 <p class="description">1 if custom sizes are supported, 0 otherwise</p>
1519 <h4 class="discussion">Discussion</h4>
1520 <p class="discussion">This function returns the minimum and maximum custom page sizes and printable
1521 areas based on the currently-marked (selected) options.<br>
1522 <br>
1523 If the specified PPD file does not support custom page sizes, both
1524 &quot;minimum&quot; and &quot;maximum&quot; are filled with zeroes.
1525
1526 </p>
1527 <h3 class="function"><a name="ppdPageWidth">ppdPageWidth</a></h3>
1528 <p class="description">Get the page width for the given size.</p>
1529 <p class="code">
1530 float ppdPageWidth (<br>
1531 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_file_t">ppd_file_t</a> *ppd,<br>
1532 &nbsp;&nbsp;&nbsp;&nbsp;const char *name<br>
1533 );</p>
1534 <h4 class="parameters">Parameters</h4>
1535 <dl>
1536 <dt>ppd</dt>
1537 <dd class="description">PPD file record</dd>
1538 <dt>name</dt>
1539 <dd class="description">Size name</dd>
1540 </dl>
1541 <h4 class="returnvalue">Return Value</h4>
1542 <p class="description">Width of page in points or 0.0</p>
1543 <h3 class="function"><span class="info">&nbsp;CUPS 1.1.20/Mac OS X 10.4&nbsp;</span><a name="ppdSetConformance">ppdSetConformance</a></h3>
1544 <p class="description">Set the conformance level for PPD files.</p>
1545 <p class="code">
1546 void ppdSetConformance (<br>
1547 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_conform_t">ppd_conform_t</a> c<br>
1548 );</p>
1549 <h4 class="parameters">Parameters</h4>
1550 <dl>
1551 <dt>c</dt>
1552 <dd class="description">Conformance level</dd>
1553 </dl>
1554 <h2 class="title"><a name="TYPES">Data Types</a></h2>
1555 <h3 class="typedef"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppd_attr_t">ppd_attr_t</a></h3>
1556 <p class="description">PPD Attribute Structure </p>
1557 <p class="code">
1558 typedef struct <a href="#ppd_attr_s">ppd_attr_s</a> ppd_attr_t;
1559 </p>
1560 <h3 class="typedef"><a name="ppd_choice_t">ppd_choice_t</a></h3>
1561 <p class="description">Option choices</p>
1562 <p class="code">
1563 typedef struct <a href="#ppd_choice_s">ppd_choice_s</a> ppd_choice_t;
1564 </p>
1565 <h3 class="typedef"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppd_conform_t">ppd_conform_t</a></h3>
1566 <p class="description">Conformance Levels </p>
1567 <p class="code">
1568 typedef enum <a href="#ppd_conform_e">ppd_conform_e</a> ppd_conform_t;
1569 </p>
1570 <h3 class="typedef"><a name="ppd_const_t">ppd_const_t</a></h3>
1571 <p class="description">Constraints</p>
1572 <p class="code">
1573 typedef struct <a href="#ppd_const_s">ppd_const_s</a> ppd_const_t;
1574 </p>
1575 <h3 class="typedef"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppd_coption_t">ppd_coption_t</a></h3>
1576 <p class="description">Custom Option </p>
1577 <p class="code">
1578 typedef struct <a href="#ppd_coption_s">ppd_coption_s</a> ppd_coption_t;
1579 </p>
1580 <h3 class="typedef"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppd_cparam_t">ppd_cparam_t</a></h3>
1581 <p class="description">Custom Parameter </p>
1582 <p class="code">
1583 typedef struct <a href="#ppd_cparam_s">ppd_cparam_s</a> ppd_cparam_t;
1584 </p>
1585 <h3 class="typedef"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppd_cplimit_t">ppd_cplimit_t</a></h3>
1586 <p class="description">Custom Parameter Limit </p>
1587 <p class="code">
1588 typedef union <a href="#ppd_cplimit_u">ppd_cplimit_u</a> ppd_cplimit_t;
1589 </p>
1590 <h3 class="typedef"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppd_cptype_t">ppd_cptype_t</a></h3>
1591 <p class="description">Custom Parameter Type </p>
1592 <p class="code">
1593 typedef enum ppd_cptype_e ppd_cptype_t;
1594 </p>
1595 <h3 class="typedef"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppd_cpvalue_t">ppd_cpvalue_t</a></h3>
1596 <p class="description">Custom Parameter Value </p>
1597 <p class="code">
1598 typedef union <a href="#ppd_cpvalue_u">ppd_cpvalue_u</a> ppd_cpvalue_t;
1599 </p>
1600 <h3 class="typedef"><a name="ppd_cs_t">ppd_cs_t</a></h3>
1601 <p class="description">Colorspaces</p>
1602 <p class="code">
1603 typedef enum <a href="#ppd_cs_e">ppd_cs_e</a> ppd_cs_t;
1604 </p>
1605 <h3 class="typedef"><a name="ppd_emul_t">ppd_emul_t</a></h3>
1606 <p class="description">Emulators</p>
1607 <p class="code">
1608 typedef struct <a href="#ppd_emul_s">ppd_emul_s</a> ppd_emul_t;
1609 </p>
1610 <h3 class="typedef"><a name="ppd_file_t">ppd_file_t</a></h3>
1611 <p class="description">PPD File</p>
1612 <p class="code">
1613 typedef struct <a href="#ppd_file_s">ppd_file_s</a> ppd_file_t;
1614 </p>
1615 <h3 class="typedef"><a name="ppd_group_t">ppd_group_t</a></h3>
1616 <p class="description">Groups</p>
1617 <p class="code">
1618 typedef struct <a href="#ppd_group_s">ppd_group_s</a> ppd_group_t;
1619 </p>
1620 <h3 class="typedef"><a name="ppd_option_t">ppd_option_t</a></h3>
1621 <p class="description">Options</p>
1622 <p class="code">
1623 typedef struct <a href="#ppd_option_s">ppd_option_s</a> ppd_option_t;
1624 </p>
1625 <h3 class="typedef"><a name="ppd_profile_t">ppd_profile_t</a></h3>
1626 <p class="description">sRGB Color Profiles</p>
1627 <p class="code">
1628 typedef struct <a href="#ppd_profile_s">ppd_profile_s</a> ppd_profile_t;
1629 </p>
1630 <h3 class="typedef"><a name="ppd_section_t">ppd_section_t</a></h3>
1631 <p class="description">Order dependency sections</p>
1632 <p class="code">
1633 typedef enum <a href="#ppd_section_e">ppd_section_e</a> ppd_section_t;
1634 </p>
1635 <h3 class="typedef"><a name="ppd_size_t">ppd_size_t</a></h3>
1636 <p class="description">Page Sizes</p>
1637 <p class="code">
1638 typedef struct <a href="#ppd_size_s">ppd_size_s</a> ppd_size_t;
1639 </p>
1640 <h3 class="typedef"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppd_status_t">ppd_status_t</a></h3>
1641 <p class="description">Status Codes </p>
1642 <p class="code">
1643 typedef enum <a href="#ppd_status_e">ppd_status_e</a> ppd_status_t;
1644 </p>
1645 <h3 class="typedef"><a name="ppd_ui_t">ppd_ui_t</a></h3>
1646 <p class="description">UI Types</p>
1647 <p class="code">
1648 typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t;
1649 </p>
1650 <h2 class="title"><a name="STRUCTURES">Structures</a></h2>
1651 <h3 class="struct"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppd_attr_s">ppd_attr_s</a></h3>
1652 <p class="description">PPD Attribute Structure </p>
1653 <p class="code">struct ppd_attr_s {<br>
1654 &nbsp;&nbsp;&nbsp;&nbsp;char name[PPD_MAX_NAME];<br>
1655 &nbsp;&nbsp;&nbsp;&nbsp;char spec[PPD_MAX_NAME];<br>
1656 &nbsp;&nbsp;&nbsp;&nbsp;char text[PPD_MAX_TEXT];<br>
1657 &nbsp;&nbsp;&nbsp;&nbsp;char *value;<br>
1658 };</p>
1659 <h4 class="members">Members</h4>
1660 <dl>
1661 <dt>name[PPD_MAX_NAME] </dt>
1662 <dd class="description">Name of attribute (cupsXYZ)</dd>
1663 <dt>spec[PPD_MAX_NAME] </dt>
1664 <dd class="description">Specifier string, if any</dd>
1665 <dt>text[PPD_MAX_TEXT] </dt>
1666 <dd class="description">Human-readable text, if any</dd>
1667 <dt>value </dt>
1668 <dd class="description">Value string</dd>
1669 </dl>
1670 <h3 class="struct"><a name="ppd_choice_s">ppd_choice_s</a></h3>
1671 <p class="description">Option choices</p>
1672 <p class="code">struct ppd_choice_s {<br>
1673 &nbsp;&nbsp;&nbsp;&nbsp;char choice[PPD_MAX_NAME];<br>
1674 &nbsp;&nbsp;&nbsp;&nbsp;char *code;<br>
1675 &nbsp;&nbsp;&nbsp;&nbsp;char marked;<br>
1676 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_option_t">ppd_option_t</a> *option;<br>
1677 &nbsp;&nbsp;&nbsp;&nbsp;char text[PPD_MAX_TEXT];<br>
1678 };</p>
1679 <h4 class="members">Members</h4>
1680 <dl>
1681 <dt>choice[PPD_MAX_NAME] </dt>
1682 <dd class="description">Computer-readable option name</dd>
1683 <dt>code </dt>
1684 <dd class="description">Code to send for this option</dd>
1685 <dt>marked </dt>
1686 <dd class="description">0 if not selected, 1 otherwise</dd>
1687 <dt>option </dt>
1688 <dd class="description">Pointer to parent option structure</dd>
1689 <dt>text[PPD_MAX_TEXT] </dt>
1690 <dd class="description">Human-readable option name</dd>
1691 </dl>
1692 <h3 class="struct"><a name="ppd_const_s">ppd_const_s</a></h3>
1693 <p class="description">Constraints</p>
1694 <p class="code">struct ppd_const_s {<br>
1695 &nbsp;&nbsp;&nbsp;&nbsp;char choice1[PPD_MAX_NAME];<br>
1696 &nbsp;&nbsp;&nbsp;&nbsp;char choice2[PPD_MAX_NAME];<br>
1697 &nbsp;&nbsp;&nbsp;&nbsp;char option1[PPD_MAX_NAME];<br>
1698 &nbsp;&nbsp;&nbsp;&nbsp;char option2[PPD_MAX_NAME];<br>
1699 };</p>
1700 <h4 class="members">Members</h4>
1701 <dl>
1702 <dt>choice1[PPD_MAX_NAME] </dt>
1703 <dd class="description">First option/choice (blank for all)</dd>
1704 <dt>choice2[PPD_MAX_NAME] </dt>
1705 <dd class="description">Second option/choice (blank for all)</dd>
1706 <dt>option1[PPD_MAX_NAME] </dt>
1707 <dd class="description">First keyword</dd>
1708 <dt>option2[PPD_MAX_NAME] </dt>
1709 <dd class="description">Second keyword</dd>
1710 </dl>
1711 <h3 class="struct"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppd_coption_s">ppd_coption_s</a></h3>
1712 <p class="description">Custom Option </p>
1713 <p class="code">struct ppd_coption_s {<br>
1714 &nbsp;&nbsp;&nbsp;&nbsp;char keyword[PPD_MAX_NAME];<br>
1715 &nbsp;&nbsp;&nbsp;&nbsp;int marked;<br>
1716 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_option_t">ppd_option_t</a> *option;<br>
1717 &nbsp;&nbsp;&nbsp;&nbsp;cups_array_t *params;<br>
1718 };</p>
1719 <h4 class="members">Members</h4>
1720 <dl>
1721 <dt>keyword[PPD_MAX_NAME] </dt>
1722 <dd class="description">Name of option that is being extended...</dd>
1723 <dt>marked </dt>
1724 <dd class="description">Extended option is marked</dd>
1725 <dt>option </dt>
1726 <dd class="description">Option that is being extended...</dd>
1727 <dt>params </dt>
1728 <dd class="description">Parameters</dd>
1729 </dl>
1730 <h3 class="struct"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppd_cparam_s">ppd_cparam_s</a></h3>
1731 <p class="description">Custom Parameter </p>
1732 <p class="code">struct ppd_cparam_s {<br>
1733 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_cpvalue_t">ppd_cpvalue_t</a> current;<br>
1734 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_cplimit_t">ppd_cplimit_t</a> minimum, maximum;<br>
1735 &nbsp;&nbsp;&nbsp;&nbsp;char name[PPD_MAX_NAME];<br>
1736 &nbsp;&nbsp;&nbsp;&nbsp;int order;<br>
1737 &nbsp;&nbsp;&nbsp;&nbsp;char text[PPD_MAX_TEXT];<br>
1738 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_cptype_t">ppd_cptype_t</a> type;<br>
1739 };</p>
1740 <h4 class="members">Members</h4>
1741 <dl>
1742 <dt>current </dt>
1743 <dd class="description">Current value</dd>
1744 <dt>maximum </dt>
1745 <dd class="description">Maximum value</dd>
1746 <dt>name[PPD_MAX_NAME] </dt>
1747 <dd class="description">Parameter name</dd>
1748 <dt>order </dt>
1749 <dd class="description">Order (0 to N)</dd>
1750 <dt>text[PPD_MAX_TEXT] </dt>
1751 <dd class="description">Human-readable text</dd>
1752 <dt>type </dt>
1753 <dd class="description">Parameter type</dd>
1754 </dl>
1755 <h3 class="struct"><a name="ppd_emul_s">ppd_emul_s</a></h3>
1756 <p class="description">Emulators</p>
1757 <p class="code">struct ppd_emul_s {<br>
1758 &nbsp;&nbsp;&nbsp;&nbsp;char name[PPD_MAX_NAME];<br>
1759 &nbsp;&nbsp;&nbsp;&nbsp;char *start;<br>
1760 &nbsp;&nbsp;&nbsp;&nbsp;char *stop;<br>
1761 };</p>
1762 <h4 class="members">Members</h4>
1763 <dl>
1764 <dt>name[PPD_MAX_NAME] </dt>
1765 <dd class="description">Emulator name</dd>
1766 <dt>start </dt>
1767 <dd class="description">Code to switch to this emulation</dd>
1768 <dt>stop </dt>
1769 <dd class="description">Code to stop this emulation</dd>
1770 </dl>
1771 <h3 class="struct"><a name="ppd_file_s">ppd_file_s</a></h3>
1772 <p class="description">PPD File</p>
1773 <p class="code">struct ppd_file_s {<br>
1774 &nbsp;&nbsp;&nbsp;&nbsp;int accurate_screens;<br>
1775 &nbsp;&nbsp;&nbsp;&nbsp;int color_device;<br>
1776 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_cs_t">ppd_cs_t</a> colorspace;<br>
1777 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_const_t">ppd_const_t</a> *consts;<br>
1778 &nbsp;&nbsp;&nbsp;&nbsp;int contone_only;<br>
1779 &nbsp;&nbsp;&nbsp;&nbsp;float custom_margins[4];<br>
1780 &nbsp;&nbsp;&nbsp;&nbsp;float custom_max[2];<br>
1781 &nbsp;&nbsp;&nbsp;&nbsp;float custom_min[2];<br>
1782 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_emul_t">ppd_emul_t</a> *emulations;<br>
1783 &nbsp;&nbsp;&nbsp;&nbsp;char **filters;<br>
1784 &nbsp;&nbsp;&nbsp;&nbsp;int flip_duplex;<br>
1785 &nbsp;&nbsp;&nbsp;&nbsp;char **fonts;<br>
1786 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_group_t">ppd_group_t</a> *groups;<br>
1787 &nbsp;&nbsp;&nbsp;&nbsp;char *jcl_begin;<br>
1788 &nbsp;&nbsp;&nbsp;&nbsp;char *jcl_end;<br>
1789 &nbsp;&nbsp;&nbsp;&nbsp;char *jcl_ps;<br>
1790 &nbsp;&nbsp;&nbsp;&nbsp;int landscape;<br>
1791 &nbsp;&nbsp;&nbsp;&nbsp;char *lang_encoding;<br>
1792 &nbsp;&nbsp;&nbsp;&nbsp;char *lang_version;<br>
1793 &nbsp;&nbsp;&nbsp;&nbsp;int language_level;<br>
1794 &nbsp;&nbsp;&nbsp;&nbsp;int manual_copies;<br>
1795 &nbsp;&nbsp;&nbsp;&nbsp;char *manufacturer;<br>
1796 &nbsp;&nbsp;&nbsp;&nbsp;int model_number;<br>
1797 &nbsp;&nbsp;&nbsp;&nbsp;char *modelname;<br>
1798 &nbsp;&nbsp;&nbsp;&nbsp;char *nickname;<br>
1799 &nbsp;&nbsp;&nbsp;&nbsp;int num_consts;<br>
1800 &nbsp;&nbsp;&nbsp;&nbsp;int num_emulations;<br>
1801 &nbsp;&nbsp;&nbsp;&nbsp;int num_filters;<br>
1802 &nbsp;&nbsp;&nbsp;&nbsp;int num_fonts;<br>
1803 &nbsp;&nbsp;&nbsp;&nbsp;int num_groups;<br>
1804 &nbsp;&nbsp;&nbsp;&nbsp;int num_profiles;<br>
1805 &nbsp;&nbsp;&nbsp;&nbsp;int num_sizes;<br>
1806 &nbsp;&nbsp;&nbsp;&nbsp;char *patches;<br>
1807 &nbsp;&nbsp;&nbsp;&nbsp;char *pcfilename;<br>
1808 &nbsp;&nbsp;&nbsp;&nbsp;char *product;<br>
1809 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_profile_t">ppd_profile_t</a> *profiles;<br>
1810 &nbsp;&nbsp;&nbsp;&nbsp;char *protocols;<br>
1811 &nbsp;&nbsp;&nbsp;&nbsp;char *shortnickname;<br>
1812 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_size_t">ppd_size_t</a> *sizes;<br>
1813 &nbsp;&nbsp;&nbsp;&nbsp;int throughput;<br>
1814 &nbsp;&nbsp;&nbsp;&nbsp;char *ttrasterizer;<br>
1815 &nbsp;&nbsp;&nbsp;&nbsp;int variable_sizes;<br>
1816 };</p>
1817 <h4 class="members">Members</h4>
1818 <dl>
1819 <dt>accurate_screens </dt>
1820 <dd class="description">1 = supports accurate screens, 0 = not</dd>
1821 <dt>color_device </dt>
1822 <dd class="description">1 = color device, 0 = grayscale</dd>
1823 <dt>colorspace </dt>
1824 <dd class="description">Default colorspace</dd>
1825 <dt>consts </dt>
1826 <dd class="description">UI/Non-UI constraints</dd>
1827 <dt>contone_only </dt>
1828 <dd class="description">1 = continuous tone only, 0 = not</dd>
1829 <dt>custom_margins[4] </dt>
1830 <dd class="description">Margins around page</dd>
1831 <dt>custom_max[2] </dt>
1832 <dd class="description">Maximum variable page size</dd>
1833 <dt>custom_min[2] </dt>
1834 <dd class="description">Minimum variable page size</dd>
1835 <dt>emulations </dt>
1836 <dd class="description">Emulations and the code to invoke them</dd>
1837 <dt>filters </dt>
1838 <dd class="description">Filter strings...</dd>
1839 <dt>flip_duplex <span class="info">&nbsp;DEPRECATED&nbsp;</span></dt>
1840 <dd class="description">1 = Flip page for back sides </dd>
1841 <dt>fonts </dt>
1842 <dd class="description">Pre-loaded fonts</dd>
1843 <dt>groups </dt>
1844 <dd class="description">UI groups</dd>
1845 <dt>jcl_begin </dt>
1846 <dd class="description">Start JCL commands</dd>
1847 <dt>jcl_end </dt>
1848 <dd class="description">End JCL commands</dd>
1849 <dt>jcl_ps </dt>
1850 <dd class="description">Enter PostScript interpreter</dd>
1851 <dt>landscape </dt>
1852 <dd class="description">-90 or 90</dd>
1853 <dt>lang_encoding </dt>
1854 <dd class="description">Language encoding</dd>
1855 <dt>lang_version </dt>
1856 <dd class="description">Language version (English, Spanish, etc.)</dd>
1857 <dt>language_level </dt>
1858 <dd class="description">Language level of device</dd>
1859 <dt>manual_copies </dt>
1860 <dd class="description">1 = Copies done manually, 0 = hardware</dd>
1861 <dt>manufacturer </dt>
1862 <dd class="description">Manufacturer name</dd>
1863 <dt>model_number </dt>
1864 <dd class="description">Device-specific model number</dd>
1865 <dt>modelname </dt>
1866 <dd class="description">Model name (general)</dd>
1867 <dt>nickname </dt>
1868 <dd class="description">Nickname (specific)</dd>
1869 <dt>num_consts </dt>
1870 <dd class="description">Number of UI/Non-UI constraints</dd>
1871 <dt>num_emulations </dt>
1872 <dd class="description">Number of emulations supported</dd>
1873 <dt>num_filters </dt>
1874 <dd class="description">Number of filters</dd>
1875 <dt>num_fonts </dt>
1876 <dd class="description">Number of pre-loaded fonts</dd>
1877 <dt>num_groups </dt>
1878 <dd class="description">Number of UI groups</dd>
1879 <dt>num_profiles <span class="info">&nbsp;DEPRECATED&nbsp;</span></dt>
1880 <dd class="description">Number of sRGB color profiles </dd>
1881 <dt>num_sizes </dt>
1882 <dd class="description">Number of page sizes</dd>
1883 <dt>patches </dt>
1884 <dd class="description">Patch commands to be sent to printer</dd>
1885 <dt>pcfilename <span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span></dt>
1886 <dd class="description">PCFileName string </dd>
1887 <dt>product </dt>
1888 <dd class="description">Product name (from PS RIP/interpreter)</dd>
1889 <dt>profiles <span class="info">&nbsp;DEPRECATED&nbsp;</span></dt>
1890 <dd class="description">sRGB color profiles </dd>
1891 <dt>protocols <span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span></dt>
1892 <dd class="description">Protocols (BCP, TBCP) string </dd>
1893 <dt>shortnickname </dt>
1894 <dd class="description">Short version of nickname</dd>
1895 <dt>sizes </dt>
1896 <dd class="description">Page sizes</dd>
1897 <dt>throughput </dt>
1898 <dd class="description">Pages per minute</dd>
1899 <dt>ttrasterizer </dt>
1900 <dd class="description">Truetype rasterizer</dd>
1901 <dt>variable_sizes </dt>
1902 <dd class="description">1 = supports variable sizes, 0 = doesn't</dd>
1903 </dl>
1904 <h3 class="struct"><a name="ppd_group_s">ppd_group_s</a></h3>
1905 <p class="description">Groups</p>
1906 <p class="code">struct ppd_group_s {<br>
1907 &nbsp;&nbsp;&nbsp;&nbsp;char text[PPD_MAX_TEXT - PPD_MAX_NAME];<br>
1908 &nbsp;&nbsp;&nbsp;&nbsp;char name[PPD_MAX_NAME];<br>
1909 &nbsp;&nbsp;&nbsp;&nbsp;int num_options;<br>
1910 &nbsp;&nbsp;&nbsp;&nbsp;int num_subgroups;<br>
1911 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_option_t">ppd_option_t</a> *options;<br>
1912 &nbsp;&nbsp;&nbsp;&nbsp;struct <a href="#ppd_group_s">ppd_group_s</a> *subgroups;<br>
1913 };</p>
1914 <h4 class="members">Members</h4>
1915 <dl>
1916 <dt>PPD_MAX_NAME] </dt>
1917 <dd class="description">Human-readable group name</dd>
1918 <dt>name[PPD_MAX_NAME] <span class="info">&nbsp;CUPS 1.1.18/Mac OS X 10.3&nbsp;</span></dt>
1919 <dd class="description">Group name </dd>
1920 <dt>num_options </dt>
1921 <dd class="description">Number of options</dd>
1922 <dt>num_subgroups </dt>
1923 <dd class="description">Number of sub-groups</dd>
1924 <dt>options </dt>
1925 <dd class="description">Options</dd>
1926 <dt>subgroups </dt>
1927 <dd class="description">Sub-groups (max depth = 1)</dd>
1928 </dl>
1929 <h3 class="struct"><a name="ppd_option_s">ppd_option_s</a></h3>
1930 <p class="description">Options</p>
1931 <p class="code">struct ppd_option_s {<br>
1932 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_choice_t">ppd_choice_t</a> *choices;<br>
1933 &nbsp;&nbsp;&nbsp;&nbsp;char conflicted;<br>
1934 &nbsp;&nbsp;&nbsp;&nbsp;char defchoice[PPD_MAX_NAME];<br>
1935 &nbsp;&nbsp;&nbsp;&nbsp;char keyword[PPD_MAX_NAME];<br>
1936 &nbsp;&nbsp;&nbsp;&nbsp;int num_choices;<br>
1937 &nbsp;&nbsp;&nbsp;&nbsp;float order;<br>
1938 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_section_t">ppd_section_t</a> section;<br>
1939 &nbsp;&nbsp;&nbsp;&nbsp;char text[PPD_MAX_TEXT];<br>
1940 &nbsp;&nbsp;&nbsp;&nbsp;<a href="#ppd_ui_t">ppd_ui_t</a> ui;<br>
1941 };</p>
1942 <h4 class="members">Members</h4>
1943 <dl>
1944 <dt>choices </dt>
1945 <dd class="description">Option choices</dd>
1946 <dt>conflicted </dt>
1947 <dd class="description">0 if no conflicts exist, 1 otherwise</dd>
1948 <dt>defchoice[PPD_MAX_NAME] </dt>
1949 <dd class="description">Default option choice</dd>
1950 <dt>keyword[PPD_MAX_NAME] </dt>
1951 <dd class="description">Option keyword name (&quot;PageSize&quot;, etc.)</dd>
1952 <dt>num_choices </dt>
1953 <dd class="description">Number of option choices</dd>
1954 <dt>order </dt>
1955 <dd class="description">Order number</dd>
1956 <dt>section </dt>
1957 <dd class="description">Section for command</dd>
1958 <dt>text[PPD_MAX_TEXT] </dt>
1959 <dd class="description">Human-readable text</dd>
1960 <dt>ui </dt>
1961 <dd class="description">Type of UI option</dd>
1962 </dl>
1963 <h3 class="struct"><a name="ppd_profile_s">ppd_profile_s</a></h3>
1964 <p class="description">sRGB Color Profiles</p>
1965 <p class="code">struct ppd_profile_s {<br>
1966 &nbsp;&nbsp;&nbsp;&nbsp;float density;<br>
1967 &nbsp;&nbsp;&nbsp;&nbsp;float gamma;<br>
1968 &nbsp;&nbsp;&nbsp;&nbsp;float matrix[3][3];<br>
1969 &nbsp;&nbsp;&nbsp;&nbsp;char media_type[PPD_MAX_NAME];<br>
1970 &nbsp;&nbsp;&nbsp;&nbsp;char resolution[PPD_MAX_NAME];<br>
1971 };</p>
1972 <h4 class="members">Members</h4>
1973 <dl>
1974 <dt>density </dt>
1975 <dd class="description">Ink density to use</dd>
1976 <dt>gamma </dt>
1977 <dd class="description">Gamma correction to use</dd>
1978 <dt>matrix[3][3] </dt>
1979 <dd class="description">Transform matrix</dd>
1980 <dt>media_type[PPD_MAX_NAME] </dt>
1981 <dd class="description">Media type or &quot;-&quot;</dd>
1982 <dt>resolution[PPD_MAX_NAME] </dt>
1983 <dd class="description">Resolution or &quot;-&quot;</dd>
1984 </dl>
1985 <h3 class="struct"><a name="ppd_size_s">ppd_size_s</a></h3>
1986 <p class="description">Page Sizes</p>
1987 <p class="code">struct ppd_size_s {<br>
1988 &nbsp;&nbsp;&nbsp;&nbsp;float bottom;<br>
1989 &nbsp;&nbsp;&nbsp;&nbsp;float left;<br>
1990 &nbsp;&nbsp;&nbsp;&nbsp;float length;<br>
1991 &nbsp;&nbsp;&nbsp;&nbsp;int marked;<br>
1992 &nbsp;&nbsp;&nbsp;&nbsp;char name[PPD_MAX_NAME];<br>
1993 &nbsp;&nbsp;&nbsp;&nbsp;float right;<br>
1994 &nbsp;&nbsp;&nbsp;&nbsp;float top;<br>
1995 &nbsp;&nbsp;&nbsp;&nbsp;float width;<br>
1996 };</p>
1997 <h4 class="members">Members</h4>
1998 <dl>
1999 <dt>bottom </dt>
2000 <dd class="description">Bottom printable margin in points</dd>
2001 <dt>left </dt>
2002 <dd class="description">Left printable margin in points</dd>
2003 <dt>length </dt>
2004 <dd class="description">Length of media in points</dd>
2005 <dt>marked </dt>
2006 <dd class="description">Page size selected?</dd>
2007 <dt>name[PPD_MAX_NAME] </dt>
2008 <dd class="description">Media size option</dd>
2009 <dt>right </dt>
2010 <dd class="description">Right printable margin in points</dd>
2011 <dt>top </dt>
2012 <dd class="description">Top printable margin in points</dd>
2013 <dt>width </dt>
2014 <dd class="description">Width of media in points</dd>
2015 </dl>
2016 <h2 class="title"><a name="UNIONS">Unions</a></h2>
2017 <h3 class="union"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppd_cplimit_u">ppd_cplimit_u</a></h3>
2018 <p class="description">Custom Parameter Limit </p>
2019 <p class="code">union ppd_cplimit_u {<br>
2020 &nbsp;&nbsp;&nbsp;&nbsp;float custom_curve;<br>
2021 &nbsp;&nbsp;&nbsp;&nbsp;int custom_int;<br>
2022 &nbsp;&nbsp;&nbsp;&nbsp;float custom_invcurve;<br>
2023 &nbsp;&nbsp;&nbsp;&nbsp;int custom_passcode;<br>
2024 &nbsp;&nbsp;&nbsp;&nbsp;int custom_password;<br>
2025 &nbsp;&nbsp;&nbsp;&nbsp;float custom_points;<br>
2026 &nbsp;&nbsp;&nbsp;&nbsp;float custom_real;<br>
2027 &nbsp;&nbsp;&nbsp;&nbsp;int custom_string;<br>
2028 };</p>
2029 <h4 class="members">Members</h4>
2030 <dl>
2031 <dt>custom_curve </dt>
2032 <dd class="description">Gamma value</dd>
2033 <dt>custom_int </dt>
2034 <dd class="description">Integer value</dd>
2035 <dt>custom_invcurve </dt>
2036 <dd class="description">Gamma value</dd>
2037 <dt>custom_passcode </dt>
2038 <dd class="description">Passcode length</dd>
2039 <dt>custom_password </dt>
2040 <dd class="description">Password length</dd>
2041 <dt>custom_points </dt>
2042 <dd class="description">Measurement value</dd>
2043 <dt>custom_real </dt>
2044 <dd class="description">Real value</dd>
2045 <dt>custom_string </dt>
2046 <dd class="description">String length</dd>
2047 </dl>
2048 <h3 class="union"><span class="info">&nbsp;CUPS 1.2/Mac OS X 10.5&nbsp;</span><a name="ppd_cpvalue_u">ppd_cpvalue_u</a></h3>
2049 <p class="description">Custom Parameter Value </p>
2050 <p class="code">union ppd_cpvalue_u {<br>
2051 &nbsp;&nbsp;&nbsp;&nbsp;float custom_curve;<br>
2052 &nbsp;&nbsp;&nbsp;&nbsp;int custom_int;<br>
2053 &nbsp;&nbsp;&nbsp;&nbsp;float custom_invcurve;<br>
2054 &nbsp;&nbsp;&nbsp;&nbsp;char *custom_passcode;<br>
2055 &nbsp;&nbsp;&nbsp;&nbsp;char *custom_password;<br>
2056 &nbsp;&nbsp;&nbsp;&nbsp;float custom_points;<br>
2057 &nbsp;&nbsp;&nbsp;&nbsp;float custom_real;<br>
2058 &nbsp;&nbsp;&nbsp;&nbsp;char *custom_string;<br>
2059 };</p>
2060 <h4 class="members">Members</h4>
2061 <dl>
2062 <dt>custom_curve </dt>
2063 <dd class="description">Gamma value</dd>
2064 <dt>custom_int </dt>
2065 <dd class="description">Integer value</dd>
2066 <dt>custom_invcurve </dt>
2067 <dd class="description">Gamma value</dd>
2068 <dt>custom_passcode </dt>
2069 <dd class="description">Passcode value</dd>
2070 <dt>custom_password </dt>
2071 <dd class="description">Password value</dd>
2072 <dt>custom_points </dt>
2073 <dd class="description">Measurement value</dd>
2074 <dt>custom_real </dt>
2075 <dd class="description">Real value</dd>
2076 <dt>custom_string </dt>
2077 <dd class="description">String value</dd>
2078 </dl>
2079 <h2 class="title"><a name="ENUMERATIONS">Constants</a></h2>
2080 <h3 class="enumeration"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppd_conform_e">ppd_conform_e</a></h3>
2081 <p class="description">Conformance Levels </p>
2082 <h4 class="constants">Constants</h4>
2083 <dl>
2084 <dt>PPD_CONFORM_RELAXED </dt>
2085 <dd class="description">Relax whitespace and control char</dd>
2086 <dt>PPD_CONFORM_STRICT </dt>
2087 <dd class="description">Require strict conformance</dd>
2088 </dl>
2089 <h3 class="enumeration"><a name="ppd_cs_e">ppd_cs_e</a></h3>
2090 <p class="description">Colorspaces</p>
2091 <h4 class="constants">Constants</h4>
2092 <dl>
2093 <dt>PPD_CS_CMY </dt>
2094 <dd class="description">CMY colorspace</dd>
2095 <dt>PPD_CS_CMYK </dt>
2096 <dd class="description">CMYK colorspace</dd>
2097 <dt>PPD_CS_GRAY </dt>
2098 <dd class="description">Grayscale colorspace</dd>
2099 <dt>PPD_CS_N </dt>
2100 <dd class="description">DeviceN colorspace</dd>
2101 <dt>PPD_CS_RGB </dt>
2102 <dd class="description">RGB colorspace</dd>
2103 <dt>PPD_CS_RGBK </dt>
2104 <dd class="description">RGBK (K = gray) colorspace</dd>
2105 </dl>
2106 <h3 class="enumeration"><a name="ppd_section_e">ppd_section_e</a></h3>
2107 <p class="description">Order dependency sections</p>
2108 <h4 class="constants">Constants</h4>
2109 <dl>
2110 <dt>PPD_ORDER_ANY </dt>
2111 <dd class="description">Option code can be anywhere in the file</dd>
2112 <dt>PPD_ORDER_DOCUMENT </dt>
2113 <dd class="description">... must be in the DocumentSetup section</dd>
2114 <dt>PPD_ORDER_EXIT </dt>
2115 <dd class="description">... must be sent prior to the document</dd>
2116 <dt>PPD_ORDER_JCL </dt>
2117 <dd class="description">... must be sent as a JCL command</dd>
2118 <dt>PPD_ORDER_PAGE </dt>
2119 <dd class="description">... must be in the PageSetup section</dd>
2120 <dt>PPD_ORDER_PROLOG </dt>
2121 <dd class="description">... must be in the Prolog section</dd>
2122 </dl>
2123 <h3 class="enumeration"><span class="info">&nbsp;CUPS 1.1.19/Mac OS X 10.3&nbsp;</span><a name="ppd_status_e">ppd_status_e</a></h3>
2124 <p class="description">Status Codes </p>
2125 <h4 class="constants">Constants</h4>
2126 <dl>
2127 <dt>PPD_ALLOC_ERROR </dt>
2128 <dd class="description">Memory allocation error</dd>
2129 <dt>PPD_BAD_CUSTOM_PARAM </dt>
2130 <dd class="description">Bad custom parameter</dd>
2131 <dt>PPD_BAD_OPEN_GROUP </dt>
2132 <dd class="description">Bad OpenGroup</dd>
2133 <dt>PPD_BAD_OPEN_UI </dt>
2134 <dd class="description">Bad OpenUI/JCLOpenUI</dd>
2135 <dt>PPD_BAD_ORDER_DEPENDENCY </dt>
2136 <dd class="description">Bad OrderDependency</dd>
2137 <dt>PPD_BAD_UI_CONSTRAINTS </dt>
2138 <dd class="description">Bad UIConstraints</dd>
2139 <dt>PPD_BAD_VALUE </dt>
2140 <dd class="description">Bad value string</dd>
2141 <dt>PPD_FILE_OPEN_ERROR </dt>
2142 <dd class="description">Unable to open PPD file</dd>
2143 <dt>PPD_ILLEGAL_CHARACTER </dt>
2144 <dd class="description">Illegal control character</dd>
2145 <dt>PPD_ILLEGAL_MAIN_KEYWORD </dt>
2146 <dd class="description">Illegal main keyword string</dd>
2147 <dt>PPD_ILLEGAL_OPTION_KEYWORD </dt>
2148 <dd class="description">Illegal option keyword string</dd>
2149 <dt>PPD_ILLEGAL_TRANSLATION </dt>
2150 <dd class="description">Illegal translation string</dd>
2151 <dt>PPD_ILLEGAL_WHITESPACE </dt>
2152 <dd class="description">Illegal whitespace character</dd>
2153 <dt>PPD_INTERNAL_ERROR </dt>
2154 <dd class="description">Internal error</dd>
2155 <dt>PPD_LINE_TOO_LONG </dt>
2156 <dd class="description">Line longer than 255 chars</dd>
2157 <dt>PPD_MISSING_ASTERISK </dt>
2158 <dd class="description">Missing asterisk in column 0</dd>
2159 <dt>PPD_MISSING_CLOSE_GROUP </dt>
2160 <dd class="description">Missing CloseGroup</dd>
2161 <dt>PPD_MISSING_OPTION_KEYWORD </dt>
2162 <dd class="description">Missing option keyword</dd>
2163 <dt>PPD_MISSING_PPDADOBE4 </dt>
2164 <dd class="description">Missing PPD-Adobe-4.x header</dd>
2165 <dt>PPD_MISSING_VALUE </dt>
2166 <dd class="description">Missing value string</dd>
2167 <dt>PPD_NESTED_OPEN_GROUP </dt>
2168 <dd class="description">OpenGroup without a CloseGroup first</dd>
2169 <dt>PPD_NESTED_OPEN_UI </dt>
2170 <dd class="description">OpenUI/JCLOpenUI without a CloseUI/JCLCloseUI first</dd>
2171 <dt>PPD_NULL_FILE </dt>
2172 <dd class="description">NULL PPD file pointer</dd>
2173 <dt>PPD_OK </dt>
2174 <dd class="description">OK</dd>
2175 </dl>
2176 <h3 class="enumeration"><a name="ppd_ui_e">ppd_ui_e</a></h3>
2177 <p class="description">UI Types</p>
2178 <h4 class="constants">Constants</h4>
2179 <dl>
2180 <dt>PPD_UI_BOOLEAN </dt>
2181 <dd class="description">True or False option</dd>
2182 <dt>PPD_UI_PICKMANY </dt>
2183 <dd class="description">Pick zero or more from a list</dd>
2184 <dt>PPD_UI_PICKONE </dt>
2185 <dd class="description">Pick one from a list</dd>
2186 </dl>
2187 </div>
2188 </body>
2189 </html>