1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
3 <!-- SECTION: Programming -->
5 <title>PPD API (DEPRECATED)
</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"><!--
11 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
14 H1, H2, H3, H4, H5, H6, P, TD, TH {
15 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
19 font-family: monaco, courier, monospace;
24 font-family: monaco, courier, monospace;
28 border: dotted thin #7f7f7f;
44 border: dotted thin #999999;
49 PRE.command EM, PRE.example EM {
50 font-family: lucida grande, geneva, helvetica, arial, sans-serif;
54 font-family: monaco, courier, monospace;
65 border: solid thin #999999;
76 -moz-border-radius: 10px;
81 text-decoration: none;
84 A:link:hover, A:visited:hover, A:active {
85 text-decoration: underline;
92 TR.data, TD.data, TR.data TD {
95 border-bottom: solid 1pt #999999;
99 border-bottom: solid 1pt #999999;
106 border: solid thin #999999;
107 border-collapse: collapse;
123 border: solid thin #cccccc;
130 border-bottom: solid thin #999999;
139 caption-side: bottom;
163 border: thin solid black;
171 H2 SPAN.info, H3 SPAN.info, H4 SPAN.info {
180 border-bottom: solid 2pt #000000;
183 DIV.indent, TABLE.indent {
191 border-collapse: collapse;
194 TABLE.indent TD, TABLE.indent TH {
199 border-collapse: collapse;
207 border-bottom: solid thin #cccccc;
212 vertical-align: bottom;
221 border-bottom: solid thin #eeeeee;
226 TABLE.list TR:nth-child(even) {
230 TABLE.list TR:nth-child(odd) {
249 font-family: monaco, courier, monospace;
253 border: solid thin #999999;
254 border-collapse: collapse;
259 DIV.summary TABLE TD, DIV.summary TABLE TH {
260 border: solid thin #999999;
266 DIV.summary TABLE THEAD TH {
270 /* API documentation styles... */
277 div.body h3, div.body h4, div.body h5 {
278 margin-bottom: 0.5em;
281 .class, .enumeration, .function, .struct, .typedef, .union {
282 border-bottom: solid thin #999999;
289 code, p.code, pre, ul.code li {
290 font-family: monaco, courier, monospace;
293 ul.code, ul.contents, ul.subcontents {
294 list-style-type: none;
304 ul.contents li ul.code, ul.contents li ul.subcontents {
317 margin-bottom: 0.5em;
320 /* This is just for the HTML files generated with the framedhelp target */
323 border: solid thin black;
332 div.contents ul.contents {
335 div.contents ul.subcontents li {
344 "$Id: api-ppd.header 7616 2008-05-28 00:34:13Z mike $"
346 PPD API header for CUPS.
348 Copyright 2008-2012 by Apple Inc.
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/".
357 <h1 class='title'
>PPD API (DEPRECATED)
</h1>
359 <blockquote>The PPD API is deprecated starting in CUPS
1.6/OS X
10.8. Please use the new Job Ticket APIs in the
<a href=
"api-cups.html">CUPS API
</a> documentation. These functions will be removed in a future release of CUPS.
</blockquote>
361 <div class='summary'
><table summary='General Information'
>
375 <td>Programming:
<a href='api-overview.html' target='_top'
>Introduction to CUPS Programming
</a><br>
376 Programming:
<a href='api-cups.html' target='_top'
>CUPS API
</a><br>
377 Specifications:
<a href='spec-ppd.html' target='_top'
>CUPS PPD Extensions
</a></td>
381 <h2 class=
"title">Contents
</h2>
382 <ul class=
"contents">
383 <li><a href=
"#OVERVIEW">Overview
</a><ul class=
"subcontents">
384 <li><a href=
"#LOADING">Loading a PPD File
</a></li>
385 <li><a href=
"#OPTIONS_AND_GROUPS">Options and Groups
</a></li>
386 <li><a href=
"#CONSTRAINTS">Constraints
</a></li>
387 <li><a href=
"#PAGE_SIZES">Page Sizes
</a></li>
388 <li><a href=
"#ATTRIBUTES">Attributes
</a></li>
390 <li><a href=
"#FUNCTIONS">Functions
</a><ul class=
"code">
391 <li><a href=
"#cupsGetConflicts" title=
"Get a list of conflicting options in a marked PPD.">cupsGetConflicts
</a></li>
392 <li><a href=
"#cupsMarkOptions" title=
"Mark command-line options in a PPD file.">cupsMarkOptions
</a></li>
393 <li><a href=
"#cupsResolveConflicts" title=
"Resolve conflicts in a marked PPD.">cupsResolveConflicts
</a></li>
394 <li><a href=
"#ppdClose" title=
"Free all memory used by the PPD file.">ppdClose
</a></li>
395 <li><a href=
"#ppdCollect" title=
"Collect all marked options that reside in the specified
396 section.">ppdCollect
</a></li>
397 <li><a href=
"#ppdCollect2" title=
"Collect all marked options that reside in the
398 specified section and minimum order.">ppdCollect2
</a></li>
399 <li><a href=
"#ppdConflicts" title=
"Check to see if there are any conflicts among the
400 marked option choices.">ppdConflicts
</a></li>
401 <li><a href=
"#ppdEmit" title=
"Emit code for marked options to a file.">ppdEmit
</a></li>
402 <li><a href=
"#ppdEmitAfterOrder" title=
"Emit a subset of the code for marked options to a file.">ppdEmitAfterOrder
</a></li>
403 <li><a href=
"#ppdEmitFd" title=
"Emit code for marked options to a file.">ppdEmitFd
</a></li>
404 <li><a href=
"#ppdEmitJCL" title=
"Emit code for JCL options to a file.">ppdEmitJCL
</a></li>
405 <li><a href=
"#ppdEmitJCLEnd" title=
"Emit JCLEnd code to a file.">ppdEmitJCLEnd
</a></li>
406 <li><a href=
"#ppdEmitString" title=
"Get a string containing the code for marked options.">ppdEmitString
</a></li>
407 <li><a href=
"#ppdErrorString" title=
"Returns the text assocated with a status.">ppdErrorString
</a></li>
408 <li><a href=
"#ppdFindAttr" title=
"Find the first matching attribute.">ppdFindAttr
</a></li>
409 <li><a href=
"#ppdFindChoice" title=
"Return a pointer to an option choice.">ppdFindChoice
</a></li>
410 <li><a href=
"#ppdFindCustomOption" title=
"Find a custom option.">ppdFindCustomOption
</a></li>
411 <li><a href=
"#ppdFindCustomParam" title=
"Find a parameter for a custom option.">ppdFindCustomParam
</a></li>
412 <li><a href=
"#ppdFindMarkedChoice" title=
"Return the marked choice for the specified option.">ppdFindMarkedChoice
</a></li>
413 <li><a href=
"#ppdFindNextAttr" title=
"Find the next matching attribute.">ppdFindNextAttr
</a></li>
414 <li><a href=
"#ppdFindOption" title=
"Return a pointer to the specified option.">ppdFindOption
</a></li>
415 <li><a href=
"#ppdFirstCustomParam" title=
"Return the first parameter for a custom option.">ppdFirstCustomParam
</a></li>
416 <li><a href=
"#ppdFirstOption" title=
"Return the first option in the PPD file.">ppdFirstOption
</a></li>
417 <li><a href=
"#ppdInstallableConflict" title=
"Test whether an option choice conflicts with
418 an installable option.">ppdInstallableConflict
</a></li>
419 <li><a href=
"#ppdIsMarked" title=
"Check to see if an option is marked.">ppdIsMarked
</a></li>
420 <li><a href=
"#ppdLastError" title=
"Return the status from the last ppdOpen*().">ppdLastError
</a></li>
421 <li><a href=
"#ppdLocalize" title=
"Localize the PPD file to the current locale.">ppdLocalize
</a></li>
422 <li><a href=
"#ppdLocalizeAttr" title=
"Localize an attribute.">ppdLocalizeAttr
</a></li>
423 <li><a href=
"#ppdLocalizeIPPReason" title=
"Get the localized version of a cupsIPPReason
424 attribute.">ppdLocalizeIPPReason
</a></li>
425 <li><a href=
"#ppdLocalizeMarkerName" title=
"Get the localized version of a marker-names
426 attribute value.">ppdLocalizeMarkerName
</a></li>
427 <li><a href=
"#ppdMarkDefaults" title=
"Mark all default options in the PPD file.">ppdMarkDefaults
</a></li>
428 <li><a href=
"#ppdMarkOption" title=
"Mark an option in a PPD file and return the number of
429 conflicts.">ppdMarkOption
</a></li>
430 <li><a href=
"#ppdNextCustomParam" title=
"Return the next parameter for a custom option.">ppdNextCustomParam
</a></li>
431 <li><a href=
"#ppdNextOption" title=
"Return the next option in the PPD file.">ppdNextOption
</a></li>
432 <li><a href=
"#ppdOpen" title=
"Read a PPD file into memory.">ppdOpen
</a></li>
433 <li><a href=
"#ppdOpen2" title=
"Read a PPD file into memory.">ppdOpen2
</a></li>
434 <li><a href=
"#ppdOpenFd" title=
"Read a PPD file into memory.">ppdOpenFd
</a></li>
435 <li><a href=
"#ppdOpenFile" title=
"Read a PPD file into memory.">ppdOpenFile
</a></li>
436 <li><a href=
"#ppdPageLength" title=
"Get the page length for the given size.">ppdPageLength
</a></li>
437 <li><a href=
"#ppdPageSize" title=
"Get the page size record for the named size.">ppdPageSize
</a></li>
438 <li><a href=
"#ppdPageSizeLimits" title=
"Return the custom page size limits.">ppdPageSizeLimits
</a></li>
439 <li><a href=
"#ppdPageWidth" title=
"Get the page width for the given size.">ppdPageWidth
</a></li>
440 <li><a href=
"#ppdSetConformance" title=
"Set the conformance level for PPD files.">ppdSetConformance
</a></li>
442 <li><a href=
"#TYPES">Data Types
</a><ul class=
"code">
443 <li><a href=
"#ppd_attr_t" title=
"PPD Attribute Structure ">ppd_attr_t
</a></li>
444 <li><a href=
"#ppd_choice_t" title=
"Option choices">ppd_choice_t
</a></li>
445 <li><a href=
"#ppd_conform_t" title=
"Conformance Levels ">ppd_conform_t
</a></li>
446 <li><a href=
"#ppd_const_t" title=
"Constraints">ppd_const_t
</a></li>
447 <li><a href=
"#ppd_coption_t" title=
"Custom Option ">ppd_coption_t
</a></li>
448 <li><a href=
"#ppd_cparam_t" title=
"Custom Parameter ">ppd_cparam_t
</a></li>
449 <li><a href=
"#ppd_cplimit_t" title=
"Custom Parameter Limit ">ppd_cplimit_t
</a></li>
450 <li><a href=
"#ppd_cptype_t" title=
"Custom Parameter Type ">ppd_cptype_t
</a></li>
451 <li><a href=
"#ppd_cpvalue_t" title=
"Custom Parameter Value ">ppd_cpvalue_t
</a></li>
452 <li><a href=
"#ppd_cs_t" title=
"Colorspaces">ppd_cs_t
</a></li>
453 <li><a href=
"#ppd_emul_t" title=
"Emulators">ppd_emul_t
</a></li>
454 <li><a href=
"#ppd_file_t" title=
"PPD File">ppd_file_t
</a></li>
455 <li><a href=
"#ppd_group_t" title=
"Groups">ppd_group_t
</a></li>
456 <li><a href=
"#ppd_option_t" title=
"Options">ppd_option_t
</a></li>
457 <li><a href=
"#ppd_profile_t" title=
"sRGB Color Profiles">ppd_profile_t
</a></li>
458 <li><a href=
"#ppd_section_t" title=
"Order dependency sections">ppd_section_t
</a></li>
459 <li><a href=
"#ppd_size_t" title=
"Page Sizes">ppd_size_t
</a></li>
460 <li><a href=
"#ppd_status_t" title=
"Status Codes ">ppd_status_t
</a></li>
461 <li><a href=
"#ppd_ui_t" title=
"UI Types">ppd_ui_t
</a></li>
463 <li><a href=
"#STRUCTURES">Structures
</a><ul class=
"code">
464 <li><a href=
"#ppd_attr_s" title=
"PPD Attribute Structure ">ppd_attr_s
</a></li>
465 <li><a href=
"#ppd_choice_s" title=
"Option choices">ppd_choice_s
</a></li>
466 <li><a href=
"#ppd_const_s" title=
"Constraints">ppd_const_s
</a></li>
467 <li><a href=
"#ppd_coption_s" title=
"Custom Option ">ppd_coption_s
</a></li>
468 <li><a href=
"#ppd_cparam_s" title=
"Custom Parameter ">ppd_cparam_s
</a></li>
469 <li><a href=
"#ppd_emul_s" title=
"Emulators">ppd_emul_s
</a></li>
470 <li><a href=
"#ppd_file_s" title=
"PPD File">ppd_file_s
</a></li>
471 <li><a href=
"#ppd_group_s" title=
"Groups">ppd_group_s
</a></li>
472 <li><a href=
"#ppd_option_s" title=
"Options">ppd_option_s
</a></li>
473 <li><a href=
"#ppd_profile_s" title=
"sRGB Color Profiles">ppd_profile_s
</a></li>
474 <li><a href=
"#ppd_size_s" title=
"Page Sizes">ppd_size_s
</a></li>
476 <li><a href=
"#UNIONS">Unions
</a><ul class=
"code">
477 <li><a href=
"#ppd_cplimit_u" title=
"Custom Parameter Limit ">ppd_cplimit_u
</a></li>
478 <li><a href=
"#ppd_cpvalue_u" title=
"Custom Parameter Value ">ppd_cpvalue_u
</a></li>
480 <li><a href=
"#ENUMERATIONS">Constants
</a><ul class=
"code">
481 <li><a href=
"#ppd_conform_e" title=
"Conformance Levels ">ppd_conform_e
</a></li>
482 <li><a href=
"#ppd_cs_e" title=
"Colorspaces">ppd_cs_e
</a></li>
483 <li><a href=
"#ppd_section_e" title=
"Order dependency sections">ppd_section_e
</a></li>
484 <li><a href=
"#ppd_status_e" title=
"Status Codes ">ppd_status_e
</a></li>
485 <li><a href=
"#ppd_ui_e" title=
"UI Types">ppd_ui_e
</a></li>
489 "$Id: api-ppd.shtml 7616 2008-05-28 00:34:13Z mike $"
491 PPD API introduction for CUPS.
493 Copyright 2007-2012 by Apple Inc.
494 Copyright 1997-2006 by Easy Software Products, all rights reserved.
496 These coded instructions, statements, and computer programs are the
497 property of Apple Inc. and are protected by Federal copyright
498 law. Distribution and use rights are outlined in the file "LICENSE.txt"
499 which should have been included with this file. If this file is
500 file is missing or damaged, see the license at "http://www.cups.org/".
503 <h2 class='title'
><a name='OVERVIEW'
>Overview
</a></h2>
505 <blockquote>The PPD API is deprecated starting in CUPS
1.6/OS X
10.8. Please use the new Job Ticket APIs in the
<a href=
"api-cups.html">CUPS API
</a> documentation. These functions will be removed in a future release of CUPS.
</blockquote>
507 <p>The CUPS PPD API provides read-only access the data in PostScript Printer
508 Description (
"PPD") files which are used for all printers with a driver. With
509 it you can obtain the data necessary to display printer options to users, mark
510 option choices and check for conflicting choices, and output marked choices in
511 PostScript output. The
<a href=
"#ppd_file_t"><code>ppd_file_t
</code></a>
512 structure contains all of the information in a PPD file.
</p>
514 <blockquote><b>Note:
</b>
516 <p>The CUPS PPD API uses the terms
"option" and
"choice" instead of the Adobe
517 terms
"MainKeyword" and
"OptionKeyword" to refer to specific printer options and
518 features. CUPS also treats option (
"MainKeyword") and choice (
"OptionKeyword")
519 values as case-insensitive strings, so option
"InputSlot" and choice
"Upper"
520 are equivalent to
"inputslot" and
"upper", respectively.
</p>
523 <h3><a name=
"LOADING">Loading a PPD File
</a></h3>
525 <p>The
<a href=
"#ppdOpenFile"><code>ppdOpenFile
</code></a> function
"opens" a
526 PPD file and loads it into memory. For example, the following code opens the
527 current printer's PPD file in a CUPS filter:
</p>
529 <pre class=
"example">
530 #include
<cups/ppd.h
>
532 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd =
<a href=
"#ppdOpenFile">ppdOpenFile
</a>(getenv(
"PPD"));
535 <p>The return value is a pointer to a new
536 <a href=
"#ppd_file_t"><code>ppd_file_t
</code></a> structure or
<code>NULL
</code>
537 if the PPD file does not exist or cannot be loaded. The
538 <a href=
"#ppdClose"><code>ppdClose
</code></a> function frees the memory used
539 by the structure:
</p>
541 <pre class=
"example">
542 #include
<cups/ppd.h
>
544 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd;
546 <a href=
"#ppdClose">ppdClose
</a>(ppd);
549 <p>Once closed, pointers to the
<a href=
"#ppd_file_t"><code>ppd_file_t
</code></a>
550 structure and any data in it will no longer be valid.
</p>
552 <h3><a name=
"OPTIONS_AND_GROUPS">Options and Groups
</a></h3>
554 <p>PPD files support multiple options, which are stored in arrays of
555 <a href=
"#ppd_option_t"><code>ppd_option_t
</code></a> and
556 <a href=
"#ppd_choice_t"><code>ppd_choice_t
</code></a> structures.
</p>
558 <p>Each option in turn is associated with a group stored in a
559 <a href=
"#ppd_group_t"><code>ppd_group_t
</code></a> structure. Groups can be
560 specified in the PPD file; if an option is not associated with a group
561 then it is put in an automatically-generated
"General" group. Groups can also
562 have sub-groups, however CUPS currently ignores sub-groups because of past
563 abuses of this functionality.
</p>
565 <p>Option choices are selected by marking them using one of three functions. The
566 first is
<a href=
"#ppdMarkDefaults"><code>ppdMarkDefaults
</code></a> which
567 selects all of the default options in the PPD file:
</p>
569 <pre class=
"example">
570 #include
<cups/ppd.h
>
572 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd;
574 <a href=
"#ppdMarkDefaults">ppdMarkDefaults
</a>(ppd);
577 <p>The second is
<a href=
"#ppdMarkOption"><code>ppdMarkOption
</code></a>
578 which selects a single option choice in the PPD file. For example, the following
579 code selects the upper paper tray:
</p>
581 <pre class=
"example">
582 #include
<cups/ppd.h
>
584 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd;
586 <a href=
"#ppdMarkOption">ppdMarkOption
</a>(ppd,
"InputSlot",
"Upper");
589 <p>The last function is
590 <a href=
"#cupsMarkOptions"><code>cupsMarkOptions
</code></a> which selects
591 multiple option choices in the PPD file from an array of CUPS options, mapping
592 IPP attributes like
"media" and
"sides" to their corresponding PPD options. You
593 typically use this function in a print filter with
594 <code>cupsParseOptions
</code> and
595 <a href=
"#ppdMarkDefaults"><code>ppdMarkDefaults
</code></a> to select all of
596 the option choices needed for the job, for example:
</p>
598 <pre class=
"example">
599 #include
<cups/ppd.h
>
601 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd =
<a href=
"#ppdOpenFile">ppdOpenFile
</a>(getenv(
"PPD"));
602 cups_option_t *options = NULL;
603 int num_options = cupsParseOptions(argv[
5],
0,
&options);
605 <a href=
"#ppdMarkDefaults">ppdMarkDefaults
</a>(ppd);
606 <a href=
"#cupsMarkOptions">cupsMarkOptions
</a>(ppd, num_options, options);
607 cupsFreeOptions(num_options, options);
610 <h3><a name=
"CONSTRAINTS">Constraints
</a></h3>
612 <p>PPD files support specification of conflict conditions, called
613 constraints, between different options. Constraints are stored in an array of
614 <a href=
"#ppd_const_t"><code>ppd_const_t
</code></a> structures which specify
615 the options and choices that conflict with each other. The
616 <a href=
"#ppdConflicts"><code>ppdConflicts
</code></a> function tells you
617 how many of the selected options are incompatible. Since constraints are
618 normally specified in pairs, the returned value is typically an even number.
</p>
620 <h3><a name=
"PAGE_SIZES">Page Sizes
</a></h3>
622 <p>Page sizes are special options which have physical dimensions and margins
623 associated with them. The size information is stored in
624 <a href=
"#ppd_size_t"><code>ppd_size_t
</code></a> structures and is available
625 by looking up the named size with the
626 <a href=
"#ppdPageSize"><code>ppdPageSize
</code></a> function. The page size and
627 margins are returned in units called points; there are
72 points per inch. If
628 you pass
<code>NULL
</code> for the size, the currently selected size is
631 <pre class=
"example">
632 #include
<cups/ppd.h
>
634 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd;
635 <a href=
"#ppd_size_t">ppd_size_t
</a> *size =
<a href=
"#ppdPageSize">ppdPageSize
</a>(ppd, NULL);
638 <p>Besides the standard page sizes listed in a PPD file, some printers
639 support variable or custom page sizes. Custom page sizes are supported if the
640 <code>variables_sizes
</code> member of the
641 <a href=
"#ppd_file_t"><code>ppd_file_t
</code></a> structure is non-zero.
642 The
<code>custom_min
</code>,
<code>custom_max
</code>, and
643 <code>custom_margins
</code> members of the
644 <a href=
"#ppd_file_t"><code>ppd_file_t
</code></a> structure define the limits
645 of the printable area. To get the resulting media size, use a page size string
646 of the form
"Custom.<I>width</I>x<I>length</I>", where
"width" and
"length" are
647 in points. Custom page size names can also be specified in inches
648 (
"Custom.<i>width</i>x<i>height</i>in"), centimeters
649 (
"Custom.<i>width</i>x<i>height</i>cm"), or millimeters
650 (
"Custom.<i>width</i>x<i>height</i>mm"):
</p>
652 <pre class=
"example">
653 #include
<cups/ppd.h
>
655 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd;
657 /* Get an
576x720 point custom page size */
658 <a href=
"#ppd_size_t">ppd_size_t
</a> *size =
<a href=
"#ppdPageSize">ppdPageSize
</a>(ppd,
"Custom.576x720");
660 /* Get an
8x10 inch custom page size */
661 <a href=
"#ppd_size_t">ppd_size_t
</a> *size =
<a href=
"#ppdPageSize">ppdPageSize
</a>(ppd,
"Custom.8x10in");
663 /* Get a
100x200 millimeter custom page size */
664 <a href=
"#ppd_size_t">ppd_size_t
</a> *size =
<a href=
"#ppdPageSize">ppdPageSize
</a>(ppd,
"Custom.100x200mm");
666 /* Get a
12.7x34.5 centimeter custom page size */
667 <a href=
"#ppd_size_t">ppd_size_t
</a> *size =
<a href=
"#ppdPageSize">ppdPageSize
</a>(ppd,
"Custom.12.7x34.5cm");
670 <p>If the PPD does not support variable page sizes, the
671 <a href=
"#ppdPageSize"><code>ppdPageSize
</code></a> function will return
672 <code>NULL
</code>.
</p>
674 <h3><a name=
"ATTRIBUTES">Attributes
</a></h3>
676 <p>Every PPD file is composed of one or more attributes. Most of these
677 attributes are used to define groups, options, choices, and page sizes,
678 however several informational attributes may be present which you can access
679 in your program or filter. Attributes normally look like one of the following
680 examples in a PPD file:
</p>
682 <pre class=
"example">
685 *name spec/text:
"value"
688 <p>The
<a href=
"#ppdFindAttr"><code>ppdFindAttr
</code></a> and
689 <a href=
"#ppdFindNextAttr"><code>ppdFindNextAttr
</code></a> functions find the
690 first and next instances, respectively, of the named attribute with the given
691 "spec" string and return a
<a href=
"#ppd_attr_t"><code>ppd_attr_t
</code></a>
692 structure. If you provide a NULL specifier string, all attributes with the
693 given name will be returned. For example, the following code lists all of the
694 <code>Product
</code> attributes in a PPD file:
</p>
696 <pre class=
"example">
697 #include
<cups/ppd.h
>
699 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd;
700 <a href=
"#ppd_attr_t">ppd_attr_t
</a> *attr;
702 for (attr =
<a href=
"#ppdFindAttr">ppdFindAttr
</a>(ppd,
"Product", NULL);
704 attr =
<a href=
"#ppdFindNextAttr">ppdFindNextAttr
</a>(ppd,
"Product", NULL))
707 <h2 class=
"title"><a name=
"FUNCTIONS">Functions
</a></h2>
708 <h3 class=
"function"><span class=
"info"> CUPS
1.4/OS X
10.6 </span><a name=
"cupsGetConflicts">cupsGetConflicts
</a></h3>
709 <p class=
"description">Get a list of conflicting options in a marked PPD.
</p>
711 int cupsGetConflicts (
<br>
712 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
713 const char *option,
<br>
714 const char *choice,
<br>
715 cups_option_t **options
<br>
717 <h4 class=
"parameters">Parameters
</h4>
720 <dd class=
"description">PPD file
</dd>
722 <dd class=
"description">Option to test
</dd>
724 <dd class=
"description">Choice to test
</dd>
726 <dd class=
"description">Conflicting options
</dd>
728 <h4 class=
"returnvalue">Return Value
</h4>
729 <p class=
"description">Number of conflicting options
</p>
730 <h4 class=
"discussion">Discussion
</h4>
731 <p class=
"discussion">This function gets a list of options that would conflict if
"option
" and
732 "choice
" were marked in the PPD. You would typically call this function
733 after marking the currently selected options in the PPD in order to
734 determine whether a new option selection would cause a conflict.
<br>
736 The number of conflicting options are returned with
"options
" pointing to
737 the conflicting options. The returned option array must be freed using
738 <a href=
"#cupsFreeOptions"><code>cupsFreeOptions
</code></a>.
741 <h3 class=
"function"><a name=
"cupsMarkOptions">cupsMarkOptions
</a></h3>
742 <p class=
"description">Mark command-line options in a PPD file.
</p>
744 int cupsMarkOptions (
<br>
745 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
746 int num_options,
<br>
747 cups_option_t *options
<br>
749 <h4 class=
"parameters">Parameters
</h4>
752 <dd class=
"description">PPD file
</dd>
754 <dd class=
"description">Number of options
</dd>
756 <dd class=
"description">Options
</dd>
758 <h4 class=
"returnvalue">Return Value
</h4>
759 <p class=
"description">1 if conflicts exist,
0 otherwise
</p>
760 <h4 class=
"discussion">Discussion
</h4>
761 <p class=
"discussion">This function maps the IPP
"finishings
",
"media
",
"mirror
",
762 "multiple-document-handling
",
"output-bin
",
"print-color-mode
",
763 "print-quality
",
"printer-resolution
", and
"sides
" attributes to their
764 corresponding PPD options and choices.
</p>
765 <h3 class=
"function"><span class=
"info"> CUPS
1.4/OS X
10.6 </span><a name=
"cupsResolveConflicts">cupsResolveConflicts
</a></h3>
766 <p class=
"description">Resolve conflicts in a marked PPD.
</p>
768 int cupsResolveConflicts (
<br>
769 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
770 const char *option,
<br>
771 const char *choice,
<br>
772 int *num_options,
<br>
773 cups_option_t **options
<br>
775 <h4 class=
"parameters">Parameters
</h4>
778 <dd class=
"description">PPD file
</dd>
780 <dd class=
"description">Newly selected option or
<code>NULL
</code> for none
</dd>
782 <dd class=
"description">Newly selected choice or
<code>NULL
</code> for none
</dd>
784 <dd class=
"description">Number of additional selected options
</dd>
786 <dd class=
"description">Additional selected options
</dd>
788 <h4 class=
"returnvalue">Return Value
</h4>
789 <p class=
"description">1 on success,
0 on failure
</p>
790 <h4 class=
"discussion">Discussion
</h4>
791 <p class=
"discussion">This function attempts to resolve any conflicts in a marked PPD, returning
792 a list of option changes that are required to resolve them. On input,
793 "num_options
" and
"options
" contain any pending option changes that have
794 not yet been marked, while
"option
" and
"choice
" contain the most recent
795 selection which may or may not be in
"num_options
" or
"options
".
<br>
797 On successful return,
"num_options
" and
"options
" are updated to contain
798 "option
" and
"choice
" along with any changes required to resolve conflicts
799 specified in the PPD file and
1 is returned.
<br>
801 If option conflicts cannot be resolved,
"num_options
" and
"options
" are not
802 changed and
0 is returned.
<br>
804 When resolving conflicts,
<code>cupsResolveConflicts
</code> does not consider
805 changes to the current page size (
<code>media
</code>,
<code>PageSize
</code>, and
806 <code>PageRegion
</code>) or to the most recent option specified in
"option
".
807 Thus, if the only way to resolve a conflict is to change the page size
808 or the option the user most recently changed,
<code>cupsResolveConflicts
</code>
809 will return
0 to indicate it was unable to resolve the conflicts.
<br>
811 The
<code>cupsResolveConflicts
</code> function uses one of two sources of option
812 constraint information. The preferred constraint information is defined by
813 <code>cupsUIConstraints
</code> and
<code>cupsUIResolver
</code> attributes - in this
814 case, the PPD file provides constraint resolution actions.
<br>
816 The backup constraint information is defined by the
817 <code>UIConstraints
</code> and
<code>NonUIConstraints
</code> attributes. These
818 constraints are resolved algorithmically by first selecting the default
819 choice for the conflicting option, then iterating over all possible choices
820 until a non-conflicting option choice is found.
823 <h3 class=
"function"><a name=
"ppdClose">ppdClose
</a></h3>
824 <p class=
"description">Free all memory used by the PPD file.
</p>
827 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd
<br>
829 <h4 class=
"parameters">Parameters
</h4>
832 <dd class=
"description">PPD file record
</dd>
834 <h3 class=
"function"><a name=
"ppdCollect">ppdCollect
</a></h3>
835 <p class=
"description">Collect all marked options that reside in the specified
839 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
840 <a href=
"#ppd_section_t">ppd_section_t
</a> section,
<br>
841 <a href=
"#ppd_choice_t">ppd_choice_t
</a> ***choices
<br>
843 <h4 class=
"parameters">Parameters
</h4>
846 <dd class=
"description">PPD file data
</dd>
848 <dd class=
"description">Section to collect
</dd>
850 <dd class=
"description">Pointers to choices
</dd>
852 <h4 class=
"returnvalue">Return Value
</h4>
853 <p class=
"description">Number of options marked
</p>
854 <h4 class=
"discussion">Discussion
</h4>
855 <p class=
"discussion">The choices array should be freed using
<code>free
</code> when you are
856 finished with it.
</p>
857 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdCollect2">ppdCollect2
</a></h3>
858 <p class=
"description">Collect all marked options that reside in the
859 specified section and minimum order.
</p>
861 int ppdCollect2 (
<br>
862 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
863 <a href=
"#ppd_section_t">ppd_section_t
</a> section,
<br>
864 float min_order,
<br>
865 <a href=
"#ppd_choice_t">ppd_choice_t
</a> ***choices
<br>
867 <h4 class=
"parameters">Parameters
</h4>
870 <dd class=
"description">PPD file data
</dd>
872 <dd class=
"description">Section to collect
</dd>
874 <dd class=
"description">Minimum OrderDependency value
</dd>
876 <dd class=
"description">Pointers to choices
</dd>
878 <h4 class=
"returnvalue">Return Value
</h4>
879 <p class=
"description">Number of options marked
</p>
880 <h4 class=
"discussion">Discussion
</h4>
881 <p class=
"discussion">The choices array should be freed using
<code>free
</code> when you are
885 <h3 class=
"function"><a name=
"ppdConflicts">ppdConflicts
</a></h3>
886 <p class=
"description">Check to see if there are any conflicts among the
887 marked option choices.
</p>
889 int ppdConflicts (
<br>
890 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd
<br>
892 <h4 class=
"parameters">Parameters
</h4>
895 <dd class=
"description">PPD to check
</dd>
897 <h4 class=
"returnvalue">Return Value
</h4>
898 <p class=
"description">Number of conflicts found
</p>
899 <h4 class=
"discussion">Discussion
</h4>
900 <p class=
"discussion">The returned value is the same as returned by
<a href=
"#ppdMarkOption"><code>ppdMarkOption
</code></a>.
</p>
901 <h3 class=
"function"><a name=
"ppdEmit">ppdEmit
</a></h3>
902 <p class=
"description">Emit code for marked options to a file.
</p>
905 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
906 FILE *fp,
<br>
907 <a href=
"#ppd_section_t">ppd_section_t
</a> section
<br>
909 <h4 class=
"parameters">Parameters
</h4>
912 <dd class=
"description">PPD file record
</dd>
914 <dd class=
"description">File to write to
</dd>
916 <dd class=
"description">Section to write
</dd>
918 <h4 class=
"returnvalue">Return Value
</h4>
919 <p class=
"description">0 on success, -
1 on failure
</p>
920 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdEmitAfterOrder">ppdEmitAfterOrder
</a></h3>
921 <p class=
"description">Emit a subset of the code for marked options to a file.
</p>
923 int ppdEmitAfterOrder (
<br>
924 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
925 FILE *fp,
<br>
926 <a href=
"#ppd_section_t">ppd_section_t
</a> section,
<br>
927 int limit,
<br>
928 float min_order
<br>
930 <h4 class=
"parameters">Parameters
</h4>
933 <dd class=
"description">PPD file record
</dd>
935 <dd class=
"description">File to write to
</dd>
937 <dd class=
"description">Section to write
</dd>
939 <dd class=
"description">Non-zero to use min_order
</dd>
941 <dd class=
"description">Lowest OrderDependency
</dd>
943 <h4 class=
"returnvalue">Return Value
</h4>
944 <p class=
"description">0 on success, -
1 on failure
</p>
945 <h4 class=
"discussion">Discussion
</h4>
946 <p class=
"discussion">When
"limit
" is non-zero, this function only emits options whose
947 OrderDependency value is greater than or equal to
"min_order
".
<br>
949 When
"limit
" is zero, this function is identical to ppdEmit().
952 <h3 class=
"function"><a name=
"ppdEmitFd">ppdEmitFd
</a></h3>
953 <p class=
"description">Emit code for marked options to a file.
</p>
956 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
957 int fd,
<br>
958 <a href=
"#ppd_section_t">ppd_section_t
</a> section
<br>
960 <h4 class=
"parameters">Parameters
</h4>
963 <dd class=
"description">PPD file record
</dd>
965 <dd class=
"description">File to write to
</dd>
967 <dd class=
"description">Section to write
</dd>
969 <h4 class=
"returnvalue">Return Value
</h4>
970 <p class=
"description">0 on success, -
1 on failure
</p>
971 <h3 class=
"function"><a name=
"ppdEmitJCL">ppdEmitJCL
</a></h3>
972 <p class=
"description">Emit code for JCL options to a file.
</p>
975 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
976 FILE *fp,
<br>
977 int job_id,
<br>
978 const char *user,
<br>
979 const char *title
<br>
981 <h4 class=
"parameters">Parameters
</h4>
984 <dd class=
"description">PPD file record
</dd>
986 <dd class=
"description">File to write to
</dd>
988 <dd class=
"description">Job ID
</dd>
990 <dd class=
"description">Username
</dd>
992 <dd class=
"description">Title
</dd>
994 <h4 class=
"returnvalue">Return Value
</h4>
995 <p class=
"description">0 on success, -
1 on failure
</p>
996 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdEmitJCLEnd">ppdEmitJCLEnd
</a></h3>
997 <p class=
"description">Emit JCLEnd code to a file.
</p>
999 int ppdEmitJCLEnd (
<br>
1000 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1001 FILE *fp
<br>
1003 <h4 class=
"parameters">Parameters
</h4>
1006 <dd class=
"description">PPD file record
</dd>
1008 <dd class=
"description">File to write to
</dd>
1010 <h4 class=
"returnvalue">Return Value
</h4>
1011 <p class=
"description">0 on success, -
1 on failure
</p>
1012 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdEmitString">ppdEmitString
</a></h3>
1013 <p class=
"description">Get a string containing the code for marked options.
</p>
1015 char *ppdEmitString (
<br>
1016 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1017 <a href=
"#ppd_section_t">ppd_section_t
</a> section,
<br>
1018 float min_order
<br>
1020 <h4 class=
"parameters">Parameters
</h4>
1023 <dd class=
"description">PPD file record
</dd>
1025 <dd class=
"description">Section to write
</dd>
1027 <dd class=
"description">Lowest OrderDependency
</dd>
1029 <h4 class=
"returnvalue">Return Value
</h4>
1030 <p class=
"description">String containing option code or
<code>NULL
</code> if there is no option code
</p>
1031 <h4 class=
"discussion">Discussion
</h4>
1032 <p class=
"discussion">When
"min_order
" is greater than zero, this function only includes options
1033 whose OrderDependency value is greater than or equal to
"min_order
".
1034 Otherwise, all options in the specified section are included in the
1035 returned string.
<br>
1037 The return string is allocated on the heap and should be freed using
1038 <code>free
</code> when you are done with it.
1041 <h3 class=
"function"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppdErrorString">ppdErrorString
</a></h3>
1042 <p class=
"description">Returns the text assocated with a status.
</p>
1044 const char *ppdErrorString (
<br>
1045 <a href=
"#ppd_status_t">ppd_status_t
</a> status
<br>
1047 <h4 class=
"parameters">Parameters
</h4>
1050 <dd class=
"description">PPD status
</dd>
1052 <h4 class=
"returnvalue">Return Value
</h4>
1053 <p class=
"description">Status string
</p>
1054 <h3 class=
"function"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppdFindAttr">ppdFindAttr
</a></h3>
1055 <p class=
"description">Find the first matching attribute.
</p>
1057 <a href=
"#ppd_attr_t">ppd_attr_t
</a> *ppdFindAttr (
<br>
1058 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1059 const char *name,
<br>
1060 const char *spec
<br>
1062 <h4 class=
"parameters">Parameters
</h4>
1065 <dd class=
"description">PPD file data
</dd>
1067 <dd class=
"description">Attribute name
</dd>
1069 <dd class=
"description">Specifier string or
<code>NULL
</code></dd>
1071 <h4 class=
"returnvalue">Return Value
</h4>
1072 <p class=
"description">Attribute or
<code>NULL
</code> if not found
</p>
1073 <h3 class=
"function"><a name=
"ppdFindChoice">ppdFindChoice
</a></h3>
1074 <p class=
"description">Return a pointer to an option choice.
</p>
1076 <a href=
"#ppd_choice_t">ppd_choice_t
</a> *ppdFindChoice (
<br>
1077 <a href=
"#ppd_option_t">ppd_option_t
</a> *o,
<br>
1078 const char *choice
<br>
1080 <h4 class=
"parameters">Parameters
</h4>
1083 <dd class=
"description">Pointer to option
</dd>
1085 <dd class=
"description">Name of choice
</dd>
1087 <h4 class=
"returnvalue">Return Value
</h4>
1088 <p class=
"description">Choice pointer or
<code>NULL
</code></p>
1089 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdFindCustomOption">ppdFindCustomOption
</a></h3>
1090 <p class=
"description">Find a custom option.
</p>
1092 <a href=
"#ppd_coption_t">ppd_coption_t
</a> *ppdFindCustomOption (
<br>
1093 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1094 const char *keyword
<br>
1096 <h4 class=
"parameters">Parameters
</h4>
1099 <dd class=
"description">PPD file
</dd>
1101 <dd class=
"description">Custom option name
</dd>
1103 <h4 class=
"returnvalue">Return Value
</h4>
1104 <p class=
"description">Custom option or NULL
</p>
1105 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdFindCustomParam">ppdFindCustomParam
</a></h3>
1106 <p class=
"description">Find a parameter for a custom option.
</p>
1108 <a href=
"#ppd_cparam_t">ppd_cparam_t
</a> *ppdFindCustomParam (
<br>
1109 <a href=
"#ppd_coption_t">ppd_coption_t
</a> *opt,
<br>
1110 const char *name
<br>
1112 <h4 class=
"parameters">Parameters
</h4>
1115 <dd class=
"description">Custom option
</dd>
1117 <dd class=
"description">Parameter name
</dd>
1119 <h4 class=
"returnvalue">Return Value
</h4>
1120 <p class=
"description">Custom parameter or NULL
</p>
1121 <h3 class=
"function"><a name=
"ppdFindMarkedChoice">ppdFindMarkedChoice
</a></h3>
1122 <p class=
"description">Return the marked choice for the specified option.
</p>
1124 <a href=
"#ppd_choice_t">ppd_choice_t
</a> *ppdFindMarkedChoice (
<br>
1125 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1126 const char *option
<br>
1128 <h4 class=
"parameters">Parameters
</h4>
1131 <dd class=
"description">PPD file
</dd>
1133 <dd class=
"description">Keyword/option name
</dd>
1135 <h4 class=
"returnvalue">Return Value
</h4>
1136 <p class=
"description">Pointer to choice or
<code>NULL
</code></p>
1137 <h3 class=
"function"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppdFindNextAttr">ppdFindNextAttr
</a></h3>
1138 <p class=
"description">Find the next matching attribute.
</p>
1140 <a href=
"#ppd_attr_t">ppd_attr_t
</a> *ppdFindNextAttr (
<br>
1141 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1142 const char *name,
<br>
1143 const char *spec
<br>
1145 <h4 class=
"parameters">Parameters
</h4>
1148 <dd class=
"description">PPD file data
</dd>
1150 <dd class=
"description">Attribute name
</dd>
1152 <dd class=
"description">Specifier string or
<code>NULL
</code></dd>
1154 <h4 class=
"returnvalue">Return Value
</h4>
1155 <p class=
"description">Attribute or
<code>NULL
</code> if not found
</p>
1156 <h3 class=
"function"><a name=
"ppdFindOption">ppdFindOption
</a></h3>
1157 <p class=
"description">Return a pointer to the specified option.
</p>
1159 <a href=
"#ppd_option_t">ppd_option_t
</a> *ppdFindOption (
<br>
1160 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1161 const char *option
<br>
1163 <h4 class=
"parameters">Parameters
</h4>
1166 <dd class=
"description">PPD file data
</dd>
1168 <dd class=
"description">Option/Keyword name
</dd>
1170 <h4 class=
"returnvalue">Return Value
</h4>
1171 <p class=
"description">Pointer to option or
<code>NULL
</code></p>
1172 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdFirstCustomParam">ppdFirstCustomParam
</a></h3>
1173 <p class=
"description">Return the first parameter for a custom option.
</p>
1175 <a href=
"#ppd_cparam_t">ppd_cparam_t
</a> *ppdFirstCustomParam (
<br>
1176 <a href=
"#ppd_coption_t">ppd_coption_t
</a> *opt
<br>
1178 <h4 class=
"parameters">Parameters
</h4>
1181 <dd class=
"description">Custom option
</dd>
1183 <h4 class=
"returnvalue">Return Value
</h4>
1184 <p class=
"description">Custom parameter or NULL
</p>
1185 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdFirstOption">ppdFirstOption
</a></h3>
1186 <p class=
"description">Return the first option in the PPD file.
</p>
1188 <a href=
"#ppd_option_t">ppd_option_t
</a> *ppdFirstOption (
<br>
1189 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd
<br>
1191 <h4 class=
"parameters">Parameters
</h4>
1194 <dd class=
"description">PPD file
</dd>
1196 <h4 class=
"returnvalue">Return Value
</h4>
1197 <p class=
"description">First option or
<code>NULL
</code></p>
1198 <h4 class=
"discussion">Discussion
</h4>
1199 <p class=
"discussion">Options are returned from all groups in ascending alphanumeric order.
1202 <h3 class=
"function"><span class=
"info"> CUPS
1.4/OS X
10.6 </span><a name=
"ppdInstallableConflict">ppdInstallableConflict
</a></h3>
1203 <p class=
"description">Test whether an option choice conflicts with
1204 an installable option.
</p>
1206 int ppdInstallableConflict (
<br>
1207 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1208 const char *option,
<br>
1209 const char *choice
<br>
1211 <h4 class=
"parameters">Parameters
</h4>
1214 <dd class=
"description">PPD file
</dd>
1216 <dd class=
"description">Option
</dd>
1218 <dd class=
"description">Choice
</dd>
1220 <h4 class=
"returnvalue">Return Value
</h4>
1221 <p class=
"description">1 if conflicting,
0 if not conflicting
</p>
1222 <h4 class=
"discussion">Discussion
</h4>
1223 <p class=
"discussion">This function tests whether a particular option choice is available based
1224 on constraints against options in the
"InstallableOptions
" group.
1227 <h3 class=
"function"><a name=
"ppdIsMarked">ppdIsMarked
</a></h3>
1228 <p class=
"description">Check to see if an option is marked.
</p>
1230 int ppdIsMarked (
<br>
1231 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1232 const char *option,
<br>
1233 const char *choice
<br>
1235 <h4 class=
"parameters">Parameters
</h4>
1238 <dd class=
"description">PPD file data
</dd>
1240 <dd class=
"description">Option/Keyword name
</dd>
1242 <dd class=
"description">Choice name
</dd>
1244 <h4 class=
"returnvalue">Return Value
</h4>
1245 <p class=
"description">Non-zero if option is marked
</p>
1246 <h3 class=
"function"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppdLastError">ppdLastError
</a></h3>
1247 <p class=
"description">Return the status from the last ppdOpen*().
</p>
1249 <a href=
"#ppd_status_t">ppd_status_t
</a> ppdLastError (
<br>
1250 int *line
<br>
1252 <h4 class=
"parameters">Parameters
</h4>
1255 <dd class=
"description">Line number
</dd>
1257 <h4 class=
"returnvalue">Return Value
</h4>
1258 <p class=
"description">Status code
</p>
1259 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdLocalize">ppdLocalize
</a></h3>
1260 <p class=
"description">Localize the PPD file to the current locale.
</p>
1262 int ppdLocalize (
<br>
1263 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd
<br>
1265 <h4 class=
"parameters">Parameters
</h4>
1268 <dd class=
"description">PPD file
</dd>
1270 <h4 class=
"returnvalue">Return Value
</h4>
1271 <p class=
"description">0 on success, -
1 on error
</p>
1272 <h4 class=
"discussion">Discussion
</h4>
1273 <p class=
"discussion">All groups, options, and choices are localized, as are ICC profile
1274 descriptions, printer presets, and custom option parameters. Each
1275 localized string uses the UTF-
8 character encoding.
1278 <h3 class=
"function"><a name=
"ppdLocalizeAttr">ppdLocalizeAttr
</a></h3>
1279 <p class=
"description">Localize an attribute.
</p>
1281 <a href=
"#ppd_attr_t">ppd_attr_t
</a> *ppdLocalizeAttr (
<br>
1282 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1283 const char *keyword,
<br>
1284 const char *spec
<br>
1286 <h4 class=
"parameters">Parameters
</h4>
1289 <dd class=
"description">PPD file
</dd>
1291 <dd class=
"description">Main keyword
</dd>
1293 <dd class=
"description">Option keyword or
<code>NULL
</code> for none
</dd>
1295 <h4 class=
"returnvalue">Return Value
</h4>
1296 <p class=
"description">Localized attribute or
<code>NULL
</code> if none exists
</p>
1297 <h4 class=
"discussion">Discussion
</h4>
1298 <p class=
"discussion">This function uses the current locale to find the localized attribute for
1299 the given main and option keywords. If no localized version of the
1300 attribute exists for the current locale, the unlocalized version is returned.
</p>
1301 <h3 class=
"function"><span class=
"info"> CUPS
1.3/OS X
10.5 </span><a name=
"ppdLocalizeIPPReason">ppdLocalizeIPPReason
</a></h3>
1302 <p class=
"description">Get the localized version of a cupsIPPReason
1305 const char *ppdLocalizeIPPReason (
<br>
1306 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1307 const char *reason,
<br>
1308 const char *scheme,
<br>
1309 char *buffer,
<br>
1310 size_t bufsize
<br>
1312 <h4 class=
"parameters">Parameters
</h4>
1315 <dd class=
"description">PPD file
</dd>
1317 <dd class=
"description">IPP reason keyword to look up
</dd>
1319 <dd class=
"description">URI scheme or NULL for text
</dd>
1321 <dd class=
"description">Value buffer
</dd>
1323 <dd class=
"description">Size of value buffer
</dd>
1325 <h4 class=
"returnvalue">Return Value
</h4>
1326 <p class=
"description">Value or NULL if not found
</p>
1327 <h4 class=
"discussion">Discussion
</h4>
1328 <p class=
"discussion">This function uses the current locale to find the corresponding reason
1329 text or URI from the attribute value. If
"scheme
" is NULL or
"text
",
1330 the returned value contains human-readable (UTF-
8) text from the translation
1331 string or attribute value. Otherwise the corresponding URI is returned.
<br>
1333 If no value of the requested scheme can be found, NULL is returned.
1336 <h3 class=
"function"><span class=
"info"> CUPS
1.4/OS X
10.6 </span><a name=
"ppdLocalizeMarkerName">ppdLocalizeMarkerName
</a></h3>
1337 <p class=
"description">Get the localized version of a marker-names
1338 attribute value.
</p>
1340 const char *ppdLocalizeMarkerName (
<br>
1341 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1342 const char *name
<br>
1344 <h4 class=
"parameters">Parameters
</h4>
1347 <dd class=
"description">PPD file
</dd>
1349 <dd class=
"description">Marker name to look up
</dd>
1351 <h4 class=
"returnvalue">Return Value
</h4>
1352 <p class=
"description">Value or
<code>NULL
</code> if not found
</p>
1353 <h4 class=
"discussion">Discussion
</h4>
1354 <p class=
"discussion">This function uses the current locale to find the corresponding name
1355 text from the attribute value. If no localized text for the requested
1356 name can be found,
<code>NULL
</code> is returned.
1359 <h3 class=
"function"><a name=
"ppdMarkDefaults">ppdMarkDefaults
</a></h3>
1360 <p class=
"description">Mark all default options in the PPD file.
</p>
1362 void ppdMarkDefaults (
<br>
1363 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd
<br>
1365 <h4 class=
"parameters">Parameters
</h4>
1368 <dd class=
"description">PPD file record
</dd>
1370 <h3 class=
"function"><a name=
"ppdMarkOption">ppdMarkOption
</a></h3>
1371 <p class=
"description">Mark an option in a PPD file and return the number of
1374 int ppdMarkOption (
<br>
1375 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1376 const char *option,
<br>
1377 const char *choice
<br>
1379 <h4 class=
"parameters">Parameters
</h4>
1382 <dd class=
"description">PPD file record
</dd>
1384 <dd class=
"description">Keyword
</dd>
1386 <dd class=
"description">Option name
</dd>
1388 <h4 class=
"returnvalue">Return Value
</h4>
1389 <p class=
"description">Number of conflicts
</p>
1390 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdNextCustomParam">ppdNextCustomParam
</a></h3>
1391 <p class=
"description">Return the next parameter for a custom option.
</p>
1393 <a href=
"#ppd_cparam_t">ppd_cparam_t
</a> *ppdNextCustomParam (
<br>
1394 <a href=
"#ppd_coption_t">ppd_coption_t
</a> *opt
<br>
1396 <h4 class=
"parameters">Parameters
</h4>
1399 <dd class=
"description">Custom option
</dd>
1401 <h4 class=
"returnvalue">Return Value
</h4>
1402 <p class=
"description">Custom parameter or NULL
</p>
1403 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdNextOption">ppdNextOption
</a></h3>
1404 <p class=
"description">Return the next option in the PPD file.
</p>
1406 <a href=
"#ppd_option_t">ppd_option_t
</a> *ppdNextOption (
<br>
1407 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd
<br>
1409 <h4 class=
"parameters">Parameters
</h4>
1412 <dd class=
"description">PPD file
</dd>
1414 <h4 class=
"returnvalue">Return Value
</h4>
1415 <p class=
"description">Next option or
<code>NULL
</code></p>
1416 <h4 class=
"discussion">Discussion
</h4>
1417 <p class=
"discussion">Options are returned from all groups in ascending alphanumeric order.
1420 <h3 class=
"function"><a name=
"ppdOpen">ppdOpen
</a></h3>
1421 <p class=
"description">Read a PPD file into memory.
</p>
1423 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppdOpen (
<br>
1424 FILE *fp
<br>
1426 <h4 class=
"parameters">Parameters
</h4>
1429 <dd class=
"description">File to read from
</dd>
1431 <h4 class=
"returnvalue">Return Value
</h4>
1432 <p class=
"description">PPD file record
</p>
1433 <h3 class=
"function"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppdOpen2">ppdOpen2
</a></h3>
1434 <p class=
"description">Read a PPD file into memory.
</p>
1436 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppdOpen2 (
<br>
1437 cups_file_t *fp
<br>
1439 <h4 class=
"parameters">Parameters
</h4>
1442 <dd class=
"description">File to read from
</dd>
1444 <h4 class=
"returnvalue">Return Value
</h4>
1445 <p class=
"description">PPD file record or
<code>NULL
</code> if the PPD file could not be opened.
</p>
1446 <h3 class=
"function"><a name=
"ppdOpenFd">ppdOpenFd
</a></h3>
1447 <p class=
"description">Read a PPD file into memory.
</p>
1449 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppdOpenFd (
<br>
1450 int fd
<br>
1452 <h4 class=
"parameters">Parameters
</h4>
1455 <dd class=
"description">File to read from
</dd>
1457 <h4 class=
"returnvalue">Return Value
</h4>
1458 <p class=
"description">PPD file record or
<code>NULL
</code> if the PPD file could not be opened.
</p>
1459 <h3 class=
"function"><a name=
"ppdOpenFile">ppdOpenFile
</a></h3>
1460 <p class=
"description">Read a PPD file into memory.
</p>
1462 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppdOpenFile (
<br>
1463 const char *filename
<br>
1465 <h4 class=
"parameters">Parameters
</h4>
1468 <dd class=
"description">File to read from
</dd>
1470 <h4 class=
"returnvalue">Return Value
</h4>
1471 <p class=
"description">PPD file record or
<code>NULL
</code> if the PPD file could not be opened.
</p>
1472 <h3 class=
"function"><a name=
"ppdPageLength">ppdPageLength
</a></h3>
1473 <p class=
"description">Get the page length for the given size.
</p>
1475 float ppdPageLength (
<br>
1476 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1477 const char *name
<br>
1479 <h4 class=
"parameters">Parameters
</h4>
1482 <dd class=
"description">PPD file
</dd>
1484 <dd class=
"description">Size name
</dd>
1486 <h4 class=
"returnvalue">Return Value
</h4>
1487 <p class=
"description">Length of page in points or
0.0</p>
1488 <h3 class=
"function"><a name=
"ppdPageSize">ppdPageSize
</a></h3>
1489 <p class=
"description">Get the page size record for the named size.
</p>
1491 <a href=
"#ppd_size_t">ppd_size_t
</a> *ppdPageSize (
<br>
1492 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1493 const char *name
<br>
1495 <h4 class=
"parameters">Parameters
</h4>
1498 <dd class=
"description">PPD file record
</dd>
1500 <dd class=
"description">Size name
</dd>
1502 <h4 class=
"returnvalue">Return Value
</h4>
1503 <p class=
"description">Size record for page or NULL
</p>
1504 <h3 class=
"function"><span class=
"info"> CUPS
1.4/OS X
10.6 </span><a name=
"ppdPageSizeLimits">ppdPageSizeLimits
</a></h3>
1505 <p class=
"description">Return the custom page size limits.
</p>
1507 int ppdPageSizeLimits (
<br>
1508 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1509 <a href=
"#ppd_size_t">ppd_size_t
</a> *minimum,
<br>
1510 <a href=
"#ppd_size_t">ppd_size_t
</a> *maximum
<br>
1512 <h4 class=
"parameters">Parameters
</h4>
1515 <dd class=
"description">PPD file record
</dd>
1517 <dd class=
"description">Minimum custom size
</dd>
1519 <dd class=
"description">Maximum custom size
</dd>
1521 <h4 class=
"returnvalue">Return Value
</h4>
1522 <p class=
"description">1 if custom sizes are supported,
0 otherwise
</p>
1523 <h4 class=
"discussion">Discussion
</h4>
1524 <p class=
"discussion">This function returns the minimum and maximum custom page sizes and printable
1525 areas based on the currently-marked (selected) options.
<br>
1527 If the specified PPD file does not support custom page sizes, both
1528 "minimum
" and
"maximum
" are filled with zeroes.
1531 <h3 class=
"function"><a name=
"ppdPageWidth">ppdPageWidth
</a></h3>
1532 <p class=
"description">Get the page width for the given size.
</p>
1534 float ppdPageWidth (
<br>
1535 <a href=
"#ppd_file_t">ppd_file_t
</a> *ppd,
<br>
1536 const char *name
<br>
1538 <h4 class=
"parameters">Parameters
</h4>
1541 <dd class=
"description">PPD file record
</dd>
1543 <dd class=
"description">Size name
</dd>
1545 <h4 class=
"returnvalue">Return Value
</h4>
1546 <p class=
"description">Width of page in points or
0.0</p>
1547 <h3 class=
"function"><span class=
"info"> CUPS
1.1.20/OS X
10.4 </span><a name=
"ppdSetConformance">ppdSetConformance
</a></h3>
1548 <p class=
"description">Set the conformance level for PPD files.
</p>
1550 void ppdSetConformance (
<br>
1551 <a href=
"#ppd_conform_t">ppd_conform_t
</a> c
<br>
1553 <h4 class=
"parameters">Parameters
</h4>
1556 <dd class=
"description">Conformance level
</dd>
1558 <h2 class=
"title"><a name=
"TYPES">Data Types
</a></h2>
1559 <h3 class=
"typedef"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppd_attr_t">ppd_attr_t
</a></h3>
1560 <p class=
"description">PPD Attribute Structure
</p>
1562 typedef struct
<a href=
"#ppd_attr_s">ppd_attr_s
</a> ppd_attr_t;
1564 <h3 class=
"typedef"><a name=
"ppd_choice_t">ppd_choice_t
</a></h3>
1565 <p class=
"description">Option choices
</p>
1567 typedef struct
<a href=
"#ppd_choice_s">ppd_choice_s
</a> ppd_choice_t;
1569 <h3 class=
"typedef"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppd_conform_t">ppd_conform_t
</a></h3>
1570 <p class=
"description">Conformance Levels
</p>
1572 typedef enum
<a href=
"#ppd_conform_e">ppd_conform_e
</a> ppd_conform_t;
1574 <h3 class=
"typedef"><a name=
"ppd_const_t">ppd_const_t
</a></h3>
1575 <p class=
"description">Constraints
</p>
1577 typedef struct
<a href=
"#ppd_const_s">ppd_const_s
</a> ppd_const_t;
1579 <h3 class=
"typedef"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppd_coption_t">ppd_coption_t
</a></h3>
1580 <p class=
"description">Custom Option
</p>
1582 typedef struct
<a href=
"#ppd_coption_s">ppd_coption_s
</a> ppd_coption_t;
1584 <h3 class=
"typedef"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppd_cparam_t">ppd_cparam_t
</a></h3>
1585 <p class=
"description">Custom Parameter
</p>
1587 typedef struct
<a href=
"#ppd_cparam_s">ppd_cparam_s
</a> ppd_cparam_t;
1589 <h3 class=
"typedef"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppd_cplimit_t">ppd_cplimit_t
</a></h3>
1590 <p class=
"description">Custom Parameter Limit
</p>
1592 typedef union
<a href=
"#ppd_cplimit_u">ppd_cplimit_u
</a> ppd_cplimit_t;
1594 <h3 class=
"typedef"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppd_cptype_t">ppd_cptype_t
</a></h3>
1595 <p class=
"description">Custom Parameter Type
</p>
1597 typedef enum ppd_cptype_e ppd_cptype_t;
1599 <h3 class=
"typedef"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppd_cpvalue_t">ppd_cpvalue_t
</a></h3>
1600 <p class=
"description">Custom Parameter Value
</p>
1602 typedef union
<a href=
"#ppd_cpvalue_u">ppd_cpvalue_u
</a> ppd_cpvalue_t;
1604 <h3 class=
"typedef"><a name=
"ppd_cs_t">ppd_cs_t
</a></h3>
1605 <p class=
"description">Colorspaces
</p>
1607 typedef enum
<a href=
"#ppd_cs_e">ppd_cs_e
</a> ppd_cs_t;
1609 <h3 class=
"typedef"><a name=
"ppd_emul_t">ppd_emul_t
</a></h3>
1610 <p class=
"description">Emulators
</p>
1612 typedef struct
<a href=
"#ppd_emul_s">ppd_emul_s
</a> ppd_emul_t;
1614 <h3 class=
"typedef"><a name=
"ppd_file_t">ppd_file_t
</a></h3>
1615 <p class=
"description">PPD File
</p>
1617 typedef struct
<a href=
"#ppd_file_s">ppd_file_s
</a> ppd_file_t;
1619 <h3 class=
"typedef"><a name=
"ppd_group_t">ppd_group_t
</a></h3>
1620 <p class=
"description">Groups
</p>
1622 typedef struct
<a href=
"#ppd_group_s">ppd_group_s
</a> ppd_group_t;
1624 <h3 class=
"typedef"><a name=
"ppd_option_t">ppd_option_t
</a></h3>
1625 <p class=
"description">Options
</p>
1627 typedef struct
<a href=
"#ppd_option_s">ppd_option_s
</a> ppd_option_t;
1629 <h3 class=
"typedef"><a name=
"ppd_profile_t">ppd_profile_t
</a></h3>
1630 <p class=
"description">sRGB Color Profiles
</p>
1632 typedef struct
<a href=
"#ppd_profile_s">ppd_profile_s
</a> ppd_profile_t;
1634 <h3 class=
"typedef"><a name=
"ppd_section_t">ppd_section_t
</a></h3>
1635 <p class=
"description">Order dependency sections
</p>
1637 typedef enum
<a href=
"#ppd_section_e">ppd_section_e
</a> ppd_section_t;
1639 <h3 class=
"typedef"><a name=
"ppd_size_t">ppd_size_t
</a></h3>
1640 <p class=
"description">Page Sizes
</p>
1642 typedef struct
<a href=
"#ppd_size_s">ppd_size_s
</a> ppd_size_t;
1644 <h3 class=
"typedef"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppd_status_t">ppd_status_t
</a></h3>
1645 <p class=
"description">Status Codes
</p>
1647 typedef enum
<a href=
"#ppd_status_e">ppd_status_e
</a> ppd_status_t;
1649 <h3 class=
"typedef"><a name=
"ppd_ui_t">ppd_ui_t
</a></h3>
1650 <p class=
"description">UI Types
</p>
1652 typedef enum
<a href=
"#ppd_ui_e">ppd_ui_e
</a> ppd_ui_t;
1654 <h2 class=
"title"><a name=
"STRUCTURES">Structures
</a></h2>
1655 <h3 class=
"struct"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppd_attr_s">ppd_attr_s
</a></h3>
1656 <p class=
"description">PPD Attribute Structure
</p>
1657 <p class=
"code">struct ppd_attr_s {
<br>
1658 char name[PPD_MAX_NAME];
<br>
1659 char spec[PPD_MAX_NAME];
<br>
1660 char text[PPD_MAX_TEXT];
<br>
1661 char *value;
<br>
1663 <h4 class=
"members">Members
</h4>
1665 <dt>name[PPD_MAX_NAME]
</dt>
1666 <dd class=
"description">Name of attribute (cupsXYZ)
</dd>
1667 <dt>spec[PPD_MAX_NAME]
</dt>
1668 <dd class=
"description">Specifier string, if any
</dd>
1669 <dt>text[PPD_MAX_TEXT]
</dt>
1670 <dd class=
"description">Human-readable text, if any
</dd>
1672 <dd class=
"description">Value string
</dd>
1674 <h3 class=
"struct"><a name=
"ppd_choice_s">ppd_choice_s
</a></h3>
1675 <p class=
"description">Option choices
</p>
1676 <p class=
"code">struct ppd_choice_s {
<br>
1677 char choice[PPD_MAX_NAME];
<br>
1678 char *code;
<br>
1679 char marked;
<br>
1680 <a href=
"#ppd_option_t">ppd_option_t
</a> *option;
<br>
1681 char text[PPD_MAX_TEXT];
<br>
1683 <h4 class=
"members">Members
</h4>
1685 <dt>choice[PPD_MAX_NAME]
</dt>
1686 <dd class=
"description">Computer-readable option name
</dd>
1688 <dd class=
"description">Code to send for this option
</dd>
1690 <dd class=
"description">0 if not selected,
1 otherwise
</dd>
1692 <dd class=
"description">Pointer to parent option structure
</dd>
1693 <dt>text[PPD_MAX_TEXT]
</dt>
1694 <dd class=
"description">Human-readable option name
</dd>
1696 <h3 class=
"struct"><a name=
"ppd_const_s">ppd_const_s
</a></h3>
1697 <p class=
"description">Constraints
</p>
1698 <p class=
"code">struct ppd_const_s {
<br>
1699 char choice1[PPD_MAX_NAME];
<br>
1700 char choice2[PPD_MAX_NAME];
<br>
1701 char option1[PPD_MAX_NAME];
<br>
1702 char option2[PPD_MAX_NAME];
<br>
1704 <h4 class=
"members">Members
</h4>
1706 <dt>choice1[PPD_MAX_NAME]
</dt>
1707 <dd class=
"description">First option/choice (blank for all)
</dd>
1708 <dt>choice2[PPD_MAX_NAME]
</dt>
1709 <dd class=
"description">Second option/choice (blank for all)
</dd>
1710 <dt>option1[PPD_MAX_NAME]
</dt>
1711 <dd class=
"description">First keyword
</dd>
1712 <dt>option2[PPD_MAX_NAME]
</dt>
1713 <dd class=
"description">Second keyword
</dd>
1715 <h3 class=
"struct"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppd_coption_s">ppd_coption_s
</a></h3>
1716 <p class=
"description">Custom Option
</p>
1717 <p class=
"code">struct ppd_coption_s {
<br>
1718 char keyword[PPD_MAX_NAME];
<br>
1719 int marked;
<br>
1720 <a href=
"#ppd_option_t">ppd_option_t
</a> *option;
<br>
1721 cups_array_t *params;
<br>
1723 <h4 class=
"members">Members
</h4>
1725 <dt>keyword[PPD_MAX_NAME]
</dt>
1726 <dd class=
"description">Name of option that is being extended...
</dd>
1728 <dd class=
"description">Extended option is marked
</dd>
1730 <dd class=
"description">Option that is being extended...
</dd>
1732 <dd class=
"description">Parameters
</dd>
1734 <h3 class=
"struct"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppd_cparam_s">ppd_cparam_s
</a></h3>
1735 <p class=
"description">Custom Parameter
</p>
1736 <p class=
"code">struct ppd_cparam_s {
<br>
1737 <a href=
"#ppd_cpvalue_t">ppd_cpvalue_t
</a> current;
<br>
1738 <a href=
"#ppd_cplimit_t">ppd_cplimit_t
</a> minimum, maximum;
<br>
1739 char name[PPD_MAX_NAME];
<br>
1740 int order;
<br>
1741 char text[PPD_MAX_TEXT];
<br>
1742 <a href=
"#ppd_cptype_t">ppd_cptype_t
</a> type;
<br>
1744 <h4 class=
"members">Members
</h4>
1747 <dd class=
"description">Current value
</dd>
1749 <dd class=
"description">Maximum value
</dd>
1750 <dt>name[PPD_MAX_NAME]
</dt>
1751 <dd class=
"description">Parameter name
</dd>
1753 <dd class=
"description">Order (
0 to N)
</dd>
1754 <dt>text[PPD_MAX_TEXT]
</dt>
1755 <dd class=
"description">Human-readable text
</dd>
1757 <dd class=
"description">Parameter type
</dd>
1759 <h3 class=
"struct"><a name=
"ppd_emul_s">ppd_emul_s
</a></h3>
1760 <p class=
"description">Emulators
</p>
1761 <p class=
"code">struct ppd_emul_s {
<br>
1762 char name[PPD_MAX_NAME];
<br>
1763 char *start;
<br>
1764 char *stop;
<br>
1766 <h4 class=
"members">Members
</h4>
1768 <dt>name[PPD_MAX_NAME]
</dt>
1769 <dd class=
"description">Emulator name
</dd>
1771 <dd class=
"description">Code to switch to this emulation
</dd>
1773 <dd class=
"description">Code to stop this emulation
</dd>
1775 <h3 class=
"struct"><a name=
"ppd_file_s">ppd_file_s
</a></h3>
1776 <p class=
"description">PPD File
</p>
1777 <p class=
"code">struct ppd_file_s {
<br>
1778 int accurate_screens;
<br>
1779 int color_device;
<br>
1780 <a href=
"#ppd_cs_t">ppd_cs_t
</a> colorspace;
<br>
1781 <a href=
"#ppd_const_t">ppd_const_t
</a> *consts;
<br>
1782 int contone_only;
<br>
1783 float custom_margins[
4];
<br>
1784 float custom_max[
2];
<br>
1785 float custom_min[
2];
<br>
1786 <a href=
"#ppd_emul_t">ppd_emul_t
</a> *emulations;
<br>
1787 char **filters;
<br>
1788 int flip_duplex;
<br>
1789 char **fonts;
<br>
1790 <a href=
"#ppd_group_t">ppd_group_t
</a> *groups;
<br>
1791 char *jcl_begin;
<br>
1792 char *jcl_end;
<br>
1793 char *jcl_ps;
<br>
1794 int landscape;
<br>
1795 char *lang_encoding;
<br>
1796 char *lang_version;
<br>
1797 int language_level;
<br>
1798 int manual_copies;
<br>
1799 char *manufacturer;
<br>
1800 int model_number;
<br>
1801 char *modelname;
<br>
1802 char *nickname;
<br>
1803 int num_consts;
<br>
1804 int num_emulations;
<br>
1805 int num_filters;
<br>
1806 int num_fonts;
<br>
1807 int num_groups;
<br>
1808 int num_profiles;
<br>
1809 int num_sizes;
<br>
1810 char *patches;
<br>
1811 char *pcfilename;
<br>
1812 char *product;
<br>
1813 <a href=
"#ppd_profile_t">ppd_profile_t
</a> *profiles;
<br>
1814 char *protocols;
<br>
1815 char *shortnickname;
<br>
1816 <a href=
"#ppd_size_t">ppd_size_t
</a> *sizes;
<br>
1817 int throughput;
<br>
1818 char *ttrasterizer;
<br>
1819 int variable_sizes;
<br>
1821 <h4 class=
"members">Members
</h4>
1823 <dt>accurate_screens
</dt>
1824 <dd class=
"description">1 = supports accurate screens,
0 = not
</dd>
1825 <dt>color_device
</dt>
1826 <dd class=
"description">1 = color device,
0 = grayscale
</dd>
1827 <dt>colorspace
</dt>
1828 <dd class=
"description">Default colorspace
</dd>
1830 <dd class=
"description">UI/Non-UI constraints
</dd>
1831 <dt>contone_only
</dt>
1832 <dd class=
"description">1 = continuous tone only,
0 = not
</dd>
1833 <dt>custom_margins[
4]
</dt>
1834 <dd class=
"description">Margins around page
</dd>
1835 <dt>custom_max[
2]
</dt>
1836 <dd class=
"description">Maximum variable page size
</dd>
1837 <dt>custom_min[
2]
</dt>
1838 <dd class=
"description">Minimum variable page size
</dd>
1839 <dt>emulations
</dt>
1840 <dd class=
"description">Emulations and the code to invoke them
</dd>
1842 <dd class=
"description">Filter strings...
</dd>
1843 <dt>flip_duplex
<span class=
"info"> DEPRECATED
</span></dt>
1844 <dd class=
"description">1 = Flip page for back sides
</dd>
1846 <dd class=
"description">Pre-loaded fonts
</dd>
1848 <dd class=
"description">UI groups
</dd>
1850 <dd class=
"description">Start JCL commands
</dd>
1852 <dd class=
"description">End JCL commands
</dd>
1854 <dd class=
"description">Enter PostScript interpreter
</dd>
1856 <dd class=
"description">-
90 or
90</dd>
1857 <dt>lang_encoding
</dt>
1858 <dd class=
"description">Language encoding
</dd>
1859 <dt>lang_version
</dt>
1860 <dd class=
"description">Language version (English, Spanish, etc.)
</dd>
1861 <dt>language_level
</dt>
1862 <dd class=
"description">Language level of device
</dd>
1863 <dt>manual_copies
</dt>
1864 <dd class=
"description">1 = Copies done manually,
0 = hardware
</dd>
1865 <dt>manufacturer
</dt>
1866 <dd class=
"description">Manufacturer name
</dd>
1867 <dt>model_number
</dt>
1868 <dd class=
"description">Device-specific model number
</dd>
1870 <dd class=
"description">Model name (general)
</dd>
1872 <dd class=
"description">Nickname (specific)
</dd>
1873 <dt>num_consts
</dt>
1874 <dd class=
"description">Number of UI/Non-UI constraints
</dd>
1875 <dt>num_emulations
</dt>
1876 <dd class=
"description">Number of emulations supported
</dd>
1877 <dt>num_filters
</dt>
1878 <dd class=
"description">Number of filters
</dd>
1880 <dd class=
"description">Number of pre-loaded fonts
</dd>
1881 <dt>num_groups
</dt>
1882 <dd class=
"description">Number of UI groups
</dd>
1883 <dt>num_profiles
<span class=
"info"> DEPRECATED
</span></dt>
1884 <dd class=
"description">Number of sRGB color profiles
</dd>
1886 <dd class=
"description">Number of page sizes
</dd>
1888 <dd class=
"description">Patch commands to be sent to printer
</dd>
1889 <dt>pcfilename
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1890 <dd class=
"description">PCFileName string
</dd>
1892 <dd class=
"description">Product name (from PS RIP/interpreter)
</dd>
1893 <dt>profiles
<span class=
"info"> DEPRECATED
</span></dt>
1894 <dd class=
"description">sRGB color profiles
</dd>
1895 <dt>protocols
<span class=
"info"> CUPS
1.1.19/OS X
10.3 </span></dt>
1896 <dd class=
"description">Protocols (BCP, TBCP) string
</dd>
1897 <dt>shortnickname
</dt>
1898 <dd class=
"description">Short version of nickname
</dd>
1900 <dd class=
"description">Page sizes
</dd>
1901 <dt>throughput
</dt>
1902 <dd class=
"description">Pages per minute
</dd>
1903 <dt>ttrasterizer
</dt>
1904 <dd class=
"description">Truetype rasterizer
</dd>
1905 <dt>variable_sizes
</dt>
1906 <dd class=
"description">1 = supports variable sizes,
0 = doesn't
</dd>
1908 <h3 class=
"struct"><a name=
"ppd_group_s">ppd_group_s
</a></h3>
1909 <p class=
"description">Groups
</p>
1910 <p class=
"code">struct ppd_group_s {
<br>
1911 char text[PPD_MAX_TEXT - PPD_MAX_NAME];
<br>
1912 char name[PPD_MAX_NAME];
<br>
1913 int num_options;
<br>
1914 int num_subgroups;
<br>
1915 <a href=
"#ppd_option_t">ppd_option_t
</a> *options;
<br>
1916 struct
<a href=
"#ppd_group_s">ppd_group_s
</a> *subgroups;
<br>
1918 <h4 class=
"members">Members
</h4>
1920 <dt>PPD_MAX_NAME]
</dt>
1921 <dd class=
"description">Human-readable group name
</dd>
1922 <dt>name[PPD_MAX_NAME]
<span class=
"info"> CUPS
1.1.18/OS X
10.3 </span></dt>
1923 <dd class=
"description">Group name
</dd>
1924 <dt>num_options
</dt>
1925 <dd class=
"description">Number of options
</dd>
1926 <dt>num_subgroups
</dt>
1927 <dd class=
"description">Number of sub-groups
</dd>
1929 <dd class=
"description">Options
</dd>
1931 <dd class=
"description">Sub-groups (max depth =
1)
</dd>
1933 <h3 class=
"struct"><a name=
"ppd_option_s">ppd_option_s
</a></h3>
1934 <p class=
"description">Options
</p>
1935 <p class=
"code">struct ppd_option_s {
<br>
1936 <a href=
"#ppd_choice_t">ppd_choice_t
</a> *choices;
<br>
1937 char conflicted;
<br>
1938 char defchoice[PPD_MAX_NAME];
<br>
1939 char keyword[PPD_MAX_NAME];
<br>
1940 int num_choices;
<br>
1941 float order;
<br>
1942 <a href=
"#ppd_section_t">ppd_section_t
</a> section;
<br>
1943 char text[PPD_MAX_TEXT];
<br>
1944 <a href=
"#ppd_ui_t">ppd_ui_t
</a> ui;
<br>
1946 <h4 class=
"members">Members
</h4>
1949 <dd class=
"description">Option choices
</dd>
1950 <dt>conflicted
</dt>
1951 <dd class=
"description">0 if no conflicts exist,
1 otherwise
</dd>
1952 <dt>defchoice[PPD_MAX_NAME]
</dt>
1953 <dd class=
"description">Default option choice
</dd>
1954 <dt>keyword[PPD_MAX_NAME]
</dt>
1955 <dd class=
"description">Option keyword name (
"PageSize
", etc.)
</dd>
1956 <dt>num_choices
</dt>
1957 <dd class=
"description">Number of option choices
</dd>
1959 <dd class=
"description">Order number
</dd>
1961 <dd class=
"description">Section for command
</dd>
1962 <dt>text[PPD_MAX_TEXT]
</dt>
1963 <dd class=
"description">Human-readable text
</dd>
1965 <dd class=
"description">Type of UI option
</dd>
1967 <h3 class=
"struct"><a name=
"ppd_profile_s">ppd_profile_s
</a></h3>
1968 <p class=
"description">sRGB Color Profiles
</p>
1969 <p class=
"code">struct ppd_profile_s {
<br>
1970 float density;
<br>
1971 float gamma;
<br>
1972 float matrix[
3][
3];
<br>
1973 char media_type[PPD_MAX_NAME];
<br>
1974 char resolution[PPD_MAX_NAME];
<br>
1976 <h4 class=
"members">Members
</h4>
1979 <dd class=
"description">Ink density to use
</dd>
1981 <dd class=
"description">Gamma correction to use
</dd>
1982 <dt>matrix[
3][
3]
</dt>
1983 <dd class=
"description">Transform matrix
</dd>
1984 <dt>media_type[PPD_MAX_NAME]
</dt>
1985 <dd class=
"description">Media type or
"-
"</dd>
1986 <dt>resolution[PPD_MAX_NAME]
</dt>
1987 <dd class=
"description">Resolution or
"-
"</dd>
1989 <h3 class=
"struct"><a name=
"ppd_size_s">ppd_size_s
</a></h3>
1990 <p class=
"description">Page Sizes
</p>
1991 <p class=
"code">struct ppd_size_s {
<br>
1992 float bottom;
<br>
1993 float left;
<br>
1994 float length;
<br>
1995 int marked;
<br>
1996 char name[PPD_MAX_NAME];
<br>
1997 float right;
<br>
1998 float top;
<br>
1999 float width;
<br>
2001 <h4 class=
"members">Members
</h4>
2004 <dd class=
"description">Bottom printable margin in points
</dd>
2006 <dd class=
"description">Left printable margin in points
</dd>
2008 <dd class=
"description">Length of media in points
</dd>
2010 <dd class=
"description">Page size selected?
</dd>
2011 <dt>name[PPD_MAX_NAME]
</dt>
2012 <dd class=
"description">Media size option
</dd>
2014 <dd class=
"description">Right printable margin in points
</dd>
2016 <dd class=
"description">Top printable margin in points
</dd>
2018 <dd class=
"description">Width of media in points
</dd>
2020 <h2 class=
"title"><a name=
"UNIONS">Unions
</a></h2>
2021 <h3 class=
"union"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppd_cplimit_u">ppd_cplimit_u
</a></h3>
2022 <p class=
"description">Custom Parameter Limit
</p>
2023 <p class=
"code">union ppd_cplimit_u {
<br>
2024 float custom_curve;
<br>
2025 int custom_int;
<br>
2026 float custom_invcurve;
<br>
2027 int custom_passcode;
<br>
2028 int custom_password;
<br>
2029 float custom_points;
<br>
2030 float custom_real;
<br>
2031 int custom_string;
<br>
2033 <h4 class=
"members">Members
</h4>
2035 <dt>custom_curve
</dt>
2036 <dd class=
"description">Gamma value
</dd>
2037 <dt>custom_int
</dt>
2038 <dd class=
"description">Integer value
</dd>
2039 <dt>custom_invcurve
</dt>
2040 <dd class=
"description">Gamma value
</dd>
2041 <dt>custom_passcode
</dt>
2042 <dd class=
"description">Passcode length
</dd>
2043 <dt>custom_password
</dt>
2044 <dd class=
"description">Password length
</dd>
2045 <dt>custom_points
</dt>
2046 <dd class=
"description">Measurement value
</dd>
2047 <dt>custom_real
</dt>
2048 <dd class=
"description">Real value
</dd>
2049 <dt>custom_string
</dt>
2050 <dd class=
"description">String length
</dd>
2052 <h3 class=
"union"><span class=
"info"> CUPS
1.2/OS X
10.5 </span><a name=
"ppd_cpvalue_u">ppd_cpvalue_u
</a></h3>
2053 <p class=
"description">Custom Parameter Value
</p>
2054 <p class=
"code">union ppd_cpvalue_u {
<br>
2055 float custom_curve;
<br>
2056 int custom_int;
<br>
2057 float custom_invcurve;
<br>
2058 char *custom_passcode;
<br>
2059 char *custom_password;
<br>
2060 float custom_points;
<br>
2061 float custom_real;
<br>
2062 char *custom_string;
<br>
2064 <h4 class=
"members">Members
</h4>
2066 <dt>custom_curve
</dt>
2067 <dd class=
"description">Gamma value
</dd>
2068 <dt>custom_int
</dt>
2069 <dd class=
"description">Integer value
</dd>
2070 <dt>custom_invcurve
</dt>
2071 <dd class=
"description">Gamma value
</dd>
2072 <dt>custom_passcode
</dt>
2073 <dd class=
"description">Passcode value
</dd>
2074 <dt>custom_password
</dt>
2075 <dd class=
"description">Password value
</dd>
2076 <dt>custom_points
</dt>
2077 <dd class=
"description">Measurement value
</dd>
2078 <dt>custom_real
</dt>
2079 <dd class=
"description">Real value
</dd>
2080 <dt>custom_string
</dt>
2081 <dd class=
"description">String value
</dd>
2083 <h2 class=
"title"><a name=
"ENUMERATIONS">Constants
</a></h2>
2084 <h3 class=
"enumeration"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppd_conform_e">ppd_conform_e
</a></h3>
2085 <p class=
"description">Conformance Levels
</p>
2086 <h4 class=
"constants">Constants
</h4>
2088 <dt>PPD_CONFORM_RELAXED
</dt>
2089 <dd class=
"description">Relax whitespace and control char
</dd>
2090 <dt>PPD_CONFORM_STRICT
</dt>
2091 <dd class=
"description">Require strict conformance
</dd>
2093 <h3 class=
"enumeration"><a name=
"ppd_cs_e">ppd_cs_e
</a></h3>
2094 <p class=
"description">Colorspaces
</p>
2095 <h4 class=
"constants">Constants
</h4>
2097 <dt>PPD_CS_CMY
</dt>
2098 <dd class=
"description">CMY colorspace
</dd>
2099 <dt>PPD_CS_CMYK
</dt>
2100 <dd class=
"description">CMYK colorspace
</dd>
2101 <dt>PPD_CS_GRAY
</dt>
2102 <dd class=
"description">Grayscale colorspace
</dd>
2104 <dd class=
"description">DeviceN colorspace
</dd>
2105 <dt>PPD_CS_RGB
</dt>
2106 <dd class=
"description">RGB colorspace
</dd>
2107 <dt>PPD_CS_RGBK
</dt>
2108 <dd class=
"description">RGBK (K = gray) colorspace
</dd>
2110 <h3 class=
"enumeration"><a name=
"ppd_section_e">ppd_section_e
</a></h3>
2111 <p class=
"description">Order dependency sections
</p>
2112 <h4 class=
"constants">Constants
</h4>
2114 <dt>PPD_ORDER_ANY
</dt>
2115 <dd class=
"description">Option code can be anywhere in the file
</dd>
2116 <dt>PPD_ORDER_DOCUMENT
</dt>
2117 <dd class=
"description">... must be in the DocumentSetup section
</dd>
2118 <dt>PPD_ORDER_EXIT
</dt>
2119 <dd class=
"description">... must be sent prior to the document
</dd>
2120 <dt>PPD_ORDER_JCL
</dt>
2121 <dd class=
"description">... must be sent as a JCL command
</dd>
2122 <dt>PPD_ORDER_PAGE
</dt>
2123 <dd class=
"description">... must be in the PageSetup section
</dd>
2124 <dt>PPD_ORDER_PROLOG
</dt>
2125 <dd class=
"description">... must be in the Prolog section
</dd>
2127 <h3 class=
"enumeration"><span class=
"info"> CUPS
1.1.19/OS X
10.3 </span><a name=
"ppd_status_e">ppd_status_e
</a></h3>
2128 <p class=
"description">Status Codes
</p>
2129 <h4 class=
"constants">Constants
</h4>
2131 <dt>PPD_ALLOC_ERROR
</dt>
2132 <dd class=
"description">Memory allocation error
</dd>
2133 <dt>PPD_BAD_CUSTOM_PARAM
</dt>
2134 <dd class=
"description">Bad custom parameter
</dd>
2135 <dt>PPD_BAD_OPEN_GROUP
</dt>
2136 <dd class=
"description">Bad OpenGroup
</dd>
2137 <dt>PPD_BAD_OPEN_UI
</dt>
2138 <dd class=
"description">Bad OpenUI/JCLOpenUI
</dd>
2139 <dt>PPD_BAD_ORDER_DEPENDENCY
</dt>
2140 <dd class=
"description">Bad OrderDependency
</dd>
2141 <dt>PPD_BAD_UI_CONSTRAINTS
</dt>
2142 <dd class=
"description">Bad UIConstraints
</dd>
2143 <dt>PPD_BAD_VALUE
</dt>
2144 <dd class=
"description">Bad value string
</dd>
2145 <dt>PPD_FILE_OPEN_ERROR
</dt>
2146 <dd class=
"description">Unable to open PPD file
</dd>
2147 <dt>PPD_ILLEGAL_CHARACTER
</dt>
2148 <dd class=
"description">Illegal control character
</dd>
2149 <dt>PPD_ILLEGAL_MAIN_KEYWORD
</dt>
2150 <dd class=
"description">Illegal main keyword string
</dd>
2151 <dt>PPD_ILLEGAL_OPTION_KEYWORD
</dt>
2152 <dd class=
"description">Illegal option keyword string
</dd>
2153 <dt>PPD_ILLEGAL_TRANSLATION
</dt>
2154 <dd class=
"description">Illegal translation string
</dd>
2155 <dt>PPD_ILLEGAL_WHITESPACE
</dt>
2156 <dd class=
"description">Illegal whitespace character
</dd>
2157 <dt>PPD_INTERNAL_ERROR
</dt>
2158 <dd class=
"description">Internal error
</dd>
2159 <dt>PPD_LINE_TOO_LONG
</dt>
2160 <dd class=
"description">Line longer than
255 chars
</dd>
2161 <dt>PPD_MISSING_ASTERISK
</dt>
2162 <dd class=
"description">Missing asterisk in column
0</dd>
2163 <dt>PPD_MISSING_CLOSE_GROUP
</dt>
2164 <dd class=
"description">Missing CloseGroup
</dd>
2165 <dt>PPD_MISSING_OPTION_KEYWORD
</dt>
2166 <dd class=
"description">Missing option keyword
</dd>
2167 <dt>PPD_MISSING_PPDADOBE4
</dt>
2168 <dd class=
"description">Missing PPD-Adobe-
4.x header
</dd>
2169 <dt>PPD_MISSING_VALUE
</dt>
2170 <dd class=
"description">Missing value string
</dd>
2171 <dt>PPD_NESTED_OPEN_GROUP
</dt>
2172 <dd class=
"description">OpenGroup without a CloseGroup first
</dd>
2173 <dt>PPD_NESTED_OPEN_UI
</dt>
2174 <dd class=
"description">OpenUI/JCLOpenUI without a CloseUI/JCLCloseUI first
</dd>
2175 <dt>PPD_NULL_FILE
</dt>
2176 <dd class=
"description">NULL PPD file pointer
</dd>
2178 <dd class=
"description">OK
</dd>
2180 <h3 class=
"enumeration"><a name=
"ppd_ui_e">ppd_ui_e
</a></h3>
2181 <p class=
"description">UI Types
</p>
2182 <h4 class=
"constants">Constants
</h4>
2184 <dt>PPD_UI_BOOLEAN
</dt>
2185 <dd class=
"description">True or False option
</dd>
2186 <dt>PPD_UI_PICKMANY
</dt>
2187 <dd class=
"description">Pick zero or more from a list
</dd>
2188 <dt>PPD_UI_PICKONE
</dt>
2189 <dd class=
"description">Pick one from a list
</dd>