<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- SECTION: Programming --> <head> <title>PPD API</title> <meta name="keywords" content="Programming"> <meta name="creator" content="Mini-XML v2.6"> <style type="text/css"><!-- BODY { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } H1, H2, H3, H4, H5, H6, P, TD, TH { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } KBD { font-family: monaco, courier, monospace; font-weight: bold; } PRE { font-family: monaco, courier, monospace; } PRE.command { margin-left: 36pt; } P.compact { margin: 0; } P.example { font-style: italic; margin-left: 36pt; } PRE.example { background: #eeeeee; border: dotted thin #999999; margin-left: 36pt; padding: 10pt; } PRE.command EM, PRE.example EM { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } P.command { font-family: monaco, courier, monospace; margin-left: 36pt; } P.formula { font-style: italic; margin-left: 36pt; } BLOCKQUOTE { background: #eeeeee; border: solid thin #999999; padding: 10pt; } A IMG { border: none; } A:link:hover IMG { background: #f0f0f0; border-radius: 10px; -moz-border-radius: 10px; } A:link, A:visited { font-weight: normal; text-decoration: none; } A:link:hover, A:visited:hover, A:active { text-decoration: underline; } SUB, SUP { font-size: 50%; } TR.data, TD.data, TR.data TD { margin-top: 10pt; padding: 5pt; border-bottom: solid 1pt #999999; } TR.data TH { border-bottom: solid 1pt #999999; padding-top: 10pt; padding-left: 5pt; text-align: left; } DIV.table TABLE { border: solid thin #999999; border-collapse: collapse; border-spacing: 0; margin-left: auto; margin-right: auto; } DIV.table CAPTION { caption-side: top; font-size: 120%; font-style: italic; font-weight: bold; margin-left: auto; margin-right: auto; } DIV.table TABLE TD { border: solid thin #cccccc; padding-top: 5pt; } DIV.table TABLE TH { background: #cccccc; border: none; border-bottom: solid thin #999999; } DIV.figure TABLE { margin-left: auto; margin-right: auto; } DIV.figure CAPTION { caption-side: bottom; font-size: 120%; font-style: italic; font-weight: bold; margin-left: auto; margin-right: auto; } TH.label { text-align: right; vertical-align: top; } TH.sublabel { text-align: right; font-weight: normal; } HR { border: solid thin; } SPAN.info { background: black; border: thin solid black; color: white; font-size: 80%; font-style: italic; font-weight: bold; white-space: nowrap; } H2 SPAN.info, H3 SPAN.info, H4 SPAN.info { float: right; font-size: 100%; } H1.title { } H2.title, H3.title { border-bottom: solid 2pt #000000; } DIV.indent, TABLE.indent { margin-top: 2em; margin-left: auto; margin-right: auto; width: 90%; } TABLE.indent { border-collapse: collapse; } TABLE.indent TD, TABLE.indent TH { padding: 0; } TABLE.list { border-collapse: collapse; margin-left: auto; margin-right: auto; width: 90%; } TABLE.list TH { background: white; border-bottom: solid thin #cccccc; color: #444444; padding-top: 10pt; padding-left: 5pt; text-align: left; vertical-align: bottom; white-space: nowrap; } TABLE.list TH A { color: #4444cc; } TABLE.list TD { border-bottom: solid thin #eeeeee; padding-top: 5pt; padding-left: 5pt; } TABLE.list TR:nth-child(even) { background: #f8f8f8; } TABLE.list TR:nth-child(odd) { background: #f4f4f4; } DT { margin-left: 36pt; margin-top: 12pt; } DD { margin-left: 54pt; } DL.category DT { font-weight: bold; } P.summary { margin-left: 36pt; font-family: monaco, courier, monospace; } DIV.summary TABLE { border: solid thin #999999; border-collapse: collapse; border-spacing: 0; margin: 10px; } DIV.summary TABLE TD, DIV.summary TABLE TH { border: solid thin #999999; padding: 5px; text-align: left; vertical-align: top; } DIV.summary TABLE THEAD TH { background: #eeeeee; } /* API documentation styles... */ div.body h1 { margin: 0; } div.body h2 { margin-top: 1.5em; } div.body h3, div.body h4, div.body h5 { margin-bottom: 0.5em; margin-top: 1.5em; } .class, .enumeration, .function, .struct, .typedef, .union { border-bottom: solid thin #999999; margin-bottom: 0; margin-top: 2em; } .description { margin-top: 0.5em; } code, p.code, pre, ul.code li { font-family: monaco, courier, monospace; font-size: 90%; } ul.code, ul.contents, ul.subcontents { list-style-type: none; margin: 0; padding-left: 0; } ul.code li { margin: 0; } ul.contents > li { margin-top: 1em; } ul.contents li ul.code, ul.contents li ul.subcontents { padding-left: 2em; } div.body dl { margin-left: 0; margin-top: 0; } div.body dt { font-style: italic; margin-left: 0; margin-top: 0; } div.body dd { margin-bottom: 0.5em; } /* This is just for the HTML files generated with the framedhelp target */ div.contents { background: #e8e8e8; border: solid thin black; padding: 10px; } div.contents h1 { font-size: 110%; } div.contents h2 { font-size: 100%; } div.contents ul.contents { font-size: 80%; } div.contents ul.subcontents li { margin-left: 1em; text-indent: -1em; } --></style> </head> <body> <div class='body'> <!-- "$Id$" PPD API header for the Common UNIX Printing System (CUPS). Copyright 2008-2009 by Apple Inc. These coded instructions, statements, and computer programs are the property of Apple Inc. and are protected by Federal copyright law. Distribution and use rights are outlined in the file "LICENSE.txt" which should have been included with this file. If this file is file is missing or damaged, see the license at "http://www.cups.org/". --> <h1 class='title'>PPD API</h1> <div class='summary'><table summary='General Information'> <thead> <tr> <th>Header</th> <th>cups/ppd.h</th> </tr> </thead> <tbody> <tr> <th>Library</th> <td>-lcups</td> </tr> <tr> <th>See Also</th> <td>Programming: <a href='api-overview.html' target='_top'>Introduction to CUPS Programming</a><br> Programming: <a href='api-cups.html' target='_top'>CUPS API</a><br> Specifications: <a href='spec-ppd.html' target='_top'>CUPS PPD Extensions</a></td> </tr> </tbody> </table></div> <h2 class="title">Contents</h2> <ul class="contents"> <ul class="subcontents"> <li><a href="#OVERVIEW">Overview</a><ul class="subcontents"> <li><a href="#LOADING">Loading a PPD File</a></li> <li><a href="#OPTIONS_AND_GROUPS">Options and Groups</a></li> <li><a href="#CONSTRAINTS">Constraints</a></li> <li><a href="#PAGE_SIZES">Page Sizes</a></li> <li><a href="#ATTRIBUTES">Attributes</a></li> </ul></li> <li><a href="#FUNCTIONS">Functions</a><ul class="code"> <li><a href="#cupsGetConflicts" title="Get a list of conflicting options in a marked PPD.">cupsGetConflicts</a></li> <li><a href="#cupsMarkOptions" title="Mark command-line options in a PPD file.">cupsMarkOptions</a></li> <li><a href="#cupsResolveConflicts" title="Resolve conflicts in a marked PPD.">cupsResolveConflicts</a></li> <li><a href="#ppdClose" title="Free all memory used by the PPD file.">ppdClose</a></li> <li><a href="#ppdCollect" title="Collect all marked options that reside in the specified section.">ppdCollect</a></li> <li><a href="#ppdCollect2" title="Collect all marked options that reside in the specified section and minimum order.">ppdCollect2</a></li> <li><a href="#ppdConflicts" title="Check to see if there are any conflicts among the marked option choices.">ppdConflicts</a></li> <li><a href="#ppdEmit" title="Emit code for marked options to a file.">ppdEmit</a></li> <li><a href="#ppdEmitAfterOrder" title="Emit a subset of the code for marked options to a file.">ppdEmitAfterOrder</a></li> <li><a href="#ppdEmitFd" title="Emit code for marked options to a file.">ppdEmitFd</a></li> <li><a href="#ppdEmitJCL" title="Emit code for JCL options to a file.">ppdEmitJCL</a></li> <li><a href="#ppdEmitJCLEnd" title="Emit JCLEnd code to a file.">ppdEmitJCLEnd</a></li> <li><a href="#ppdEmitString" title="Get a string containing the code for marked options.">ppdEmitString</a></li> <li><a href="#ppdErrorString" title="Returns the text assocated with a status.">ppdErrorString</a></li> <li><a href="#ppdFindAttr" title="Find the first matching attribute.">ppdFindAttr</a></li> <li><a href="#ppdFindChoice" title="Return a pointer to an option choice.">ppdFindChoice</a></li> <li><a href="#ppdFindCustomOption" title="Find a custom option.">ppdFindCustomOption</a></li> <li><a href="#ppdFindCustomParam" title="Find a parameter for a custom option.">ppdFindCustomParam</a></li> <li><a href="#ppdFindMarkedChoice" title="Return the marked choice for the specified option.">ppdFindMarkedChoice</a></li> <li><a href="#ppdFindNextAttr" title="Find the next matching attribute.">ppdFindNextAttr</a></li> <li><a href="#ppdFindOption" title="Return a pointer to the specified option.">ppdFindOption</a></li> <li><a href="#ppdFirstCustomParam" title="Return the first parameter for a custom option.">ppdFirstCustomParam</a></li> <li><a href="#ppdFirstOption" title="Return the first option in the PPD file.">ppdFirstOption</a></li> <li><a href="#ppdInstallableConflict" title="Test whether an option choice conflicts with an installable option.">ppdInstallableConflict</a></li> <li><a href="#ppdIsMarked" title="Check to see if an option is marked.">ppdIsMarked</a></li> <li><a href="#ppdLastError" title="Return the status from the last ppdOpen*().">ppdLastError</a></li> <li><a href="#ppdLocalize" title="Localize the PPD file to the current locale.">ppdLocalize</a></li> <li><a href="#ppdLocalizeAttr" title="Localize an attribute.">ppdLocalizeAttr</a></li> <li><a href="#ppdLocalizeIPPReason" title="Get the localized version of a cupsIPPReason attribute.">ppdLocalizeIPPReason</a></li> <li><a href="#ppdLocalizeMarkerName" title="Get the localized version of a marker-names attribute value.">ppdLocalizeMarkerName</a></li> <li><a href="#ppdMarkDefaults" title="Mark all default options in the PPD file.">ppdMarkDefaults</a></li> <li><a href="#ppdMarkOption" title="Mark an option in a PPD file and return the number of conflicts.">ppdMarkOption</a></li> <li><a href="#ppdNextCustomParam" title="Return the next parameter for a custom option.">ppdNextCustomParam</a></li> <li><a href="#ppdNextOption" title="Return the next option in the PPD file.">ppdNextOption</a></li> <li><a href="#ppdOpen" title="Read a PPD file into memory.">ppdOpen</a></li> <li><a href="#ppdOpen2" title="Read a PPD file into memory.">ppdOpen2</a></li> <li><a href="#ppdOpenFd" title="Read a PPD file into memory.">ppdOpenFd</a></li> <li><a href="#ppdOpenFile" title="Read a PPD file into memory.">ppdOpenFile</a></li> <li><a href="#ppdPageLength" title="Get the page length for the given size.">ppdPageLength</a></li> <li><a href="#ppdPageSize" title="Get the page size record for the given size.">ppdPageSize</a></li> <li><a href="#ppdPageSizeLimits" title="Return the custom page size limits.">ppdPageSizeLimits</a></li> <li><a href="#ppdPageWidth" title="Get the page width for the given size.">ppdPageWidth</a></li> <li><a href="#ppdSetConformance" title="Set the conformance level for PPD files.">ppdSetConformance</a></li> </ul></li> <li><a href="#TYPES">Data Types</a><ul class="code"> <li><a href="#ppd_attr_t" title="PPD Attribute Structure ">ppd_attr_t</a></li> <li><a href="#ppd_choice_t" title="Option choices">ppd_choice_t</a></li> <li><a href="#ppd_conform_t" title="Conformance Levels ">ppd_conform_t</a></li> <li><a href="#ppd_const_t" title="Constraints">ppd_const_t</a></li> <li><a href="#ppd_coption_t" title="Custom Option ">ppd_coption_t</a></li> <li><a href="#ppd_cparam_t" title="Custom Parameter ">ppd_cparam_t</a></li> <li><a href="#ppd_cplimit_t" title="Custom Parameter Limit ">ppd_cplimit_t</a></li> <li><a href="#ppd_cptype_t" title="Custom Parameter Type ">ppd_cptype_t</a></li> <li><a href="#ppd_cpvalue_t" title="Custom Parameter Value ">ppd_cpvalue_t</a></li> <li><a href="#ppd_cs_t" title="Colorspaces">ppd_cs_t</a></li> <li><a href="#ppd_emul_t" title="Emulators">ppd_emul_t</a></li> <li><a href="#ppd_file_t" title="PPD File">ppd_file_t</a></li> <li><a href="#ppd_group_t" title="Groups">ppd_group_t</a></li> <li><a href="#ppd_option_t" title="Options">ppd_option_t</a></li> <li><a href="#ppd_profile_t" title="sRGB Color Profiles">ppd_profile_t</a></li> <li><a href="#ppd_section_t" title="Order dependency sections">ppd_section_t</a></li> <li><a href="#ppd_size_t" title="Page Sizes">ppd_size_t</a></li> <li><a href="#ppd_status_t" title="Status Codes ">ppd_status_t</a></li> <li><a href="#ppd_ui_t" title="UI Types">ppd_ui_t</a></li> </ul></li> <li><a href="#STRUCTURES">Structures</a><ul class="code"> <li><a href="#ppd_attr_s" title="PPD Attribute Structure ">ppd_attr_s</a></li> <li><a href="#ppd_choice_s" title="Option choices">ppd_choice_s</a></li> <li><a href="#ppd_const_s" title="Constraints">ppd_const_s</a></li> <li><a href="#ppd_coption_s" title="Custom Option ">ppd_coption_s</a></li> <li><a href="#ppd_cparam_s" title="Custom Parameter ">ppd_cparam_s</a></li> <li><a href="#ppd_emul_s" title="Emulators">ppd_emul_s</a></li> <li><a href="#ppd_file_s" title="PPD File">ppd_file_s</a></li> <li><a href="#ppd_group_s" title="Groups">ppd_group_s</a></li> <li><a href="#ppd_option_s" title="Options">ppd_option_s</a></li> <li><a href="#ppd_profile_s" title="sRGB Color Profiles">ppd_profile_s</a></li> <li><a href="#ppd_size_s" title="Page Sizes">ppd_size_s</a></li> </ul></li> <li><a href="#UNIONS">Unions</a><ul class="code"> <li><a href="#ppd_cplimit_u" title="Custom Parameter Limit ">ppd_cplimit_u</a></li> <li><a href="#ppd_cpvalue_u" title="Custom Parameter Value ">ppd_cpvalue_u</a></li> </ul></li> <li><a href="#ENUMERATIONS">Constants</a><ul class="code"> <li><a href="#ppd_conform_e" title="Conformance Levels ">ppd_conform_e</a></li> <li><a href="#ppd_cptype_e" title="Custom Parameter Type ">ppd_cptype_e</a></li> <li><a href="#ppd_cs_e" title="Colorspaces">ppd_cs_e</a></li> <li><a href="#ppd_section_e" title="Order dependency sections">ppd_section_e</a></li> <li><a href="#ppd_status_e" title="Status Codes ">ppd_status_e</a></li> <li><a href="#ppd_ui_e" title="UI Types">ppd_ui_e</a></li> </ul></li> <!-- "$Id$" PPD API introduction for the Common UNIX Printing System (CUPS). Copyright 2007-2008 by Apple Inc. Copyright 1997-2006 by Easy Software Products, all rights reserved. These coded instructions, statements, and computer programs are the property of Apple Inc. and are protected by Federal copyright law. Distribution and use rights are outlined in the file "LICENSE.txt" which should have been included with this file. If this file is file is missing or damaged, see the license at "http://www.cups.org/". --> <h2 class='title'><a name='OVERVIEW'>Overview</a></h2> <p>The CUPS PPD API provides read-only access the data in PostScript Printer Description ("PPD") files which are used for all printers with a driver. With it you can obtain the data necessary to display printer options to users, mark option choices and check for conflicting choices, and output marked choices in PostScript output. The <a href="#ppd_file_t"><code>ppd_file_t</code></a> structure contains all of the information in a PPD file.</p> <blockquote><b>Note:</b> <p>The CUPS PPD API uses the terms "option" and "choice" instead of the Adobe terms "MainKeyword" and "OptionKeyword" to refer to specific printer options and features. CUPS also treats option ("MainKeyword") and choice ("OptionKeyword") values as case-insensitive strings, so option "InputSlot" and choice "Upper" are equivalent to "inputslot" and "upper", respectively.</p> </blockquote> <h3><a name="LOADING">Loading a PPD File</a></h3> <p>The <a href="#ppdOpenFile"><code>ppdOpenFile</code></a> function "opens" a PPD file and loads it into memory. For example, the following code opens the current printer's PPD file in a CUPS filter:</p> <pre class="example"> #include <cups/ppd.h> <a href="#ppd_file_t">ppd_file_t</a> *ppd = <a href="#ppdOpenFile">ppdOpenFile</a>(getenv("PPD")); </pre> <p>The return value is a pointer to a new <a href="#ppd_file_t"><code>ppd_file_t</code></a> structure or <code>NULL</code> if the PPD file does not exist or cannot be loaded. The <a href="#ppdClose"><code>ppdClose</code></a> function frees the memory used by the structure:</p> <pre class="example"> #include <cups/ppd.h> <a href="#ppd_file_t">ppd_file_t</a> *ppd; <a href="#ppdClose">ppdClose</a>(ppd); </pre> <p>Once closed, pointers to the <a href="#ppd_file_t"><code>ppd_file_t</code></a> structure and any data in it will no longer be valid.</p> <h3><a name="OPTIONS_AND_GROUPS">Options and Groups</a></h3> <p>PPD files support multiple options, which are stored in arrays of <a href="#ppd_option_t"><code>ppd_option_t</code></a> and <a href="#ppd_choice_t"><code>ppd_choice_t</code></a> structures.</p> <p>Each option in turn is associated with a group stored in a <a href="#ppd_group_t"><code>ppd_group_t</code></a> structure. Groups can be specified in the PPD file; if an option is not associated with a group then it is put in an automatically-generated "General" group. Groups can also have sub-groups, however CUPS currently ignores sub-groups because of past abuses of this functionality.</p> <p>Option choices are selected by marking them using one of three functions. The first is <a href="#ppdMarkDefaults"><code>ppdMarkDefaults</code></a> which selects all of the default options in the PPD file:</p> <pre class="example"> #include <cups/ppd.h> <a href="#ppd_file_t">ppd_file_t</a> *ppd; <a href="#ppdMarkDefaults">ppdMarkDefaults</a>(ppd); </pre> <p>The second is <a href="#ppdMarkOption"><code>ppdMarkOption</code></a> which selects a single option choice in the PPD file. For example, the following code selects the upper paper tray:</p> <pre class="example"> #include <cups/ppd.h> <a href="#ppd_file_t">ppd_file_t</a> *ppd; <a href="#ppdMarkOption">ppdMarkOption</a>(ppd, "InputSlot", "Upper"); </pre> <p>The last function is <a href="#cupsMarkOptions"><code>cupsMarkOptions</code></a> which selects multiple option choices in the PPD file from an array of CUPS options, mapping IPP attributes like "media" and "sides" to their corresponding PPD options. You typically use this function in a print filter with <code>cupsParseOptions</code> and <a href="#ppdMarkDefaults"><code>ppdMarkDefaults</code></a> to select all of the option choices needed for the job, for example:</p> <pre class="example"> #include <cups/ppd.h> <a href="#ppd_file_t">ppd_file_t</a> *ppd = <a href="#ppdOpenFile">ppdOpenFile</a>(getenv("PPD")); cups_option_t *options = NULL; int num_options = cupsParseOptions(argv[5], 0, &options); <a href="#ppdMarkDefaults">ppdMarkDefaults</a>(ppd); <a href="#cupsMarkOptions">cupsMarkOptions</a>(ppd, num_options, options); cupsFreeOptions(num_options, options); </pre> <h3><a name="CONSTRAINTS">Constraints</a></h3> <p>PPD files support specification of conflict conditions, called constraints, between different options. Constraints are stored in an array of <a href="#ppd_const_t"><code>ppd_const_t</code></a> structures which specify the options and choices that conflict with each other. The <a href="#ppdConflicts"><code>ppdConflicts</code></a> function tells you how many of the selected options are incompatible. Since constraints are normally specified in pairs, the returned value is typically an even number.</p> <h3><a name="PAGE_SIZES">Page Sizes</a></h3> <p>Page sizes are special options which have physical dimensions and margins associated with them. The size information is stored in <a href="#ppd_size_t"><code>ppd_size_t</code></a> structures and is available by looking up the named size with the <a href="#ppdPageSize"><code>ppdPageSize</code></a> function. The page size and margins are returned in units called points; there are 72 points per inch. If you pass <code>NULL</code> for the size, the currently selected size is returned:</p> <pre class="example"> #include <cups/ppd.h> <a href="#ppd_file_t">ppd_file_t</a> *ppd; <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, NULL); </pre> <p>Besides the standard page sizes listed in a PPD file, some printers support variable or custom page sizes. Custom page sizes are supported if the <code>variables_sizes</code> member of the <a href="#ppd_file_t"><code>ppd_file_t</code></a> structure is non-zero. The <code>custom_min</code>, <code>custom_max</code>, and <code>custom_margins</code> members of the <a href="#ppd_file_t"><code>ppd_file_t</code></a> structure define the limits of the printable area. To get the resulting media size, use a page size string of the form "Custom.<I>width</I>x<I>length</I>", where "width" and "length" are in points. Custom page size names can also be specified in inches ("Custom.<i>width</i>x<i>height</i>in"), centimeters ("Custom.<i>width</i>x<i>height</i>cm"), or millimeters ("Custom.<i>width</i>x<i>height</i>mm"):</p> <pre class="example"> #include <cups/ppd.h> <a href="#ppd_file_t">ppd_file_t</a> *ppd; /* Get an 576x720 point custom page size */ <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, "Custom.576x720"); /* Get an 8x10 inch custom page size */ <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, "Custom.8x10in"); /* Get a 100x200 millimeter custom page size */ <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, "Custom.100x200mm"); /* Get a 12.7x34.5 centimeter custom page size */ <a href="#ppd_size_t">ppd_size_t</a> *size = <a href="#ppdPageSize">ppdPageSize</a>(ppd, "Custom.12.7x34.5cm"); </pre> <p>If the PPD does not support variable page sizes, the <a href="#ppdPageSize"><code>ppdPageSize</code></a> function will return <code>NULL</code>.</p> <h3><a name="ATTRIBUTES">Attributes</a></h3> <p>Every PPD file is composed of one or more attributes. Most of these attributes are used to define groups, options, choices, and page sizes, however several informational attributes may be present which you can access in your program or filter. Attributes normally look like one of the following examples in a PPD file:</p> <pre class="example"> *name: "value" *name spec: "value" *name spec/text: "value" </pre> <p>The <a href="#ppdFindAttr"><code>ppdFindAttr</code></a> and <a href="#ppdFindNextAttr"><code>ppdFindNextAttr</code></a> functions find the first and next instances, respectively, of the named attribute with the given "spec" string and return a <a href="#ppd_attr_t"><code>ppd_attr_t</code></a> structure. If you provide a NULL specifier string, all attributes with the given name will be returned. For example, the following code lists all of the <code>Product</code> attributes in a PPD file:</p> <pre class="example"> #include <cups/ppd.h> <a href="#ppd_file_t">ppd_file_t</a> *ppd; <a href="#ppd_attr_t">ppd_attr_t</a> *attr; for (attr = <a href="#ppdFindAttr">ppdFindAttr</a>(ppd, "Product", NULL); attr != NULL; attr = <a href="#ppdFindNextAttr">ppdFindNextAttr</a>(ppd, "Product", NULL)) puts(attr->value); </pre> <h2 class="title"><a name="FUNCTIONS">Functions</a></h2> <h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a name="cupsGetConflicts">cupsGetConflicts</a></h3> <p class="description">Get a list of conflicting options in a marked PPD.</p> <p class="code"> int cupsGetConflicts (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *option,<br> const char *choice,<br> cups_option_t **options<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>option</dt> <dd class="description">Option to test</dd> <dt>choice</dt> <dd class="description">Choice to test</dd> <dt>options</dt> <dd class="description">Conflicting options</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Number of conflicting options</p> <h4 class="discussion">Discussion</h4> <p class="discussion">This function gets a list of options that would conflict if "option" and "choice" were marked in the PPD. You would typically call this function after marking the currently selected options in the PPD in order to determine whether a new option selection would cause a conflict.<br> <br> The number of conflicting options are returned with "options" pointing to the conflicting options. The returned option array must be freed using <a href="#cupsFreeOptions"><code>cupsFreeOptions</code></a>. </p> <h3 class="function"><a name="cupsMarkOptions">cupsMarkOptions</a></h3> <p class="description">Mark command-line options in a PPD file.</p> <p class="code"> int cupsMarkOptions (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> int num_options,<br> cups_option_t *options<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>num_options</dt> <dd class="description">Number of options</dd> <dt>options</dt> <dd class="description">Options</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">1 if conflicts exist, 0 otherwise</p> <h4 class="discussion">Discussion</h4> <p class="discussion">This function maps the IPP "finishings", "media", "mirror", "multiple-document-handling", "output-bin", "printer-resolution", and "sides" attributes to their corresponding PPD options and choices.</p> <h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a name="cupsResolveConflicts">cupsResolveConflicts</a></h3> <p class="description">Resolve conflicts in a marked PPD.</p> <p class="code"> int cupsResolveConflicts (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *option,<br> const char *choice,<br> int *num_options,<br> cups_option_t **options<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>option</dt> <dd class="description">Newly selected option or <code>NULL</code> for none</dd> <dt>choice</dt> <dd class="description">Newly selected choice or <code>NULL</code> for none</dd> <dt>num_options</dt> <dd class="description">Number of additional selected options</dd> <dt>options</dt> <dd class="description">Additional selected options</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">1 on success, 0 on failure</p> <h4 class="discussion">Discussion</h4> <p class="discussion">This function attempts to resolve any conflicts in a marked PPD, returning a list of option changes that are required to resolve them. On input, "num_options" and "options" contain any pending option changes that have not yet been marked, while "option" and "choice" contain the most recent selection which may or may not be in "num_options" or "options".<br> <br> On successful return, "num_options" and "options" are updated to contain "option" and "choice" along with any changes required to resolve conflicts specified in the PPD file and 1 is returned.<br> <br> If option conflicts cannot be resolved, "num_options" and "options" are not changed and 0 is returned.<br> <br> When resolving conflicts, <code>cupsResolveConflicts</code> does not consider changes to the current page size (<code>media</code>, <code>PageSize</code>, and <code>PageRegion</code>) or to the most recent option specified in "option". Thus, if the only way to resolve a conflict is to change the page size or the option the user most recently changed, <code>cupsResolveConflicts</code> will return 0 to indicate it was unable to resolve the conflicts.<br> <br> The <code>cupsResolveConflicts</code> function uses one of two sources of option constraint information. The preferred constraint information is defined by <code>cupsUIConstraints</code> and <code>cupsUIResolver</code> attributes - in this case, the PPD file provides constraint resolution actions.<br> <br> The backup constraint information is defined by the <code>UIConstraints</code> and <code>NonUIConstraints</code> attributes. These constraints are resolved algorithmically by first selecting the default choice for the conflicting option, then iterating over all possible choices until a non-conflicting option choice is found. </p> <h3 class="function"><a name="ppdClose">ppdClose</a></h3> <p class="description">Free all memory used by the PPD file.</p> <p class="code"> void ppdClose (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> </dl> <h3 class="function"><a name="ppdCollect">ppdCollect</a></h3> <p class="description">Collect all marked options that reside in the specified section.</p> <p class="code"> int ppdCollect (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> <a href="#ppd_section_t">ppd_section_t</a> section,<br> <a href="#ppd_choice_t">ppd_choice_t</a> ***choices<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file data</dd> <dt>section</dt> <dd class="description">Section to collect</dd> <dt>choices</dt> <dd class="description">Pointers to choices</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Number of options marked</p> <h4 class="discussion">Discussion</h4> <p class="discussion">The choices array should be freed using <code>free</code> when you are finished with it.</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdCollect2">ppdCollect2</a></h3> <p class="description">Collect all marked options that reside in the specified section and minimum order.</p> <p class="code"> int ppdCollect2 (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> <a href="#ppd_section_t">ppd_section_t</a> section,<br> float min_order,<br> <a href="#ppd_choice_t">ppd_choice_t</a> ***choices<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file data</dd> <dt>section</dt> <dd class="description">Section to collect</dd> <dt>min_order</dt> <dd class="description">Minimum OrderDependency value</dd> <dt>choices</dt> <dd class="description">Pointers to choices</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Number of options marked</p> <h4 class="discussion">Discussion</h4> <p class="discussion">The choices array should be freed using <code>free</code> when you are finished with it. </p> <h3 class="function"><a name="ppdConflicts">ppdConflicts</a></h3> <p class="description">Check to see if there are any conflicts among the marked option choices.</p> <p class="code"> int ppdConflicts (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD to check</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Number of conflicts found</p> <h4 class="discussion">Discussion</h4> <p class="discussion">The returned value is the same as returned by <a href="#ppdMarkOption"><code>ppdMarkOption</code></a>.</p> <h3 class="function"><a name="ppdEmit">ppdEmit</a></h3> <p class="description">Emit code for marked options to a file.</p> <p class="code"> int ppdEmit (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> FILE *fp,<br> <a href="#ppd_section_t">ppd_section_t</a> section<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>fp</dt> <dd class="description">File to write to</dd> <dt>section</dt> <dd class="description">Section to write</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">0 on success, -1 on failure</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdEmitAfterOrder">ppdEmitAfterOrder</a></h3> <p class="description">Emit a subset of the code for marked options to a file.</p> <p class="code"> int ppdEmitAfterOrder (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> FILE *fp,<br> <a href="#ppd_section_t">ppd_section_t</a> section,<br> int limit,<br> float min_order<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>fp</dt> <dd class="description">File to write to</dd> <dt>section</dt> <dd class="description">Section to write</dd> <dt>limit</dt> <dd class="description">Non-zero to use min_order</dd> <dt>min_order</dt> <dd class="description">Lowest OrderDependency</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">0 on success, -1 on failure</p> <h4 class="discussion">Discussion</h4> <p class="discussion">When "limit" is non-zero, this function only emits options whose OrderDependency value is greater than or equal to "min_order".<br> <br> When "limit" is zero, this function is identical to ppdEmit(). </p> <h3 class="function"><a name="ppdEmitFd">ppdEmitFd</a></h3> <p class="description">Emit code for marked options to a file.</p> <p class="code"> int ppdEmitFd (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> int fd,<br> <a href="#ppd_section_t">ppd_section_t</a> section<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>fd</dt> <dd class="description">File to write to</dd> <dt>section</dt> <dd class="description">Section to write</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">0 on success, -1 on failure</p> <h3 class="function"><a name="ppdEmitJCL">ppdEmitJCL</a></h3> <p class="description">Emit code for JCL options to a file.</p> <p class="code"> int ppdEmitJCL (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> FILE *fp,<br> int job_id,<br> const char *user,<br> const char *title<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>fp</dt> <dd class="description">File to write to</dd> <dt>job_id</dt> <dd class="description">Job ID</dd> <dt>user</dt> <dd class="description">Username</dd> <dt>title</dt> <dd class="description">Title</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">0 on success, -1 on failure</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdEmitJCLEnd">ppdEmitJCLEnd</a></h3> <p class="description">Emit JCLEnd code to a file.</p> <p class="code"> int ppdEmitJCLEnd (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> FILE *fp<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>fp</dt> <dd class="description">File to write to</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">0 on success, -1 on failure</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdEmitString">ppdEmitString</a></h3> <p class="description">Get a string containing the code for marked options.</p> <p class="code"> char *ppdEmitString (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> <a href="#ppd_section_t">ppd_section_t</a> section,<br> float min_order<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>section</dt> <dd class="description">Section to write</dd> <dt>min_order</dt> <dd class="description">Lowest OrderDependency</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">String containing option code or <code>NULL</code> if there is no option code</p> <h4 class="discussion">Discussion</h4> <p class="discussion">When "min_order" is greater than zero, this function only includes options whose OrderDependency value is greater than or equal to "min_order". Otherwise, all options in the specified section are included in the returned string.<br> <br> The return string is allocated on the heap and should be freed using <code>free</code> when you are done with it. </p> <h3 class="function"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppdErrorString">ppdErrorString</a></h3> <p class="description">Returns the text assocated with a status.</p> <p class="code"> const char *ppdErrorString (<br> <a href="#ppd_status_t">ppd_status_t</a> status<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>status</dt> <dd class="description">PPD status</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Status string</p> <h3 class="function"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppdFindAttr">ppdFindAttr</a></h3> <p class="description">Find the first matching attribute.</p> <p class="code"> <a href="#ppd_attr_t">ppd_attr_t</a> *ppdFindAttr (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *name,<br> const char *spec<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file data</dd> <dt>name</dt> <dd class="description">Attribute name</dd> <dt>spec</dt> <dd class="description">Specifier string or <code>NULL</code></dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Attribute or <code>NULL</code> if not found</p> <h3 class="function"><a name="ppdFindChoice">ppdFindChoice</a></h3> <p class="description">Return a pointer to an option choice.</p> <p class="code"> <a href="#ppd_choice_t">ppd_choice_t</a> *ppdFindChoice (<br> <a href="#ppd_option_t">ppd_option_t</a> *o,<br> const char *choice<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>o</dt> <dd class="description">Pointer to option</dd> <dt>choice</dt> <dd class="description">Name of choice</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Choice pointer or <code>NULL</code></p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdFindCustomOption">ppdFindCustomOption</a></h3> <p class="description">Find a custom option.</p> <p class="code"> <a href="#ppd_coption_t">ppd_coption_t</a> *ppdFindCustomOption (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *keyword<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>keyword</dt> <dd class="description">Custom option name</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Custom option or NULL</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdFindCustomParam">ppdFindCustomParam</a></h3> <p class="description">Find a parameter for a custom option.</p> <p class="code"> <a href="#ppd_cparam_t">ppd_cparam_t</a> *ppdFindCustomParam (<br> <a href="#ppd_coption_t">ppd_coption_t</a> *opt,<br> const char *name<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>opt</dt> <dd class="description">Custom option</dd> <dt>name</dt> <dd class="description">Parameter name</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Custom parameter or NULL</p> <h3 class="function"><a name="ppdFindMarkedChoice">ppdFindMarkedChoice</a></h3> <p class="description">Return the marked choice for the specified option.</p> <p class="code"> <a href="#ppd_choice_t">ppd_choice_t</a> *ppdFindMarkedChoice (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *option<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>option</dt> <dd class="description">Keyword/option name</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Pointer to choice or <code>NULL</code></p> <h3 class="function"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppdFindNextAttr">ppdFindNextAttr</a></h3> <p class="description">Find the next matching attribute.</p> <p class="code"> <a href="#ppd_attr_t">ppd_attr_t</a> *ppdFindNextAttr (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *name,<br> const char *spec<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file data</dd> <dt>name</dt> <dd class="description">Attribute name</dd> <dt>spec</dt> <dd class="description">Specifier string or <code>NULL</code></dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Attribute or <code>NULL</code> if not found</p> <h3 class="function"><a name="ppdFindOption">ppdFindOption</a></h3> <p class="description">Return a pointer to the specified option.</p> <p class="code"> <a href="#ppd_option_t">ppd_option_t</a> *ppdFindOption (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *option<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file data</dd> <dt>option</dt> <dd class="description">Option/Keyword name</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Pointer to option or <code>NULL</code></p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdFirstCustomParam">ppdFirstCustomParam</a></h3> <p class="description">Return the first parameter for a custom option.</p> <p class="code"> <a href="#ppd_cparam_t">ppd_cparam_t</a> *ppdFirstCustomParam (<br> <a href="#ppd_coption_t">ppd_coption_t</a> *opt<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>opt</dt> <dd class="description">Custom option</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Custom parameter or NULL</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdFirstOption">ppdFirstOption</a></h3> <p class="description">Return the first option in the PPD file.</p> <p class="code"> <a href="#ppd_option_t">ppd_option_t</a> *ppdFirstOption (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">First option or <code>NULL</code></p> <h4 class="discussion">Discussion</h4> <p class="discussion">Options are returned from all groups in ascending alphanumeric order. </p> <h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a name="ppdInstallableConflict">ppdInstallableConflict</a></h3> <p class="description">Test whether an option choice conflicts with an installable option.</p> <p class="code"> int ppdInstallableConflict (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *option,<br> const char *choice<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>option</dt> <dd class="description">Option</dd> <dt>choice</dt> <dd class="description">Choice</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">1 if conflicting, 0 if not conflicting</p> <h4 class="discussion">Discussion</h4> <p class="discussion">This function tests whether a particular option choice is available based on constraints against options in the "InstallableOptions" group. </p> <h3 class="function"><a name="ppdIsMarked">ppdIsMarked</a></h3> <p class="description">Check to see if an option is marked.</p> <p class="code"> int ppdIsMarked (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *option,<br> const char *choice<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file data</dd> <dt>option</dt> <dd class="description">Option/Keyword name</dd> <dt>choice</dt> <dd class="description">Choice name</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Non-zero if option is marked</p> <h3 class="function"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppdLastError">ppdLastError</a></h3> <p class="description">Return the status from the last ppdOpen*().</p> <p class="code"> <a href="#ppd_status_t">ppd_status_t</a> ppdLastError (<br> int *line<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>line</dt> <dd class="description">Line number</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Status code</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdLocalize">ppdLocalize</a></h3> <p class="description">Localize the PPD file to the current locale.</p> <p class="code"> int ppdLocalize (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">0 on success, -1 on error</p> <h4 class="discussion">Discussion</h4> <p class="discussion">All groups, options, and choices are localized, as are ICC profile descriptions, printer presets, and custom option parameters. Each localized string uses the UTF-8 character encoding. </p> <h3 class="function"><a name="ppdLocalizeAttr">ppdLocalizeAttr</a></h3> <p class="description">Localize an attribute.</p> <p class="code"> <a href="#ppd_attr_t">ppd_attr_t</a> *ppdLocalizeAttr (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *keyword,<br> const char *spec<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>keyword</dt> <dd class="description">Main keyword</dd> <dt>spec</dt> <dd class="description">Option keyword or <code>NULL</code> for none</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Localized attribute or <code>NULL</code> if none exists</p> <h4 class="discussion">Discussion</h4> <p class="discussion">This function uses the current locale to find the localized attribute for the given main and option keywords. If no localized version of the attribute exists for the current locale, the unlocalized version is returned.</p> <h3 class="function"><span class="info"> CUPS 1.3/Mac OS X 10.5 </span><a name="ppdLocalizeIPPReason">ppdLocalizeIPPReason</a></h3> <p class="description">Get the localized version of a cupsIPPReason attribute.</p> <p class="code"> const char *ppdLocalizeIPPReason (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *reason,<br> const char *scheme,<br> char *buffer,<br> size_t bufsize<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>reason</dt> <dd class="description">IPP reason keyword to look up</dd> <dt>scheme</dt> <dd class="description">URI scheme or NULL for text</dd> <dt>buffer</dt> <dd class="description">Value buffer</dd> <dt>bufsize</dt> <dd class="description">Size of value buffer</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Value or NULL if not found</p> <h4 class="discussion">Discussion</h4> <p class="discussion">This function uses the current locale to find the corresponding reason text or URI from the attribute value. If "scheme" is NULL or "text", the returned value contains human-readable (UTF-8) text from the translation string or attribute value. Otherwise the corresponding URI is returned.<br> <br> If no value of the requested scheme can be found, NULL is returned. </p> <h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a name="ppdLocalizeMarkerName">ppdLocalizeMarkerName</a></h3> <p class="description">Get the localized version of a marker-names attribute value.</p> <p class="code"> const char *ppdLocalizeMarkerName (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *name<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>name</dt> <dd class="description">Marker name to look up</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Value or <code>NULL</code> if not found</p> <h4 class="discussion">Discussion</h4> <p class="discussion">This function uses the current locale to find the corresponding name text from the attribute value. If no localized text for the requested name can be found, <code>NULL</code> is returned. </p> <h3 class="function"><a name="ppdMarkDefaults">ppdMarkDefaults</a></h3> <p class="description">Mark all default options in the PPD file.</p> <p class="code"> void ppdMarkDefaults (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> </dl> <h3 class="function"><a name="ppdMarkOption">ppdMarkOption</a></h3> <p class="description">Mark an option in a PPD file and return the number of conflicts.</p> <p class="code"> int ppdMarkOption (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *option,<br> const char *choice<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>option</dt> <dd class="description">Keyword</dd> <dt>choice</dt> <dd class="description">Option name</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Number of conflicts</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdNextCustomParam">ppdNextCustomParam</a></h3> <p class="description">Return the next parameter for a custom option.</p> <p class="code"> <a href="#ppd_cparam_t">ppd_cparam_t</a> *ppdNextCustomParam (<br> <a href="#ppd_coption_t">ppd_coption_t</a> *opt<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>opt</dt> <dd class="description">Custom option</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Custom parameter or NULL</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdNextOption">ppdNextOption</a></h3> <p class="description">Return the next option in the PPD file.</p> <p class="code"> <a href="#ppd_option_t">ppd_option_t</a> *ppdNextOption (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Next option or <code>NULL</code></p> <h4 class="discussion">Discussion</h4> <p class="discussion">Options are returned from all groups in ascending alphanumeric order. </p> <h3 class="function"><a name="ppdOpen">ppdOpen</a></h3> <p class="description">Read a PPD file into memory.</p> <p class="code"> <a href="#ppd_file_t">ppd_file_t</a> *ppdOpen (<br> FILE *fp<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>fp</dt> <dd class="description">File to read from</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">PPD file record</p> <h3 class="function"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppdOpen2">ppdOpen2</a></h3> <p class="description">Read a PPD file into memory.</p> <p class="code"> <a href="#ppd_file_t">ppd_file_t</a> *ppdOpen2 (<br> cups_file_t *fp<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>fp</dt> <dd class="description">File to read from</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">PPD file record or <code>NULL</code> if the PPD file could not be opened.</p> <h3 class="function"><a name="ppdOpenFd">ppdOpenFd</a></h3> <p class="description">Read a PPD file into memory.</p> <p class="code"> <a href="#ppd_file_t">ppd_file_t</a> *ppdOpenFd (<br> int fd<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>fd</dt> <dd class="description">File to read from</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">PPD file record or <code>NULL</code> if the PPD file could not be opened.</p> <h3 class="function"><a name="ppdOpenFile">ppdOpenFile</a></h3> <p class="description">Read a PPD file into memory.</p> <p class="code"> <a href="#ppd_file_t">ppd_file_t</a> *ppdOpenFile (<br> const char *filename<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>filename</dt> <dd class="description">File to read from</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">PPD file record or <code>NULL</code> if the PPD file could not be opened.</p> <h3 class="function"><a name="ppdPageLength">ppdPageLength</a></h3> <p class="description">Get the page length for the given size.</p> <p class="code"> float ppdPageLength (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *name<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file</dd> <dt>name</dt> <dd class="description">Size name</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Length of page in points or 0.0</p> <h3 class="function"><a name="ppdPageSize">ppdPageSize</a></h3> <p class="description">Get the page size record for the given size.</p> <p class="code"> <a href="#ppd_size_t">ppd_size_t</a> *ppdPageSize (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *name<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>name</dt> <dd class="description">Size name</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Size record for page or NULL</p> <h3 class="function"><span class="info"> CUPS 1.4/Mac OS X 10.6 </span><a name="ppdPageSizeLimits">ppdPageSizeLimits</a></h3> <p class="description">Return the custom page size limits.</p> <p class="code"> int ppdPageSizeLimits (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> <a href="#ppd_size_t">ppd_size_t</a> *minimum,<br> <a href="#ppd_size_t">ppd_size_t</a> *maximum<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>minimum</dt> <dd class="description">Minimum custom size</dd> <dt>maximum</dt> <dd class="description">Maximum custom size</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">1 if custom sizes are supported, 0 otherwise</p> <h4 class="discussion">Discussion</h4> <p class="discussion">This function returns the minimum and maximum custom page sizes and printable areas based on the currently-marked (selected) options.<br> <br> If the specified PPD file does not support custom page sizes, both "minimum" and "maximum" are filled with zeroes. </p> <h3 class="function"><a name="ppdPageWidth">ppdPageWidth</a></h3> <p class="description">Get the page width for the given size.</p> <p class="code"> float ppdPageWidth (<br> <a href="#ppd_file_t">ppd_file_t</a> *ppd,<br> const char *name<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>ppd</dt> <dd class="description">PPD file record</dd> <dt>name</dt> <dd class="description">Size name</dd> </dl> <h4 class="returnvalue">Return Value</h4> <p class="description">Width of page in points or 0.0</p> <h3 class="function"><span class="info"> CUPS 1.1.20/Mac OS X 10.4 </span><a name="ppdSetConformance">ppdSetConformance</a></h3> <p class="description">Set the conformance level for PPD files.</p> <p class="code"> void ppdSetConformance (<br> <a href="#ppd_conform_t">ppd_conform_t</a> c<br> );</p> <h4 class="parameters">Parameters</h4> <dl> <dt>c</dt> <dd class="description">Conformance level</dd> </dl> <h2 class="title"><a name="TYPES">Data Types</a></h2> <h3 class="typedef"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppd_attr_t">ppd_attr_t</a></h3> <p class="description">PPD Attribute Structure </p> <p class="code"> typedef struct <a href="#ppd_attr_s">ppd_attr_s</a> ppd_attr_t; </p> <h3 class="typedef"><a name="ppd_choice_t">ppd_choice_t</a></h3> <p class="description">Option choices</p> <p class="code"> typedef struct <a href="#ppd_choice_s">ppd_choice_s</a> ppd_choice_t; </p> <h3 class="typedef"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppd_conform_t">ppd_conform_t</a></h3> <p class="description">Conformance Levels </p> <p class="code"> typedef enum <a href="#ppd_conform_e">ppd_conform_e</a> ppd_conform_t; </p> <h3 class="typedef"><a name="ppd_const_t">ppd_const_t</a></h3> <p class="description">Constraints</p> <p class="code"> typedef struct <a href="#ppd_const_s">ppd_const_s</a> ppd_const_t; </p> <h3 class="typedef"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_coption_t">ppd_coption_t</a></h3> <p class="description">Custom Option </p> <p class="code"> typedef struct <a href="#ppd_coption_s">ppd_coption_s</a> ppd_coption_t; </p> <h3 class="typedef"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_cparam_t">ppd_cparam_t</a></h3> <p class="description">Custom Parameter </p> <p class="code"> typedef struct <a href="#ppd_cparam_s">ppd_cparam_s</a> ppd_cparam_t; </p> <h3 class="typedef"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_cplimit_t">ppd_cplimit_t</a></h3> <p class="description">Custom Parameter Limit </p> <p class="code"> typedef union <a href="#ppd_cplimit_u">ppd_cplimit_u</a> ppd_cplimit_t; </p> <h3 class="typedef"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_cptype_t">ppd_cptype_t</a></h3> <p class="description">Custom Parameter Type </p> <p class="code"> typedef enum <a href="#ppd_cptype_e">ppd_cptype_e</a> ppd_cptype_t; </p> <h3 class="typedef"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_cpvalue_t">ppd_cpvalue_t</a></h3> <p class="description">Custom Parameter Value </p> <p class="code"> typedef union <a href="#ppd_cpvalue_u">ppd_cpvalue_u</a> ppd_cpvalue_t; </p> <h3 class="typedef"><a name="ppd_cs_t">ppd_cs_t</a></h3> <p class="description">Colorspaces</p> <p class="code"> typedef enum <a href="#ppd_cs_e">ppd_cs_e</a> ppd_cs_t; </p> <h3 class="typedef"><a name="ppd_emul_t">ppd_emul_t</a></h3> <p class="description">Emulators</p> <p class="code"> typedef struct <a href="#ppd_emul_s">ppd_emul_s</a> ppd_emul_t; </p> <h3 class="typedef"><a name="ppd_file_t">ppd_file_t</a></h3> <p class="description">PPD File</p> <p class="code"> typedef struct <a href="#ppd_file_s">ppd_file_s</a> ppd_file_t; </p> <h3 class="typedef"><a name="ppd_group_t">ppd_group_t</a></h3> <p class="description">Groups</p> <p class="code"> typedef struct <a href="#ppd_group_s">ppd_group_s</a> ppd_group_t; </p> <h3 class="typedef"><a name="ppd_option_t">ppd_option_t</a></h3> <p class="description">Options</p> <p class="code"> typedef struct <a href="#ppd_option_s">ppd_option_s</a> ppd_option_t; </p> <h3 class="typedef"><a name="ppd_profile_t">ppd_profile_t</a></h3> <p class="description">sRGB Color Profiles</p> <p class="code"> typedef struct <a href="#ppd_profile_s">ppd_profile_s</a> ppd_profile_t; </p> <h3 class="typedef"><a name="ppd_section_t">ppd_section_t</a></h3> <p class="description">Order dependency sections</p> <p class="code"> typedef enum <a href="#ppd_section_e">ppd_section_e</a> ppd_section_t; </p> <h3 class="typedef"><a name="ppd_size_t">ppd_size_t</a></h3> <p class="description">Page Sizes</p> <p class="code"> typedef struct <a href="#ppd_size_s">ppd_size_s</a> ppd_size_t; </p> <h3 class="typedef"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppd_status_t">ppd_status_t</a></h3> <p class="description">Status Codes </p> <p class="code"> typedef enum <a href="#ppd_status_e">ppd_status_e</a> ppd_status_t; </p> <h3 class="typedef"><a name="ppd_ui_t">ppd_ui_t</a></h3> <p class="description">UI Types</p> <p class="code"> typedef enum <a href="#ppd_ui_e">ppd_ui_e</a> ppd_ui_t; </p> <h2 class="title"><a name="STRUCTURES">Structures</a></h2> <h3 class="struct"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppd_attr_s">ppd_attr_s</a></h3> <p class="description">PPD Attribute Structure </p> <p class="code">struct ppd_attr_s {<br> char name[PPD_MAX_NAME];<br> char spec[PPD_MAX_NAME];<br> char text[PPD_MAX_TEXT];<br> char *value;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>name[PPD_MAX_NAME] </dt> <dd class="description">Name of attribute (cupsXYZ)</dd> <dt>spec[PPD_MAX_NAME] </dt> <dd class="description">Specifier string, if any</dd> <dt>text[PPD_MAX_TEXT] </dt> <dd class="description">Human-readable text, if any</dd> <dt>value </dt> <dd class="description">Value string</dd> </dl> <h3 class="struct"><a name="ppd_choice_s">ppd_choice_s</a></h3> <p class="description">Option choices</p> <p class="code">struct ppd_choice_s {<br> char choice[PPD_MAX_NAME];<br> char *code;<br> char marked;<br> <a href="#ppd_option_t">ppd_option_t</a> *option;<br> char text[PPD_MAX_TEXT];<br> };</p> <h4 class="members">Members</h4> <dl> <dt>choice[PPD_MAX_NAME] </dt> <dd class="description">Computer-readable option name</dd> <dt>code </dt> <dd class="description">Code to send for this option</dd> <dt>marked </dt> <dd class="description">0 if not selected, 1 otherwise</dd> <dt>option </dt> <dd class="description">Pointer to parent option structure</dd> <dt>text[PPD_MAX_TEXT] </dt> <dd class="description">Human-readable option name</dd> </dl> <h3 class="struct"><a name="ppd_const_s">ppd_const_s</a></h3> <p class="description">Constraints</p> <p class="code">struct ppd_const_s {<br> char choice1[PPD_MAX_NAME];<br> char choice2[PPD_MAX_NAME];<br> char option1[PPD_MAX_NAME];<br> char option2[PPD_MAX_NAME];<br> };</p> <h4 class="members">Members</h4> <dl> <dt>choice1[PPD_MAX_NAME] </dt> <dd class="description">First option/choice (blank for all)</dd> <dt>choice2[PPD_MAX_NAME] </dt> <dd class="description">Second option/choice (blank for all)</dd> <dt>option1[PPD_MAX_NAME] </dt> <dd class="description">First keyword</dd> <dt>option2[PPD_MAX_NAME] </dt> <dd class="description">Second keyword</dd> </dl> <h3 class="struct"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_coption_s">ppd_coption_s</a></h3> <p class="description">Custom Option </p> <p class="code">struct ppd_coption_s {<br> char keyword[PPD_MAX_NAME];<br> int marked;<br> <a href="#ppd_option_t">ppd_option_t</a> *option;<br> cups_array_t *params;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>keyword[PPD_MAX_NAME] </dt> <dd class="description">Name of option that is being extended...</dd> <dt>marked </dt> <dd class="description">Extended option is marked</dd> <dt>option </dt> <dd class="description">Option that is being extended...</dd> <dt>params </dt> <dd class="description">Parameters</dd> </dl> <h3 class="struct"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_cparam_s">ppd_cparam_s</a></h3> <p class="description">Custom Parameter </p> <p class="code">struct ppd_cparam_s {<br> <a href="#ppd_cpvalue_t">ppd_cpvalue_t</a> current;<br> <a href="#ppd_cplimit_t">ppd_cplimit_t</a> minimum, maximum;<br> char name[PPD_MAX_NAME];<br> int order;<br> char text[PPD_MAX_TEXT];<br> <a href="#ppd_cptype_t">ppd_cptype_t</a> type;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>current </dt> <dd class="description">Current value</dd> <dt>maximum </dt> <dd class="description">Maximum value</dd> <dt>name[PPD_MAX_NAME] </dt> <dd class="description">Parameter name</dd> <dt>order </dt> <dd class="description">Order (0 to N)</dd> <dt>text[PPD_MAX_TEXT] </dt> <dd class="description">Human-readable text</dd> <dt>type </dt> <dd class="description">Parameter type</dd> </dl> <h3 class="struct"><a name="ppd_emul_s">ppd_emul_s</a></h3> <p class="description">Emulators</p> <p class="code">struct ppd_emul_s {<br> char name[PPD_MAX_NAME];<br> char *start;<br> char *stop;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>name[PPD_MAX_NAME] </dt> <dd class="description">Emulator name</dd> <dt>start </dt> <dd class="description">Code to switch to this emulation</dd> <dt>stop </dt> <dd class="description">Code to stop this emulation</dd> </dl> <h3 class="struct"><a name="ppd_file_s">ppd_file_s</a></h3> <p class="description">PPD File</p> <p class="code">struct ppd_file_s {<br> int accurate_screens;<br> int color_device;<br> <a href="#ppd_cs_t">ppd_cs_t</a> colorspace;<br> <a href="#ppd_const_t">ppd_const_t</a> *consts;<br> int contone_only;<br> float custom_margins[4];<br> float custom_max[2];<br> float custom_min[2];<br> <a href="#ppd_emul_t">ppd_emul_t</a> *emulations;<br> char **filters;<br> int flip_duplex;<br> char **fonts;<br> <a href="#ppd_group_t">ppd_group_t</a> *groups;<br> char *jcl_begin;<br> char *jcl_end;<br> char *jcl_ps;<br> int landscape;<br> char *lang_encoding;<br> char *lang_version;<br> int language_level;<br> int manual_copies;<br> char *manufacturer;<br> int model_number;<br> char *modelname;<br> char *nickname;<br> int num_consts;<br> int num_emulations;<br> int num_filters;<br> int num_fonts;<br> int num_groups;<br> int num_profiles;<br> int num_sizes;<br> char *patches;<br> char *pcfilename;<br> char *product;<br> <a href="#ppd_profile_t">ppd_profile_t</a> *profiles;<br> char *protocols;<br> void *pwg;<br> char *shortnickname;<br> <a href="#ppd_size_t">ppd_size_t</a> *sizes;<br> int throughput;<br> char *ttrasterizer;<br> int variable_sizes;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>accurate_screens </dt> <dd class="description">1 = supports accurate screens, 0 = not</dd> <dt>color_device </dt> <dd class="description">1 = color device, 0 = grayscale</dd> <dt>colorspace </dt> <dd class="description">Default colorspace</dd> <dt>consts </dt> <dd class="description">UI/Non-UI constraints</dd> <dt>contone_only </dt> <dd class="description">1 = continuous tone only, 0 = not</dd> <dt>custom_margins[4] </dt> <dd class="description">Margins around page</dd> <dt>custom_max[2] </dt> <dd class="description">Maximum variable page size</dd> <dt>custom_min[2] </dt> <dd class="description">Minimum variable page size</dd> <dt>emulations </dt> <dd class="description">Emulations and the code to invoke them</dd> <dt>filters </dt> <dd class="description">Filter strings...</dd> <dt>flip_duplex <span class="info"> DEPRECATED </span></dt> <dd class="description">1 = Flip page for back sides </dd> <dt>fonts </dt> <dd class="description">Pre-loaded fonts</dd> <dt>groups </dt> <dd class="description">UI groups</dd> <dt>jcl_begin </dt> <dd class="description">Start JCL commands</dd> <dt>jcl_end </dt> <dd class="description">End JCL commands</dd> <dt>jcl_ps </dt> <dd class="description">Enter PostScript interpreter</dd> <dt>landscape </dt> <dd class="description">-90 or 90</dd> <dt>lang_encoding </dt> <dd class="description">Language encoding</dd> <dt>lang_version </dt> <dd class="description">Language version (English, Spanish, etc.)</dd> <dt>language_level </dt> <dd class="description">Language level of device</dd> <dt>manual_copies </dt> <dd class="description">1 = Copies done manually, 0 = hardware</dd> <dt>manufacturer </dt> <dd class="description">Manufacturer name</dd> <dt>model_number </dt> <dd class="description">Device-specific model number</dd> <dt>modelname </dt> <dd class="description">Model name (general)</dd> <dt>nickname </dt> <dd class="description">Nickname (specific)</dd> <dt>num_consts </dt> <dd class="description">Number of UI/Non-UI constraints</dd> <dt>num_emulations </dt> <dd class="description">Number of emulations supported</dd> <dt>num_filters </dt> <dd class="description">Number of filters</dd> <dt>num_fonts </dt> <dd class="description">Number of pre-loaded fonts</dd> <dt>num_groups </dt> <dd class="description">Number of UI groups</dd> <dt>num_profiles <span class="info"> DEPRECATED </span></dt> <dd class="description">Number of sRGB color profiles </dd> <dt>num_sizes </dt> <dd class="description">Number of page sizes</dd> <dt>patches </dt> <dd class="description">Patch commands to be sent to printer</dd> <dt>pcfilename <span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span></dt> <dd class="description">PCFileName string </dd> <dt>product </dt> <dd class="description">Product name (from PS RIP/interpreter)</dd> <dt>profiles <span class="info"> DEPRECATED </span></dt> <dd class="description">sRGB color profiles </dd> <dt>protocols <span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span></dt> <dd class="description">Protocols (BCP, TBCP) string </dd> <dt>pwg </dt> <dd class="description">PWG to/from PPD mappings</dd> <dt>shortnickname </dt> <dd class="description">Short version of nickname</dd> <dt>sizes </dt> <dd class="description">Page sizes</dd> <dt>throughput </dt> <dd class="description">Pages per minute</dd> <dt>ttrasterizer </dt> <dd class="description">Truetype rasterizer</dd> <dt>variable_sizes </dt> <dd class="description">1 = supports variable sizes, 0 = doesn't</dd> </dl> <h3 class="struct"><a name="ppd_group_s">ppd_group_s</a></h3> <p class="description">Groups</p> <p class="code">struct ppd_group_s {<br> char text[PPD_MAX_TEXT - PPD_MAX_NAME];<br> char name[PPD_MAX_NAME];<br> int num_options;<br> int num_subgroups;<br> <a href="#ppd_option_t">ppd_option_t</a> *options;<br> struct <a href="#ppd_group_s">ppd_group_s</a> *subgroups;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>PPD_MAX_NAME] </dt> <dd class="description">Human-readable group name</dd> <dt>name[PPD_MAX_NAME] <span class="info"> CUPS 1.1.18/Mac OS X 10.3 </span></dt> <dd class="description">Group name </dd> <dt>num_options </dt> <dd class="description">Number of options</dd> <dt>num_subgroups </dt> <dd class="description">Number of sub-groups</dd> <dt>options </dt> <dd class="description">Options</dd> <dt>subgroups </dt> <dd class="description">Sub-groups (max depth = 1)</dd> </dl> <h3 class="struct"><a name="ppd_option_s">ppd_option_s</a></h3> <p class="description">Options</p> <p class="code">struct ppd_option_s {<br> <a href="#ppd_choice_t">ppd_choice_t</a> *choices;<br> char conflicted;<br> char defchoice[PPD_MAX_NAME];<br> char keyword[PPD_MAX_NAME];<br> int num_choices;<br> float order;<br> <a href="#ppd_section_t">ppd_section_t</a> section;<br> char text[PPD_MAX_TEXT];<br> <a href="#ppd_ui_t">ppd_ui_t</a> ui;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>choices </dt> <dd class="description">Option choices</dd> <dt>conflicted </dt> <dd class="description">0 if no conflicts exist, 1 otherwise</dd> <dt>defchoice[PPD_MAX_NAME] </dt> <dd class="description">Default option choice</dd> <dt>keyword[PPD_MAX_NAME] </dt> <dd class="description">Option keyword name ("PageSize", etc.)</dd> <dt>num_choices </dt> <dd class="description">Number of option choices</dd> <dt>order </dt> <dd class="description">Order number</dd> <dt>section </dt> <dd class="description">Section for command</dd> <dt>text[PPD_MAX_TEXT] </dt> <dd class="description">Human-readable text</dd> <dt>ui </dt> <dd class="description">Type of UI option</dd> </dl> <h3 class="struct"><a name="ppd_profile_s">ppd_profile_s</a></h3> <p class="description">sRGB Color Profiles</p> <p class="code">struct ppd_profile_s {<br> float density;<br> float gamma;<br> float matrix[3][3];<br> char media_type[PPD_MAX_NAME];<br> char resolution[PPD_MAX_NAME];<br> };</p> <h4 class="members">Members</h4> <dl> <dt>density </dt> <dd class="description">Ink density to use</dd> <dt>gamma </dt> <dd class="description">Gamma correction to use</dd> <dt>matrix[3][3] </dt> <dd class="description">Transform matrix</dd> <dt>media_type[PPD_MAX_NAME] </dt> <dd class="description">Media type or "-"</dd> <dt>resolution[PPD_MAX_NAME] </dt> <dd class="description">Resolution or "-"</dd> </dl> <h3 class="struct"><a name="ppd_size_s">ppd_size_s</a></h3> <p class="description">Page Sizes</p> <p class="code">struct ppd_size_s {<br> float bottom;<br> float left;<br> float length;<br> int marked;<br> char name[PPD_MAX_NAME];<br> float right;<br> float top;<br> float width;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>bottom </dt> <dd class="description">Bottom printable margin in points</dd> <dt>left </dt> <dd class="description">Left printable margin in points</dd> <dt>length </dt> <dd class="description">Length of media in points</dd> <dt>marked </dt> <dd class="description">Page size selected?</dd> <dt>name[PPD_MAX_NAME] </dt> <dd class="description">Media size option</dd> <dt>right </dt> <dd class="description">Right printable margin in points</dd> <dt>top </dt> <dd class="description">Top printable margin in points</dd> <dt>width </dt> <dd class="description">Width of media in points</dd> </dl> <h2 class="title"><a name="UNIONS">Unions</a></h2> <h3 class="union"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_cplimit_u">ppd_cplimit_u</a></h3> <p class="description">Custom Parameter Limit </p> <p class="code">union ppd_cplimit_u {<br> float custom_curve;<br> int custom_int;<br> float custom_invcurve;<br> int custom_passcode;<br> int custom_password;<br> float custom_points;<br> float custom_real;<br> int custom_string;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>custom_curve </dt> <dd class="description">Gamma value</dd> <dt>custom_int </dt> <dd class="description">Integer value</dd> <dt>custom_invcurve </dt> <dd class="description">Gamma value</dd> <dt>custom_passcode </dt> <dd class="description">Passcode length</dd> <dt>custom_password </dt> <dd class="description">Password length</dd> <dt>custom_points </dt> <dd class="description">Measurement value</dd> <dt>custom_real </dt> <dd class="description">Real value</dd> <dt>custom_string </dt> <dd class="description">String length</dd> </dl> <h3 class="union"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_cpvalue_u">ppd_cpvalue_u</a></h3> <p class="description">Custom Parameter Value </p> <p class="code">union ppd_cpvalue_u {<br> float custom_curve;<br> int custom_int;<br> float custom_invcurve;<br> char *custom_passcode;<br> char *custom_password;<br> float custom_points;<br> float custom_real;<br> char *custom_string;<br> };</p> <h4 class="members">Members</h4> <dl> <dt>custom_curve </dt> <dd class="description">Gamma value</dd> <dt>custom_int </dt> <dd class="description">Integer value</dd> <dt>custom_invcurve </dt> <dd class="description">Gamma value</dd> <dt>custom_passcode </dt> <dd class="description">Passcode value</dd> <dt>custom_password </dt> <dd class="description">Password value</dd> <dt>custom_points </dt> <dd class="description">Measurement value</dd> <dt>custom_real </dt> <dd class="description">Real value</dd> <dt>custom_string </dt> <dd class="description">String value</dd> </dl> <h2 class="title"><a name="ENUMERATIONS">Constants</a></h2> <h3 class="enumeration"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppd_conform_e">ppd_conform_e</a></h3> <p class="description">Conformance Levels </p> <h4 class="constants">Constants</h4> <dl> <dt>PPD_CONFORM_RELAXED </dt> <dd class="description">Relax whitespace and control char</dd> <dt>PPD_CONFORM_STRICT </dt> <dd class="description">Require strict conformance</dd> </dl> <h3 class="enumeration"><span class="info"> CUPS 1.2/Mac OS X 10.5 </span><a name="ppd_cptype_e">ppd_cptype_e</a></h3> <p class="description">Custom Parameter Type </p> <h4 class="constants">Constants</h4> <dl> <dt>PPD_CUSTOM_CURVE </dt> <dd class="description">Curve value for f(x) = x^value</dd> <dt>PPD_CUSTOM_INT </dt> <dd class="description">Integer number value</dd> <dt>PPD_CUSTOM_INVCURVE </dt> <dd class="description">Curve value for f(x) = x^(1/value)</dd> <dt>PPD_CUSTOM_PASSCODE </dt> <dd class="description">String of (hidden) numbers</dd> <dt>PPD_CUSTOM_PASSWORD </dt> <dd class="description">String of (hidden) characters</dd> <dt>PPD_CUSTOM_POINTS </dt> <dd class="description">Measurement value in points</dd> <dt>PPD_CUSTOM_REAL </dt> <dd class="description">Real number value</dd> <dt>PPD_CUSTOM_STRING </dt> <dd class="description">String of characters</dd> </dl> <h3 class="enumeration"><a name="ppd_cs_e">ppd_cs_e</a></h3> <p class="description">Colorspaces</p> <h4 class="constants">Constants</h4> <dl> <dt>PPD_CS_CMY </dt> <dd class="description">CMY colorspace</dd> <dt>PPD_CS_CMYK </dt> <dd class="description">CMYK colorspace</dd> <dt>PPD_CS_GRAY </dt> <dd class="description">Grayscale colorspace</dd> <dt>PPD_CS_N </dt> <dd class="description">DeviceN colorspace</dd> <dt>PPD_CS_RGB </dt> <dd class="description">RGB colorspace</dd> <dt>PPD_CS_RGBK </dt> <dd class="description">RGBK (K = gray) colorspace</dd> </dl> <h3 class="enumeration"><a name="ppd_section_e">ppd_section_e</a></h3> <p class="description">Order dependency sections</p> <h4 class="constants">Constants</h4> <dl> <dt>PPD_ORDER_ANY </dt> <dd class="description">Option code can be anywhere in the file</dd> <dt>PPD_ORDER_DOCUMENT </dt> <dd class="description">... must be in the DocumentSetup section</dd> <dt>PPD_ORDER_EXIT </dt> <dd class="description">... must be sent prior to the document</dd> <dt>PPD_ORDER_JCL </dt> <dd class="description">... must be sent as a JCL command</dd> <dt>PPD_ORDER_PAGE </dt> <dd class="description">... must be in the PageSetup section</dd> <dt>PPD_ORDER_PROLOG </dt> <dd class="description">... must be in the Prolog section</dd> </dl> <h3 class="enumeration"><span class="info"> CUPS 1.1.19/Mac OS X 10.3 </span><a name="ppd_status_e">ppd_status_e</a></h3> <p class="description">Status Codes </p> <h4 class="constants">Constants</h4> <dl> <dt>PPD_ALLOC_ERROR </dt> <dd class="description">Memory allocation error</dd> <dt>PPD_BAD_CUSTOM_PARAM </dt> <dd class="description">Bad custom parameter</dd> <dt>PPD_BAD_OPEN_GROUP </dt> <dd class="description">Bad OpenGroup</dd> <dt>PPD_BAD_OPEN_UI </dt> <dd class="description">Bad OpenUI/JCLOpenUI</dd> <dt>PPD_BAD_ORDER_DEPENDENCY </dt> <dd class="description">Bad OrderDependency</dd> <dt>PPD_BAD_UI_CONSTRAINTS </dt> <dd class="description">Bad UIConstraints</dd> <dt>PPD_BAD_VALUE </dt> <dd class="description">Bad value string</dd> <dt>PPD_FILE_OPEN_ERROR </dt> <dd class="description">Unable to open PPD file</dd> <dt>PPD_ILLEGAL_CHARACTER </dt> <dd class="description">Illegal control character</dd> <dt>PPD_ILLEGAL_MAIN_KEYWORD </dt> <dd class="description">Illegal main keyword string</dd> <dt>PPD_ILLEGAL_OPTION_KEYWORD </dt> <dd class="description">Illegal option keyword string</dd> <dt>PPD_ILLEGAL_TRANSLATION </dt> <dd class="description">Illegal translation string</dd> <dt>PPD_ILLEGAL_WHITESPACE </dt> <dd class="description">Illegal whitespace character</dd> <dt>PPD_INTERNAL_ERROR </dt> <dd class="description">Internal error</dd> <dt>PPD_LINE_TOO_LONG </dt> <dd class="description">Line longer than 255 chars</dd> <dt>PPD_MISSING_ASTERISK </dt> <dd class="description">Missing asterisk in column 0</dd> <dt>PPD_MISSING_OPTION_KEYWORD </dt> <dd class="description">Missing option keyword</dd> <dt>PPD_MISSING_PPDADOBE4 </dt> <dd class="description">Missing PPD-Adobe-4.x header</dd> <dt>PPD_MISSING_VALUE </dt> <dd class="description">Missing value string</dd> <dt>PPD_NESTED_OPEN_GROUP </dt> <dd class="description">OpenGroup without a CloseGroup first</dd> <dt>PPD_NESTED_OPEN_UI </dt> <dd class="description">OpenUI/JCLOpenUI without a CloseUI/JCLCloseUI first</dd> <dt>PPD_NULL_FILE </dt> <dd class="description">NULL PPD file pointer</dd> <dt>PPD_OK </dt> <dd class="description">OK</dd> </dl> <h3 class="enumeration"><a name="ppd_ui_e">ppd_ui_e</a></h3> <p class="description">UI Types</p> <h4 class="constants">Constants</h4> <dl> <dt>PPD_UI_BOOLEAN </dt> <dd class="description">True or False option</dd> <dt>PPD_UI_PICKMANY </dt> <dd class="description">Pick zero or more from a list</dd> <dt>PPD_UI_PICKONE </dt> <dd class="description">Pick one from a list</dd> </dl> </div> </body> </html>