diff options
Diffstat (limited to 'doc/help')
| -rw-r--r-- | doc/help/api-admin.html | 253 | ||||
| -rw-r--r-- | doc/help/api-array.html | 1070 | ||||
| -rw-r--r-- | doc/help/api-cups.html | 3607 | ||||
| -rw-r--r-- | doc/help/api-filedir.html | 1003 | ||||
| -rw-r--r-- | doc/help/api-filter.html | 643 | ||||
| -rw-r--r-- | doc/help/api-httpipp.html | 6777 | ||||
| -rw-r--r-- | doc/help/api-overview.html | 512 | ||||
| -rw-r--r-- | doc/help/api-ppd.html | 2352 | ||||
| -rw-r--r-- | doc/help/api-raster.html | 1440 | ||||
| -rw-r--r-- | doc/help/cupspm.epub | bin | 0 -> 219684 bytes | |||
| -rw-r--r-- | doc/help/cupspm.html | 6493 | ||||
| -rw-r--r-- | doc/help/man-ipptool.html | 3 | ||||
| -rw-r--r-- | doc/help/man-ipptoolfile.html | 51 | ||||
| -rw-r--r-- | doc/help/man-lpstat.html | 6 | ||||
| -rw-r--r-- | doc/help/postscript-driver.html | 49 | ||||
| -rw-r--r-- | doc/help/ppd-compiler.html | 63 | ||||
| -rw-r--r-- | doc/help/raster-driver.html | 45 | ||||
| -rw-r--r-- | doc/help/spec-ppd.html | 173 |
18 files changed, 8855 insertions, 15685 deletions
diff --git a/doc/help/api-admin.html b/doc/help/api-admin.html index 5ca4096..c3f6838 100644 --- a/doc/help/api-admin.html +++ b/doc/help/api-admin.html @@ -1,12 +1,15 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!doctype html> <html> <!-- SECTION: Programming --> -<head> - <title>Administration APIs </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<style type="text/css"><!-- + <head> + <title>Administration APIs</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="Mini-XML v2.11"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- BODY { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } @@ -349,9 +352,8 @@ div.contents ul.subcontents li { text-indent: -1em; } --></style> -</head> -<body> -<div class='body'> + </head> + <body> <!-- Administrative API header for CUPS. @@ -386,24 +388,26 @@ div.contents ul.subcontents li { </tr> </tbody> </table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#OVERVIEW">Overview</a><ul class="subcontents"> - <li><a href="#SETTINGS">Scheduler Settings</a></li> - <li><a href="#DEVICES">Devices</a></li> -</ul></li> -<li><a href="#FUNCTIONS">Functions</a><ul class="code"> - <li><a href="#cupsAdminCreateWindowsPPD" title="Create the Windows PPD file for a printer.">cupsAdminCreateWindowsPPD</a></li> - <li><a href="#cupsAdminExportSamba" title="Export a printer to Samba.">cupsAdminExportSamba</a></li> - <li><a href="#cupsAdminGetServerSettings" title="Get settings from the server.">cupsAdminGetServerSettings</a></li> - <li><a href="#cupsAdminSetServerSettings" title="Set settings on the server.">cupsAdminSetServerSettings</a></li> - <li><a href="#cupsGetDevices" title="Get available printer devices.">cupsGetDevices</a></li> -</ul></li> -<li><a href="#TYPES">Data Types</a><ul class="code"> - <li><a href="#cups_device_cb_t" title="Device callback -">cups_device_cb_t</a></li> -</ul></li> -</ul> + <div class="contents"> + <h2 class="title">Contents</h2> + <ul class="contents"> + <li><a href="#OVERVIEW">Overview</a><ul class="subcontents"> + <li><a href="#SETTINGS">Scheduler Settings</a></li> + <li><a href="#DEVICES">Devices</a></li> + </ul></li> + <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents"> + <li><a href="#cupsAdminCreateWindowsPPD">cupsAdminCreateWindowsPPD</a></li> + <li><a href="#cupsAdminExportSamba">cupsAdminExportSamba</a></li> + <li><a href="#cupsAdminGetServerSettings">cupsAdminGetServerSettings</a></li> + <li><a href="#cupsAdminSetServerSettings">cupsAdminSetServerSettings</a></li> + <li><a href="#cupsGetDevices">cupsGetDevices</a></li> + </ul></li> + <li><a href="#TYPES">Data Types</a><ul class="subcontents"> + <li><a href="#cups_device_cb_t">cups_device_cb_t</a></li> + </ul></li> + </ul> + </div> + <div class="body"> <!-- Administrative API documentation for CUPS. @@ -500,143 +504,116 @@ show_devices(void) <a href="#cupsGetDevices">cupsGetDevices</a>(CUPS_HTTP_DEFAULT, 30, NULL, NULL, get_devices_cb, NULL); } </pre> -<h2 class="title"><a name="FUNCTIONS">Functions</a></h2> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="cupsAdminCreateWindowsPPD">cupsAdminCreateWindowsPPD</a></h3> -<p class="description">Create the Windows PPD file for a printer.</p> + <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> +<h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsAdminCreateWindowsPPD">cupsAdminCreateWindowsPPD</a></h3> + <p class="description">Create the Windows PPD file for a printer.</p> <p class="code"> -char *cupsAdminCreateWindowsPPD (<br> - http_t *http,<br> - const char *dest,<br> - char *buffer,<br> - int bufsize<br> -);</p> +char *cupsAdminCreateWindowsPPD(http_t *http, const char *dest, char *buffer, int bufsize);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>dest</dt> -<dd class="description">Printer or class</dd> -<dt>buffer</dt> -<dd class="description">Filename buffer</dd> -<dt>bufsize</dt> -<dd class="description">Size of filename buffer</dd> -</dl> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>dest</th> + <td class="description">Printer or class</td></tr> +<tr><th>buffer</th> + <td class="description">Filename buffer</td></tr> +<tr><th>bufsize</th> + <td class="description">Size of filename buffer</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">PPD file or NULL</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="cupsAdminExportSamba">cupsAdminExportSamba</a></h3> -<p class="description">Export a printer to Samba.</p> + <p class="description">PPD file or NULL</p> +<h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsAdminExportSamba">cupsAdminExportSamba</a></h3> + <p class="description">Export a printer to Samba.</p> <p class="code"> -int cupsAdminExportSamba (<br> - const char *dest,<br> - const char *ppd,<br> - const char *samba_server,<br> - const char *samba_user,<br> - const char *samba_password,<br> - FILE *logfile<br> -);</p> +int cupsAdminExportSamba(const char *dest, const char *ppd, const char *samba_server, const char *samba_user, const char *samba_password, FILE *logfile);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>dest</dt> -<dd class="description">Destination to export</dd> -<dt>ppd</dt> -<dd class="description">PPD file</dd> -<dt>samba_server</dt> -<dd class="description">Samba server</dd> -<dt>samba_user</dt> -<dd class="description">Samba username</dd> -<dt>samba_password</dt> -<dd class="description">Samba password</dd> -<dt>logfile</dt> -<dd class="description">Log file, if any</dd> -</dl> +<table class="list"><tbody> +<tr><th>dest</th> + <td class="description">Destination to export</td></tr> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>samba_server</th> + <td class="description">Samba server</td></tr> +<tr><th>samba_user</th> + <td class="description">Samba username</td></tr> +<tr><th>samba_password</th> + <td class="description">Samba password</td></tr> +<tr><th>logfile</th> + <td class="description">Log file, if any</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsAdminGetServerSettings">cupsAdminGetServerSettings</a></h3> -<p class="description">Get settings from the server.</p> + <p class="description">1 on success, 0 on failure</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsAdminGetServerSettings">cupsAdminGetServerSettings</a></h3> + <p class="description">Get settings from the server.</p> <p class="code"> -int cupsAdminGetServerSettings (<br> - http_t *http,<br> - int *num_settings,<br> - cups_option_t **settings<br> -);</p> +int cupsAdminGetServerSettings(http_t *http, int *num_settings, cups_option_t **settings);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>num_settings</dt> -<dd class="description">Number of settings</dd> -<dt>settings</dt> -<dd class="description">Settings</dd> -</dl> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>num_settings</th> + <td class="description">Number of settings</td></tr> +<tr><th>settings</th> + <td class="description">Settings</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> + <p class="description">1 on success, 0 on failure</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">The returned settings should be freed with cupsFreeOptions() when + <p class="discussion">The returned settings should be freed with cupsFreeOptions() when you are done with them. </p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsAdminSetServerSettings">cupsAdminSetServerSettings</a></h3> -<p class="description">Set settings on the server.</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsAdminSetServerSettings">cupsAdminSetServerSettings</a></h3> + <p class="description">Set settings on the server.</p> <p class="code"> -int cupsAdminSetServerSettings (<br> - http_t *http,<br> - int num_settings,<br> - cups_option_t *settings<br> -);</p> +int cupsAdminSetServerSettings(http_t *http, int num_settings, cups_option_t *settings);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>num_settings</dt> -<dd class="description">Number of settings</dd> -<dt>settings</dt> -<dd class="description">Settings</dd> -</dl> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>num_settings</th> + <td class="description">Number of settings</td></tr> +<tr><th>settings</th> + <td class="description">Settings</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsGetDevices">cupsGetDevices</a></h3> -<p class="description">Get available printer devices.</p> + <p class="description">1 on success, 0 on failure</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsGetDevices">cupsGetDevices</a></h3> + <p class="description">Get available printer devices.</p> <p class="code"> -ipp_status_t cupsGetDevices (<br> - http_t *http,<br> - int timeout,<br> - const char *include_schemes,<br> - const char *exclude_schemes,<br> - <a href="#cups_device_cb_t">cups_device_cb_t</a> callback,<br> - void *user_data<br> -);</p> +ipp_status_t cupsGetDevices(http_t *http, int timeout, const char *include_schemes, const char *exclude_schemes, <a href="#cups_device_cb_t">cups_device_cb_t</a> callback, void *user_data);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>timeout</dt> -<dd class="description">Timeout in seconds or <code>CUPS_TIMEOUT_DEFAULT</code></dd> -<dt>include_schemes</dt> -<dd class="description">Comma-separated URI schemes to include or <code>CUPS_INCLUDE_ALL</code></dd> -<dt>exclude_schemes</dt> -<dd class="description">Comma-separated URI schemes to exclude or <code>CUPS_EXCLUDE_NONE</code></dd> -<dt>callback</dt> -<dd class="description">Callback function</dd> -<dt>user_data</dt> -<dd class="description">User data pointer</dd> -</dl> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>timeout</th> + <td class="description">Timeout in seconds or <code>CUPS_TIMEOUT_DEFAULT</code></td></tr> +<tr><th>include_schemes</th> + <td class="description">Comma-separated URI schemes to include or <code>CUPS_INCLUDE_ALL</code></td></tr> +<tr><th>exclude_schemes</th> + <td class="description">Comma-separated URI schemes to exclude or <code>CUPS_EXCLUDE_NONE</code></td></tr> +<tr><th>callback</th> + <td class="description">Callback function</td></tr> +<tr><th>user_data</th> + <td class="description">User data pointer</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Request status - <code>IPP_OK</code> on success.</p> + <p class="description">Request status - <code>IPP_OK</code> on success.</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function sends a CUPS-Get-Devices request and streams the discovered + <p class="discussion">This function sends a CUPS-Get-Devices request and streams the discovered devices to the specified callback function. The "timeout" parameter controls how long the request lasts, while the "include_schemes" and "exclude_schemes" parameters provide comma-delimited lists of backends to include or omit from the request respectively. </p> -<h2 class="title"><a name="TYPES">Data Types</a></h2> -<h3 class="typedef"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cups_device_cb_t">cups_device_cb_t</a></h3> -<p class="description">Device callback + <h2 class="title"><a id="TYPES">Data Types</a></h2> + <h3 class="typedef"><a id="cups_device_cb_t"><span class="info"> CUPS 1.4/macOS 10.6 </span>cups_device_cb_t</a></h3> + <p class="description">Device callback </p> -<p class="code"> + <p class="code"> typedef void (*cups_device_cb_t)(const char *device_class, const char *device_id, const char *device_info, const char *device_make_and_model, const char *device_uri, const char *device_location, void *user_data); </p> -</div> -</body> + </div> + </body> </html> diff --git a/doc/help/api-array.html b/doc/help/api-array.html deleted file mode 100644 index 51b8039..0000000 --- a/doc/help/api-array.html +++ /dev/null @@ -1,1070 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- SECTION: Programming --> -<head> - <title>Array API </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<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 { - border: dotted thin #7f7f7f; - margin-left: 36pt; - padding: 10px; -} - -P.compact { - margin: 0; -} - -P.example { - font-style: italic; - margin-left: 36pt; -} - -DL.man DD { - margin-left: 5em; -} - -DL.man DT { - margin-left: 0; -} - -PRE.man { - margin: 0; -} - -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: inherit; - 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'> -<!-- - Array API header for CUPS. - - Copyright 2008-2011 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'>Array API</h1> - -<div class='summary'><table summary='General Information'> -<thead> -<tr> - <th>Header</th> - <th>cups/array.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></td> -</tr> -</tbody> -</table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#OVERVIEW">Overview</a><ul class="subcontents"> - <li><a href="#MANAGING_ARRAYS">Managing Arrays</a></li> - <li><a href="#FINDING_AND_ENUMERATING">Finding and Enumerating Elements</a></li> -</ul></li> -<li><a href="#FUNCTIONS">Functions</a><ul class="code"> - <li><a href="#cupsArrayAdd" title="Add an element to the array.">cupsArrayAdd</a></li> - <li><a href="#cupsArrayClear" title="Clear the array.">cupsArrayClear</a></li> - <li><a href="#cupsArrayCount" title="Get the number of elements in the array.">cupsArrayCount</a></li> - <li><a href="#cupsArrayCurrent" title="Return the current element in the array.">cupsArrayCurrent</a></li> - <li><a href="#cupsArrayDelete" title="Free all memory used by the array.">cupsArrayDelete</a></li> - <li><a href="#cupsArrayDup" title="Duplicate the array.">cupsArrayDup</a></li> - <li><a href="#cupsArrayFind" title="Find an element in the array.">cupsArrayFind</a></li> - <li><a href="#cupsArrayFirst" title="Get the first element in the array.">cupsArrayFirst</a></li> - <li><a href="#cupsArrayGetIndex" title="Get the index of the current element.">cupsArrayGetIndex</a></li> - <li><a href="#cupsArrayGetInsert" title="Get the index of the last inserted element.">cupsArrayGetInsert</a></li> - <li><a href="#cupsArrayIndex" title="Get the N-th element in the array.">cupsArrayIndex</a></li> - <li><a href="#cupsArrayInsert" title="Insert an element in the array.">cupsArrayInsert</a></li> - <li><a href="#cupsArrayLast" title="Get the last element in the array.">cupsArrayLast</a></li> - <li><a href="#cupsArrayNew" title="Create a new array.">cupsArrayNew</a></li> - <li><a href="#cupsArrayNew2" title="Create a new array with hash.">cupsArrayNew2</a></li> - <li><a href="#cupsArrayNew3" title="Create a new array with hash and/or free function.">cupsArrayNew3</a></li> - <li><a href="#cupsArrayNext" title="Get the next element in the array.">cupsArrayNext</a></li> - <li><a href="#cupsArrayPrev" title="Get the previous element in the array.">cupsArrayPrev</a></li> - <li><a href="#cupsArrayRemove" title="Remove an element from the array.">cupsArrayRemove</a></li> - <li><a href="#cupsArrayRestore" title="Reset the current element to the last cupsArraySave.">cupsArrayRestore</a></li> - <li><a href="#cupsArraySave" title="Mark the current element for a later cupsArrayRestore.">cupsArraySave</a></li> - <li><a href="#cupsArrayUserData" title="Return the user data for an array.">cupsArrayUserData</a></li> -</ul></li> -<li><a href="#TYPES">Data Types</a><ul class="code"> - <li><a href="#cups_acopy_func_t" title="Array element copy function">cups_acopy_func_t</a></li> - <li><a href="#cups_afree_func_t" title="Array element free function">cups_afree_func_t</a></li> - <li><a href="#cups_ahash_func_t" title="Array hash function">cups_ahash_func_t</a></li> - <li><a href="#cups_array_func_t" title="Array comparison function">cups_array_func_t</a></li> - <li><a href="#cups_array_t" title="CUPS array type">cups_array_t</a></li> -</ul></li> -</ul> -<!-- - Array API introduction for CUPS. - - Copyright 2007-2011 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 array API provides a high-performance generic array container. -The contents of the array container can be sorted and the container itself is -designed for optimal speed and memory usage under a wide variety of conditions. -Sorted arrays use a binary search algorithm from the last found or inserted -element to quickly find matching elements in the array. Arrays created with the -optional hash function can often find elements with a single lookup. The -<a href='#cups_array_t'><code>cups_array_t</code></a> type is used when -referring to a CUPS array.</p> - -<p>The CUPS scheduler (<tt>cupsd</tt>) and many of the CUPS API -functions use the array API to efficiently manage large lists of -data.</p> - -<h3><a name='MANAGING_ARRAYS'>Managing Arrays</a></h3> - -<p>Arrays are created using either the -<a href='#cupsArrayNew'><code>cupsArrayNew</code></a>, -<a href='#cupsArrayNew2'><code>cupsArrayNew2</code></a>, or -<a href='#cupsArrayNew2'><code>cupsArrayNew3</code></a> functions. The -first function creates a new array with the specified callback function -and user data pointer:</p> - -<pre class='example'> -#include <cups/array.h> - -static int compare_func(void *first, void *second, void *user_data); - -void *user_data; -<a href='#cups_array_t'>cups_array_t</a> *array = <a href='#cupsArrayNew'>cupsArrayNew</a>(compare_func, user_data); -</pre> - -<p>The comparison function (type -<a href="#cups_arrayfunc_t"><code>cups_arrayfunc_t</code></a>) is called -whenever an element is added to the array and can be <code>NULL</code> to -create an unsorted array. The function returns -1 if the first element should -come before the second, 0 if the first and second elements should have the same -ordering, and 1 if the first element should come after the second.</p> - -<p>The "user_data" pointer is passed to your comparison function. Pass -<code>NULL</code> if you do not need to associate the elements in your array -with additional information.</p> - -<p>The <a href='#cupsArrayNew2'><code>cupsArrayNew2</code></a> function adds -two more arguments to support hashed lookups, which can potentially provide -instantaneous ("O(1)") lookups in your array:</p> - -<pre class='example'> -#include <cups/array.h> - -#define HASH_SIZE 512 /* Size of hash table */ - -static int compare_func(void *first, void *second, void *user_data); -static int hash_func(void *element, void *user_data); - -void *user_data; -<a href='#cups_array_t'>cups_array_t</a> *hash_array = <a href='#cupsArrayNew2'>cupsArrayNew2</a>(compare_func, user_data, hash_func, HASH_SIZE); -</pre> - -<p>The hash function (type -<a href="#cups_ahash_func_t"><code>cups_ahash_func_t</code></a>) should return a -number from 0 to (hash_size-1) that (hopefully) uniquely identifies the -element and is called whenever you look up an element in the array with -<a href='#cupsArrayFind'><code>cupsArrayFind</code></a>. The hash size is -only limited by available memory, but generally should not be larger than -16384 to realize any performance improvement.</p> - -<p>The <a href='#cupsArrayNew3'><code>cupsArrayNew3</code></a> function adds -copy and free callbacks to support basic memory management of elements:</p> - -<pre class='example'> -#include <cups/array.h> - -#define HASH_SIZE 512 /* Size of hash table */ - -static int compare_func(void *first, void *second, void *user_data); -static void *copy_func(void *element, void *user_data); -static void free_func(void *element, void *user_data); -static int hash_func(void *element, void *user_data); - -void *user_data; -<a href='#cups_array_t'>cups_array_t</a> *array = <a href='#cupsArrayNew3'>cupsArrayNew3</a>(compare_func, user_data, NULL, 0, copy_func, free_func); - -<a href='#cups_array_t'>cups_array_t</a> *hash_array = <a href='#cupsArrayNew3'>cupsArrayNew3</a>(compare_func, user_data, hash_func, HASH_SIZE, copy_func, free_func); -</pre> - -<p>Once you have created the array, you add elements using the -<a href='#cupsArrayAdd'><code>cupsArrayAdd</code></a> -<a href='#cupsArrayInsert'><code>cupsArrayInsert</code></a> functions. -The first function adds an element to the array, adding the new element -after any elements that have the same order, while the second inserts the -element before others with the same order. For unsorted arrays, -<a href='#cupsArrayAdd'><code>cupsArrayAdd</code></a> appends the element to -the end of the array while -<a href='#cupsArrayInsert'><code>cupsArrayInsert</code></a> inserts the -element at the beginning of the array. For example, the following code -creates a sorted array of character strings:</p> - -<pre class='example'> -#include <cups/array.h> - -/* Use strcmp() to compare strings - it will ignore the user_data pointer */ -<a href='#cups_array_t'>cups_array_t</a> *array = <a href='#cupsArrayNew'>cupsArrayNew</a>((<a href='#cups_array_func_t'>cups_array_func_t</a>)strcmp, NULL); - -/* Add four strings to the array */ -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "One Fish"); -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "Two Fish"); -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "Red Fish"); -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "Blue Fish"); -</pre> - -<p>Elements are removed using the -<a href='#cupsArrayRemove'><code>cupsArrayRemove</code></a> function, for -example:</p> - -<pre class='example'> -#include <cups/array.h> - -/* Use strcmp() to compare strings - it will ignore the user_data pointer */ -<a href='#cups_array_t'>cups_array_t</a> *array = <a href='#cupsArrayNew'>cupsArrayNew</a>((<a href='#cups_array_func_t'>cups_array_func_t</a>)strcmp, NULL); - -/* Add four strings to the array */ -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "One Fish"); -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "Two Fish"); -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "Red Fish"); -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "Blue Fish"); - -/* Remove "Red Fish" */ -<a href='#cupsArrayRemove'>cupsArrayRemove</a>(array, "Red Fish"); -</pre> - -<p>Finally, you free the memory used by the array using the -<a href='#cupsArrayDelete'><code>cupsArrayDelete</code></a> function. All -of the memory for the array and hash table (if any) is freed, however <em>CUPS -does not free the elements unless you provide copy and free functions</em>.</p> - -<h3><a name='FINDING_AND_ENUMERATING'>Finding and Enumerating Elements</a></h3> - -<p>CUPS provides several functions to find and enumerate elements in an -array. Each one sets or updates a "current index" into the array, such that -future lookups will start where the last one left off:</p> - -<dl> - <dt><a href='#cupsArrayFind'><code>cupsArrayFind</code></a></dt> - <dd>Returns the first matching element.</dd> - <dt><a href='#cupsArrayFirst'><code>cupsArrayFirst</code></a></dt> - <dd>Returns the first element in the array.</dd> - <dt><a href='#cupsArrayIndex'><code>cupsArrayIndex</code></a></dt> - <dd>Returns the Nth element in the array, starting at 0.</dd> - <dt><a href='#cupsArrayLast'><code>cupsArrayLast</code></a></dt> - <dd>Returns the last element in the array.</dd> - <dt><a href='#cupsArrayNext'><code>cupsArrayNext</code></a></dt> - <dd>Returns the next element in the array.</dd> - <dt><a href='#cupsArrayPrev'><code>cupsArrayPrev</code></a></dt> - <dd>Returns the previous element in the array.</dd> -</dl> - -<p>Each of these functions returns <code>NULL</code> when there is no -corresponding element. For example, a simple <code>for</code> loop using the -<a href='#cupsArrayFirst'><code>cupsArrayFirst</code></a> and -<a href='#cupsArrayNext'><code>cupsArrayNext</code></a> functions will -enumerate all of the strings in our previous example:</p> - -<pre class='example'> -#include <cups/array.h> - -/* Use strcmp() to compare strings - it will ignore the user_data pointer */ -<a href='#cups_array_t'>cups_array_t</a> *array = <a href='#cupsArrayNew'>cupsArrayNew</a>((<a href='#cups_array_func_t'>cups_array_func_t</a>)strcmp, NULL); - -/* Add four strings to the array */ -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "One Fish"); -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "Two Fish"); -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "Red Fish"); -<a href='#cupsArrayAdd'>cupsArrayAdd</a>(array, "Blue Fish"); - -/* Show all of the strings in the array */ -char *s; -for (s = (char *)<a href='#cupsArrayFirst'>cupsArrayFirst</a>(array); s != NULL; s = (char *)<a href='#cupsArrayNext'>cupsArrayNext</a>(array)) - puts(s); -</pre> -<h2 class="title"><a name="FUNCTIONS">Functions</a></h2> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayAdd">cupsArrayAdd</a></h3> -<p class="description">Add an element to the array.</p> -<p class="code"> -int cupsArrayAdd (<br> - <a href="#cups_array_t">cups_array_t</a> *a,<br> - void *e<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -<dt>e</dt> -<dd class="description">Element</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">When adding an element to a sorted array, non-unique elements are -appended at the end of the run of identical elements. For unsorted arrays, -the element is appended to the end of the array. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayClear">cupsArrayClear</a></h3> -<p class="description">Clear the array.</p> -<p class="code"> -void cupsArrayClear (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is equivalent to removing all elements in the array. -The caller is responsible for freeing the memory used by the -elements themselves. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayCount">cupsArrayCount</a></h3> -<p class="description">Get the number of elements in the array.</p> -<p class="code"> -int cupsArrayCount (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of elements</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayCurrent">cupsArrayCurrent</a></h3> -<p class="description">Return the current element in the array.</p> -<p class="code"> -void *cupsArrayCurrent (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Element</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The current element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, -<a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayDelete">cupsArrayDelete</a></h3> -<p class="description">Free all memory used by the array.</p> -<p class="code"> -void cupsArrayDelete (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The caller is responsible for freeing the memory used by the -elements themselves. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayDup">cupsArrayDup</a></h3> -<p class="description">Duplicate the array.</p> -<p class="code"> -<a href="#cups_array_t">cups_array_t</a> *cupsArrayDup (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Duplicate array</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayFind">cupsArrayFind</a></h3> -<p class="description">Find an element in the array.</p> -<p class="code"> -void *cupsArrayFind (<br> - <a href="#cups_array_t">cups_array_t</a> *a,<br> - void *e<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -<dt>e</dt> -<dd class="description">Element</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Element found or <code>NULL</code></p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayFirst">cupsArrayFirst</a></h3> -<p class="description">Get the first element in the array.</p> -<p class="code"> -void *cupsArrayFirst (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">First element or <code>NULL</code> if the array is empty</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsArrayGetIndex">cupsArrayGetIndex</a></h3> -<p class="description">Get the index of the current element.</p> -<p class="code"> -int cupsArrayGetIndex (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Index of the current element, starting at 0</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The current element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, -<a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsArrayGetInsert">cupsArrayGetInsert</a></h3> -<p class="description">Get the index of the last inserted element.</p> -<p class="code"> -int cupsArrayGetInsert (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Index of the last inserted element, starting at 0</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayIndex">cupsArrayIndex</a></h3> -<p class="description">Get the N-th element in the array.</p> -<p class="code"> -void *cupsArrayIndex (<br> - <a href="#cups_array_t">cups_array_t</a> *a,<br> - int n<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -<dt>n</dt> -<dd class="description">Index into array, starting at 0</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">N-th element or <code>NULL</code></p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayInsert">cupsArrayInsert</a></h3> -<p class="description">Insert an element in the array.</p> -<p class="code"> -int cupsArrayInsert (<br> - <a href="#cups_array_t">cups_array_t</a> *a,<br> - void *e<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -<dt>e</dt> -<dd class="description">Element</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 on failure, 1 on success</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">When inserting an element in a sorted array, non-unique elements are -inserted at the beginning of the run of identical elements. For unsorted -arrays, the element is inserted at the beginning of the array. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayLast">cupsArrayLast</a></h3> -<p class="description">Get the last element in the array.</p> -<p class="code"> -void *cupsArrayLast (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Last element or <code>NULL</code> if the array is empty</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayNew">cupsArrayNew</a></h3> -<p class="description">Create a new array.</p> -<p class="code"> -<a href="#cups_array_t">cups_array_t</a> *cupsArrayNew (<br> - <a href="#cups_array_func_t">cups_array_func_t</a> f,<br> - void *d<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>f</dt> -<dd class="description">Comparison function or <code>NULL</code> for an unsorted array</dd> -<dt>d</dt> -<dd class="description">User data pointer or <code>NULL</code></dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Array</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The comparison function ("f") is used to create a sorted array. The function -receives pointers to two elements and the user data pointer ("d") - the user -data pointer argument can safely be omitted when not required so functions -like <code>strcmp</code> can be used for sorted string arrays. - -</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsArrayNew2">cupsArrayNew2</a></h3> -<p class="description">Create a new array with hash.</p> -<p class="code"> -<a href="#cups_array_t">cups_array_t</a> *cupsArrayNew2 (<br> - <a href="#cups_array_func_t">cups_array_func_t</a> f,<br> - void *d,<br> - <a href="#cups_ahash_func_t">cups_ahash_func_t</a> h,<br> - int hsize<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>f</dt> -<dd class="description">Comparison function or <code>NULL</code> for an unsorted array</dd> -<dt>d</dt> -<dd class="description">User data or <code>NULL</code></dd> -<dt>h</dt> -<dd class="description">Hash function or <code>NULL</code> for unhashed lookups</dd> -<dt>hsize</dt> -<dd class="description">Hash size (>= 0)</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Array</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The comparison function ("f") is used to create a sorted array. The function -receives pointers to two elements and the user data pointer ("d") - the user -data pointer argument can safely be omitted when not required so functions -like <code>strcmp</code> can be used for sorted string arrays.<br> -<br> -The hash function ("h") is used to implement cached lookups with the -specified hash size ("hsize"). - -</p> -<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="cupsArrayNew3">cupsArrayNew3</a></h3> -<p class="description">Create a new array with hash and/or free function.</p> -<p class="code"> -<a href="#cups_array_t">cups_array_t</a> *cupsArrayNew3 (<br> - <a href="#cups_array_func_t">cups_array_func_t</a> f,<br> - void *d,<br> - <a href="#cups_ahash_func_t">cups_ahash_func_t</a> h,<br> - int hsize,<br> - <a href="#cups_acopy_func_t">cups_acopy_func_t</a> cf,<br> - <a href="#cups_afree_func_t">cups_afree_func_t</a> ff<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>f</dt> -<dd class="description">Comparison function or <code>NULL</code> for an unsorted array</dd> -<dt>d</dt> -<dd class="description">User data or <code>NULL</code></dd> -<dt>h</dt> -<dd class="description">Hash function or <code>NULL</code> for unhashed lookups</dd> -<dt>hsize</dt> -<dd class="description">Hash size (>= 0)</dd> -<dt>cf</dt> -<dd class="description">Copy function</dd> -<dt>ff</dt> -<dd class="description">Free function</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Array</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The comparison function ("f") is used to create a sorted array. The function -receives pointers to two elements and the user data pointer ("d") - the user -data pointer argument can safely be omitted when not required so functions -like <code>strcmp</code> can be used for sorted string arrays.<br> -<br> -The hash function ("h") is used to implement cached lookups with the -specified hash size ("hsize").<br> -<br> -The copy function ("cf") is used to automatically copy/retain elements when -added or the array is copied.<br> -<br> -The free function ("cf") is used to automatically free/release elements when -removed or the array is deleted. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayNext">cupsArrayNext</a></h3> -<p class="description">Get the next element in the array.</p> -<p class="code"> -void *cupsArrayNext (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Next element or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is equivalent to "cupsArrayIndex(a, cupsArrayGetIndex(a) + 1)".<br> -<br> -The next element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, -<a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a> -to set the current element. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayPrev">cupsArrayPrev</a></h3> -<p class="description">Get the previous element in the array.</p> -<p class="code"> -void *cupsArrayPrev (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Previous element or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is equivalent to "cupsArrayIndex(a, cupsArrayGetIndex(a) - 1)".<br> -<br> -The previous element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, -<a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a> -to set the current element. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayRemove">cupsArrayRemove</a></h3> -<p class="description">Remove an element from the array.</p> -<p class="code"> -int cupsArrayRemove (<br> - <a href="#cups_array_t">cups_array_t</a> *a,<br> - void *e<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -<dt>e</dt> -<dd class="description">Element</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">If more than one element matches "e", only the first matching element is -removed.<br> -<br> -The caller is responsible for freeing the memory used by the -removed element. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayRestore">cupsArrayRestore</a></h3> -<p class="description">Reset the current element to the last <a href="#cupsArraySave"><code>cupsArraySave</code></a>.</p> -<p class="code"> -void *cupsArrayRestore (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New current element</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArraySave">cupsArraySave</a></h3> -<p class="description">Mark the current element for a later <a href="#cupsArrayRestore"><code>cupsArrayRestore</code></a>.</p> -<p class="code"> -int cupsArraySave (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</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">The current element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, -<a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a> -to set the current element.<br> -<br> -The save/restore stack is guaranteed to be at least 32 elements deep. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsArrayUserData">cupsArrayUserData</a></h3> -<p class="description">Return the user data for an array.</p> -<p class="code"> -void *cupsArrayUserData (<br> - <a href="#cups_array_t">cups_array_t</a> *a<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>a</dt> -<dd class="description">Array</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">User data</p> -<h2 class="title"><a name="TYPES">Data Types</a></h2> -<h3 class="typedef"><a name="cups_acopy_func_t">cups_acopy_func_t</a></h3> -<p class="description">Array element copy function</p> -<p class="code"> -typedef void *(*cups_acopy_func_t)(void *element, void *data); -</p> -<h3 class="typedef"><a name="cups_afree_func_t">cups_afree_func_t</a></h3> -<p class="description">Array element free function</p> -<p class="code"> -typedef void (*cups_afree_func_t)(void *element, void *data); -</p> -<h3 class="typedef"><a name="cups_ahash_func_t">cups_ahash_func_t</a></h3> -<p class="description">Array hash function</p> -<p class="code"> -typedef int (*cups_ahash_func_t)(void *element, void *data); -</p> -<h3 class="typedef"><a name="cups_array_func_t">cups_array_func_t</a></h3> -<p class="description">Array comparison function</p> -<p class="code"> -typedef int (*cups_array_func_t)(void *first, void *second, void *data); -</p> -<h3 class="typedef"><a name="cups_array_t">cups_array_t</a></h3> -<p class="description">CUPS array type</p> -<p class="code"> -typedef struct _cups_array_s cups_array_t; -</p> -</div> -</body> -</html> diff --git a/doc/help/api-cups.html b/doc/help/api-cups.html deleted file mode 100644 index d95025b..0000000 --- a/doc/help/api-cups.html +++ /dev/null @@ -1,3607 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- SECTION: Programming --> -<head> - <title>CUPS API </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<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 { - border: dotted thin #7f7f7f; - margin-left: 36pt; - padding: 10px; -} - -P.compact { - margin: 0; -} - -P.example { - font-style: italic; - margin-left: 36pt; -} - -DL.man DD { - margin-left: 5em; -} - -DL.man DT { - margin-left: 0; -} - -PRE.man { - margin: 0; -} - -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: inherit; - 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'> -<!-- - CUPS API header for CUPS. - - Copyright 2008-2011 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'>CUPS API</h1> - -<div class='summary'><table summary='General Information'> -<thead> -<tr> - <th>Header</th> - <th>cups/cups.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-array.html' target='_top'>Array API</a><br> - Programming: <a href='api-filedir.html' target='_top'>File and Directory APIs</a><br> - Programming: <a href='api-filter.html' target='_top'>Filter and Backend Programming</a><br> - Programming: <a href='api-httpipp.html' target='_top'>HTTP and IPP APIs</a><br> - Programming: <a href='api-ppd.html' target='_top'>PPD API</a><br> - Programming: <a href='api-raster.html' target='_top'>Raster API</a></td> -</tr> -</tbody> -</table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#OVERVIEW">Overview</a><ul class="subcontents"> - <li><a href="#CLIENTS_AND_SERVERS">Clients and Servers</a></li> - <li><a href="#PRINTERS_AND_CLASSES">Printers and Classes</a></li> - <li><a href="#OPTIONS">Options</a></li> - <li><a href="#PRINT_JOBS">Print Jobs</a></li> - <li><a href="#ERROR_HANDLING">Error Handling</a></li> - <li><a href="#PASSWORDS_AND_AUTHENTICATION">Passwords and Authentication</a></li> -</ul></li> -<li><a href="#FUNCTIONS">Functions</a><ul class="code"> - <li><a href="#cupsAddDest" title="Add a destination to the list of destinations.">cupsAddDest</a></li> - <li><a href="#cupsAddOption" title="Add an option to an option array.">cupsAddOption</a></li> - <li><a href="#cupsAdminCreateWindowsPPD" title="Create the Windows PPD file for a printer.">cupsAdminCreateWindowsPPD</a></li> - <li><a href="#cupsAdminExportSamba" title="Export a printer to Samba.">cupsAdminExportSamba</a></li> - <li><a href="#cupsAdminGetServerSettings" title="Get settings from the server.">cupsAdminGetServerSettings</a></li> - <li><a href="#cupsAdminSetServerSettings" title="Set settings on the server.">cupsAdminSetServerSettings</a></li> - <li><a href="#cupsCancelDestJob" title="Include necessary headers...">cupsCancelDestJob</a></li> - <li><a href="#cupsCancelJob" title="Cancel a print job on the default server.">cupsCancelJob</a></li> - <li><a href="#cupsCancelJob2" title="Cancel or purge a print job.">cupsCancelJob2</a></li> - <li><a href="#cupsCheckDestSupported" title="Check that the option and value are supported -by the destination.">cupsCheckDestSupported</a></li> - <li><a href="#cupsCloseDestJob" title="Close a job and start printing.">cupsCloseDestJob</a></li> - <li><a href="#cupsConnectDest" title="Connect to the server for a destination.">cupsConnectDest</a></li> - <li><a href="#cupsConnectDestBlock" title="Connect to the server for a destination.">cupsConnectDestBlock</a></li> - <li><a href="#cupsCopyDest" title="Callback block">cupsCopyDest</a></li> - <li><a href="#cupsCopyDestConflicts" title="Get conflicts and resolutions for a new -option/value pair.">cupsCopyDestConflicts</a></li> - <li><a href="#cupsCopyDestInfo" title="Get the supported values/capabilities for the -destination.">cupsCopyDestInfo</a></li> - <li><a href="#cupsCreateDestJob" title="Create a job on a destination.">cupsCreateDestJob</a></li> - <li><a href="#cupsCreateJob" title="Create an empty job for streaming.">cupsCreateJob</a></li> - <li><a href="#cupsEncryption" title="Get the current encryption settings.">cupsEncryption</a></li> - <li><a href="#cupsEnumDests" title="Enumerate available destinations with a callback function.">cupsEnumDests</a></li> - <li><a href="#cupsEnumDestsBlock" title="Enumerate available destinations with a block.">cupsEnumDestsBlock</a></li> - <li><a href="#cupsFindDestDefault" title="Find the default value(s) for the given option.">cupsFindDestDefault</a></li> - <li><a href="#cupsFindDestReady" title="Find the default value(s) for the given option.">cupsFindDestReady</a></li> - <li><a href="#cupsFindDestSupported" title="Find the default value(s) for the given option.">cupsFindDestSupported</a></li> - <li><a href="#cupsFinishDestDocument" title="Finish the current document.">cupsFinishDestDocument</a></li> - <li><a href="#cupsFinishDocument" title="Finish sending a document.">cupsFinishDocument</a></li> - <li><a href="#cupsFreeDestInfo" title="Free destination information obtained using -cupsCopyDestInfo.">cupsFreeDestInfo</a></li> - <li><a href="#cupsFreeDests" title="Free the memory used by the list of destinations.">cupsFreeDests</a></li> - <li><a href="#cupsFreeJobs" title="Free memory used by job data.">cupsFreeJobs</a></li> - <li><a href="#cupsFreeOptions" title="Free all memory used by options.">cupsFreeOptions</a></li> - <li><a href="#cupsGetClasses" title="Get a list of printer classes from the default server.">cupsGetClasses</a></li> - <li><a href="#cupsGetDefault" title="Get the default printer or class for the default server.">cupsGetDefault</a></li> - <li><a href="#cupsGetDefault2" title="Get the default printer or class for the specified server.">cupsGetDefault2</a></li> - <li><a href="#cupsGetDest" title="Get the named destination from the list.">cupsGetDest</a></li> - <li><a href="#cupsGetDestMediaByIndex" title="Get a media name, dimension, and margins for a -specific size.">cupsGetDestMediaByIndex</a></li> - <li><a href="#cupsGetDestMediaByName" title="Get media names, dimensions, and margins.">cupsGetDestMediaByName</a></li> - <li><a href="#cupsGetDestMediaBySize" title="Get media names, dimensions, and margins.">cupsGetDestMediaBySize</a></li> - <li><a href="#cupsGetDestMediaCount" title="Get the number of sizes supported by a -destination.">cupsGetDestMediaCount</a></li> - <li><a href="#cupsGetDestMediaDefault" title="Get the default size for a destination.">cupsGetDestMediaDefault</a></li> - <li><a href="#cupsGetDestWithURI" title="Get a destination associated with a URI.">cupsGetDestWithURI</a></li> - <li><a href="#cupsGetDests" title="Get the list of destinations from the default server.">cupsGetDests</a></li> - <li><a href="#cupsGetDests2" title="Get the list of destinations from the specified server.">cupsGetDests2</a></li> - <li><a href="#cupsGetJobs" title="Get the jobs from the default server.">cupsGetJobs</a></li> - <li><a href="#cupsGetJobs2" title="Get the jobs from the specified server.">cupsGetJobs2</a></li> - <li><a href="#cupsGetNamedDest" title="Get options for the named destination.">cupsGetNamedDest</a></li> - <li><a href="#cupsGetOption" title="Get an option value.">cupsGetOption</a></li> - <li><a href="#cupsGetPassword" title="Get a password from the user.">cupsGetPassword</a></li> - <li><a href="#cupsGetPassword2" title="Get a password from the user using the advanced -password callback.">cupsGetPassword2</a></li> - <li><a href="#cupsGetPrinters" title="Get a list of printers from the default server.">cupsGetPrinters</a></li> - <li><a href="#cupsLangDefault" title="Return the default language.">cupsLangDefault</a></li> - <li><a href="#cupsLangEncoding" title="Return the character encoding (us-ascii, etc.) -for the given language.">cupsLangEncoding</a></li> - <li><a href="#cupsLangFlush" title="Flush all language data out of the cache.">cupsLangFlush</a></li> - <li><a href="#cupsLangFree" title="Free language data.">cupsLangFree</a></li> - <li><a href="#cupsLangGet" title="Get a language.">cupsLangGet</a></li> - <li><a href="#cupsLocalizeDestMedia" title="Get the localized string for a destination media -size.">cupsLocalizeDestMedia</a></li> - <li><a href="#cupsLocalizeDestOption" title="Get the localized string for a destination -option.">cupsLocalizeDestOption</a></li> - <li><a href="#cupsLocalizeDestValue" title="Get the localized string for a destination -option+value pair.">cupsLocalizeDestValue</a></li> - <li><a href="#cupsNotifySubject" title="Return the subject for the given notification message.">cupsNotifySubject</a></li> - <li><a href="#cupsNotifyText" title="Return the text for the given notification message.">cupsNotifyText</a></li> - <li><a href="#cupsParseOptions" title="Parse options from a command-line argument.">cupsParseOptions</a></li> - <li><a href="#cupsPrintFile" title="Print a file to a printer or class on the default server.">cupsPrintFile</a></li> - <li><a href="#cupsPrintFile2" title="Print a file to a printer or class on the specified -server.">cupsPrintFile2</a></li> - <li><a href="#cupsPrintFiles" title="Print one or more files to a printer or class on the -default server.">cupsPrintFiles</a></li> - <li><a href="#cupsPrintFiles2" title="Print one or more files to a printer or class on the -specified server.">cupsPrintFiles2</a></li> - <li><a href="#cupsRemoveDest" title="Remove a destination from the destination list.">cupsRemoveDest</a></li> - <li><a href="#cupsRemoveOption" title="Remove an option from an option array.">cupsRemoveOption</a></li> - <li><a href="#cupsServer" title="Return the hostname/address of the current server.">cupsServer</a></li> - <li><a href="#cupsSetClientCertCB" title="Set the client certificate callback.">cupsSetClientCertCB</a></li> - <li><a href="#cupsSetCredentials" title="Set the default credentials to be used for SSL/TLS -connections.">cupsSetCredentials</a></li> - <li><a href="#cupsSetDefaultDest" title="Set the default destination.">cupsSetDefaultDest</a></li> - <li><a href="#cupsSetDests" title="Save the list of destinations for the default server.">cupsSetDests</a></li> - <li><a href="#cupsSetDests2" title="Save the list of destinations for the specified server.">cupsSetDests2</a></li> - <li><a href="#cupsSetEncryption" title="Set the encryption preference.">cupsSetEncryption</a></li> - <li><a href="#cupsSetPasswordCB" title="Set the password callback for CUPS.">cupsSetPasswordCB</a></li> - <li><a href="#cupsSetPasswordCB2" title="Set the advanced password callback for CUPS.">cupsSetPasswordCB2</a></li> - <li><a href="#cupsSetServer" title="Set the default server name and port.">cupsSetServer</a></li> - <li><a href="#cupsSetServerCertCB" title="Set the server certificate callback.">cupsSetServerCertCB</a></li> - <li><a href="#cupsSetUser" title="Set the default user name.">cupsSetUser</a></li> - <li><a href="#cupsSetUserAgent" title="Set the default HTTP User-Agent string.">cupsSetUserAgent</a></li> - <li><a href="#cupsStartDestDocument" title="Start a new document.">cupsStartDestDocument</a></li> - <li><a href="#cupsStartDocument" title="Add a document to a job created with cupsCreateJob().">cupsStartDocument</a></li> - <li><a href="#cupsTempFd" title="Creates a temporary file.">cupsTempFd</a></li> - <li><a href="#cupsTempFile" title="Generates a temporary filename.">cupsTempFile</a></li> - <li><a href="#cupsTempFile2" title="Creates a temporary CUPS file.">cupsTempFile2</a></li> - <li><a href="#cupsUser" title="Return the current user's name.">cupsUser</a></li> - <li><a href="#cupsUserAgent" title="Return the default HTTP User-Agent string.">cupsUserAgent</a></li> - <li><a href="#pwgFormatSizeName" title="Generate a PWG self-describing media size name.">pwgFormatSizeName</a></li> - <li><a href="#pwgInitSize" title="Initialize a pwg_size_t structure using IPP Job Template -attributes.">pwgInitSize</a></li> - <li><a href="#pwgMediaForLegacy" title="Find a PWG media size by ISO/IPP legacy name.">pwgMediaForLegacy</a></li> - <li><a href="#pwgMediaForPPD" title="Find a PWG media size by Adobe PPD name.">pwgMediaForPPD</a></li> - <li><a href="#pwgMediaForPWG" title="Find a PWG media size by 5101.1 self-describing name.">pwgMediaForPWG</a></li> - <li><a href="#pwgMediaForSize" title="Get the PWG media size for the given dimensions.">pwgMediaForSize</a></li> -</ul></li> -<li><a href="#TYPES">Data Types</a><ul class="code"> - <li><a href="#cups_client_cert_cb_t" title="Client credentials callback -">cups_client_cert_cb_t</a></li> - <li><a href="#cups_dest_block_t" title="Destination enumeration block -">cups_dest_block_t</a></li> - <li><a href="#cups_dest_cb_t" title="Destination enumeration callback -">cups_dest_cb_t</a></li> - <li><a href="#cups_dest_t" title="Destination">cups_dest_t</a></li> - <li><a href="#cups_dinfo_t" title="Destination capability and status -information ">cups_dinfo_t</a></li> - <li><a href="#cups_job_t" title="Job">cups_job_t</a></li> - <li><a href="#cups_option_t" title="Printer Options">cups_option_t</a></li> - <li><a href="#cups_password_cb2_t" title="New password callback -">cups_password_cb2_t</a></li> - <li><a href="#cups_password_cb_t" title="Password callback">cups_password_cb_t</a></li> - <li><a href="#cups_ptype_t" title="Printer type/capability bits">cups_ptype_t</a></li> - <li><a href="#cups_server_cert_cb_t" title="Server credentials callback -">cups_server_cert_cb_t</a></li> - <li><a href="#cups_size_t" title="Media Size ">cups_size_t</a></li> - <li><a href="#pwg_map_t" title="Map element - PPD to/from PWG">pwg_map_t</a></li> - <li><a href="#pwg_media_t" title="Common media size data">pwg_media_t</a></li> - <li><a href="#pwg_size_t" title="Size element - PPD to/from PWG">pwg_size_t</a></li> -</ul></li> -<li><a href="#STRUCTURES">Structures</a><ul class="code"> - <li><a href="#cups_dest_s" title="Destination">cups_dest_s</a></li> - <li><a href="#cups_job_s" title="Job">cups_job_s</a></li> - <li><a href="#cups_option_s" title="Printer Options">cups_option_s</a></li> - <li><a href="#cups_size_s" title="Media Size ">cups_size_s</a></li> - <li><a href="#pollfd" title="User data (unused)">pollfd</a></li> - <li><a href="#pwg_map_s" title="Map element - PPD to/from PWG">pwg_map_s</a></li> - <li><a href="#pwg_media_s" title="Common media size data">pwg_media_s</a></li> - <li><a href="#pwg_size_s" title="Size element - PPD to/from PWG">pwg_size_s</a></li> -</ul></li> -<li><a href="#VARIABLES">Variables</a><ul class="code"> - <li><a href="#CF_RETURNS_RETAINED" title="Get the Apple language identifier associated with a -locale ID.">CF_RETURNS_RETAINED</a></li> -</ul></li> -<li><a href="#ENUMERATIONS">Constants</a><ul class="code"> - <li><a href="#cups_ptype_e" title="Printer type/capability bit -constants">cups_ptype_e</a></li> -</ul></li> -</ul> -<!-- - API introduction for CUPS. - - Copyright 2007-2013 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 API provides the convenience functions needed to support -applications, filters, printer drivers, and backends that need to interface -with the CUPS scheduler.</p> - -<h3><a name='CLIENTS_AND_SERVERS'>Clients and Servers</a></h3> - -<p>CUPS is based on the Internet Printing Protocol ("IPP"), which allows -clients (applications) to communicate with a server (the scheduler) to get a -list of printers, send print jobs, and so forth. You identify which server -you want to communicate with using a pointer to the opaque structure -<code>http_t</code>. All of the examples in this document use the -<code>CUPS_HTTP_DEFAULT</code> constant, referring to the default connection -to the scheduler. The <a href='api-httpipp.html' target='_top'>HTTP and IPP -APIs</a> document provides more information on server connections.</p> - -<h3><a name='PRINTERS_AND_CLASSES'>Printers and Classes</a></h3> - -<p>Printers and classes (collections of printers) are accessed through -the <a href="#cups_dest_t"><code>cups_dest_t</code></a> structure which -includes the name (<code>name</code>), instance (<code>instance</code> - -a way of selecting certain saved options/settings), and the options and -attributes associated with that destination (<code>num_options</code> and -<code>options</code>). Destinations are created using the -<a href="#cupsGetDests"><code>cupsGetDests</code></a> function and freed -using the <a href='#cupsFreeDests'><code>cupsFreeDests</code></a> function. -The <a href='#cupsGetDest'><code>cupsGetDest</code></a> function finds a -specific destination for printing:</p> - -<pre class='example'> -#include <cups/cups.h> - -<a href='#cups_dest_t'>cups_dest_t</a> *dests; -int num_dests = <a href='#cupsGetDests'>cupsGetDests</a>(&dests); -<a href='#cups_dest_t'>cups_dest_t</a> *dest = <a href='#cupsGetDest'>cupsGetDest</a>("name", NULL, num_dests, dests); - -/* do something with dest */ - -<a href='#cupsFreeDests'>cupsFreeDests</a>(num_dests, dests); -</pre> - -<p>Passing <code>NULL</code> to -<a href='#cupsGetDest'><code>cupsGetDest</code></a> for the destination name -will return the default destination. Similarly, passing a <code>NULL</code> -instance will return the default instance for that destination.</p> - -<div class='table'><table summary='Table 1: Printer Attributes' width='80%'> -<caption>Table 1: <a name='TABLE1'>Printer Attributes</a></caption> -<thead> -<tr> - <th>Attribute Name</th> - <th>Description</th> -</tr> -</thead> -<tbody> -<tr> - <td>"auth-info-required"</td> - <td>The type of authentication required for printing to this - destination: "none", "username,password", "domain,username,password", - or "negotiate" (Kerberos)</td> -</tr> -<tr> - <td>"printer-info"</td> - <td>The human-readable description of the destination such as "My - Laser Printer".</td> -</tr> -<tr> - <td>"printer-is-accepting-jobs"</td> - <td>"true" if the destination is accepting new jobs, "false" if - not.</td> -</tr> -<tr> - <td>"printer-is-shared"</td> - <td>"true" if the destination is being shared with other computers, - "false" if not.</td> -</tr> -<tr> - <td>"printer-location"</td> - <td>The human-readable location of the destination such as "Lab 4".</td> -</tr> -<tr> - <td>"printer-make-and-model"</td> - <td>The human-readable make and model of the destination such as "HP - LaserJet 4000 Series".</td> -</tr> -<tr> - <td>"printer-state"</td> - <td>"3" if the destination is idle, "4" if the destination is printing - a job, and "5" if the destination is stopped.</td> -</tr> -<tr> - <td>"printer-state-change-time"</td> - <td>The UNIX time when the destination entered the current state.</td> -</tr> -<tr> - <td>"printer-state-reasons"</td> - <td>Additional comma-delimited state keywords for the destination - such as "media-tray-empty-error" and "toner-low-warning".</td> -</tr> -<tr> - <td>"printer-type"</td> - <td>The <a href='#cups_printer_t'><code>cups_printer_t</code></a> - value associated with the destination.</td> -</tr> -</tbody> -</table></div> - -<h3><a name='OPTIONS'>Options</a></h3> - -<p>Options are stored in arrays of -<a href='#cups_option_t'><code>cups_option_t</code></a> structures. Each -option has a name (<code>name</code>) and value (<code>value</code>) -associated with it. The <a href='#cups_dest_t'><code>cups_dest_t</code></a> -<code>num_options</code> and <code>options</code> members contain the -default options for a particular destination, along with several informational -attributes about the destination as shown in <a href='#TABLE1'>Table 1</a>. -The <a href='#cupsGetOption'><code>cupsGetOption</code></a> function gets -the value for the named option. For example, the following code lists the -available destinations and their human-readable descriptions:</p> - -<pre class='example'> -#include <cups/cups.h> - -<a href='#cups_dest_t'>cups_dest_t</a> *dests; -int num_dests = <a href='#cupsGetDests'>cupsGetDests</a>(&dests); -<a href='#cups_dest_t'>cups_dest_t</a> *dest; -int i; -const char *value; - -for (i = num_dests, dest = dests; i > 0; i --, dest ++) - if (dest->instance == NULL) - { - value = <a href='#cupsGetOption'>cupsGetOption</a>("printer-info", dest->num_options, dest->options); - printf("%s (%s)\n", dest->name, value ? value : "no description"); - } - -<a href='#cupsFreeDests'>cupsFreeDests</a>(num_dests, dests); -</pre> - -<p>You can create your own option arrays using the -<a href='#cupsAddOption'><code>cupsAddOption</code></a> function, which -adds a single named option to an array:</p> - -<pre class='example'> -#include <cups/cups.h> - -int num_options = 0; -<a href='#cups_option_t'>cups_option_t</a> *options = NULL; - -/* The returned num_options value is updated as needed */ -num_options = <a href='#cupsAddOption'>cupsAddOption</a>("first", "value", num_options, &options); - -/* This adds a second option value */ -num_options = <a href='#cupsAddOption'>cupsAddOption</a>("second", "value", num_options, &options); - -/* This replaces the first option we added */ -num_options = <a href='#cupsAddOption'>cupsAddOption</a>("first", "new value", num_options, &options); -</pre> - -<p>Use a <code>for</code> loop to copy the options from a destination:</p> - -<pre class='example'> -#include <cups/cups.h> - -int i; -int num_options = 0; -<a href='#cups_option_t'>cups_option_t</a> *options = NULL; -<a href='#cups_dest_t'>cups_dest_t</a> *dest; - -for (i = 0; i < dest->num_options; i ++) - num_options = <a href='#cupsAddOption'>cupsAddOption</a>(dest->options[i].name, dest->options[i].value, - num_options, &options); -</pre> - -<p>Use the <a href='#cupsFreeOptions'><code>cupsFreeOptions</code></a> -function to free the options array when you are done using it:</p> - -<pre class='example'> -<a href='#cupsFreeOptions'>cupsFreeOptions</a>(num_options, options); -</pre> - -<h3><a name='PRINT_JOBS'>Print Jobs</a></h3> - -<p>Print jobs are identified by a locally-unique job ID number from 1 to -2<sup>31</sup>-1 and have options and one or more files for printing to a -single destination. The <a href='#cupsPrintFile'><code>cupsPrintFile</code></a> -function creates a new job with one file. The following code prints the CUPS -test page file:</p> - -<pre class='example'> -#include <cups/cups.h> - -<a href='#cups_dest_t'>cups_dest_t</a> *dest; -int num_options; -<a href='#cups_option_t'>cups_option_t</a> *options; -int job_id; - -/* Print a single file */ -job_id = <a href='#cupsPrintFile'>cupsPrintFile</a>(dest->name, "/usr/share/cups/data/testprint.ps", - "Test Print", num_options, options); -</pre> - -<p>The <a href='#cupsPrintFiles'><code>cupsPrintFiles</code></a> function -creates a job with multiple files. The files are provided in a -<code>char *</code> array:</p> - -<pre class='example'> -#include <cups/cups.h> - -<a href='#cups_dest_t'>cups_dest_t</a> *dest; -int num_options; -<a href='#cups_option_t'>cups_option_t</a> *options; -int job_id; -char *files[3] = { "file1.pdf", "file2.pdf", "file3.pdf" }; - -/* Print three files */ -job_id = <a href='#cupsPrintFiles'>cupsPrintFiles</a>(dest->name, 3, files, "Test Print", num_options, options); -</pre> - -<p>Finally, the <a href='#cupsCreateJob'><code>cupsCreateJob</code></a> -function creates a new job with no files in it. Files are added using the -<a href='#cupsStartDocument'><code>cupsStartDocument</code></a>, -<a href='api-httpipp.html#cupsWriteRequestData'><code>cupsWriteRequestData</code></a>, -and <a href='#cupsFinishDocument'><code>cupsFinishDocument</code></a> functions. -The following example creates a job with 10 text files for printing:</p> - -<pre class='example'> -#include <cups/cups.h> - -<a href='#cups_dest_t'>cups_dest_t</a> *dest; -int num_options; -<a href='#cups_option_t'>cups_option_t</a> *options; -int job_id; -int i; -char buffer[1024]; - -/* Create the job */ -job_id = <a href='#cupsCreateJob'>cupsCreateJob</a>(CUPS_HTTP_DEFAULT, dest->name, "10 Text Files", - num_options, options); - -/* If the job is created, add 10 files */ -if (job_id > 0) -{ - for (i = 1; i <= 10; i ++) - { - snprintf(buffer, sizeof(buffer), "file%d.txt", i); - - <a href='#cupsStartDocument'>cupsStartDocument</a>(CUPS_HTTP_DEFAULT, dest->name, job_id, buffer, - CUPS_FORMAT_TEXT, i == 10); - - snprintf(buffer, sizeof(buffer), - "File %d\n" - "\n" - "One fish,\n" - "Two fish,\n - "Red fish,\n - "Blue fish\n", i); - - /* cupsWriteRequestData can be called as many times as needed */ - <a href='#cupsWriteRequestData'>cupsWriteRequestData</a>(CUPS_HTTP_DEFAULT, buffer, strlen(buffer)); - - <a href='#cupsFinishDocument'>cupsFinishDocument</a>(CUPS_HTTP_DEFAULT, dest->name); - } -} -</pre> - -<p>Once you have created a job, you can monitor its status using the -<a href='#cupsGetJobs'><code>cupsGetJobs</code></a> function, which returns -an array of <a href='#cups_job_t'><code>cups_job_t</code></a> structures. -Each contains the job ID (<code>id</code>), destination name -(<code>dest</code>), title (<code>title</code>), and other information -associated with the job. The job array is freed using the -<a href='#cupsFreeJobs'><code>cupsFreeJobs</code></a> function. The following -example monitors a specific job ID, showing the current job state once every -5 seconds until the job is completed:</p> - -<pre class='example'> -#include <cups/cups.h> - -<a href='#cups_dest_t'>cups_dest_t</a> *dest; -int job_id; -int num_jobs; -<a href='#cups_job_t'>cups_job_t</a> *jobs; -int i; -ipp_jstate_t job_state = IPP_JOB_PENDING; - -while (job_state < IPP_JOB_STOPPED) -{ - /* Get my jobs (1) with any state (-1) */ - num_jobs = <a href='#cupsGetJobs'>cupsGetJobs</a>(&jobs, dest->name, 1, -1); - - /* Loop to find my job */ - job_state = IPP_JOB_COMPLETED; - - for (i = 0; i < num_jobs; i ++) - if (jobs[i].id == job_id) - { - job_state = jobs[i].state; - break; - } - - /* Free the job array */ - <a href='#cupsFreeJobs'>cupsFreeJobs</a>(num_jobs, jobs); - - /* Show the current state */ - switch (job_state) - { - case IPP_JOB_PENDING : - printf("Job %d is pending.\n", job_id); - break; - case IPP_JOB_HELD : - printf("Job %d is held.\n", job_id); - break; - case IPP_JOB_PROCESSING : - printf("Job %d is processing.\n", job_id); - break; - case IPP_JOB_STOPPED : - printf("Job %d is stopped.\n", job_id); - break; - case IPP_JOB_CANCELED : - printf("Job %d is canceled.\n", job_id); - break; - case IPP_JOB_ABORTED : - printf("Job %d is aborted.\n", job_id); - break; - case IPP_JOB_COMPLETED : - printf("Job %d is completed.\n", job_id); - break; - } - - /* Sleep if the job is not finished */ - if (job_state < IPP_JOB_STOPPED) - sleep(5); -} -</pre> - -<p>To cancel a job, use the -<a href='#cupsCancelJob'><code>cupsCancelJob</code></a> function with the -job ID:</p> - -<pre class='example'> -#include <cups/cups.h> - -<a href='#cups_dest_t'>cups_dest_t</a> *dest; -int job_id; - -<a href='#cupsCancelJob'>cupsCancelJob</a>(dest->name, job_id); -</pre> - -<h3><a name='ERROR_HANDLING'>Error Handling</a></h3> - -<p>If any of the CUPS API printing functions returns an error, the reason for -that error can be found by calling the -<a href='#cupsLastError'><code>cupsLastError</code></a> and -<a href='#cupsLastErrorString'><code>cupsLastErrorString</code></a> functions. -<a href='#cupsLastError'><code>cupsLastError</code></a> returns the last IPP -error code -(<a href='api-httpipp.html#ipp_status_t'><code>ipp_status_t</code></a>) -that was encountered, while -<a href='#cupsLastErrorString'><code>cupsLastErrorString</code></a> returns -a (localized) human-readable string that can be shown to the user. For example, -if any of the job creation functions returns a job ID of 0, you can use -<a href='#cupsLastErrorString'><code>cupsLastErrorString</code></a> to show -the reason why the job could not be created:</p> - -<pre class='example'> -#include <cups/cups.h> - -int job_id; - -if (job_id == 0) - puts(cupsLastErrorString()); -</pre> - -<h3><a name='PASSWORDS_AND_AUTHENTICATION'>Passwords and Authentication</a></h3> - -<p>CUPS supports authentication of any request, including submission of print -jobs. The default mechanism for getting the username and password is to use the -login user and a password from the console.</p> - -<p>To support other types of applications, in particular Graphical User -Interfaces ("GUIs"), the CUPS API provides functions to set the default -username and to register a callback function that returns a password string.</p> - -<p>The <a href="#cupsSetPasswordCB"><code>cupsSetPasswordCB</code></a> -function is used to set a password callback in your program. Only one -function can be used at any time.</p> - -<p>The <a href="#cupsSetUser"><code>cupsSetUser</code></a> function sets the -current username for authentication. This function can be called by your -password callback function to change the current username as needed.</p> - -<p>The following example shows a simple password callback that gets a -username and password from the user:</p> - -<pre class='example'> -#include <cups/cups.h> - -const char * -my_password_cb(const char *prompt) -{ - char user[65]; - - - puts(prompt); - - /* Get a username from the user */ - printf("Username: "); - if (fgets(user, sizeof(user), stdin) == NULL) - return (NULL); - - /* Strip the newline from the string and set the user */ - user[strlen(user) - 1] = '\0'; - - <a href='#cupsSetUser'>cupsSetUser</a>(user); - - /* Use getpass() to ask for the password... */ - return (getpass("Password: ")); -} - -<a href='#cupsSetPasswordCB'>cupsSetPasswordCB</a>(my_password_cb); -</pre> - -<p>Similarly, a GUI could display the prompt string in a window with input -fields for the username and password. The username should default to the -string returned by the <a href="#cupsUser"><code>cupsUser</code></a> -function.</p> -<h2 class="title"><a name="FUNCTIONS">Functions</a></h2> -<h3 class="function"><a name="cupsAddDest">cupsAddDest</a></h3> -<p class="description">Add a destination to the list of destinations.</p> -<p class="code"> -int cupsAddDest (<br> - const char *name,<br> - const char *instance,<br> - int num_dests,<br> - <a href="#cups_dest_t">cups_dest_t</a> **dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>instance</dt> -<dd class="description">Instance name or <code>NULL</code> for none/primary</dd> -<dt>num_dests</dt> -<dd class="description">Number of destinations</dd> -<dt>dests</dt> -<dd class="description">Destinations</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New number of destinations</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function cannot be used to add a new class or printer queue, -it only adds a new container of saved options for the named -destination or instance.<br> -<br> -If the named destination already exists, the destination list is -returned unchanged. Adding a new instance of a destination creates -a copy of that destination's options.<br> -<br> -Use the <a href="#cupsSaveDests"><code>cupsSaveDests</code></a> function to save the updated list of -destinations to the user's lpoptions file.</p> -<h3 class="function"><a name="cupsAddOption">cupsAddOption</a></h3> -<p class="description">Add an option to an option array.</p> -<p class="code"> -int cupsAddOption (<br> - const char *name,<br> - const char *value,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> **options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Name of option</dd> -<dt>value</dt> -<dd class="description">Value of option</dd> -<dt>num_options</dt> -<dd class="description">Number of options</dd> -<dt>options</dt> -<dd class="description">Pointer to options</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of options</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">New option arrays can be initialized simply by passing 0 for the -"num_options" parameter.</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="cupsAdminCreateWindowsPPD">cupsAdminCreateWindowsPPD</a></h3> -<p class="description">Create the Windows PPD file for a printer.</p> -<p class="code"> -char *cupsAdminCreateWindowsPPD (<br> - http_t *http,<br> - const char *dest,<br> - char *buffer,<br> - int bufsize<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>dest</dt> -<dd class="description">Printer or class</dd> -<dt>buffer</dt> -<dd class="description">Filename buffer</dd> -<dt>bufsize</dt> -<dd class="description">Size of filename buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">PPD file or NULL</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="cupsAdminExportSamba">cupsAdminExportSamba</a></h3> -<p class="description">Export a printer to Samba.</p> -<p class="code"> -int cupsAdminExportSamba (<br> - const char *dest,<br> - const char *ppd,<br> - const char *samba_server,<br> - const char *samba_user,<br> - const char *samba_password,<br> - FILE *logfile<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dest</dt> -<dd class="description">Destination to export</dd> -<dt>ppd</dt> -<dd class="description">PPD file</dd> -<dt>samba_server</dt> -<dd class="description">Samba server</dd> -<dt>samba_user</dt> -<dd class="description">Samba username</dd> -<dt>samba_password</dt> -<dd class="description">Samba password</dd> -<dt>logfile</dt> -<dd class="description">Log file, if any</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsAdminGetServerSettings">cupsAdminGetServerSettings</a></h3> -<p class="description">Get settings from the server.</p> -<p class="code"> -int cupsAdminGetServerSettings (<br> - http_t *http,<br> - int *num_settings,<br> - <a href="#cups_option_t">cups_option_t</a> **settings<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>num_settings</dt> -<dd class="description">Number of settings</dd> -<dt>settings</dt> -<dd class="description">Settings</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">The returned settings should be freed with cupsFreeOptions() when -you are done with them. - -</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsAdminSetServerSettings">cupsAdminSetServerSettings</a></h3> -<p class="description">Set settings on the server.</p> -<p class="code"> -int cupsAdminSetServerSettings (<br> - http_t *http,<br> - int num_settings,<br> - <a href="#cups_option_t">cups_option_t</a> *settings<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>num_settings</dt> -<dd class="description">Number of settings</dd> -<dt>settings</dt> -<dd class="description">Settings</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> -<h3 class="function"><a name="cupsCancelDestJob">cupsCancelDestJob</a></h3> -<p class="description">Include necessary headers...</p> -<p class="code"> -ipp_status_t cupsCancelDestJob (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - int job_id<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>job_id</dt> -<dd class="description">Job ID</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Cancel a job on a destination.</p> -<p class="discussion">The "job_id" is the number returned by cupsCreateDestJob.<br> -<br> -Returns <code>IPP_STATUS_OK</code> on success and -<code>IPP_STATUS_ERRPR_NOT_AUTHORIZED</code> or -<code>IPP_STATUS_ERROR_FORBIDDEN</code> on failure. - -</p> -<h3 class="function"><a name="cupsCancelJob">cupsCancelJob</a></h3> -<p class="description">Cancel a print job on the default server.</p> -<p class="code"> -int cupsCancelJob (<br> - const char *name,<br> - int job_id<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Name of printer or class</dd> -<dt>job_id</dt> -<dd class="description">Job ID, <code>CUPS_JOBID_CURRENT</code> for the current job, or <code>CUPS_JOBID_ALL</code> for all jobs</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">Pass <code>CUPS_JOBID_ALL</code> to cancel all jobs or <code>CUPS_JOBID_CURRENT</code> -to cancel the current job on the named destination.<br> -<br> -Use the <a href="#cupsLastError"><code>cupsLastError</code></a> and <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> functions to get -the cause of any failure.</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsCancelJob2">cupsCancelJob2</a></h3> -<p class="description">Cancel or purge a print job.</p> -<p class="code"> -ipp_status_t cupsCancelJob2 (<br> - http_t *http,<br> - const char *name,<br> - int job_id,<br> - int purge<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>name</dt> -<dd class="description">Name of printer or class</dd> -<dt>job_id</dt> -<dd class="description">Job ID, <code>CUPS_JOBID_CURRENT</code> for the current job, or <code>CUPS_JOBID_ALL</code> for all jobs</dd> -<dt>purge</dt> -<dd class="description">1 to purge, 0 to cancel</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">IPP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Canceled jobs remain in the job history while purged jobs are removed -from the job history.<br> -<br> -Pass <code>CUPS_JOBID_ALL</code> to cancel all jobs or <code>CUPS_JOBID_CURRENT</code> -to cancel the current job on the named destination.<br> -<br> -Use the <a href="#cupsLastError"><code>cupsLastError</code></a> and <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> functions to get -the cause of any failure. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsCheckDestSupported">cupsCheckDestSupported</a></h3> -<p class="description">Check that the option and value are supported -by the destination.</p> -<p class="code"> -int cupsCheckDestSupported (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - const char *option,<br> - const char *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>option</dt> -<dd class="description">Option</dd> -<dt>value</dt> -<dd class="description">Value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if supported, 0 otherwise</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Returns 1 if supported, 0 otherwise. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsCloseDestJob">cupsCloseDestJob</a></h3> -<p class="description">Close a job and start printing.</p> -<p class="code"> -ipp_status_t cupsCloseDestJob (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *info,<br> - int job_id<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>info</dt> -<dd class="description">Destination information</dd> -<dt>job_id</dt> -<dd class="description">Job ID</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">IPP status code</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Use when the last call to cupsStartDocument passed 0 for "last_document". -"job_id" is the job ID returned by cupsCreateDestJob. Returns <code>IPP_STATUS_OK</code> -on success. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsConnectDest">cupsConnectDest</a></h3> -<p class="description">Connect to the server for a destination.</p> -<p class="code"> -http_t *cupsConnectDest (<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - unsigned flags,<br> - int msec,<br> - int *cancel,<br> - char *resource,<br> - size_t resourcesize,<br> - <a href="#cups_dest_cb_t">cups_dest_cb_t</a> cb,<br> - void *user_data<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>flags</dt> -<dd class="description">Connection flags</dd> -<dt>msec</dt> -<dd class="description">Timeout in milliseconds</dd> -<dt>cancel</dt> -<dd class="description">Pointer to "cancel" variable</dd> -<dt>resource</dt> -<dd class="description">Resource buffer</dd> -<dt>resourcesize</dt> -<dd class="description">Size of resource buffer</dd> -<dt>cb</dt> -<dd class="description">Callback function</dd> -<dt>user_data</dt> -<dd class="description">User data pointer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Connection to server or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Connect to the destination, returning a new http_t connection object and -optionally the resource path to use for the destination. These calls will -block until a connection is made, the timeout expires, the integer pointed -to by "cancel" is non-zero, or the callback function (or block) returns 0, -The caller is responsible for calling httpClose() on the returned object. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsConnectDestBlock">cupsConnectDestBlock</a></h3> -<p class="description">Connect to the server for a destination.</p> -<p class="code"> -http_t *cupsConnectDestBlock (<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - unsigned flags,<br> - int msec,<br> - int *cancel,<br> - char *resource,<br> - size_t resourcesize,<br> - <a href="#cups_dest_block_t">cups_dest_block_t</a> block<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>flags</dt> -<dd class="description">Connection flags</dd> -<dt>msec</dt> -<dd class="description">Timeout in milliseconds</dd> -<dt>cancel</dt> -<dd class="description">Pointer to "cancel" variable</dd> -<dt>resource</dt> -<dd class="description">Resource buffer</dd> -<dt>resourcesize</dt> -<dd class="description">Size of resource buffer</dd> -<dt>block</dt> -<dd class="description">Callback block</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Connection to server or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Connect to the destination, returning a new http_t connection object and -optionally the resource path to use for the destination. These calls will -block until a connection is made, the timeout expires, the integer pointed -to by "cancel" is non-zero, or the callback function (or block) returns 0, -The caller is responsible for calling httpClose() on the returned object. - -</p> -<h3 class="function"><a name="cupsCopyDest">cupsCopyDest</a></h3> -<p class="description">Callback block</p> -<p class="code"> -int cupsCopyDest (<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - int num_dests,<br> - <a href="#cups_dest_t">cups_dest_t</a> **dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dest</dt> -<dt>num_dests</dt> -<dt>dests</dt> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Copy a destination.</p> -<p class="discussion">Make a copy of the destination to an array of destinations (or just a single -copy) - for use with the cupsEnumDests* functions. The caller is responsible -for calling cupsFreeDests() on the returned object(s). - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsCopyDestConflicts">cupsCopyDestConflicts</a></h3> -<p class="description">Get conflicts and resolutions for a new -option/value pair.</p> -<p class="code"> -int cupsCopyDestConflicts (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options,<br> - const char *new_option,<br> - const char *new_value,<br> - int *num_conflicts,<br> - <a href="#cups_option_t">cups_option_t</a> **conflicts,<br> - int *num_resolved,<br> - <a href="#cups_option_t">cups_option_t</a> **resolved<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>num_options</dt> -<dd class="description">Number of current options</dd> -<dt>options</dt> -<dd class="description">Current options</dd> -<dt>new_option</dt> -<dd class="description">New option</dd> -<dt>new_value</dt> -<dd class="description">New value</dd> -<dt>num_conflicts</dt> -<dd class="description">Number of conflicting options</dd> -<dt>conflicts</dt> -<dd class="description">Conflicting options</dd> -<dt>num_resolved</dt> -<dd class="description">Number of options to resolve</dd> -<dt>resolved</dt> -<dd class="description">Resolved options</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if there is a conflict, 0 if none, -1 on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">"num_options" and "options" represent the currently selected options by the -user. "new_option" and "new_value" are the setting the user has just -changed.<br> -<br> -Returns 1 if there is a conflict, 0 if there are no conflicts, and -1 if -there was an unrecoverable error such as a resolver loop.<br> -<br> -If "num_conflicts" and "conflicts" are not <code>NULL</code>, they are set to -contain the list of conflicting option/value pairs. Similarly, if -"num_resolved" and "resolved" are not <code>NULL</code> they will be set to the -list of changes needed to resolve the conflict.<br> -<br> -If cupsCopyDestConflicts returns 1 but "num_resolved" and "resolved" are set -to 0 and <code>NULL</code>, respectively, then the conflict cannot be resolved. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsCopyDestInfo">cupsCopyDestInfo</a></h3> -<p class="description">Get the supported values/capabilities for the -destination.</p> -<p class="code"> -<a href="#cups_dinfo_t">cups_dinfo_t</a> *cupsCopyDestInfo (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Destination information</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The caller is responsible for calling <a href="#cupsFreeDestInfo"><code>cupsFreeDestInfo</code></a> on the return -value. <code>NULL</code> is returned on error. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsCreateDestJob">cupsCreateDestJob</a></h3> -<p class="description">Create a job on a destination.</p> -<p class="code"> -ipp_status_t cupsCreateDestJob (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *info,<br> - int *job_id,<br> - const char *title,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>info</dt> -<dd class="description">Destination information</dd> -<dt>job_id</dt> -<dd class="description">Job ID or 0 on error</dd> -<dt>title</dt> -<dd class="description">Job name</dd> -<dt>num_options</dt> -<dd class="description">Number of job options</dd> -<dt>options</dt> -<dd class="description">Job options</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">IPP status code</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success, saving the job ID -in the variable pointed to by "job_id". - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsCreateJob">cupsCreateJob</a></h3> -<p class="description">Create an empty job for streaming.</p> -<p class="code"> -int cupsCreateJob (<br> - http_t *http,<br> - const char *name,<br> - const char *title,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>title</dt> -<dd class="description">Title of job</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">Job ID or 0 on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Use this function when you want to stream print data using the -<a href="#cupsStartDocument"><code>cupsStartDocument</code></a>, <a href="#cupsWriteRequestData"><code>cupsWriteRequestData</code></a>, and -<a href="#cupsFinishDocument"><code>cupsFinishDocument</code></a> functions. If you have one or more files to -print, use the <a href="#cupsPrintFile2"><code>cupsPrintFile2</code></a> or <a href="#cupsPrintFiles2"><code>cupsPrintFiles2</code></a> function -instead. - -</p> -<h3 class="function"><a name="cupsEncryption">cupsEncryption</a></h3> -<p class="description">Get the current encryption settings.</p> -<p class="code"> -http_encryption_t cupsEncryption (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Encryption settings</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION -environment variable, then the ~/.cups/client.conf file, and finally the -/etc/cups/client.conf file. If not set, the default is -<code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> -<br> -Note: The current encryption setting is tracked separately for each thread -in a program. Multi-threaded programs that override the setting via the -<a href="#cupsSetEncryption"><code>cupsSetEncryption</code></a> function need to do so in each thread for the same -setting to be used.</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsEnumDests">cupsEnumDests</a></h3> -<p class="description">Enumerate available destinations with a callback function.</p> -<p class="code"> -int cupsEnumDests (<br> - unsigned flags,<br> - int msec,<br> - int *cancel,<br> - <a href="#cups_ptype_t">cups_ptype_t</a> type,<br> - <a href="#cups_ptype_t">cups_ptype_t</a> mask,<br> - <a href="#cups_dest_cb_t">cups_dest_cb_t</a> cb,<br> - void *user_data<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>flags</dt> -<dd class="description">Enumeration flags</dd> -<dt>msec</dt> -<dd class="description">Timeout in milliseconds, --1 for indefinite</dd> -<dt>cancel</dt> -<dd class="description">Pointer to "cancel" variable</dd> -<dt>type</dt> -<dd class="description">Printer type bits</dd> -<dt>mask</dt> -<dd class="description">Mask for printer type bits</dd> -<dt>cb</dt> -<dd class="description">Callback function</dd> -<dt>user_data</dt> -<dd class="description">User data</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">Destinations are enumerated from one or more sources. The callback function -receives the <code>user_data</code> pointer, destination name, instance, number of -options, and options which can be used as input to the <a href="#cupsAddDest"><code>cupsAddDest</code></a> -function. The function must return 1 to continue enumeration or 0 to stop.<br> -<br> -Enumeration happens on the current thread and does not return until all -destinations have been enumerated or the callback function returns 0. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsEnumDestsBlock">cupsEnumDestsBlock</a></h3> -<p class="description">Enumerate available destinations with a block.</p> -<p class="code"> -int cupsEnumDestsBlock (<br> - unsigned flags,<br> - int timeout,<br> - int *cancel,<br> - <a href="#cups_ptype_t">cups_ptype_t</a> type,<br> - <a href="#cups_ptype_t">cups_ptype_t</a> mask,<br> - <a href="#cups_dest_block_t">cups_dest_block_t</a> block<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>flags</dt> -<dd class="description">Enumeration flags</dd> -<dt>timeout</dt> -<dd class="description">Timeout in milliseconds, 0 for indefinite</dd> -<dt>cancel</dt> -<dd class="description">Pointer to "cancel" variable</dd> -<dt>type</dt> -<dd class="description">Printer type bits</dd> -<dt>mask</dt> -<dd class="description">Mask for printer type bits</dd> -<dt>block</dt> -<dd class="description">Block</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">Destinations are enumerated from one or more sources. The block receives the -destination name, instance, number of options, and options which can be used -as input to the <a href="#cupsAddDest"><code>cupsAddDest</code></a> function. The block must return 1 to -continue enumeration or 0 to stop.<br> -<br> -Enumeration happens on the current thread and does not return until all -destinations have been enumerated or the block returns 0. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="cupsFindDestDefault">cupsFindDestDefault</a></h3> -<p class="description">Find the default value(s) for the given option.</p> -<p class="code"> -ipp_attribute_t *cupsFindDestDefault (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - const char *option<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>option</dt> -<dd class="description">Option/attribute name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Default attribute or <code>NULL</code> for none</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, -<code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, -<code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, -<code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> -functions to inspect the default value(s) as needed. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="cupsFindDestReady">cupsFindDestReady</a></h3> -<p class="description">Find the default value(s) for the given option.</p> -<p class="code"> -ipp_attribute_t *cupsFindDestReady (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - const char *option<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>option</dt> -<dd class="description">Option/attribute name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Default attribute or <code>NULL</code> for none</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, -<code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, -<code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, -<code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> -functions to inspect the default value(s) as needed. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="cupsFindDestSupported">cupsFindDestSupported</a></h3> -<p class="description">Find the default value(s) for the given option.</p> -<p class="code"> -ipp_attribute_t *cupsFindDestSupported (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - const char *option<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>option</dt> -<dd class="description">Option/attribute name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Default attribute or <code>NULL</code> for none</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, -<code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, -<code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, -<code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> -functions to inspect the default value(s) as needed. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsFinishDestDocument">cupsFinishDestDocument</a></h3> -<p class="description">Finish the current document.</p> -<p class="code"> -ipp_status_t cupsFinishDestDocument (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *info<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>info</dt> -<dd class="description">Destination information</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of document submission</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success. - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsFinishDocument">cupsFinishDocument</a></h3> -<p class="description">Finish sending a document.</p> -<p class="code"> -ipp_status_t cupsFinishDocument (<br> - http_t *http,<br> - const char *name<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>name</dt> -<dd class="description">Destination name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of document submission</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The document must have been started using <a href="#cupsStartDocument"><code>cupsStartDocument</code></a>. - -</p> -<h3 class="function"><a name="cupsFreeDestInfo">cupsFreeDestInfo</a></h3> -<p class="description">Free destination information obtained using -<a href="#cupsCopyDestInfo"><code>cupsCopyDestInfo</code></a>.</p> -<p class="code"> -void cupsFreeDestInfo (<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -</dl> -<h3 class="function"><a name="cupsFreeDests">cupsFreeDests</a></h3> -<p class="description">Free the memory used by the list of destinations.</p> -<p class="code"> -void cupsFreeDests (<br> - int num_dests,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>num_dests</dt> -<dd class="description">Number of destinations</dd> -<dt>dests</dt> -<dd class="description">Destinations</dd> -</dl> -<h3 class="function"><a name="cupsFreeJobs">cupsFreeJobs</a></h3> -<p class="description">Free memory used by job data.</p> -<p class="code"> -void cupsFreeJobs (<br> - int num_jobs,<br> - <a href="#cups_job_t">cups_job_t</a> *jobs<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>num_jobs</dt> -<dd class="description">Number of jobs</dd> -<dt>jobs</dt> -<dd class="description">Jobs</dd> -</dl> -<h3 class="function"><a name="cupsFreeOptions">cupsFreeOptions</a></h3> -<p class="description">Free all memory used by options.</p> -<p class="code"> -void cupsFreeOptions (<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>num_options</dt> -<dd class="description">Number of options</dd> -<dt>options</dt> -<dd class="description">Pointer to options</dd> -</dl> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="cupsGetClasses">cupsGetClasses</a></h3> -<p class="description">Get a list of printer classes from the default server.</p> -<p class="code"> -int cupsGetClasses (<br> - char ***classes<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>classes</dt> -<dd class="description">Classes</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of classes</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated and no longer returns a list of printer -classes - use <a href="#cupsGetDests"><code>cupsGetDests</code></a> instead. - -</p> -<h3 class="function"><a name="cupsGetDefault">cupsGetDefault</a></h3> -<p class="description">Get the default printer or class for the default server.</p> -<p class="code"> -const char *cupsGetDefault (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Default printer or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns the default printer or class as defined by -the LPDEST or PRINTER environment variables. If these environment -variables are not set, the server default destination is returned. -Applications should use the <a href="#cupsGetDests"><code>cupsGetDests</code></a> and <a href="#cupsGetDest"><code>cupsGetDest</code></a> -functions to get the user-defined default printer, as this function does -not support the lpoptions-defined default printer.</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="cupsGetDefault2">cupsGetDefault2</a></h3> -<p class="description">Get the default printer or class for the specified server.</p> -<p class="code"> -const char *cupsGetDefault2 (<br> - http_t *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Default printer or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns the default printer or class as defined by -the LPDEST or PRINTER environment variables. If these environment -variables are not set, the server default destination is returned. -Applications should use the <a href="#cupsGetDests"><code>cupsGetDests</code></a> and <a href="#cupsGetDest"><code>cupsGetDest</code></a> -functions to get the user-defined default printer, as this function does -not support the lpoptions-defined default printer. - -</p> -<h3 class="function"><a name="cupsGetDest">cupsGetDest</a></h3> -<p class="description">Get the named destination from the list.</p> -<p class="code"> -<a href="#cups_dest_t">cups_dest_t</a> *cupsGetDest (<br> - const char *name,<br> - const char *instance,<br> - int num_dests,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Destination name or <code>NULL</code> for the default destination</dd> -<dt>instance</dt> -<dd class="description">Instance name or <code>NULL</code></dd> -<dt>num_dests</dt> -<dd class="description">Number of destinations</dd> -<dt>dests</dt> -<dd class="description">Destinations</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Destination pointer or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Use the <a href="#cupsGetDests"><code>cupsGetDests</code></a> or <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> functions to get a -list of supported destinations for the current user.</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></h3> -<p class="description">Get a media name, dimension, and margins for a -specific size.</p> -<p class="code"> -int cupsGetDestMediaByIndex (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - int n,<br> - unsigned flags,<br> - <a href="#cups_size_t">cups_size_t</a> *size<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>n</dt> -<dd class="description">Media size number (0-based)</dd> -<dt>flags</dt> -<dd class="description">Media flags</dd> -<dt>size</dt> -<dd class="description">Media size information</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">The <code>flags</code> parameter determines which set of media are indexed. For -example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will get the Nth -borderless size supported by the printer. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsGetDestMediaByName">cupsGetDestMediaByName</a></h3> -<p class="description">Get media names, dimensions, and margins.</p> -<p class="code"> -int cupsGetDestMediaByName (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - const char *media,<br> - unsigned flags,<br> - <a href="#cups_size_t">cups_size_t</a> *size<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>media</dt> -<dd class="description">Media name</dd> -<dt>flags</dt> -<dd class="description">Media matching flags</dd> -<dt>size</dt> -<dd class="description">Media size information</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 on match, 0 on failure</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The "media" string is a PWG media name. "Flags" provides some matching -guidance (multiple flags can be combined):<br> -<br> -CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, -CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, -CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, -CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and -CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the -size amongst the "ready" media.<br> -<br> -The matching result (if any) is returned in the "cups_size_t" structure.<br> -<br> -Returns 1 when there is a match and 0 if there is not a match. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></h3> -<p class="description">Get media names, dimensions, and margins.</p> -<p class="code"> -int cupsGetDestMediaBySize (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - int width,<br> - int length,<br> - unsigned flags,<br> - <a href="#cups_size_t">cups_size_t</a> *size<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>width</dt> -<dd class="description">Media width in hundredths of -of millimeters</dd> -<dt>length</dt> -<dd class="description">Media length in hundredths of -of millimeters</dd> -<dt>flags</dt> -<dd class="description">Media matching flags</dd> -<dt>size</dt> -<dd class="description">Media size information</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 on match, 0 on failure</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">"Width" and "length" are the dimensions in hundredths of millimeters. -"Flags" provides some matching guidance (multiple flags can be combined):<br> -<br> -CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, -CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, -CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, -CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and -CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the -size amongst the "ready" media.<br> -<br> -The matching result (if any) is returned in the "cups_size_t" structure.<br> -<br> -Returns 1 when there is a match and 0 if there is not a match. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="cupsGetDestMediaCount">cupsGetDestMediaCount</a></h3> -<p class="description">Get the number of sizes supported by a -destination.</p> -<p class="code"> -int cupsGetDestMediaCount (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - unsigned flags<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>flags</dt> -<dd class="description">Media flags</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of sizes</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>flags</code> parameter determines the set of media sizes that are -counted. For example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return -the number of borderless sizes. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></h3> -<p class="description">Get the default size for a destination.</p> -<p class="code"> -int cupsGetDestMediaDefault (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - unsigned flags,<br> - <a href="#cups_size_t">cups_size_t</a> *size<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>flags</dt> -<dd class="description">Media flags</dd> -<dt>size</dt> -<dd class="description">Media size information</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">The <code>flags</code> parameter determines which default size is returned. For -example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return the default -borderless size, typically US Letter or A4, but sometimes 4x6 photo media. - -</p> -<h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a name="cupsGetDestWithURI">cupsGetDestWithURI</a></h3> -<p class="description">Get a destination associated with a URI.</p> -<p class="code"> -<a href="#cups_dest_t">cups_dest_t</a> *cupsGetDestWithURI (<br> - const char *name,<br> - const char *uri<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Desired printer name or <code>NULL</code></dd> -<dt>uri</dt> -<dd class="description">URI for the printer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Destination or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">"name" is the desired name for the printer. If <code>NULL</code>, a name will be -created using the URI.<br> -<br> -"uri" is the "ipp" or "ipps" URI for the printer. - -</p> -<h3 class="function"><a name="cupsGetDests">cupsGetDests</a></h3> -<p class="description">Get the list of destinations from the default server.</p> -<p class="code"> -int cupsGetDests (<br> - <a href="#cups_dest_t">cups_dest_t</a> **dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dests</dt> -<dd class="description">Destinations</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of destinations</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Starting with CUPS 1.2, the returned list of destinations include the -printer-info, printer-is-accepting-jobs, printer-is-shared, -printer-make-and-model, printer-state, printer-state-change-time, -printer-state-reasons, and printer-type attributes as options. CUPS 1.4 -adds the marker-change-time, marker-colors, marker-high-levels, -marker-levels, marker-low-levels, marker-message, marker-names, -marker-types, and printer-commands attributes as well.<br> -<br> -Use the <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> function to free the destination list and -the <a href="#cupsGetDest"><code>cupsGetDest</code></a> function to find a particular destination.</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="cupsGetDests2">cupsGetDests2</a></h3> -<p class="description">Get the list of destinations from the specified server.</p> -<p class="code"> -int cupsGetDests2 (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> **dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>dests</dt> -<dd class="description">Destinations</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of destinations</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Starting with CUPS 1.2, the returned list of destinations include the -printer-info, printer-is-accepting-jobs, printer-is-shared, -printer-make-and-model, printer-state, printer-state-change-time, -printer-state-reasons, and printer-type attributes as options. CUPS 1.4 -adds the marker-change-time, marker-colors, marker-high-levels, -marker-levels, marker-low-levels, marker-message, marker-names, -marker-types, and printer-commands attributes as well.<br> -<br> -Use the <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> function to free the destination list and -the <a href="#cupsGetDest"><code>cupsGetDest</code></a> function to find a particular destination. - -</p> -<h3 class="function"><a name="cupsGetJobs">cupsGetJobs</a></h3> -<p class="description">Get the jobs from the default server.</p> -<p class="code"> -int cupsGetJobs (<br> - <a href="#cups_job_t">cups_job_t</a> **jobs,<br> - const char *name,<br> - int myjobs,<br> - int whichjobs<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>jobs</dt> -<dd class="description">Job data</dd> -<dt>name</dt> -<dd class="description"><code>NULL</code> = all destinations, otherwise show jobs for named destination</dd> -<dt>myjobs</dt> -<dd class="description">0 = all users, 1 = mine</dd> -<dt>whichjobs</dt> -<dd class="description"><code>CUPS_WHICHJOBS_ALL</code>, <code>CUPS_WHICHJOBS_ACTIVE</code>, or <code>CUPS_WHICHJOBS_COMPLETED</code></dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of jobs</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">A "whichjobs" value of <code>CUPS_WHICHJOBS_ALL</code> returns all jobs regardless -of state, while <code>CUPS_WHICHJOBS_ACTIVE</code> returns jobs that are -pending, processing, or held and <code>CUPS_WHICHJOBS_COMPLETED</code> returns -jobs that are stopped, canceled, aborted, or completed.</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="cupsGetJobs2">cupsGetJobs2</a></h3> -<p class="description">Get the jobs from the specified server.</p> -<p class="code"> -int cupsGetJobs2 (<br> - http_t *http,<br> - <a href="#cups_job_t">cups_job_t</a> **jobs,<br> - const char *name,<br> - int myjobs,<br> - int whichjobs<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>jobs</dt> -<dd class="description">Job data</dd> -<dt>name</dt> -<dd class="description"><code>NULL</code> = all destinations, otherwise show jobs for named destination</dd> -<dt>myjobs</dt> -<dd class="description">0 = all users, 1 = mine</dd> -<dt>whichjobs</dt> -<dd class="description"><code>CUPS_WHICHJOBS_ALL</code>, <code>CUPS_WHICHJOBS_ACTIVE</code>, or <code>CUPS_WHICHJOBS_COMPLETED</code></dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of jobs</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">A "whichjobs" value of <code>CUPS_WHICHJOBS_ALL</code> returns all jobs regardless -of state, while <code>CUPS_WHICHJOBS_ACTIVE</code> returns jobs that are -pending, processing, or held and <code>CUPS_WHICHJOBS_COMPLETED</code> returns -jobs that are stopped, canceled, aborted, or completed. - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsGetNamedDest">cupsGetNamedDest</a></h3> -<p class="description">Get options for the named destination.</p> -<p class="code"> -<a href="#cups_dest_t">cups_dest_t</a> *cupsGetNamedDest (<br> - http_t *http,<br> - const char *name,<br> - const char *instance<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>name</dt> -<dd class="description">Destination name or <code>NULL</code> for the default destination</dd> -<dt>instance</dt> -<dd class="description">Instance name or <code>NULL</code></dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Destination or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is optimized for retrieving a single destination and should -be used instead of <a href="#cupsGetDests"><code>cupsGetDests</code></a> and <a href="#cupsGetDest"><code>cupsGetDest</code></a> when you either -know the name of the destination or want to print to the default destination. -If <code>NULL</code> is returned, the destination does not exist or there is no -default destination.<br> -<br> -If "http" is <code>CUPS_HTTP_DEFAULT</code>, the connection to the default print -server will be used.<br> -<br> -If "name" is <code>NULL</code>, the default printer for the current user will be -returned.<br> -<br> -The returned destination must be freed using <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> with a -"num_dests" value of 1. - -</p> -<h3 class="function"><a name="cupsGetOption">cupsGetOption</a></h3> -<p class="description">Get an option value.</p> -<p class="code"> -const char *cupsGetOption (<br> - const char *name,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Name of option</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">Option value or <code>NULL</code></p> -<h3 class="function"><a name="cupsGetPassword">cupsGetPassword</a></h3> -<p class="description">Get a password from the user.</p> -<p class="code"> -const char *cupsGetPassword (<br> - const char *prompt<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>prompt</dt> -<dd class="description">Prompt string</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Password</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Uses the current password callback function. Returns <code>NULL</code> if the -user does not provide a password.<br> -<br> -Note: The current password callback function is tracked separately for each -thread in a program. Multi-threaded programs that override the setting via -the <a href="#cupsSetPasswordCB"><code>cupsSetPasswordCB</code></a> or <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> functions need to -do so in each thread for the same function to be used.</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsGetPassword2">cupsGetPassword2</a></h3> -<p class="description">Get a password from the user using the advanced -password callback.</p> -<p class="code"> -const char *cupsGetPassword2 (<br> - const char *prompt,<br> - http_t *http,<br> - const char *method,<br> - const char *resource<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>prompt</dt> -<dd class="description">Prompt string</dd> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>method</dt> -<dd class="description">Request method ("GET", "POST", "PUT")</dd> -<dt>resource</dt> -<dd class="description">Resource path</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Password</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Uses the current password callback function. Returns <code>NULL</code> if the -user does not provide a password.<br> -<br> -Note: The current password callback function is tracked separately for each -thread in a program. Multi-threaded programs that override the setting via -the <a href="#cupsSetPasswordCB"><code>cupsSetPasswordCB</code></a> or <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> functions need to -do so in each thread for the same function to be used. - -</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="cupsGetPrinters">cupsGetPrinters</a></h3> -<p class="description">Get a list of printers from the default server.</p> -<p class="code"> -int cupsGetPrinters (<br> - char ***printers<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>printers</dt> -<dd class="description">Printers</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of printers</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated and no longer returns a list of printers - use -<a href="#cupsGetDests"><code>cupsGetDests</code></a> instead. - -</p> -<h3 class="function"><a name="cupsLangDefault">cupsLangDefault</a></h3> -<p class="description">Return the default language.</p> -<p class="code"> -cups_lang_t *cupsLangDefault (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Language data</p> -<h3 class="function"><a name="cupsLangEncoding">cupsLangEncoding</a></h3> -<p class="description">Return the character encoding (us-ascii, etc.) -for the given language.</p> -<p class="code"> -const char *cupsLangEncoding (<br> - cups_lang_t *lang<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>lang</dt> -<dd class="description">Language data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Character encoding</p> -<h3 class="function"><a name="cupsLangFlush">cupsLangFlush</a></h3> -<p class="description">Flush all language data out of the cache.</p> -<p class="code"> -void cupsLangFlush (void);</p> -<h3 class="function"><a name="cupsLangFree">cupsLangFree</a></h3> -<p class="description">Free language data.</p> -<p class="code"> -void cupsLangFree (<br> - cups_lang_t *lang<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>lang</dt> -<dd class="description">Language to free</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This does not actually free anything; use <a href="#cupsLangFlush"><code>cupsLangFlush</code></a> for that.</p> -<h3 class="function"><a name="cupsLangGet">cupsLangGet</a></h3> -<p class="description">Get a language.</p> -<p class="code"> -cups_lang_t *cupsLangGet (<br> - const char *language<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>language</dt> -<dd class="description">Language or locale</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Language data</p> -<h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a name="cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></h3> -<p class="description">Get the localized string for a destination media -size.</p> -<p class="code"> -const char *cupsLocalizeDestMedia (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - unsigned flags,<br> - <a href="#cups_size_t">cups_size_t</a> *size<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>flags</dt> -<dd class="description">Media flags</dd> -<dt>size</dt> -<dd class="description">Media size</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Localized string</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned string is stored in the destination information and will become -invalid if the destination information is deleted. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsLocalizeDestOption">cupsLocalizeDestOption</a></h3> -<p class="description">Get the localized string for a destination -option.</p> -<p class="code"> -const char *cupsLocalizeDestOption (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - const char *option<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>option</dt> -<dd class="description">Option to localize</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Localized string</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned string is stored in the destination information and will become -invalid if the destination information is deleted. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsLocalizeDestValue">cupsLocalizeDestValue</a></h3> -<p class="description">Get the localized string for a destination -option+value pair.</p> -<p class="code"> -const char *cupsLocalizeDestValue (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo,<br> - const char *option,<br> - const char *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>dinfo</dt> -<dd class="description">Destination information</dd> -<dt>option</dt> -<dd class="description">Option to localize</dd> -<dt>value</dt> -<dd class="description">Value to localize</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Localized string</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned string is stored in the destination information and will become -invalid if the destination information is deleted. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsNotifySubject">cupsNotifySubject</a></h3> -<p class="description">Return the subject for the given notification message.</p> -<p class="code"> -char *cupsNotifySubject (<br> - cups_lang_t *lang,<br> - ipp_t *event<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>lang</dt> -<dd class="description">Language data</dd> -<dt>event</dt> -<dd class="description">Event data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Subject string or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned string must be freed by the caller using <code>free</code>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsNotifyText">cupsNotifyText</a></h3> -<p class="description">Return the text for the given notification message.</p> -<p class="code"> -char *cupsNotifyText (<br> - cups_lang_t *lang,<br> - ipp_t *event<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>lang</dt> -<dd class="description">Language data</dd> -<dt>event</dt> -<dd class="description">Event data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Message text or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned string must be freed by the caller using <code>free</code>. - -</p> -<h3 class="function"><a name="cupsParseOptions">cupsParseOptions</a></h3> -<p class="description">Parse options from a command-line argument.</p> -<p class="code"> -int cupsParseOptions (<br> - const char *arg,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> **options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>arg</dt> -<dd class="description">Argument to parse</dd> -<dt>num_options</dt> -<dd class="description">Number of options</dd> -<dt>options</dt> -<dd class="description">Options found</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of options found</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function converts space-delimited name/value pairs according -to the PAPI text option ABNF specification. Collection values -("name={a=... b=... c=...}") are stored with the curley brackets -intact - use <code>cupsParseOptions</code> on the value to extract the -collection attributes.</p> -<h3 class="function"><a name="cupsPrintFile">cupsPrintFile</a></h3> -<p class="description">Print a file to a printer or class on the default server.</p> -<p class="code"> -int cupsPrintFile (<br> - const char *name,<br> - const char *filename,<br> - const char *title,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>filename</dt> -<dd class="description">File to print</dd> -<dt>title</dt> -<dd class="description">Title of job</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">Job ID or 0 on error</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="cupsPrintFile2">cupsPrintFile2</a></h3> -<p class="description">Print a file to a printer or class on the specified -server.</p> -<p class="code"> -int cupsPrintFile2 (<br> - http_t *http,<br> - const char *name,<br> - const char *filename,<br> - const char *title,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server</dd> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>filename</dt> -<dd class="description">File to print</dd> -<dt>title</dt> -<dd class="description">Title of job</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">Job ID or 0 on error</p> -<h3 class="function"><a name="cupsPrintFiles">cupsPrintFiles</a></h3> -<p class="description">Print one or more files to a printer or class on the -default server.</p> -<p class="code"> -int cupsPrintFiles (<br> - const char *name,<br> - int num_files,<br> - const char **files,<br> - const char *title,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>num_files</dt> -<dd class="description">Number of files</dd> -<dt>files</dt> -<dd class="description">File(s) to print</dd> -<dt>title</dt> -<dd class="description">Title of job</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">Job ID or 0 on error</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="cupsPrintFiles2">cupsPrintFiles2</a></h3> -<p class="description">Print one or more files to a printer or class on the -specified server.</p> -<p class="code"> -int cupsPrintFiles2 (<br> - http_t *http,<br> - const char *name,<br> - int num_files,<br> - const char **files,<br> - const char *title,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>num_files</dt> -<dd class="description">Number of files</dd> -<dt>files</dt> -<dd class="description">File(s) to print</dd> -<dt>title</dt> -<dd class="description">Title of job</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">Job ID or 0 on error</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsRemoveDest">cupsRemoveDest</a></h3> -<p class="description">Remove a destination from the destination list.</p> -<p class="code"> -int cupsRemoveDest (<br> - const char *name,<br> - const char *instance,<br> - int num_dests,<br> - <a href="#cups_dest_t">cups_dest_t</a> **dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>instance</dt> -<dd class="description">Instance name or <code>NULL</code></dd> -<dt>num_dests</dt> -<dd class="description">Number of destinations</dd> -<dt>dests</dt> -<dd class="description">Destinations</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New number of destinations</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Removing a destination/instance does not delete the class or printer -queue, merely the lpoptions for that destination/instance. Use the -<a href="#cupsSetDests"><code>cupsSetDests</code></a> or <a href="#cupsSetDests2"><code>cupsSetDests2</code></a> functions to save the new -options for the user. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsRemoveOption">cupsRemoveOption</a></h3> -<p class="description">Remove an option from an option array.</p> -<p class="code"> -int cupsRemoveOption (<br> - const char *name,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> **options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Option name</dd> -<dt>num_options</dt> -<dd class="description">Current number of options</dd> -<dt>options</dt> -<dd class="description">Options</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New number of options</p> -<h3 class="function"><a name="cupsServer">cupsServer</a></h3> -<p class="description">Return the hostname/address of the current server.</p> -<p class="code"> -const char *cupsServer (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Server name</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The default server comes from the CUPS_SERVER environment variable, then the -~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not -set, the default is the local system - either "localhost" or a domain socket -path.<br> -<br> -The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6 -address, or a domain socket pathname.<br> -<br> -Note: The current server is tracked separately for each thread in a program. -Multi-threaded programs that override the server via the -<a href="#cupsSetServer"><code>cupsSetServer</code></a> function need to do so in each thread for the same -server to be used.</p> -<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="cupsSetClientCertCB">cupsSetClientCertCB</a></h3> -<p class="description">Set the client certificate callback.</p> -<p class="code"> -void cupsSetClientCertCB (<br> - <a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a> cb,<br> - void *user_data<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>cb</dt> -<dd class="description">Callback function</dd> -<dt>user_data</dt> -<dd class="description">User data pointer</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> -<br> -Note: The current certificate callback is tracked separately for each thread -in a program. Multi-threaded programs that override the callback need to do -so in each thread for the same callback to be used. - -</p> -<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="cupsSetCredentials">cupsSetCredentials</a></h3> -<p class="description">Set the default credentials to be used for SSL/TLS -connections.</p> -<p class="code"> -int cupsSetCredentials (<br> - cups_array_t *credentials<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>credentials</dt> -<dd class="description">Array of credentials</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of call (0 = success)</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Note: The default credentials are tracked separately for each thread in a -program. Multi-threaded programs that override the setting need to do so in -each thread for the same setting to be used. - -</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsSetDefaultDest">cupsSetDefaultDest</a></h3> -<p class="description">Set the default destination.</p> -<p class="code"> -void cupsSetDefaultDest (<br> - const char *name,<br> - const char *instance,<br> - int num_dests,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>instance</dt> -<dd class="description">Instance name or <code>NULL</code></dd> -<dt>num_dests</dt> -<dd class="description">Number of destinations</dd> -<dt>dests</dt> -<dd class="description">Destinations</dd> -</dl> -<h3 class="function"><a name="cupsSetDests">cupsSetDests</a></h3> -<p class="description">Save the list of destinations for the default server.</p> -<p class="code"> -void cupsSetDests (<br> - int num_dests,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>num_dests</dt> -<dd class="description">Number of destinations</dd> -<dt>dests</dt> -<dd class="description">Destinations</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function saves the destinations to /etc/cups/lpoptions when run -as root and ~/.cups/lpoptions when run as a normal user.</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="cupsSetDests2">cupsSetDests2</a></h3> -<p class="description">Save the list of destinations for the specified server.</p> -<p class="code"> -int cupsSetDests2 (<br> - http_t *http,<br> - int num_dests,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dests<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>num_dests</dt> -<dd class="description">Number of destinations</dd> -<dt>dests</dt> -<dd class="description">Destinations</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">This function saves the destinations to /etc/cups/lpoptions when run -as root and ~/.cups/lpoptions when run as a normal user. - -</p> -<h3 class="function"><a name="cupsSetEncryption">cupsSetEncryption</a></h3> -<p class="description">Set the encryption preference.</p> -<p class="code"> -void cupsSetEncryption (<br> - http_encryption_t e<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>e</dt> -<dd class="description">New encryption preference</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION -environment variable, then the ~/.cups/client.conf file, and finally the -/etc/cups/client.conf file. If not set, the default is -<code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> -<br> -Note: The current encryption setting is tracked separately for each thread -in a program. Multi-threaded programs that override the setting need to do -so in each thread for the same setting to be used.</p> -<h3 class="function"><a name="cupsSetPasswordCB">cupsSetPasswordCB</a></h3> -<p class="description">Set the password callback for CUPS.</p> -<p class="code"> -void cupsSetPasswordCB (<br> - <a href="#cups_password_cb_t">cups_password_cb_t</a> cb<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>cb</dt> -<dd class="description">Callback function</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Pass <code>NULL</code> to restore the default (console) password callback, which -reads the password from the console. Programs should call either this -function or <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a>, as only one callback can be registered -by a program per thread.<br> -<br> -Note: The current password callback is tracked separately for each thread -in a program. Multi-threaded programs that override the callback need to do -so in each thread for the same callback to be used.</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsSetPasswordCB2">cupsSetPasswordCB2</a></h3> -<p class="description">Set the advanced password callback for CUPS.</p> -<p class="code"> -void cupsSetPasswordCB2 (<br> - <a href="#cups_password_cb2_t">cups_password_cb2_t</a> cb,<br> - void *user_data<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>cb</dt> -<dd class="description">Callback function</dd> -<dt>user_data</dt> -<dd class="description">User data pointer</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Pass <code>NULL</code> to restore the default (console) password callback, which -reads the password from the console. Programs should call either this -function or <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a>, as only one callback can be registered -by a program per thread.<br> -<br> -Note: The current password callback is tracked separately for each thread -in a program. Multi-threaded programs that override the callback need to do -so in each thread for the same callback to be used. - -</p> -<h3 class="function"><a name="cupsSetServer">cupsSetServer</a></h3> -<p class="description">Set the default server name and port.</p> -<p class="code"> -void cupsSetServer (<br> - const char *server<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>server</dt> -<dd class="description">Server name</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The "server" string can be a fully-qualified hostname, a numeric -IPv4 or IPv6 address, or a domain socket pathname. Hostnames and numeric IP -addresses can be optionally followed by a colon and port number to override -the default port 631, e.g. "hostname:8631". Pass <code>NULL</code> to restore the -default server name and port.<br> -<br> -Note: The current server is tracked separately for each thread in a program. -Multi-threaded programs that override the server need to do so in each -thread for the same server to be used.</p> -<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="cupsSetServerCertCB">cupsSetServerCertCB</a></h3> -<p class="description">Set the server certificate callback.</p> -<p class="code"> -void cupsSetServerCertCB (<br> - <a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a> cb,<br> - void *user_data<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>cb</dt> -<dd class="description">Callback function</dd> -<dt>user_data</dt> -<dd class="description">User data pointer</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> -<br> -Note: The current credentials callback is tracked separately for each thread -in a program. Multi-threaded programs that override the callback need to do -so in each thread for the same callback to be used. - -</p> -<h3 class="function"><a name="cupsSetUser">cupsSetUser</a></h3> -<p class="description">Set the default user name.</p> -<p class="code"> -void cupsSetUser (<br> - const char *user<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>user</dt> -<dd class="description">User name</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Pass <code>NULL</code> to restore the default user name.<br> -<br> -Note: The current user name is tracked separately for each thread in a -program. Multi-threaded programs that override the user name need to do so -in each thread for the same user name to be used.</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="cupsSetUserAgent">cupsSetUserAgent</a></h3> -<p class="description">Set the default HTTP User-Agent string.</p> -<p class="code"> -void cupsSetUserAgent (<br> - const char *user_agent<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>user_agent</dt> -<dd class="description">User-Agent string or <code>NULL</code></dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Setting the string to NULL forces the default value containing the CUPS -version, IPP version, and operating system version and architecture. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cupsStartDestDocument">cupsStartDestDocument</a></h3> -<p class="description">Start a new document.</p> -<p class="code"> -http_status_t cupsStartDestDocument (<br> - http_t *http,<br> - <a href="#cups_dest_t">cups_dest_t</a> *dest,<br> - <a href="#cups_dinfo_t">cups_dinfo_t</a> *info,<br> - int job_id,<br> - const char *docname,<br> - const char *format,<br> - int num_options,<br> - <a href="#cups_option_t">cups_option_t</a> *options,<br> - int last_document<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to destination</dd> -<dt>dest</dt> -<dd class="description">Destination</dd> -<dt>info</dt> -<dd class="description">Destination information</dd> -<dt>job_id</dt> -<dd class="description">Job ID</dd> -<dt>docname</dt> -<dd class="description">Document name</dd> -<dt>format</dt> -<dd class="description">Document format</dd> -<dt>num_options</dt> -<dd class="description">Number of document options</dd> -<dt>options</dt> -<dd class="description">Document options</dd> -<dt>last_document</dt> -<dd class="description">1 if this is the last document</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of document creation</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">"job_id" is the job ID returned by cupsCreateDestJob. "docname" is the name -of the document/file being printed, "format" is the MIME media type for the -document (see CUPS_FORMAT_xxx constants), and "num_options" and "options" -are the options do be applied to the document. "last_document" should be 1 -if this is the last document to be submitted in the job. Returns -<code>HTTP_CONTINUE</code> on success. - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsStartDocument">cupsStartDocument</a></h3> -<p class="description">Add a document to a job created with cupsCreateJob().</p> -<p class="code"> -http_status_t cupsStartDocument (<br> - http_t *http,<br> - const char *name,<br> - int job_id,<br> - const char *docname,<br> - const char *format,<br> - int last_document<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>job_id</dt> -<dd class="description">Job ID from <a href="#cupsCreateJob"><code>cupsCreateJob</code></a></dd> -<dt>docname</dt> -<dd class="description">Name of document</dd> -<dt>format</dt> -<dd class="description">MIME type or <code>CUPS_FORMAT_foo</code></dd> -<dt>last_document</dt> -<dd class="description">1 for last document in job, 0 otherwise</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status of request</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Use <a href="#cupsWriteRequestData"><code>cupsWriteRequestData</code></a> to write data for the document and -<a href="#cupsFinishDocument"><code>cupsFinishDocument</code></a> to finish the document and get the submission status.<br> -<br> -The MIME type constants <code>CUPS_FORMAT_AUTO</code>, <code>CUPS_FORMAT_PDF</code>, -<code>CUPS_FORMAT_POSTSCRIPT</code>, <code>CUPS_FORMAT_RAW</code>, and -<code>CUPS_FORMAT_TEXT</code> are provided for the "format" argument, although -any supported MIME type string can be supplied. - -</p> -<h3 class="function"><a name="cupsTempFd">cupsTempFd</a></h3> -<p class="description">Creates a temporary file.</p> -<p class="code"> -int cupsTempFd (<br> - char *filename,<br> - int len<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>filename</dt> -<dd class="description">Pointer to buffer</dd> -<dt>len</dt> -<dd class="description">Size of buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New file descriptor or -1 on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The temporary filename is returned in the filename buffer. -The temporary file is opened for reading and writing.</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="cupsTempFile">cupsTempFile</a></h3> -<p class="description">Generates a temporary filename.</p> -<p class="code"> -char *cupsTempFile (<br> - char *filename,<br> - int len<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>filename</dt> -<dd class="description">Pointer to buffer</dd> -<dt>len</dt> -<dd class="description">Size of buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Filename or <code>NULL</code> on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The temporary filename is returned in the filename buffer. -This function is deprecated and will no longer generate a temporary -filename - use <a href="#cupsTempFd"><code>cupsTempFd</code></a> or <a href="#cupsTempFile2"><code>cupsTempFile2</code></a> instead. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsTempFile2">cupsTempFile2</a></h3> -<p class="description">Creates a temporary CUPS file.</p> -<p class="code"> -cups_file_t *cupsTempFile2 (<br> - char *filename,<br> - int len<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>filename</dt> -<dd class="description">Pointer to buffer</dd> -<dt>len</dt> -<dd class="description">Size of buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">CUPS file or <code>NULL</code> on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The temporary filename is returned in the filename buffer. -The temporary file is opened for writing. - -</p> -<h3 class="function"><a name="cupsUser">cupsUser</a></h3> -<p class="description">Return the current user's name.</p> -<p class="code"> -const char *cupsUser (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">User name</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Note: The current user name is tracked separately for each thread in a -program. Multi-threaded programs that override the user name with the -<a href="#cupsSetUser"><code>cupsSetUser</code></a> function need to do so in each thread for the same user -name to be used.</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="cupsUserAgent">cupsUserAgent</a></h3> -<p class="description">Return the default HTTP User-Agent string.</p> -<p class="code"> -const char *cupsUserAgent (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">User-Agent string</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="pwgFormatSizeName">pwgFormatSizeName</a></h3> -<p class="description">Generate a PWG self-describing media size name.</p> -<p class="code"> -int pwgFormatSizeName (<br> - char *keyword,<br> - size_t keysize,<br> - const char *prefix,<br> - const char *name,<br> - int width,<br> - int length,<br> - const char *units<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>keyword</dt> -<dd class="description">Keyword buffer</dd> -<dt>keysize</dt> -<dd class="description">Size of keyword buffer</dd> -<dt>prefix</dt> -<dd class="description">Prefix for PWG size or <code>NULL</code> for automatic</dd> -<dt>name</dt> -<dd class="description">Size name or <code>NULL</code></dd> -<dt>width</dt> -<dd class="description">Width of page in 2540ths</dd> -<dt>length</dt> -<dd class="description">Length of page in 2540ths</dd> -<dt>units</dt> -<dd class="description">Units - "in", "mm", or <code>NULL</code> for automatic</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 generates a PWG self-describing media size name of the form -"prefix_name_WIDTHxLENGTHunits". The prefix is typically "custom" or "roll" -for user-supplied sizes but can also be "disc", "iso", "jis", "jpn", "na", -"oe", "om", "prc", or "roc". A value of <code>NULL</code> automatically chooses -"oe" or "om" depending on the units.<br> -<br> -The size name may only contain lowercase letters, numbers, "-", and ".". If -<code>NULL</code> is passed, the size name will contain the formatted dimensions.<br> -<br> -The width and length are specified in hundredths of millimeters, equivalent -to 1/100000th of a meter or 1/2540th of an inch. The width, length, and -units used for the generated size name are calculated automatically if the -units string is <code>NULL</code>, otherwise inches ("in") or millimeters ("mm") -are used. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="pwgInitSize">pwgInitSize</a></h3> -<p class="description">Initialize a pwg_size_t structure using IPP Job Template -attributes.</p> -<p class="code"> -int pwgInitSize (<br> - <a href="#pwg_size_t">pwg_size_t</a> *size,<br> - ipp_t *job,<br> - int *margins_set<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>size</dt> -<dd class="description">Size to initialize</dd> -<dt>job</dt> -<dd class="description">Job template attributes</dd> -<dt>margins_set</dt> -<dd class="description">1 if margins were set, 0 otherwise</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if size was initialized, 0 otherwise</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function initializes a pwg_size_t structure from an IPP "media" or -"media-col" attribute in the specified IPP message. 0 is returned if neither -attribute is found in the message or the values are not valid.<br> -<br> -The "margins_set" variable is initialized to 1 if any "media-xxx-margin" -member attribute was specified in the "media-col" Job Template attribute, -otherwise it is initialized to 0. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="pwgMediaForLegacy">pwgMediaForLegacy</a></h3> -<p class="description">Find a PWG media size by ISO/IPP legacy name.</p> -<p class="code"> -<a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForLegacy (<br> - const char *legacy<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>legacy</dt> -<dd class="description">Legacy size name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Matching size or NULL</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The "name" argument specifies the legacy ISO media size name, for example -"iso-a4" or "na-letter". - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="pwgMediaForPPD">pwgMediaForPPD</a></h3> -<p class="description">Find a PWG media size by Adobe PPD name.</p> -<p class="code"> -<a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForPPD (<br> - const char *ppd<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ppd</dt> -<dd class="description">PPD size name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Matching size or NULL</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The "ppd" argument specifies an Adobe page size name as defined in Table B.1 -of the Adobe PostScript Printer Description File Format Specification Version -4.3.<br> -<br> -If the name is non-standard, the returned PWG media size is stored in -thread-local storage and is overwritten by each call to the function in the -thread. Custom names can be of the form "Custom.WIDTHxLENGTH[units]" or -"WIDTHxLENGTH[units]". - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="pwgMediaForPWG">pwgMediaForPWG</a></h3> -<p class="description">Find a PWG media size by 5101.1 self-describing name.</p> -<p class="code"> -<a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForPWG (<br> - const char *pwg<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>pwg</dt> -<dd class="description">PWG size name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Matching size or NULL</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The "pwg" argument specifies a self-describing media size name of the form -"prefix_name_WIDTHxLENGTHunits" as defined in PWG 5101.1.<br> -<br> -If the name is non-standard, the returned PWG media size is stored in -thread-local storage and is overwritten by each call to the function in the -thread. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="pwgMediaForSize">pwgMediaForSize</a></h3> -<p class="description">Get the PWG media size for the given dimensions.</p> -<p class="code"> -<a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForSize (<br> - int width,<br> - int length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>width</dt> -<dd class="description">Width in hundredths of millimeters</dd> -<dt>length</dt> -<dd class="description">Length in hundredths of millimeters</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">PWG media name</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The "width" and "length" are in hundredths of millimeters, equivalent to -1/100000th of a meter or 1/2540th of an inch.<br> -<br> -If the dimensions are non-standard, the returned PWG media size is stored in -thread-local storage and is overwritten by each call to the function in the -thread. - -</p> -<h2 class="title"><a name="TYPES">Data Types</a></h2> -<h3 class="typedef"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="cups_client_cert_cb_t">cups_client_cert_cb_t</a></h3> -<p class="description">Client credentials callback -</p> -<p class="code"> -typedef int (*cups_client_cert_cb_t)(http_t *http, void *tls, cups_array_t *distinguished_names, void *user_data); -</p> -<h3 class="typedef"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cups_dest_block_t">cups_dest_block_t</a></h3> -<p class="description">Destination enumeration block -</p> -<p class="code"> -typedef int (*cups_dest_block_t(unsigned flags, <a href="#cups_dest_t">cups_dest_t</a> *dest); -</p> -<h3 class="typedef"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cups_dest_cb_t">cups_dest_cb_t</a></h3> -<p class="description">Destination enumeration callback -</p> -<p class="code"> -typedef int (*cups_dest_cb_t)(void *user_data, unsigned flags, <a href="#cups_dest_t">cups_dest_t</a> *dest); -</p> -<h3 class="typedef"><a name="cups_dest_t">cups_dest_t</a></h3> -<p class="description">Destination</p> -<p class="code"> -typedef struct <a href="#cups_dest_s">cups_dest_s</a> cups_dest_t; -</p> -<h3 class="typedef"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cups_dinfo_t">cups_dinfo_t</a></h3> -<p class="description">Destination capability and status -information </p> -<p class="code"> -typedef struct _cups_dinfo_s cups_dinfo_t; -</p> -<h3 class="typedef"><a name="cups_job_t">cups_job_t</a></h3> -<p class="description">Job</p> -<p class="code"> -typedef struct <a href="#cups_job_s">cups_job_s</a> cups_job_t; -</p> -<h3 class="typedef"><a name="cups_option_t">cups_option_t</a></h3> -<p class="description">Printer Options</p> -<p class="code"> -typedef struct <a href="#cups_option_s">cups_option_s</a> cups_option_t; -</p> -<h3 class="typedef"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cups_password_cb2_t">cups_password_cb2_t</a></h3> -<p class="description">New password callback -</p> -<p class="code"> -typedef const char *(*cups_password_cb2_t)(const char *prompt, http_t *http, const char *method, const char *resource, void *user_data); -</p> -<h3 class="typedef"><a name="cups_password_cb_t">cups_password_cb_t</a></h3> -<p class="description">Password callback</p> -<p class="code"> -typedef const char *(*cups_password_cb_t)(const char *prompt); -</p> -<h3 class="typedef"><a name="cups_ptype_t">cups_ptype_t</a></h3> -<p class="description">Printer type/capability bits</p> -<p class="code"> -typedef unsigned cups_ptype_t; -</p> -<h3 class="typedef"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="cups_server_cert_cb_t">cups_server_cert_cb_t</a></h3> -<p class="description">Server credentials callback -</p> -<p class="code"> -typedef int (*cups_server_cert_cb_t)(http_t *http, void *tls, cups_array_t *certs, void *user_data); -</p> -<h3 class="typedef"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cups_size_t">cups_size_t</a></h3> -<p class="description">Media Size </p> -<p class="code"> -typedef struct <a href="#cups_size_s">cups_size_s</a> cups_size_t; -</p> -<h3 class="typedef"><a name="pwg_map_t">pwg_map_t</a></h3> -<p class="description">Map element - PPD to/from PWG</p> -<p class="code"> -typedef struct <a href="#pwg_map_s">pwg_map_s</a> pwg_map_t; -</p> -<h3 class="typedef"><a name="pwg_media_t">pwg_media_t</a></h3> -<p class="description">Common media size data</p> -<p class="code"> -typedef struct <a href="#pwg_media_s">pwg_media_s</a> pwg_media_t; -</p> -<h3 class="typedef"><a name="pwg_size_t">pwg_size_t</a></h3> -<p class="description">Size element - PPD to/from PWG</p> -<p class="code"> -typedef struct <a href="#pwg_size_s">pwg_size_s</a> pwg_size_t; -</p> -<h2 class="title"><a name="STRUCTURES">Structures</a></h2> -<h3 class="struct"><a name="cups_dest_s">cups_dest_s</a></h3> -<p class="description">Destination</p> -<p class="code">struct cups_dest_s {<br> - char *name, *instance;<br> - int is_default;<br> - int num_options;<br> - <a href="#cups_option_t">cups_option_t</a> *options;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>instance </dt> -<dd class="description">Local instance name or NULL</dd> -<dt>is_default </dt> -<dd class="description">Is this printer the default?</dd> -<dt>num_options </dt> -<dd class="description">Number of options</dd> -<dt>options </dt> -<dd class="description">Options</dd> -</dl> -<h3 class="struct"><a name="cups_job_s">cups_job_s</a></h3> -<p class="description">Job</p> -<p class="code">struct cups_job_s {<br> - time_t completed_time;<br> - time_t creation_time;<br> - char *dest;<br> - char *format;<br> - int id;<br> - int priority;<br> - time_t processing_time;<br> - int size;<br> - ipp_jstate_t state;<br> - char *title;<br> - char *user;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>completed_time </dt> -<dd class="description">Time the job was completed</dd> -<dt>creation_time </dt> -<dd class="description">Time the job was created</dd> -<dt>dest </dt> -<dd class="description">Printer or class name</dd> -<dt>format </dt> -<dd class="description">Document format</dd> -<dt>id </dt> -<dd class="description">The job ID</dd> -<dt>priority </dt> -<dd class="description">Priority (1-100)</dd> -<dt>processing_time </dt> -<dd class="description">Time the job was processed</dd> -<dt>size </dt> -<dd class="description">Size in kilobytes</dd> -<dt>state </dt> -<dd class="description">Job state</dd> -<dt>title </dt> -<dd class="description">Title/job name</dd> -<dt>user </dt> -<dd class="description">User the submitted the job</dd> -</dl> -<h3 class="struct"><a name="cups_option_s">cups_option_s</a></h3> -<p class="description">Printer Options</p> -<p class="code">struct cups_option_s {<br> - char *name;<br> - char *value;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>name </dt> -<dd class="description">Name of option</dd> -<dt>value </dt> -<dd class="description">Value of option</dd> -</dl> -<h3 class="struct"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="cups_size_s">cups_size_s</a></h3> -<p class="description">Media Size </p> -<p class="code">struct cups_size_s {<br> - char media[128];<br> - int width, length, bottom, left, right, top;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>media[128] </dt> -<dd class="description">Media name to use</dd> -<dt>top </dt> -<dd class="description">Top margin in hundredths of -millimeters</dd> -</dl> -<h3 class="struct"><a name="pollfd">pollfd</a></h3> -<p class="description">User data (unused)</p> -<p class="code">struct pollfd *pollfds, unsigned int num_pollfds, int timeout, void *context) {<br> - _cups_dnssd_data_t *data;<br> - else if(val 0) data - got_data;<br> - void) timeout;<br> - int val;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>data </dt> -<dd class="description">Enumeration data</dd> -<dt>got_data </dt> -<dt>timeout </dt> -<dt>val </dt> -<dd class="description">Return value</dd> -</dl> -<h3 class="struct"><a name="pwg_map_s">pwg_map_s</a></h3> -<p class="description">Map element - PPD to/from PWG</p> -<p class="code">struct pwg_map_s {<br> - char *pwg, *ppd;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>ppd </dt> -<dd class="description">PPD option keyword</dd> -</dl> -<h3 class="struct"><a name="pwg_media_s">pwg_media_s</a></h3> -<p class="description">Common media size data</p> -<p class="code">struct pwg_media_s {<br> - int width, length;<br> - const char *pwg, *legacy, *ppd;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>length </dt> -<dd class="description">Length in 2540ths</dd> -<dt>ppd </dt> -<dd class="description">Standard Adobe PPD name</dd> -</dl> -<h3 class="struct"><a name="pwg_size_s">pwg_size_s</a></h3> -<p class="description">Size element - PPD to/from PWG</p> -<p class="code">struct pwg_size_s {<br> - <a href="#pwg_map_t">pwg_map_t</a> map;<br> - int width, length, left, bottom, right, top;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>map </dt> -<dd class="description">Map element</dd> -<dt>top </dt> -<dd class="description">Top margin in 2540ths</dd> -</dl> -<h2 class="title"><a name="VARIABLES">Variables</a></h2> -<h3 class="variable"><a name="CF_RETURNS_RETAINED">CF_RETURNS_RETAINED</a></h3> -<p class="description">Get the Apple language identifier associated with a -locale ID.</p> -<p class="code">const char *locale) CF_RETURNS_RETAINED;</p> -<h2 class="title"><a name="ENUMERATIONS">Constants</a></h2> -<h3 class="enumeration"><a name="cups_ptype_e">cups_ptype_e</a></h3> -<p class="description">Printer type/capability bit -constants</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_PRINTER_AUTHENTICATED <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Printer requires authentication -</dd> -<dt>CUPS_PRINTER_BIND </dt> -<dd class="description">Can bind output</dd> -<dt>CUPS_PRINTER_BW </dt> -<dd class="description">Can do B&W printing</dd> -<dt>CUPS_PRINTER_CLASS </dt> -<dd class="description">Printer class</dd> -<dt>CUPS_PRINTER_COLLATE </dt> -<dd class="description">Can collage copies</dd> -<dt>CUPS_PRINTER_COLOR </dt> -<dd class="description">Can do color printing</dd> -<dt>CUPS_PRINTER_COMMANDS <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Printer supports maintenance commands -</dd> -<dt>CUPS_PRINTER_COPIES </dt> -<dd class="description">Can do copies</dd> -<dt>CUPS_PRINTER_COVER </dt> -<dd class="description">Can cover output</dd> -<dt>CUPS_PRINTER_DEFAULT </dt> -<dd class="description">Default printer on network</dd> -<dt>CUPS_PRINTER_DELETE <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Delete printer -</dd> -<dt>CUPS_PRINTER_DUPLEX </dt> -<dd class="description">Can do duplexing</dd> -<dt>CUPS_PRINTER_FAX </dt> -<dd class="description">Fax queue</dd> -<dt>CUPS_PRINTER_LARGE </dt> -<dd class="description">Can do D/E/A1/A0</dd> -<dt>CUPS_PRINTER_LOCAL </dt> -<dd class="description">Local printer or class</dd> -<dt>CUPS_PRINTER_MEDIUM </dt> -<dd class="description">Can do Tabloid/B/C/A3/A2</dd> -<dt>CUPS_PRINTER_MFP <span class="info"> CUPS 1.4/macOS 10.6 </span></dt> -<dd class="description">Printer with scanning capabilities -</dd> -<dt>CUPS_PRINTER_NOT_SHARED <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Printer is not shared -</dd> -<dt>CUPS_PRINTER_PUNCH </dt> -<dd class="description">Can punch output</dd> -<dt>CUPS_PRINTER_REJECTING </dt> -<dd class="description">Printer is rejecting jobs</dd> -<dt>CUPS_PRINTER_REMOTE </dt> -<dd class="description">Remote printer or class</dd> -<dt>CUPS_PRINTER_SCANNER <span class="info"> CUPS 1.4/macOS 10.6 </span></dt> -<dd class="description">Scanner-only device -</dd> -<dt>CUPS_PRINTER_SMALL </dt> -<dd class="description">Can do Letter/Legal/A4</dd> -<dt>CUPS_PRINTER_SORT </dt> -<dd class="description">Can sort output</dd> -<dt>CUPS_PRINTER_STAPLE </dt> -<dd class="description">Can staple output</dd> -<dt>CUPS_PRINTER_VARIABLE </dt> -<dd class="description">Can do variable sizes</dd> -</dl> -</div> -</body> -</html> diff --git a/doc/help/api-filedir.html b/doc/help/api-filedir.html deleted file mode 100644 index d193729..0000000 --- a/doc/help/api-filedir.html +++ /dev/null @@ -1,1003 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- SECTION: Programming --> -<head> - <title>File and Directory APIs </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<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 { - border: dotted thin #7f7f7f; - margin-left: 36pt; - padding: 10px; -} - -P.compact { - margin: 0; -} - -P.example { - font-style: italic; - margin-left: 36pt; -} - -DL.man DD { - margin-left: 5em; -} - -DL.man DT { - margin-left: 0; -} - -PRE.man { - margin: 0; -} - -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: inherit; - 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'> -<!-- - File and Directory API header for CUPS. - - Copyright 2008-2011 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'>File and Directory APIs</h1> - -<div class='summary'><table summary='General Information'> -<thead> -<tr> - <th>Headers</th> - <th>cups/file.h<br> - cups/dir.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></td> -</tr> -</tbody> -</table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#OVERVIEW">Overview</a></li> -<li><a href="#FUNCTIONS">Functions</a><ul class="code"> - <li><a href="#cupsDirClose" title="Close a directory.">cupsDirClose</a></li> - <li><a href="#cupsDirOpen" title="Open a directory.">cupsDirOpen</a></li> - <li><a href="#cupsDirRead" title="Read the next directory entry.">cupsDirRead</a></li> - <li><a href="#cupsDirRewind" title="Rewind to the start of the directory.">cupsDirRewind</a></li> - <li><a href="#cupsFileClose" title="Close a CUPS file.">cupsFileClose</a></li> - <li><a href="#cupsFileCompression" title="Return whether a file is compressed.">cupsFileCompression</a></li> - <li><a href="#cupsFileEOF" title="Return the end-of-file status.">cupsFileEOF</a></li> - <li><a href="#cupsFileFind" title="Find a file using the specified path.">cupsFileFind</a></li> - <li><a href="#cupsFileFlush" title="Flush pending output.">cupsFileFlush</a></li> - <li><a href="#cupsFileGetChar" title="Get a single character from a file.">cupsFileGetChar</a></li> - <li><a href="#cupsFileGetConf" title="Get a line from a configuration file.">cupsFileGetConf</a></li> - <li><a href="#cupsFileGetLine" title="Get a CR and/or LF-terminated line that may -contain binary data.">cupsFileGetLine</a></li> - <li><a href="#cupsFileGets" title="Get a CR and/or LF-terminated line.">cupsFileGets</a></li> - <li><a href="#cupsFileLock" title="Temporarily lock access to a file.">cupsFileLock</a></li> - <li><a href="#cupsFileNumber" title="Return the file descriptor associated with a CUPS file.">cupsFileNumber</a></li> - <li><a href="#cupsFileOpen" title="Open a CUPS file.">cupsFileOpen</a></li> - <li><a href="#cupsFileOpenFd" title="Open a CUPS file using a file descriptor.">cupsFileOpenFd</a></li> - <li><a href="#cupsFilePeekChar" title="Peek at the next character from a file.">cupsFilePeekChar</a></li> - <li><a href="#cupsFilePrintf" title="Write a formatted string.">cupsFilePrintf</a></li> - <li><a href="#cupsFilePutChar" title="Write a character.">cupsFilePutChar</a></li> - <li><a href="#cupsFilePutConf" title="Write a configuration line.">cupsFilePutConf</a></li> - <li><a href="#cupsFilePuts" title="Write a string.">cupsFilePuts</a></li> - <li><a href="#cupsFileRead" title="Read from a file.">cupsFileRead</a></li> - <li><a href="#cupsFileRewind" title="Set the current file position to the beginning of the -file.">cupsFileRewind</a></li> - <li><a href="#cupsFileSeek" title="Seek in a file.">cupsFileSeek</a></li> - <li><a href="#cupsFileStderr" title="Return a CUPS file associated with stderr.">cupsFileStderr</a></li> - <li><a href="#cupsFileStdin" title="Return a CUPS file associated with stdin.">cupsFileStdin</a></li> - <li><a href="#cupsFileStdout" title="Return a CUPS file associated with stdout.">cupsFileStdout</a></li> - <li><a href="#cupsFileTell" title="Return the current file position.">cupsFileTell</a></li> - <li><a href="#cupsFileUnlock" title="Unlock access to a file.">cupsFileUnlock</a></li> - <li><a href="#cupsFileWrite" title="Write to a file.">cupsFileWrite</a></li> -</ul></li> -<li><a href="#TYPES">Data Types</a><ul class="code"> - <li><a href="#cups_dentry_t" title="Directory entry type">cups_dentry_t</a></li> - <li><a href="#cups_dir_t" title="Directory type">cups_dir_t</a></li> - <li><a href="#cups_file_t" title="CUPS file type">cups_file_t</a></li> -</ul></li> -<li><a href="#STRUCTURES">Structures</a><ul class="code"> - <li><a href="#cups_dentry_s" title="Directory entry type">cups_dentry_s</a></li> -</ul></li> -</ul> -<!-- - File and directory API introduction for CUPS. - - Copyright 2007-2011 by Apple Inc. - Copyright 1997-2005 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 file and directory APIs provide portable interfaces -for manipulating files and listing files and directories. Unlike -stdio <code>FILE</code> streams, the <code>cupsFile</code> functions -allow you to open more than 256 files at any given time. They -also manage the platform-specific details of locking, large file -support, line endings (CR, LF, or CR LF), and reading and writing -files using Flate ("gzip") compression. Finally, you can also -connect, read from, and write to network connections using the -<code>cupsFile</code> functions.</p> - -<p>The <code>cupsDir</code> functions manage the platform-specific -details of directory access/listing and provide a convenient way -to get both a list of files and the information (permissions, -size, timestamp, etc.) for each of those files.</p> -<h2 class="title"><a name="FUNCTIONS">Functions</a></h2> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsDirClose">cupsDirClose</a></h3> -<p class="description">Close a directory.</p> -<p class="code"> -void cupsDirClose (<br> - <a href="#cups_dir_t">cups_dir_t</a> *dp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dp</dt> -<dd class="description">Directory pointer</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsDirOpen">cupsDirOpen</a></h3> -<p class="description">Open a directory.</p> -<p class="code"> -<a href="#cups_dir_t">cups_dir_t</a> *cupsDirOpen (<br> - const char *directory<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>directory</dt> -<dd class="description">Directory name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Directory pointer or <code>NULL</code> if the directory could not be opened.</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsDirRead">cupsDirRead</a></h3> -<p class="description">Read the next directory entry.</p> -<p class="code"> -<a href="#cups_dentry_t">cups_dentry_t</a> *cupsDirRead (<br> - <a href="#cups_dir_t">cups_dir_t</a> *dp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dp</dt> -<dd class="description">Directory pointer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Directory entry or <code>NULL</code> when there are no more</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsDirRewind">cupsDirRewind</a></h3> -<p class="description">Rewind to the start of the directory.</p> -<p class="code"> -void cupsDirRewind (<br> - <a href="#cups_dir_t">cups_dir_t</a> *dp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dp</dt> -<dd class="description">Directory pointer</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileClose">cupsFileClose</a></h3> -<p class="description">Close a CUPS file.</p> -<p class="code"> -int cupsFileClose (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileCompression">cupsFileCompression</a></h3> -<p class="description">Return whether a file is compressed.</p> -<p class="code"> -int cupsFileCompression (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description"><code>CUPS_FILE_NONE</code> or <code>CUPS_FILE_GZIP</code></p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileEOF">cupsFileEOF</a></h3> -<p class="description">Return the end-of-file status.</p> -<p class="code"> -int cupsFileEOF (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 on end of file, 0 otherwise</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileFind">cupsFileFind</a></h3> -<p class="description">Find a file using the specified path.</p> -<p class="code"> -const char *cupsFileFind (<br> - const char *filename,<br> - const char *path,<br> - int executable,<br> - char *buffer,<br> - int bufsize<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>filename</dt> -<dd class="description">File to find</dd> -<dt>path</dt> -<dd class="description">Colon/semicolon-separated path</dd> -<dt>executable</dt> -<dd class="description">1 = executable files, 0 = any file/dir</dd> -<dt>buffer</dt> -<dd class="description">Filename buffer</dd> -<dt>bufsize</dt> -<dd class="description">Size of filename buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Full path to file or <code>NULL</code> if not found</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function allows the paths in the path string to be separated by -colons (UNIX standard) or semicolons (Windows standard) and stores the -result in the buffer supplied. If the file cannot be found in any of -the supplied paths, <code>NULL</code> is returned. A <code>NULL</code> path only -matches the current directory. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileFlush">cupsFileFlush</a></h3> -<p class="description">Flush pending output.</p> -<p class="code"> -int cupsFileFlush (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileGetChar">cupsFileGetChar</a></h3> -<p class="description">Get a single character from a file.</p> -<p class="code"> -int cupsFileGetChar (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Character or -1 on end of file</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileGetConf">cupsFileGetConf</a></h3> -<p class="description">Get a line from a configuration file.</p> -<p class="code"> -char *cupsFileGetConf (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - char *buf,<br> - size_t buflen,<br> - char **value,<br> - int *linenum<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>buf</dt> -<dd class="description">String buffer</dd> -<dt>buflen</dt> -<dd class="description">Size of string buffer</dd> -<dt>value</dt> -<dd class="description">Pointer to value</dd> -<dt>linenum</dt> -<dd class="description">Current line number</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Line read or <code>NULL</code> on end of file or error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileGetLine">cupsFileGetLine</a></h3> -<p class="description">Get a CR and/or LF-terminated line that may -contain binary data.</p> -<p class="code"> -size_t cupsFileGetLine (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - char *buf,<br> - size_t buflen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">File to read from</dd> -<dt>buf</dt> -<dd class="description">Buffer</dd> -<dt>buflen</dt> -<dd class="description">Size of buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes on line or 0 on end of file</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function differs from <a href="#cupsFileGets"><code>cupsFileGets</code></a> in that the trailing CR -and LF are preserved, as is any binary data on the line. The buffer is -nul-terminated, however you should use the returned length to determine -the number of bytes on the line. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileGets">cupsFileGets</a></h3> -<p class="description">Get a CR and/or LF-terminated line.</p> -<p class="code"> -char *cupsFileGets (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - char *buf,<br> - size_t buflen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>buf</dt> -<dd class="description">String buffer</dd> -<dt>buflen</dt> -<dd class="description">Size of string buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Line read or <code>NULL</code> on end of file or error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileLock">cupsFileLock</a></h3> -<p class="description">Temporarily lock access to a file.</p> -<p class="code"> -int cupsFileLock (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - int block<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>block</dt> -<dd class="description">1 to wait for the lock, 0 to fail right away</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileNumber">cupsFileNumber</a></h3> -<p class="description">Return the file descriptor associated with a CUPS file.</p> -<p class="code"> -int cupsFileNumber (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">File descriptor</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileOpen">cupsFileOpen</a></h3> -<p class="description">Open a CUPS file.</p> -<p class="code"> -<a href="#cups_file_t">cups_file_t</a> *cupsFileOpen (<br> - const char *filename,<br> - const char *mode<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>filename</dt> -<dd class="description">Name of file</dd> -<dt>mode</dt> -<dd class="description">Open mode</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">CUPS file or <code>NULL</code> if the file or socket cannot be opened</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The "mode" parameter can be "r" to read, "w" to write, overwriting any -existing file, "a" to append to an existing file or create a new file, -or "s" to open a socket connection.<br> -<br> -When opening for writing ("w"), an optional number from 1 to 9 can be -supplied which enables Flate compression of the file. Compression is -not supported for the "a" (append) mode.<br> -<br> -When opening a socket connection, the filename is a string of the form -"address:port" or "hostname:port". The socket will make an IPv4 or IPv6 -connection as needed, generally preferring IPv6 connections when there is -a choice. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileOpenFd">cupsFileOpenFd</a></h3> -<p class="description">Open a CUPS file using a file descriptor.</p> -<p class="code"> -<a href="#cups_file_t">cups_file_t</a> *cupsFileOpenFd (<br> - int fd,<br> - const char *mode<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fd</dt> -<dd class="description">File descriptor</dd> -<dt>mode</dt> -<dd class="description">Open mode</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">CUPS file or <code>NULL</code> if the file could not be opened</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The "mode" parameter can be "r" to read, "w" to write, "a" to append, -or "s" to treat the file descriptor as a bidirectional socket connection.<br> -<br> -When opening for writing ("w"), an optional number from 1 to 9 can be -supplied which enables Flate compression of the file. Compression is -not supported for the "a" (append) mode. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFilePeekChar">cupsFilePeekChar</a></h3> -<p class="description">Peek at the next character from a file.</p> -<p class="code"> -int cupsFilePeekChar (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Character or -1 on end of file</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFilePrintf">cupsFilePrintf</a></h3> -<p class="description">Write a formatted string.</p> -<p class="code"> -int cupsFilePrintf (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - const char *format,<br> - ...<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>format</dt> -<dd class="description">Printf-style format string</dd> -<dt>...</dt> -<dd class="description">Additional args as necessary</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes written or -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFilePutChar">cupsFilePutChar</a></h3> -<p class="description">Write a character.</p> -<p class="code"> -int cupsFilePutChar (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - int c<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>c</dt> -<dd class="description">Character to write</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsFilePutConf">cupsFilePutConf</a></h3> -<p class="description">Write a configuration line.</p> -<p class="code"> -ssize_t cupsFilePutConf (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - const char *directive,<br> - const char *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>directive</dt> -<dd class="description">Directive</dd> -<dt>value</dt> -<dd class="description">Value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes written or -1 on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function handles any comment escaping of the value. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFilePuts">cupsFilePuts</a></h3> -<p class="description">Write a string.</p> -<p class="code"> -int cupsFilePuts (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - const char *s<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>s</dt> -<dd class="description">String to write</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes written or -1 on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Like the <code>fputs</code> function, no newline is appended to the string. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileRead">cupsFileRead</a></h3> -<p class="description">Read from a file.</p> -<p class="code"> -ssize_t cupsFileRead (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - char *buf,<br> - size_t bytes<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>buf</dt> -<dd class="description">Buffer</dd> -<dt>bytes</dt> -<dd class="description">Number of bytes to read</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes read or -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileRewind">cupsFileRewind</a></h3> -<p class="description">Set the current file position to the beginning of the -file.</p> -<p class="code"> -off_t cupsFileRewind (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New file position or -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileSeek">cupsFileSeek</a></h3> -<p class="description">Seek in a file.</p> -<p class="code"> -off_t cupsFileSeek (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - off_t pos<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>pos</dt> -<dd class="description">Position in file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New file position or -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileStderr">cupsFileStderr</a></h3> -<p class="description">Return a CUPS file associated with stderr.</p> -<p class="code"> -<a href="#cups_file_t">cups_file_t</a> *cupsFileStderr (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">CUPS file</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileStdin">cupsFileStdin</a></h3> -<p class="description">Return a CUPS file associated with stdin.</p> -<p class="code"> -<a href="#cups_file_t">cups_file_t</a> *cupsFileStdin (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">CUPS file</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileStdout">cupsFileStdout</a></h3> -<p class="description">Return a CUPS file associated with stdout.</p> -<p class="code"> -<a href="#cups_file_t">cups_file_t</a> *cupsFileStdout (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">CUPS file</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileTell">cupsFileTell</a></h3> -<p class="description">Return the current file position.</p> -<p class="code"> -off_t cupsFileTell (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">File position</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileUnlock">cupsFileUnlock</a></h3> -<p class="description">Unlock access to a file.</p> -<p class="code"> -int cupsFileUnlock (<br> - <a href="#cups_file_t">cups_file_t</a> *fp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsFileWrite">cupsFileWrite</a></h3> -<p class="description">Write to a file.</p> -<p class="code"> -ssize_t cupsFileWrite (<br> - <a href="#cups_file_t">cups_file_t</a> *fp,<br> - const char *buf,<br> - size_t bytes<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fp</dt> -<dd class="description">CUPS file</dd> -<dt>buf</dt> -<dd class="description">Buffer</dd> -<dt>bytes</dt> -<dd class="description">Number of bytes to write</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes written or -1 on error</p> -<h2 class="title"><a name="TYPES">Data Types</a></h2> -<h3 class="typedef"><a name="cups_dentry_t">cups_dentry_t</a></h3> -<p class="description">Directory entry type</p> -<p class="code"> -typedef struct <a href="#cups_dentry_s">cups_dentry_s</a> cups_dentry_t; -</p> -<h3 class="typedef"><a name="cups_dir_t">cups_dir_t</a></h3> -<p class="description">Directory type</p> -<p class="code"> -typedef struct _cups_dir_s cups_dir_t; -</p> -<h3 class="typedef"><a name="cups_file_t">cups_file_t</a></h3> -<p class="description">CUPS file type</p> -<p class="code"> -typedef struct _cups_file_s cups_file_t; -</p> -<h2 class="title"><a name="STRUCTURES">Structures</a></h2> -<h3 class="struct"><a name="cups_dentry_s">cups_dentry_s</a></h3> -<p class="description">Directory entry type</p> -<p class="code">struct cups_dentry_s {<br> - struct stat fileinfo;<br> - char filename[260];<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>fileinfo </dt> -<dd class="description">File information</dd> -<dt>filename[260] </dt> -<dd class="description">File name</dd> -</dl> -</div> -</body> -</html> diff --git a/doc/help/api-filter.html b/doc/help/api-filter.html index 25e99da..94fec49 100644 --- a/doc/help/api-filter.html +++ b/doc/help/api-filter.html @@ -1,12 +1,15 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!doctype html> <html> <!-- SECTION: Programming --> -<head> - <title>Filter and Backend Programming </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<style type="text/css"><!-- + <head> + <title>Filter and Backend Programming</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="Mini-XML v2.11"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- BODY { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } @@ -349,9 +352,8 @@ div.contents ul.subcontents li { text-indent: -1em; } --></style> -</head> -<body> -<div class='body'> + </head> + <body> <!-- Filter and backend programming header for CUPS. @@ -392,51 +394,54 @@ div.contents ul.subcontents li { </tr> </tbody> </table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#OVERVIEW">Overview</a><ul class="subcontents"> - <li><a href="#SECURITY">Security Considerations</a></li> - <li><a href="#SIGNALS">Canceled Jobs and Signal Handling</a></li> - <li><a href="#PERMISSIONS">File Permissions</a></li> - <li><a href="#TEMPFILES">Temporary Files</a></li> - <li><a href="#COPIES">Copy Generation</a></li> - <li><a href="#EXITCODES">Exit Codes</a></li> - <li><a href="#ENVIRONMENT">Environment Variables</a></li> - <li><a href="#MESSAGES">Communicating with the Scheduler</a></li> - <li><a href="#COMMUNICATING_BACKEND">Communicating with the Backend</a></li> - <li><a href="#COMMUNICATING_FILTER">Communicating with Filters</a></li> - <li><a href="#SNMP">Doing SNMP Queries with Network Printers</a></li> -</ul></li> -<li><a href="#SANDBOXING">Sandboxing on macOS</a></li> -<li><a href="#FUNCTIONS">Functions</a><ul class="code"> - <li><a href="#cupsBackChannelRead" title="Read data from the backchannel.">cupsBackChannelRead</a></li> - <li><a href="#cupsBackChannelWrite" title="Write data to the backchannel.">cupsBackChannelWrite</a></li> - <li><a href="#cupsBackendDeviceURI" title="Get the device URI for a backend.">cupsBackendDeviceURI</a></li> - <li><a href="#cupsBackendReport" title="Write a device line from a backend.">cupsBackendReport</a></li> - <li><a href="#cupsSideChannelDoRequest" title="Send a side-channel command to a backend and wait for a response.">cupsSideChannelDoRequest</a></li> - <li><a href="#cupsSideChannelRead" title="Read a side-channel message.">cupsSideChannelRead</a></li> - <li><a href="#cupsSideChannelSNMPGet" title="Query a SNMP OID's value.">cupsSideChannelSNMPGet</a></li> - <li><a href="#cupsSideChannelSNMPWalk" title="Query multiple SNMP OID values.">cupsSideChannelSNMPWalk</a></li> - <li><a href="#cupsSideChannelWrite" title="Write a side-channel message.">cupsSideChannelWrite</a></li> -</ul></li> -<li><a href="#TYPES">Data Types</a><ul class="code"> - <li><a href="#cups_backend_t" title="Backend exit codes">cups_backend_t</a></li> - <li><a href="#cups_sc_bidi_t" title="Bidirectional capabilities">cups_sc_bidi_t</a></li> - <li><a href="#cups_sc_command_t" title="Request command codes">cups_sc_command_t</a></li> - <li><a href="#cups_sc_connected_t" title="Connectivity values">cups_sc_connected_t</a></li> - <li><a href="#cups_sc_state_t" title="Printer state bits">cups_sc_state_t</a></li> - <li><a href="#cups_sc_status_t" title="Response status codes">cups_sc_status_t</a></li> - <li><a href="#cups_sc_walk_func_t" title="SNMP walk callback">cups_sc_walk_func_t</a></li> -</ul></li> -<li><a href="#ENUMERATIONS">Constants</a><ul class="code"> - <li><a href="#cups_backend_e" title="Backend exit codes">cups_backend_e</a></li> - <li><a href="#cups_sc_bidi_e" title="Bidirectional capability values">cups_sc_bidi_e</a></li> - <li><a href="#cups_sc_command_e" title="Request command codes">cups_sc_command_e</a></li> - <li><a href="#cups_sc_connected_e" title="Connectivity values">cups_sc_connected_e</a></li> - <li><a href="#cups_sc_state_e" title="Printer state bits">cups_sc_state_e</a></li> - <li><a href="#cups_sc_status_e" title="Response status codes">cups_sc_status_e</a></li> -</ul></li> -</ul> + <div class="contents"> + <h2 class="title">Contents</h2> + <ul class="contents"> + <li><a href="#OVERVIEW">Overview</a><ul class="subcontents"> + <li><a href="#SECURITY">Security Considerations</a></li> + <li><a href="#SIGNALS">Canceled Jobs and Signal Handling</a></li> + <li><a href="#PERMISSIONS">File Permissions</a></li> + <li><a href="#TEMPFILES">Temporary Files</a></li> + <li><a href="#COPIES">Copy Generation</a></li> + <li><a href="#EXITCODES">Exit Codes</a></li> + <li><a href="#ENVIRONMENT">Environment Variables</a></li> + <li><a href="#MESSAGES">Communicating with the Scheduler</a></li> + <li><a href="#COMMUNICATING_BACKEND">Communicating with the Backend</a></li> + <li><a href="#COMMUNICATING_FILTER">Communicating with Filters</a></li> + <li><a href="#SNMP">Doing SNMP Queries with Network Printers</a></li> + </ul></li> + <li><a href="#SANDBOXING">Sandboxing on macOS</a></li> + <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents"> + <li><a href="#cupsBackChannelRead">cupsBackChannelRead</a></li> + <li><a href="#cupsBackChannelWrite">cupsBackChannelWrite</a></li> + <li><a href="#cupsBackendDeviceURI">cupsBackendDeviceURI</a></li> + <li><a href="#cupsBackendReport">cupsBackendReport</a></li> + <li><a href="#cupsSideChannelDoRequest">cupsSideChannelDoRequest</a></li> + <li><a href="#cupsSideChannelRead">cupsSideChannelRead</a></li> + <li><a href="#cupsSideChannelSNMPGet">cupsSideChannelSNMPGet</a></li> + <li><a href="#cupsSideChannelSNMPWalk">cupsSideChannelSNMPWalk</a></li> + <li><a href="#cupsSideChannelWrite">cupsSideChannelWrite</a></li> + </ul></li> + <li><a href="#TYPES">Data Types</a><ul class="subcontents"> + <li><a href="#cups_backend_t">cups_backend_t</a></li> + <li><a href="#cups_sc_bidi_t">cups_sc_bidi_t</a></li> + <li><a href="#cups_sc_command_t">cups_sc_command_t</a></li> + <li><a href="#cups_sc_connected_t">cups_sc_connected_t</a></li> + <li><a href="#cups_sc_state_t">cups_sc_state_t</a></li> + <li><a href="#cups_sc_status_t">cups_sc_status_t</a></li> + <li><a href="#cups_sc_walk_func_t">cups_sc_walk_func_t</a></li> + </ul></li> + <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> + <li><a href="#cups_backend_e">cups_backend_e</a></li> + <li><a href="#cups_sc_bidi_e">cups_sc_bidi_e</a></li> + <li><a href="#cups_sc_command_e">cups_sc_command_e</a></li> + <li><a href="#cups_sc_connected_e">cups_sc_connected_e</a></li> + <li><a href="#cups_sc_state_e">cups_sc_state_e</a></li> + <li><a href="#cups_sc_status_e">cups_sc_status_e</a></li> + </ul></li> + </ul> + </div> + <div class="body"> <!-- Filter and backend programming introduction for CUPS. @@ -1311,134 +1316,112 @@ void *my_data; </ol> <blockquote><b>Note:</b> The sandbox profile used in CUPS 2.0 still allows some actions that are not listed above - these privileges will be removed over time until the profile matches the list above.</blockquote> -<h2 class="title"><a name="FUNCTIONS">Functions</a></h2> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsBackChannelRead">cupsBackChannelRead</a></h3> -<p class="description">Read data from the backchannel.</p> + <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsBackChannelRead">cupsBackChannelRead</a></h3> + <p class="description">Read data from the backchannel.</p> <p class="code"> -ssize_t cupsBackChannelRead (<br> - char *buffer,<br> - size_t bytes,<br> - double timeout<br> -);</p> +ssize_t cupsBackChannelRead(char *buffer, size_t bytes, double timeout);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>buffer</dt> -<dd class="description">Buffer to read into</dd> -<dt>bytes</dt> -<dd class="description">Bytes to read</dd> -<dt>timeout</dt> -<dd class="description">Timeout in seconds, typically 0.0 to poll</dd> -</dl> +<table class="list"><tbody> +<tr><th>buffer</th> + <td class="description">Buffer to read into</td></tr> +<tr><th>bytes</th> + <td class="description">Bytes to read</td></tr> +<tr><th>timeout</th> + <td class="description">Timeout in seconds, typically 0.0 to poll</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Bytes read or -1 on error</p> + <p class="description">Bytes read or -1 on error</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">Reads up to "bytes" bytes from the backchannel/backend. The "timeout" + <p class="discussion">Reads up to "bytes" bytes from the backchannel/backend. The "timeout" parameter controls how many seconds to wait for the data - use 0.0 to return immediately if there is no data, -1.0 to wait for data indefinitely. </p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsBackChannelWrite">cupsBackChannelWrite</a></h3> -<p class="description">Write data to the backchannel.</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsBackChannelWrite">cupsBackChannelWrite</a></h3> + <p class="description">Write data to the backchannel.</p> <p class="code"> -ssize_t cupsBackChannelWrite (<br> - const char *buffer,<br> - size_t bytes,<br> - double timeout<br> -);</p> +ssize_t cupsBackChannelWrite(const char *buffer, size_t bytes, double timeout);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>buffer</dt> -<dd class="description">Buffer to write</dd> -<dt>bytes</dt> -<dd class="description">Bytes to write</dd> -<dt>timeout</dt> -<dd class="description">Timeout in seconds, typically 1.0</dd> -</dl> +<table class="list"><tbody> +<tr><th>buffer</th> + <td class="description">Buffer to write</td></tr> +<tr><th>bytes</th> + <td class="description">Bytes to write</td></tr> +<tr><th>timeout</th> + <td class="description">Timeout in seconds, typically 1.0</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Bytes written or -1 on error</p> + <p class="description">Bytes written or -1 on error</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">Writes "bytes" bytes to the backchannel/filter. The "timeout" parameter + <p class="discussion">Writes "bytes" bytes to the backchannel/filter. The "timeout" parameter controls how many seconds to wait for the data to be written - use 0.0 to return immediately if the data cannot be written, -1.0 to wait indefinitely. </p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsBackendDeviceURI">cupsBackendDeviceURI</a></h3> -<p class="description">Get the device URI for a backend.</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsBackendDeviceURI">cupsBackendDeviceURI</a></h3> + <p class="description">Get the device URI for a backend.</p> <p class="code"> -const char *cupsBackendDeviceURI (<br> - char **argv<br> -);</p> +const char *cupsBackendDeviceURI(char **argv);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>argv</dt> -<dd class="description">Command-line arguments</dd> -</dl> +<table class="list"><tbody> +<tr><th>argv</th> + <td class="description">Command-line arguments</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Device URI or <code>NULL</code></p> + <p class="description">Device URI or <code>NULL</code></p> <h4 class="discussion">Discussion</h4> -<p class="discussion">The "argv" argument is the argv argument passed to main(). This + <p class="discussion">The "argv" argument is the argv argument passed to main(). This function returns the device URI passed in the DEVICE_URI environment variable or the device URI passed in argv[0], whichever is found first. </p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsBackendReport">cupsBackendReport</a></h3> -<p class="description">Write a device line from a backend.</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsBackendReport">cupsBackendReport</a></h3> + <p class="description">Write a device line from a backend.</p> <p class="code"> -void cupsBackendReport (<br> - const char *device_scheme,<br> - const char *device_uri,<br> - const char *device_make_and_model,<br> - const char *device_info,<br> - const char *device_id,<br> - const char *device_location<br> -);</p> +void cupsBackendReport(const char *device_scheme, const char *device_uri, const char *device_make_and_model, const char *device_info, const char *device_id, const char *device_location);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>device_scheme</dt> -<dd class="description">device-scheme string</dd> -<dt>device_uri</dt> -<dd class="description">device-uri string</dd> -<dt>device_make_and_model</dt> -<dd class="description">device-make-and-model string or <code>NULL</code></dd> -<dt>device_info</dt> -<dd class="description">device-info string or <code>NULL</code></dd> -<dt>device_id</dt> -<dd class="description">device-id string or <code>NULL</code></dd> -<dt>device_location</dt> -<dd class="description">device-location string or <code>NULL</code></dd> -</dl> +<table class="list"><tbody> +<tr><th>device_scheme</th> + <td class="description">device-scheme string</td></tr> +<tr><th>device_uri</th> + <td class="description">device-uri string</td></tr> +<tr><th>device_make_and_model</th> + <td class="description">device-make-and-model string or <code>NULL</code></td></tr> +<tr><th>device_info</th> + <td class="description">device-info string or <code>NULL</code></td></tr> +<tr><th>device_id</th> + <td class="description">device-id string or <code>NULL</code></td></tr> +<tr><th>device_location</th> + <td class="description">device-location string or <code>NULL</code></td></tr> +</tbody></table> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function writes a single device line to stdout for a backend. + <p class="discussion">This function writes a single device line to stdout for a backend. It handles quoting of special characters in the device-make-and-model, device-info, device-id, and device-location strings. </p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsSideChannelDoRequest">cupsSideChannelDoRequest</a></h3> -<p class="description">Send a side-channel command to a backend and wait for a response.</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsSideChannelDoRequest">cupsSideChannelDoRequest</a></h3> + <p class="description">Send a side-channel command to a backend and wait for a response.</p> <p class="code"> -<a href="#cups_sc_status_t">cups_sc_status_t</a> cupsSideChannelDoRequest (<br> - <a href="#cups_sc_command_t">cups_sc_command_t</a> command,<br> - char *data,<br> - int *datalen,<br> - double timeout<br> -);</p> +<a href="#cups_sc_status_t">cups_sc_status_t</a> cupsSideChannelDoRequest(<a href="#cups_sc_command_t">cups_sc_command_t</a> command, char *data, int *datalen, double timeout);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>command</dt> -<dd class="description">Command to send</dd> -<dt>data</dt> -<dd class="description">Response data buffer pointer</dd> -<dt>datalen</dt> -<dd class="description">Size of data buffer on entry, number of bytes in buffer on return</dd> -<dt>timeout</dt> -<dd class="description">Timeout in seconds</dd> -</dl> +<table class="list"><tbody> +<tr><th>command</th> + <td class="description">Command to send</td></tr> +<tr><th>data</th> + <td class="description">Response data buffer pointer</td></tr> +<tr><th>datalen</th> + <td class="description">Size of data buffer on entry, number of bytes in buffer on return</td></tr> +<tr><th>timeout</th> + <td class="description">Timeout in seconds</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Status of command</p> + <p class="description">Status of command</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function is normally only called by filters, drivers, or port + <p class="discussion">This function is normally only called by filters, drivers, or port monitors in order to communicate with the backend used by the current printer. Programs must be prepared to handle timeout or "not implemented" status codes, which indicate that the backend or device @@ -1449,33 +1432,27 @@ pointed to by the "data" parameter. cupsSideChannelDoRequest() will update the value to contain the number of data bytes in the buffer. </p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsSideChannelRead">cupsSideChannelRead</a></h3> -<p class="description">Read a side-channel message.</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsSideChannelRead">cupsSideChannelRead</a></h3> + <p class="description">Read a side-channel message.</p> <p class="code"> -int cupsSideChannelRead (<br> - <a href="#cups_sc_command_t">cups_sc_command_t</a> *command,<br> - <a href="#cups_sc_status_t">cups_sc_status_t</a> *status,<br> - char *data,<br> - int *datalen,<br> - double timeout<br> -);</p> +int cupsSideChannelRead(<a href="#cups_sc_command_t">cups_sc_command_t</a> *command, <a href="#cups_sc_status_t">cups_sc_status_t</a> *status, char *data, int *datalen, double timeout);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>command</dt> -<dd class="description">Command code</dd> -<dt>status</dt> -<dd class="description">Status code</dd> -<dt>data</dt> -<dd class="description">Data buffer pointer</dd> -<dt>datalen</dt> -<dd class="description">Size of data buffer on entry, number of bytes in buffer on return</dd> -<dt>timeout</dt> -<dd class="description">Timeout in seconds</dd> -</dl> +<table class="list"><tbody> +<tr><th>command</th> + <td class="description">Command code</td></tr> +<tr><th>status</th> + <td class="description">Status code</td></tr> +<tr><th>data</th> + <td class="description">Data buffer pointer</td></tr> +<tr><th>datalen</th> + <td class="description">Size of data buffer on entry, number of bytes in buffer on return</td></tr> +<tr><th>timeout</th> + <td class="description">Timeout in seconds</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on error</p> + <p class="description">0 on success, -1 on error</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function is normally only called by backend programs to read + <p class="discussion">This function is normally only called by backend programs to read commands from a filter, driver, or port monitor program. The caller must be prepared to handle incomplete or invalid messages and return the corresponding status codes.<br> @@ -1485,30 +1462,25 @@ pointed to by the "data" parameter. cupsSideChannelDoRequest() will update the value to contain the number of data bytes in the buffer. </p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsSideChannelSNMPGet">cupsSideChannelSNMPGet</a></h3> -<p class="description">Query a SNMP OID's value.</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsSideChannelSNMPGet">cupsSideChannelSNMPGet</a></h3> + <p class="description">Query a SNMP OID's value.</p> <p class="code"> -<a href="#cups_sc_status_t">cups_sc_status_t</a> cupsSideChannelSNMPGet (<br> - const char *oid,<br> - char *data,<br> - int *datalen,<br> - double timeout<br> -);</p> +<a href="#cups_sc_status_t">cups_sc_status_t</a> cupsSideChannelSNMPGet(const char *oid, char *data, int *datalen, double timeout);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>oid</dt> -<dd class="description">OID to query</dd> -<dt>data</dt> -<dd class="description">Buffer for OID value</dd> -<dt>datalen</dt> -<dd class="description">Size of OID buffer on entry, size of value on return</dd> -<dt>timeout</dt> -<dd class="description">Timeout in seconds</dd> -</dl> +<table class="list"><tbody> +<tr><th>oid</th> + <td class="description">OID to query</td></tr> +<tr><th>data</th> + <td class="description">Buffer for OID value</td></tr> +<tr><th>datalen</th> + <td class="description">Size of OID buffer on entry, size of value on return</td></tr> +<tr><th>timeout</th> + <td class="description">Timeout in seconds</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Query status</p> + <p class="description">Query status</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function asks the backend to do a SNMP OID query on behalf of the + <p class="discussion">This function asks the backend to do a SNMP OID query on behalf of the filter, port monitor, or backend using the default community name.<br> <br> "oid" contains a numeric OID consisting of integers separated by periods, @@ -1526,30 +1498,25 @@ support SNMP queries. <code>CUPS_SC_STATUS_NO_RESPONSE</code> is returned when the printer does not respond to the SNMP query. </p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsSideChannelSNMPWalk">cupsSideChannelSNMPWalk</a></h3> -<p class="description">Query multiple SNMP OID values.</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsSideChannelSNMPWalk">cupsSideChannelSNMPWalk</a></h3> + <p class="description">Query multiple SNMP OID values.</p> <p class="code"> -<a href="#cups_sc_status_t">cups_sc_status_t</a> cupsSideChannelSNMPWalk (<br> - const char *oid,<br> - double timeout,<br> - <a href="#cups_sc_walk_func_t">cups_sc_walk_func_t</a> cb,<br> - void *context<br> -);</p> +<a href="#cups_sc_status_t">cups_sc_status_t</a> cupsSideChannelSNMPWalk(const char *oid, double timeout, <a href="#cups_sc_walk_func_t">cups_sc_walk_func_t</a> cb, void *context);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>oid</dt> -<dd class="description">First numeric OID to query</dd> -<dt>timeout</dt> -<dd class="description">Timeout for each query in seconds</dd> -<dt>cb</dt> -<dd class="description">Function to call with each value</dd> -<dt>context</dt> -<dd class="description">Application-defined pointer to send to callback</dd> -</dl> +<table class="list"><tbody> +<tr><th>oid</th> + <td class="description">First numeric OID to query</td></tr> +<tr><th>timeout</th> + <td class="description">Timeout for each query in seconds</td></tr> +<tr><th>cb</th> + <td class="description">Function to call with each value</td></tr> +<tr><th>context</th> + <td class="description">Application-defined pointer to send to callback</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Status of first query of <code>CUPS_SC_STATUS_OK</code> on success</p> + <p class="description">Status of first query of <code>CUPS_SC_STATUS_OK</code> on success</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function asks the backend to do multiple SNMP OID queries on behalf + <p class="discussion">This function asks the backend to do multiple SNMP OID queries on behalf of the filter, port monitor, or backend using the default community name. All OIDs under the "parent" OID are queried and the results are sent to the callback function you provide.<br> @@ -1572,175 +1539,133 @@ support SNMP queries. <code>CUPS_SC_STATUS_NO_RESPONSE</code> is returned when the printer does not respond to the first SNMP query. </p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsSideChannelWrite">cupsSideChannelWrite</a></h3> -<p class="description">Write a side-channel message.</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsSideChannelWrite">cupsSideChannelWrite</a></h3> + <p class="description">Write a side-channel message.</p> <p class="code"> -int cupsSideChannelWrite (<br> - <a href="#cups_sc_command_t">cups_sc_command_t</a> command,<br> - <a href="#cups_sc_status_t">cups_sc_status_t</a> status,<br> - const char *data,<br> - int datalen,<br> - double timeout<br> -);</p> +int cupsSideChannelWrite(<a href="#cups_sc_command_t">cups_sc_command_t</a> command, <a href="#cups_sc_status_t">cups_sc_status_t</a> status, const char *data, int datalen, double timeout);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>command</dt> -<dd class="description">Command code</dd> -<dt>status</dt> -<dd class="description">Status code</dd> -<dt>data</dt> -<dd class="description">Data buffer pointer</dd> -<dt>datalen</dt> -<dd class="description">Number of bytes of data</dd> -<dt>timeout</dt> -<dd class="description">Timeout in seconds</dd> -</dl> +<table class="list"><tbody> +<tr><th>command</th> + <td class="description">Command code</td></tr> +<tr><th>status</th> + <td class="description">Status code</td></tr> +<tr><th>data</th> + <td class="description">Data buffer pointer</td></tr> +<tr><th>datalen</th> + <td class="description">Number of bytes of data</td></tr> +<tr><th>timeout</th> + <td class="description">Timeout in seconds</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on error</p> + <p class="description">0 on success, -1 on error</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function is normally only called by backend programs to send + <p class="discussion">This function is normally only called by backend programs to send responses to a filter, driver, or port monitor program. </p> -<h2 class="title"><a name="TYPES">Data Types</a></h2> -<h3 class="typedef"><a name="cups_backend_t">cups_backend_t</a></h3> -<p class="description">Backend exit codes</p> -<p class="code"> + <h2 class="title"><a id="TYPES">Data Types</a></h2> + <h3 class="typedef"><a id="cups_backend_t">cups_backend_t</a></h3> + <p class="description">Backend exit codes</p> + <p class="code"> typedef enum <a href="#cups_backend_e">cups_backend_e</a> cups_backend_t; </p> -<h3 class="typedef"><a name="cups_sc_bidi_t">cups_sc_bidi_t</a></h3> -<p class="description">Bidirectional capabilities</p> -<p class="code"> + <h3 class="typedef"><a id="cups_sc_bidi_t">cups_sc_bidi_t</a></h3> + <p class="description">Bidirectional capabilities</p> + <p class="code"> typedef enum <a href="#cups_sc_bidi_e">cups_sc_bidi_e</a> cups_sc_bidi_t; </p> -<h3 class="typedef"><a name="cups_sc_command_t">cups_sc_command_t</a></h3> -<p class="description">Request command codes</p> -<p class="code"> + <h3 class="typedef"><a id="cups_sc_command_t">cups_sc_command_t</a></h3> + <p class="description">Request command codes</p> + <p class="code"> typedef enum <a href="#cups_sc_command_e">cups_sc_command_e</a> cups_sc_command_t; </p> -<h3 class="typedef"><a name="cups_sc_connected_t">cups_sc_connected_t</a></h3> -<p class="description">Connectivity values</p> -<p class="code"> + <h3 class="typedef"><a id="cups_sc_connected_t">cups_sc_connected_t</a></h3> + <p class="description">Connectivity values</p> + <p class="code"> typedef enum <a href="#cups_sc_connected_e">cups_sc_connected_e</a> cups_sc_connected_t; </p> -<h3 class="typedef"><a name="cups_sc_state_t">cups_sc_state_t</a></h3> -<p class="description">Printer state bits</p> -<p class="code"> + <h3 class="typedef"><a id="cups_sc_state_t">cups_sc_state_t</a></h3> + <p class="description">Printer state bits</p> + <p class="code"> typedef enum <a href="#cups_sc_state_e">cups_sc_state_e</a> cups_sc_state_t; </p> -<h3 class="typedef"><a name="cups_sc_status_t">cups_sc_status_t</a></h3> -<p class="description">Response status codes</p> -<p class="code"> + <h3 class="typedef"><a id="cups_sc_status_t">cups_sc_status_t</a></h3> + <p class="description">Response status codes</p> + <p class="code"> typedef enum <a href="#cups_sc_status_e">cups_sc_status_e</a> cups_sc_status_t; </p> -<h3 class="typedef"><a name="cups_sc_walk_func_t">cups_sc_walk_func_t</a></h3> -<p class="description">SNMP walk callback</p> -<p class="code"> + <h3 class="typedef"><a id="cups_sc_walk_func_t">cups_sc_walk_func_t</a></h3> + <p class="description">SNMP walk callback</p> + <p class="code"> typedef void (*cups_sc_walk_func_t)(const char *oid, const char *data, int datalen, void *context); </p> -<h2 class="title"><a name="ENUMERATIONS">Constants</a></h2> -<h3 class="enumeration"><a name="cups_backend_e">cups_backend_e</a></h3> -<p class="description">Backend exit codes</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_BACKEND_AUTH_REQUIRED </dt> -<dd class="description">Job failed, authentication required</dd> -<dt>CUPS_BACKEND_CANCEL </dt> -<dd class="description">Job failed, cancel job</dd> -<dt>CUPS_BACKEND_FAILED </dt> -<dd class="description">Job failed, use error-policy</dd> -<dt>CUPS_BACKEND_HOLD </dt> -<dd class="description">Job failed, hold job</dd> -<dt>CUPS_BACKEND_OK </dt> -<dd class="description">Job completed successfully</dd> -<dt>CUPS_BACKEND_RETRY </dt> -<dd class="description">Job failed, retry this job later</dd> -<dt>CUPS_BACKEND_RETRY_CURRENT </dt> -<dd class="description">Job failed, retry this job immediately</dd> -<dt>CUPS_BACKEND_STOP </dt> -<dd class="description">Job failed, stop queue</dd> -</dl> -<h3 class="enumeration"><a name="cups_sc_bidi_e">cups_sc_bidi_e</a></h3> -<p class="description">Bidirectional capability values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_SC_BIDI_NOT_SUPPORTED </dt> -<dd class="description">Bidirectional I/O is not supported</dd> -<dt>CUPS_SC_BIDI_SUPPORTED </dt> -<dd class="description">Bidirectional I/O is supported</dd> -</dl> -<h3 class="enumeration"><a name="cups_sc_command_e">cups_sc_command_e</a></h3> -<p class="description">Request command codes</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_SC_CMD_DRAIN_OUTPUT </dt> -<dd class="description">Drain all pending output</dd> -<dt>CUPS_SC_CMD_GET_BIDI </dt> -<dd class="description">Return bidirectional capabilities</dd> -<dt>CUPS_SC_CMD_GET_CONNECTED <span class="info"> CUPS 1.5/macOS 10.7 </span></dt> -<dd class="description">Return whether the backend is "connected" to the printer </dd> -<dt>CUPS_SC_CMD_GET_DEVICE_ID </dt> -<dd class="description">Return the IEEE-1284 device ID</dd> -<dt>CUPS_SC_CMD_GET_STATE </dt> -<dd class="description">Return the device state</dd> -<dt>CUPS_SC_CMD_SNMP_GET <span class="info"> CUPS 1.4/macOS 10.6 </span></dt> -<dd class="description">Query an SNMP OID </dd> -<dt>CUPS_SC_CMD_SNMP_GET_NEXT <span class="info"> CUPS 1.4/macOS 10.6 </span></dt> -<dd class="description">Query the next SNMP OID </dd> -<dt>CUPS_SC_CMD_SOFT_RESET </dt> -<dd class="description">Do a soft reset</dd> -</dl> -<h3 class="enumeration"><a name="cups_sc_connected_e">cups_sc_connected_e</a></h3> -<p class="description">Connectivity values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_SC_CONNECTED </dt> -<dd class="description">Backend is "connected" to printer</dd> -<dt>CUPS_SC_NOT_CONNECTED </dt> -<dd class="description">Backend is not "connected" to printer</dd> -</dl> -<h3 class="enumeration"><a name="cups_sc_state_e">cups_sc_state_e</a></h3> -<p class="description">Printer state bits</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_SC_STATE_BUSY </dt> -<dd class="description">Device is busy</dd> -<dt>CUPS_SC_STATE_ERROR </dt> -<dd class="description">Other error condition</dd> -<dt>CUPS_SC_STATE_MARKER_EMPTY </dt> -<dd class="description">Toner/ink out condition</dd> -<dt>CUPS_SC_STATE_MARKER_LOW </dt> -<dd class="description">Toner/ink low condition</dd> -<dt>CUPS_SC_STATE_MEDIA_EMPTY </dt> -<dd class="description">Paper out condition</dd> -<dt>CUPS_SC_STATE_MEDIA_LOW </dt> -<dd class="description">Paper low condition</dd> -<dt>CUPS_SC_STATE_OFFLINE </dt> -<dd class="description">Device is offline</dd> -<dt>CUPS_SC_STATE_ONLINE </dt> -<dd class="description">Device is online</dd> -</dl> -<h3 class="enumeration"><a name="cups_sc_status_e">cups_sc_status_e</a></h3> -<p class="description">Response status codes</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_SC_STATUS_BAD_MESSAGE </dt> -<dd class="description">The command/response message was invalid</dd> -<dt>CUPS_SC_STATUS_IO_ERROR </dt> -<dd class="description">An I/O error occurred</dd> -<dt>CUPS_SC_STATUS_NONE </dt> -<dd class="description">No status</dd> -<dt>CUPS_SC_STATUS_NOT_IMPLEMENTED </dt> -<dd class="description">Command not implemented</dd> -<dt>CUPS_SC_STATUS_NO_RESPONSE </dt> -<dd class="description">The device did not respond</dd> -<dt>CUPS_SC_STATUS_OK </dt> -<dd class="description">Operation succeeded</dd> -<dt>CUPS_SC_STATUS_TIMEOUT </dt> -<dd class="description">The backend did not respond</dd> -<dt>CUPS_SC_STATUS_TOO_BIG </dt> -<dd class="description">Response too big</dd> -</dl> -</div> -</body> + <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> + <h3 class="enumeration"><a id="cups_backend_e">cups_backend_e</a></h3> + <p class="description">Backend exit codes</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_BACKEND_AUTH_REQUIRED </th> <td class="description">Job failed, authentication required</td></tr> + <tr><th>CUPS_BACKEND_CANCEL </th> <td class="description">Job failed, cancel job</td></tr> + <tr><th>CUPS_BACKEND_FAILED </th> <td class="description">Job failed, use error-policy</td></tr> + <tr><th>CUPS_BACKEND_HOLD </th> <td class="description">Job failed, hold job</td></tr> + <tr><th>CUPS_BACKEND_OK </th> <td class="description">Job completed successfully</td></tr> + <tr><th>CUPS_BACKEND_RETRY </th> <td class="description">Job failed, retry this job later</td></tr> + <tr><th>CUPS_BACKEND_RETRY_CURRENT </th> <td class="description">Job failed, retry this job immediately</td></tr> + <tr><th>CUPS_BACKEND_STOP </th> <td class="description">Job failed, stop queue</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_sc_bidi_e">cups_sc_bidi_e</a></h3> + <p class="description">Bidirectional capability values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_SC_BIDI_NOT_SUPPORTED </th> <td class="description">Bidirectional I/O is not supported</td></tr> + <tr><th>CUPS_SC_BIDI_SUPPORTED </th> <td class="description">Bidirectional I/O is supported</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_sc_command_e">cups_sc_command_e</a></h3> + <p class="description">Request command codes</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_SC_CMD_DRAIN_OUTPUT </th> <td class="description">Drain all pending output</td></tr> + <tr><th>CUPS_SC_CMD_GET_BIDI </th> <td class="description">Return bidirectional capabilities</td></tr> + <tr><th>CUPS_SC_CMD_GET_CONNECTED <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">Return whether the backend is "connected" to the printer </td></tr> + <tr><th>CUPS_SC_CMD_GET_DEVICE_ID </th> <td class="description">Return the IEEE-1284 device ID</td></tr> + <tr><th>CUPS_SC_CMD_GET_STATE </th> <td class="description">Return the device state</td></tr> + <tr><th>CUPS_SC_CMD_SNMP_GET <span class="info"> CUPS 1.4/macOS 10.6 </span></th> <td class="description">Query an SNMP OID </td></tr> + <tr><th>CUPS_SC_CMD_SNMP_GET_NEXT <span class="info"> CUPS 1.4/macOS 10.6 </span></th> <td class="description">Query the next SNMP OID </td></tr> + <tr><th>CUPS_SC_CMD_SOFT_RESET </th> <td class="description">Do a soft reset</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_sc_connected_e">cups_sc_connected_e</a></h3> + <p class="description">Connectivity values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_SC_CONNECTED </th> <td class="description">Backend is "connected" to printer</td></tr> + <tr><th>CUPS_SC_NOT_CONNECTED </th> <td class="description">Backend is not "connected" to printer</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_sc_state_e">cups_sc_state_e</a></h3> + <p class="description">Printer state bits</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_SC_STATE_BUSY </th> <td class="description">Device is busy</td></tr> + <tr><th>CUPS_SC_STATE_ERROR </th> <td class="description">Other error condition</td></tr> + <tr><th>CUPS_SC_STATE_MARKER_EMPTY </th> <td class="description">Toner/ink out condition</td></tr> + <tr><th>CUPS_SC_STATE_MARKER_LOW </th> <td class="description">Toner/ink low condition</td></tr> + <tr><th>CUPS_SC_STATE_MEDIA_EMPTY </th> <td class="description">Paper out condition</td></tr> + <tr><th>CUPS_SC_STATE_MEDIA_LOW </th> <td class="description">Paper low condition</td></tr> + <tr><th>CUPS_SC_STATE_OFFLINE </th> <td class="description">Device is offline</td></tr> + <tr><th>CUPS_SC_STATE_ONLINE </th> <td class="description">Device is online</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_sc_status_e">cups_sc_status_e</a></h3> + <p class="description">Response status codes</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_SC_STATUS_BAD_MESSAGE </th> <td class="description">The command/response message was invalid</td></tr> + <tr><th>CUPS_SC_STATUS_IO_ERROR </th> <td class="description">An I/O error occurred</td></tr> + <tr><th>CUPS_SC_STATUS_NONE </th> <td class="description">No status</td></tr> + <tr><th>CUPS_SC_STATUS_NOT_IMPLEMENTED </th> <td class="description">Command not implemented</td></tr> + <tr><th>CUPS_SC_STATUS_NO_RESPONSE </th> <td class="description">The device did not respond</td></tr> + <tr><th>CUPS_SC_STATUS_OK </th> <td class="description">Operation succeeded</td></tr> + <tr><th>CUPS_SC_STATUS_TIMEOUT </th> <td class="description">The backend did not respond</td></tr> + <tr><th>CUPS_SC_STATUS_TOO_BIG </th> <td class="description">Response too big</td></tr> +</tbody></table> + </div> + </body> </html> diff --git a/doc/help/api-httpipp.html b/doc/help/api-httpipp.html deleted file mode 100644 index 525067d..0000000 --- a/doc/help/api-httpipp.html +++ /dev/null @@ -1,6777 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- SECTION: Programming --> -<head> - <title>HTTP and IPP APIs </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<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 { - border: dotted thin #7f7f7f; - margin-left: 36pt; - padding: 10px; -} - -P.compact { - margin: 0; -} - -P.example { - font-style: italic; - margin-left: 36pt; -} - -DL.man DD { - margin-left: 5em; -} - -DL.man DT { - margin-left: 0; -} - -PRE.man { - margin: 0; -} - -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: inherit; - 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'> -<!-- - HTTP and IPP API header for CUPS. - - Copyright 2007-2016 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/". ---> - -<h1 class='title'>HTTP and IPP APIs</h1> - -<div class='summary'><table summary='General Information'> -<thead> -<tr> - <th>Headers</th> - <th>cups/cups.h<br> - cups/http.h<br> - cups/ipp.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'>Introduction to CUPS Programming</a><br> - Programming: <a href='api-cups.html'>CUPS API</a><br> - References: <a href='spec-ipp.html'>CUPS Implementation of IPP</a></td> -</tr> -</tbody> -</table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#OVERVIEW">Overview</a><ul class="subcontents"> - <li><a href="#CREATING_URI_STRINGS">Creating URI Strings</a></li> - <li><a href="#SENDING_REQUESTS_WITH_FILES">Sending Requests with Files</a></li> - <li><a href="#ASYNCHRONOUS_REQUEST_PROCESSING">Asynchronous Request Processing</a></li> -</ul></li> -<li><a href="#FUNCTIONS">Functions</a><ul class="code"> - <li><a href="#cupsDoAuthentication" title="Authenticate a request.">cupsDoAuthentication</a></li> - <li><a href="#cupsDoFileRequest" title="Do an IPP request with a file.">cupsDoFileRequest</a></li> - <li><a href="#cupsDoIORequest" title="Do an IPP request with file descriptors.">cupsDoIORequest</a></li> - <li><a href="#cupsDoRequest" title="Do an IPP request.">cupsDoRequest</a></li> - <li><a href="#cupsEncodeOptions" title="Encode printer options into IPP attributes.">cupsEncodeOptions</a></li> - <li><a href="#cupsEncodeOptions2" title="Encode printer options into IPP attributes for a group.">cupsEncodeOptions2</a></li> - <li><a href="#cupsGetDevices" title="Get available printer devices.">cupsGetDevices</a></li> - <li><a href="#cupsGetFd" title="Get a file from the server.">cupsGetFd</a></li> - <li><a href="#cupsGetFile" title="Get a file from the server.">cupsGetFile</a></li> - <li><a href="#cupsGetResponse" title="Get a response to an IPP request.">cupsGetResponse</a></li> - <li><a href="#cupsLastError" title="Return the last IPP status code received on the current -thread.">cupsLastError</a></li> - <li><a href="#cupsLastErrorString" title="Return the last IPP status-message received on the -current thread.">cupsLastErrorString</a></li> - <li><a href="#cupsPutFd" title="Put a file on the server.">cupsPutFd</a></li> - <li><a href="#cupsPutFile" title="Put a file on the server.">cupsPutFile</a></li> - <li><a href="#cupsReadResponseData" title="Read additional data after the IPP response.">cupsReadResponseData</a></li> - <li><a href="#cupsSendRequest" title="Send an IPP request.">cupsSendRequest</a></li> - <li><a href="#cupsWriteRequestData" title="Write additional data after an IPP request.">cupsWriteRequestData</a></li> - <li><a href="#httpAcceptConnection" title="Accept a new HTTP client connection from the -specified listening socket.">httpAcceptConnection</a></li> - <li><a href="#httpAddCredential" title="Allocates and adds a single credential to an array.">httpAddCredential</a></li> - <li><a href="#httpAddrAny" title="Check for the "any" address.">httpAddrAny</a></li> - <li><a href="#httpAddrClose" title="Close a socket created by httpAddrConnect or -httpAddrListen.">httpAddrClose</a></li> - <li><a href="#httpAddrEqual" title="Compare two addresses.">httpAddrEqual</a></li> - <li><a href="#httpAddrFamily" title="Get the address family of an address.">httpAddrFamily</a></li> - <li><a href="#httpAddrLength" title="Return the length of the address in bytes.">httpAddrLength</a></li> - <li><a href="#httpAddrListen" title="Create a listening socket bound to the specified -address and port.">httpAddrListen</a></li> - <li><a href="#httpAddrLocalhost" title="Check for the local loopback address.">httpAddrLocalhost</a></li> - <li><a href="#httpAddrLookup" title="Lookup the hostname associated with the address.">httpAddrLookup</a></li> - <li><a href="#httpAddrPort" title="Get the port number associated with an address.">httpAddrPort</a></li> - <li><a href="#httpAddrString" title="Convert an address to a numeric string.">httpAddrString</a></li> - <li><a href="#httpAssembleURI" title="Assemble a uniform resource identifier from its -components.">httpAssembleURI</a></li> - <li><a href="#httpAssembleURIf" title="Assemble a uniform resource identifier from its -components with a formatted resource.">httpAssembleURIf</a></li> - <li><a href="#httpAssembleUUID" title="Assemble a name-based UUID URN conforming to RFC 4122.">httpAssembleUUID</a></li> - <li><a href="#httpBlocking" title="Set blocking/non-blocking behavior on a connection.">httpBlocking</a></li> - <li><a href="#httpCheck" title="Check to see if there is a pending response from the server.">httpCheck</a></li> - <li><a href="#httpClearCookie" title="Clear the cookie value(s).">httpClearCookie</a></li> - <li><a href="#httpClearFields" title="Clear HTTP request fields.">httpClearFields</a></li> - <li><a href="#httpClose" title="Close an HTTP connection.">httpClose</a></li> - <li><a href="#httpCompareCredentials" title="Compare two sets of X.509 credentials.">httpCompareCredentials</a></li> - <li><a href="#httpConnect" title="Connect to a HTTP server.">httpConnect</a></li> - <li><a href="#httpConnect2" title="Connect to a HTTP server.">httpConnect2</a></li> - <li><a href="#httpConnectEncrypt" title="Connect to a HTTP server using encryption.">httpConnectEncrypt</a></li> - <li><a href="#httpDecode64" title="Base64-decode a string.">httpDecode64</a></li> - <li><a href="#httpDecode64_2" title="Base64-decode a string.">httpDecode64_2</a></li> - <li><a href="#httpDelete" title="Send a DELETE request to the server.">httpDelete</a></li> - <li><a href="#httpEncode64" title="Base64-encode a string.">httpEncode64</a></li> - <li><a href="#httpEncode64_2" title="Base64-encode a string.">httpEncode64_2</a></li> - <li><a href="#httpEncryption" title="Set the required encryption on the link.">httpEncryption</a></li> - <li><a href="#httpError" title="Get the last error on a connection.">httpError</a></li> - <li><a href="#httpFieldValue" title="Return the HTTP field enumeration value for a field -name.">httpFieldValue</a></li> - <li><a href="#httpFlush" title="Flush data from a HTTP connection.">httpFlush</a></li> - <li><a href="#httpFlushWrite" title="Flush data in write buffer.">httpFlushWrite</a></li> - <li><a href="#httpFreeCredentials" title="Free an array of credentials.">httpFreeCredentials</a></li> - <li><a href="#httpGet" title="Send a GET request to the server.">httpGet</a></li> - <li><a href="#httpGetActivity" title="Get the most recent activity for a connection.">httpGetActivity</a></li> - <li><a href="#httpGetAddress" title="Get the address of the connected peer of a connection.">httpGetAddress</a></li> - <li><a href="#httpGetAuthString" title="Get the current authorization string.">httpGetAuthString</a></li> - <li><a href="#httpGetBlocking" title="Get the blocking/non-block state of a connection.">httpGetBlocking</a></li> - <li><a href="#httpGetContentEncoding" title="Get a common content encoding, if any, between -the client and server.">httpGetContentEncoding</a></li> - <li><a href="#httpGetCookie" title="Get any cookie data from the response.">httpGetCookie</a></li> - <li><a href="#httpGetDateString" title="Get a formatted date/time string from a time value.">httpGetDateString</a></li> - <li><a href="#httpGetDateString2" title="Get a formatted date/time string from a time value.">httpGetDateString2</a></li> - <li><a href="#httpGetDateTime" title="Get a time value from a formatted date/time string.">httpGetDateTime</a></li> - <li><a href="#httpGetEncryption" title="Get the current encryption mode of a connection.">httpGetEncryption</a></li> - <li><a href="#httpGetExpect" title="Get the value of the Expect header, if any.">httpGetExpect</a></li> - <li><a href="#httpGetFd" title="Get the file descriptor associated with a connection.">httpGetFd</a></li> - <li><a href="#httpGetField" title="Get a field value from a request/response.">httpGetField</a></li> - <li><a href="#httpGetHostByName" title="Lookup a hostname or IPv4 address, and return -address records for the specified name.">httpGetHostByName</a></li> - <li><a href="#httpGetHostname" title="Get the FQDN for the connection or local system.">httpGetHostname</a></li> - <li><a href="#httpGetKeepAlive" title="Get the current Keep-Alive state of the connection.">httpGetKeepAlive</a></li> - <li><a href="#httpGetLength" title="Get the amount of data remaining from the -content-length or transfer-encoding fields.">httpGetLength</a></li> - <li><a href="#httpGetLength2" title="Get the amount of data remaining from the -content-length or transfer-encoding fields.">httpGetLength2</a></li> - <li><a href="#httpGetPending" title="Get the number of bytes that are buffered for writing.">httpGetPending</a></li> - <li><a href="#httpGetReady" title="Get the number of bytes that can be read without blocking.">httpGetReady</a></li> - <li><a href="#httpGetRemaining" title="Get the number of remaining bytes in the message -body or current chunk.">httpGetRemaining</a></li> - <li><a href="#httpGetState" title="Get the current state of the HTTP request.">httpGetState</a></li> - <li><a href="#httpGetStatus" title="Get the status of the last HTTP request.">httpGetStatus</a></li> - <li><a href="#httpGetSubField" title="Get a sub-field value.">httpGetSubField</a></li> - <li><a href="#httpGetSubField2" title="Get a sub-field value.">httpGetSubField2</a></li> - <li><a href="#httpGetVersion" title="Get the HTTP version at the other end.">httpGetVersion</a></li> - <li><a href="#httpGets" title="Get a line of text from a HTTP connection.">httpGets</a></li> - <li><a href="#httpHead" title="Send a HEAD request to the server.">httpHead</a></li> - <li><a href="#httpInitialize" title="Initialize the HTTP interface library and set the -default HTTP proxy (if any).">httpInitialize</a></li> - <li><a href="#httpIsChunked" title="Report whether a message body is chunked.">httpIsChunked</a></li> - <li><a href="#httpIsEncrypted" title="Report whether a connection is encrypted.">httpIsEncrypted</a></li> - <li><a href="#httpMD5" title="Compute the MD5 sum of the username:group:password.">httpMD5</a></li> - <li><a href="#httpMD5Final" title="Combine the MD5 sum of the username, group, and password -with the server-supplied nonce value, method, and -request-uri.">httpMD5Final</a></li> - <li><a href="#httpMD5String" title="Convert an MD5 sum to a character string.">httpMD5String</a></li> - <li><a href="#httpOptions" title="Send an OPTIONS request to the server.">httpOptions</a></li> - <li><a href="#httpPeek" title="Peek at data from a HTTP connection.">httpPeek</a></li> - <li><a href="#httpPost" title="Send a POST request to the server.">httpPost</a></li> - <li><a href="#httpPut" title="Send a PUT request to the server.">httpPut</a></li> - <li><a href="#httpRead" title="Read data from a HTTP connection.">httpRead</a></li> - <li><a href="#httpRead2" title="Read data from a HTTP connection.">httpRead2</a></li> - <li><a href="#httpReadRequest" title="Read a HTTP request from a connection.">httpReadRequest</a></li> - <li><a href="#httpReconnect" title="Reconnect to a HTTP server.">httpReconnect</a></li> - <li><a href="#httpReconnect2" title="Reconnect to a HTTP server with timeout and optional -cancel.">httpReconnect2</a></li> - <li><a href="#httpResolveHostname" title="Resolve the hostname of the HTTP connection -address.">httpResolveHostname</a></li> - <li><a href="#httpSeparate" title="Separate a Universal Resource Identifier into its -components.">httpSeparate</a></li> - <li><a href="#httpSeparate2" title="Separate a Universal Resource Identifier into its -components.">httpSeparate2</a></li> - <li><a href="#httpSeparateURI" title="Separate a Universal Resource Identifier into its -components.">httpSeparateURI</a></li> - <li><a href="#httpSetAuthString" title="Set the current authorization string.">httpSetAuthString</a></li> - <li><a href="#httpSetCookie" title="Set the cookie value(s).">httpSetCookie</a></li> - <li><a href="#httpSetCredentials" title="Set the credentials associated with an encrypted -connection.">httpSetCredentials</a></li> - <li><a href="#httpSetDefaultField" title="Set the default value of an HTTP header.">httpSetDefaultField</a></li> - <li><a href="#httpSetExpect" title="Set the Expect: header in a request.">httpSetExpect</a></li> - <li><a href="#httpSetField" title="Set the value of an HTTP header.">httpSetField</a></li> - <li><a href="#httpSetKeepAlive" title="Set the current Keep-Alive state of a connection.">httpSetKeepAlive</a></li> - <li><a href="#httpSetLength" title="Set the content-length and content-encoding.">httpSetLength</a></li> - <li><a href="#httpSetTimeout" title="Set read/write timeouts and an optional callback.">httpSetTimeout</a></li> - <li><a href="#httpShutdown" title="Shutdown one side of an HTTP connection.">httpShutdown</a></li> - <li><a href="#httpStateString" title="Return the string describing a HTTP state value.">httpStateString</a></li> - <li><a href="#httpStatus" title="Return a short string describing a HTTP status code.">httpStatus</a></li> - <li><a href="#httpTrace" title="Send an TRACE request to the server.">httpTrace</a></li> - <li><a href="#httpURIStatusString" title="Return a string describing a URI status code.">httpURIStatusString</a></li> - <li><a href="#httpUpdate" title="Update the current HTTP state for incoming data.">httpUpdate</a></li> - <li><a href="#httpWait" title="Wait for data available on a connection.">httpWait</a></li> - <li><a href="#httpWrite" title="Write data to a HTTP connection.">httpWrite</a></li> - <li><a href="#httpWrite2" title="Write data to a HTTP connection.">httpWrite2</a></li> - <li><a href="#httpWriteResponse" title="Write a HTTP response to a client connection.">httpWriteResponse</a></li> - <li><a href="#ippAddBoolean" title="Add a boolean attribute to an IPP message.">ippAddBoolean</a></li> - <li><a href="#ippAddBooleans" title="Add an array of boolean values.">ippAddBooleans</a></li> - <li><a href="#ippAddCollection" title="Add a collection value.">ippAddCollection</a></li> - <li><a href="#ippAddCollections" title="Add an array of collection values.">ippAddCollections</a></li> - <li><a href="#ippAddDate" title="Add a date attribute to an IPP message.">ippAddDate</a></li> - <li><a href="#ippAddInteger" title="Add a integer attribute to an IPP message.">ippAddInteger</a></li> - <li><a href="#ippAddIntegers" title="Add an array of integer values.">ippAddIntegers</a></li> - <li><a href="#ippAddOctetString" title="Add an octetString value to an IPP message.">ippAddOctetString</a></li> - <li><a href="#ippAddOutOfBand" title="Add an out-of-band value to an IPP message.">ippAddOutOfBand</a></li> - <li><a href="#ippAddRange" title="Add a range of values to an IPP message.">ippAddRange</a></li> - <li><a href="#ippAddRanges" title="Add ranges of values to an IPP message.">ippAddRanges</a></li> - <li><a href="#ippAddResolution" title="Add a resolution value to an IPP message.">ippAddResolution</a></li> - <li><a href="#ippAddResolutions" title="Add resolution values to an IPP message.">ippAddResolutions</a></li> - <li><a href="#ippAddSeparator" title="Add a group separator to an IPP message.">ippAddSeparator</a></li> - <li><a href="#ippAddString" title="Add a language-encoded string to an IPP message.">ippAddString</a></li> - <li><a href="#ippAddStringf" title="Add a formatted string to an IPP message.">ippAddStringf</a></li> - <li><a href="#ippAddStringfv" title="Add a formatted string to an IPP message.">ippAddStringfv</a></li> - <li><a href="#ippAddStrings" title="Add language-encoded strings to an IPP message.">ippAddStrings</a></li> - <li><a href="#ippAttributeString" title="Convert the attribute's value to a string.">ippAttributeString</a></li> - <li><a href="#ippContainsInteger" title="Determine whether an attribute contains the -specified value or is within the list of ranges.">ippContainsInteger</a></li> - <li><a href="#ippContainsString" title="Determine whether an attribute contains the -specified string value.">ippContainsString</a></li> - <li><a href="#ippCopyAttribute" title="Copy an attribute.">ippCopyAttribute</a></li> - <li><a href="#ippCopyAttributes" title="Copy attributes from one IPP message to another.">ippCopyAttributes</a></li> - <li><a href="#ippCreateRequestedArray" title="Create a CUPS array of attribute names from the -given requested-attributes attribute.">ippCreateRequestedArray</a></li> - <li><a href="#ippDateToTime" title="Convert from RFC 1903 Date/Time format to UNIX time -in seconds.">ippDateToTime</a></li> - <li><a href="#ippDelete" title="Delete an IPP message.">ippDelete</a></li> - <li><a href="#ippDeleteAttribute" title="Delete a single attribute in an IPP message.">ippDeleteAttribute</a></li> - <li><a href="#ippDeleteValues" title="Delete values in an attribute.">ippDeleteValues</a></li> - <li><a href="#ippEnumString" title="Return a string corresponding to the enum value.">ippEnumString</a></li> - <li><a href="#ippEnumValue" title="Return the value associated with a given enum string.">ippEnumValue</a></li> - <li><a href="#ippErrorString" title="Return a name for the given status code.">ippErrorString</a></li> - <li><a href="#ippErrorValue" title="Return a status code for the given name.">ippErrorValue</a></li> - <li><a href="#ippFindAttribute" title="Find a named attribute in a request.">ippFindAttribute</a></li> - <li><a href="#ippFindNextAttribute" title="Find the next named attribute in a request.">ippFindNextAttribute</a></li> - <li><a href="#ippFirstAttribute" title="Return the first attribute in the message.">ippFirstAttribute</a></li> - <li><a href="#ippGetBoolean" title="Get a boolean value for an attribute.">ippGetBoolean</a></li> - <li><a href="#ippGetCollection" title="Get a collection value for an attribute.">ippGetCollection</a></li> - <li><a href="#ippGetCount" title="Get the number of values in an attribute.">ippGetCount</a></li> - <li><a href="#ippGetDate" title="Get a date value for an attribute.">ippGetDate</a></li> - <li><a href="#ippGetGroupTag" title="Get the group associated with an attribute.">ippGetGroupTag</a></li> - <li><a href="#ippGetInteger" title="Get the integer/enum value for an attribute.">ippGetInteger</a></li> - <li><a href="#ippGetName" title="Get the attribute name.">ippGetName</a></li> - <li><a href="#ippGetOctetString" title="Get an octetString value from an IPP attribute.">ippGetOctetString</a></li> - <li><a href="#ippGetOperation" title="Get the operation ID in an IPP message.">ippGetOperation</a></li> - <li><a href="#ippGetRange" title="Get a rangeOfInteger value from an attribute.">ippGetRange</a></li> - <li><a href="#ippGetRequestId" title="Get the request ID from an IPP message.">ippGetRequestId</a></li> - <li><a href="#ippGetResolution" title="Get a resolution value for an attribute.">ippGetResolution</a></li> - <li><a href="#ippGetState" title="Get the IPP message state.">ippGetState</a></li> - <li><a href="#ippGetStatusCode" title="Get the status code from an IPP response or event message.">ippGetStatusCode</a></li> - <li><a href="#ippGetString" title="Return the value...">ippGetString</a></li> - <li><a href="#ippGetValueTag" title="Get the value tag for an attribute.">ippGetValueTag</a></li> - <li><a href="#ippGetVersion" title="Get the major and minor version number from an IPP message.">ippGetVersion</a></li> - <li><a href="#ippLength" title="Compute the length of an IPP message.">ippLength</a></li> - <li><a href="#ippNew" title="Allocate a new IPP message.">ippNew</a></li> - <li><a href="#ippNewRequest" title="Allocate a new IPP request message.">ippNewRequest</a></li> - <li><a href="#ippNewResponse" title="Allocate a new IPP response message.">ippNewResponse</a></li> - <li><a href="#ippNextAttribute" title="Return the next attribute in the message.">ippNextAttribute</a></li> - <li><a href="#ippOpString" title="Return a name for the given operation id.">ippOpString</a></li> - <li><a href="#ippOpValue" title="Return an operation id for the given name.">ippOpValue</a></li> - <li><a href="#ippPort" title="Return the default IPP port number.">ippPort</a></li> - <li><a href="#ippRead" title="Read data for an IPP message from a HTTP connection.">ippRead</a></li> - <li><a href="#ippReadFile" title="Read data for an IPP message from a file.">ippReadFile</a></li> - <li><a href="#ippReadIO" title="Read data for an IPP message.">ippReadIO</a></li> - <li><a href="#ippSetBoolean" title="Set a boolean value in an attribute.">ippSetBoolean</a></li> - <li><a href="#ippSetCollection" title="Set a collection value in an attribute.">ippSetCollection</a></li> - <li><a href="#ippSetDate" title="Set a date value in an attribute.">ippSetDate</a></li> - <li><a href="#ippSetGroupTag" title="Set the group tag of an attribute.">ippSetGroupTag</a></li> - <li><a href="#ippSetInteger" title="Set an integer or enum value in an attribute.">ippSetInteger</a></li> - <li><a href="#ippSetName" title="Set the name of an attribute.">ippSetName</a></li> - <li><a href="#ippSetOctetString" title="Set an octetString value in an IPP attribute.">ippSetOctetString</a></li> - <li><a href="#ippSetOperation" title="Set the operation ID in an IPP request message.">ippSetOperation</a></li> - <li><a href="#ippSetPort" title="Set the default port number.">ippSetPort</a></li> - <li><a href="#ippSetRange" title="Set a rangeOfInteger value in an attribute.">ippSetRange</a></li> - <li><a href="#ippSetRequestId" title="Set the request ID in an IPP message.">ippSetRequestId</a></li> - <li><a href="#ippSetResolution" title="Set a resolution value in an attribute.">ippSetResolution</a></li> - <li><a href="#ippSetState" title="Set the current state of the IPP message.">ippSetState</a></li> - <li><a href="#ippSetStatusCode" title="Set the status code in an IPP response or event message.">ippSetStatusCode</a></li> - <li><a href="#ippSetString" title="Set a string value in an attribute.">ippSetString</a></li> - <li><a href="#ippSetStringf" title="Set a formatted string value of an attribute.">ippSetStringf</a></li> - <li><a href="#ippSetStringfv" title="Set a formatted string value of an attribute.">ippSetStringfv</a></li> - <li><a href="#ippSetValueTag" title="Set the value tag of an attribute.">ippSetValueTag</a></li> - <li><a href="#ippSetVersion" title="Set the version number in an IPP message.">ippSetVersion</a></li> - <li><a href="#ippStateString" title="Return the name corresponding to a state value.">ippStateString</a></li> - <li><a href="#ippTagString" title="Return the tag name corresponding to a tag value.">ippTagString</a></li> - <li><a href="#ippTagValue" title="Return the tag value corresponding to a tag name.">ippTagValue</a></li> - <li><a href="#ippTimeToDate" title="Convert from UNIX time to RFC 1903 format.">ippTimeToDate</a></li> - <li><a href="#ippValidateAttribute" title="Validate the contents of an attribute.">ippValidateAttribute</a></li> - <li><a href="#ippValidateAttributes" title="Validate all attributes in an IPP message.">ippValidateAttributes</a></li> - <li><a href="#ippWrite" title="Write data for an IPP message to a HTTP connection.">ippWrite</a></li> - <li><a href="#ippWriteFile" title="Write data for an IPP message to a file.">ippWriteFile</a></li> - <li><a href="#ippWriteIO" title="Write data for an IPP message.">ippWriteIO</a></li> -</ul></li> -<li><a href="#TYPES">Data Types</a><ul class="code"> - <li><a href="#gss_auth_identity_desc" title="Local functions...">gss_auth_identity_desc</a></li> - <li><a href="#http_addr_t" title="Socket address union, which -makes using IPv6 and other -address types easier and -more portable. ">http_addr_t</a></li> - <li><a href="#http_addrlist_t" title="Socket address list, which is -used to enumerate all of the -addresses that are associated -with a hostname. ">http_addrlist_t</a></li> - <li><a href="#http_auth_t" title="HTTP authentication types">http_auth_t</a></li> - <li><a href="#http_credential_t" title="HTTP credential data ">http_credential_t</a></li> - <li><a href="#http_encoding_t" title="HTTP transfer encoding values">http_encoding_t</a></li> - <li><a href="#http_encryption_t" title="HTTP encryption values">http_encryption_t</a></li> - <li><a href="#http_field_t" title="HTTP field names">http_field_t</a></li> - <li><a href="#http_keepalive_t" title="HTTP keep-alive values">http_keepalive_t</a></li> - <li><a href="#http_state_t" title="HTTP state values; states -are server-oriented...">http_state_t</a></li> - <li><a href="#http_t" title="HTTP connection type">http_t</a></li> - <li><a href="#http_timeout_cb_t" title="HTTP timeout callback ">http_timeout_cb_t</a></li> - <li><a href="#http_trust_t" title="Level of trust for credentials ">http_trust_t</a></li> - <li><a href="#http_uri_coding_t" title="URI en/decode flags">http_uri_coding_t</a></li> - <li><a href="#http_uri_status_t" title="URI separation status ">http_uri_status_t</a></li> - <li><a href="#http_version_t" title="HTTP version numbers">http_version_t</a></li> - <li><a href="#ipp_attribute_t" title="IPP attribute">ipp_attribute_t</a></li> - <li><a href="#ipp_copycb_t" title="The following structures are PRIVATE starting with CUPS 1.6/macOS 10.8. -Please use the new accessor functions available in CUPS 1.6 and later, as -these definitions will be moved to a private header file in a future release.">ipp_copycb_t</a></li> - <li><a href="#ipp_dstate_t" title="Document states">ipp_dstate_t</a></li> - <li><a href="#ipp_finish_t" title="Job collation types">ipp_finish_t</a></li> - <li><a href="#ipp_iocb_t" title="IPP IO Callback Function ">ipp_iocb_t</a></li> - <li><a href="#ipp_jcollate_t" title="Job collation types">ipp_jcollate_t</a></li> - <li><a href="#ipp_orient_t" title="Orientation values">ipp_orient_t</a></li> - <li><a href="#ipp_pstate_t" title="Printer states">ipp_pstate_t</a></li> - <li><a href="#ipp_quality_t" title="Qualities">ipp_quality_t</a></li> - <li><a href="#ipp_res_t" title="Resolution units">ipp_res_t</a></li> - <li><a href="#ipp_state_t" title="IPP states">ipp_state_t</a></li> - <li><a href="#ipp_t" title="IPP request/response data">ipp_t</a></li> - <li><a href="#ipp_uchar_t" title="Unsigned 8-bit integer/character">ipp_uchar_t</a></li> -</ul></li> -<li><a href="#STRUCTURES">Structures</a><ul class="code"> - <li><a href="#gss_auth_identity" title="Local functions...">gss_auth_identity</a></li> - <li><a href="#http_addrlist_s" title="Socket address list, which is -used to enumerate all of the -addresses that are associated -with a hostname. ">http_addrlist_s</a></li> - <li><a href="#http_credential_s" title="HTTP credential data ">http_credential_s</a></li> - <li><a href="#pollfd" title="User data (unused)">pollfd</a></li> -</ul></li> -<li><a href="#ENUMERATIONS">Constants</a><ul class="code"> - <li><a href="#http_auth_e" title="HTTP authentication types">http_auth_e</a></li> - <li><a href="#http_encoding_e" title="HTTP transfer encoding values">http_encoding_e</a></li> - <li><a href="#http_encryption_e" title="HTTP encryption values">http_encryption_e</a></li> - <li><a href="#http_field_e" title="HTTP field names">http_field_e</a></li> - <li><a href="#http_keepalive_e" title="HTTP keep-alive values">http_keepalive_e</a></li> - <li><a href="#http_state_e" title="HTTP state values; states -are server-oriented...">http_state_e</a></li> - <li><a href="#http_status_e" title="HTTP status codes">http_status_e</a></li> - <li><a href="#http_trust_e" title="Level of trust for credentials ">http_trust_e</a></li> - <li><a href="#http_uri_coding_e" title="URI en/decode flags">http_uri_coding_e</a></li> - <li><a href="#http_uri_status_e" title="URI separation status ">http_uri_status_e</a></li> - <li><a href="#http_version_e" title="HTTP version numbers">http_version_e</a></li> - <li><a href="#ipp_dstate_e" title="Document states">ipp_dstate_e</a></li> - <li><a href="#ipp_finishings_e" title="Finishings">ipp_finishings_e</a></li> - <li><a href="#ipp_jcollate_e" title="Job collation types">ipp_jcollate_e</a></li> - <li><a href="#ipp_jstate_e" title="Job states">ipp_jstate_e</a></li> - <li><a href="#ipp_op_e" title="IPP operations">ipp_op_e</a></li> - <li><a href="#ipp_orient_e" title="Orientation values">ipp_orient_e</a></li> - <li><a href="#ipp_pstate_e" title="Printer states">ipp_pstate_e</a></li> - <li><a href="#ipp_quality_e" title="Qualities">ipp_quality_e</a></li> - <li><a href="#ipp_res_e" title="Resolution units">ipp_res_e</a></li> - <li><a href="#ipp_state_e" title="IPP states">ipp_state_e</a></li> - <li><a href="#ipp_status_e" title="IPP status codes">ipp_status_e</a></li> - <li><a href="#ipp_tag_e" title="Format tags for attributes">ipp_tag_e</a></li> -</ul></li> -</ul> -<!-- - HTTP and IPP API introduction for CUPS. - - Copyright 2007-2012 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 HTTP and IPP APIs provide low-level access to the HTTP and IPP -protocols and CUPS scheduler. They are typically used by monitoring and -administration programs to perform specific functions not supported by the -high-level CUPS API functions.</p> - -<p>The HTTP APIs use an opaque structure called -<a href='#http_t'><code>http_t</code></a> to manage connections to -a particular HTTP or IPP server. The -<a href='#httpConnectEncrypt'><code>httpConnectEncrypt</code></a> function is -used to create an instance of this structure for a particular server. -The constant <code>CUPS_HTTP_DEFAULT</code> can be used with all of the -<code>cups</code> functions to refer to the default CUPS server - the functions -create a per-thread <a href='#http_t'><code>http_t</code></a> as needed.</p> - -<p>The IPP APIs use two opaque structures for requests (messages sent to the CUPS scheduler) and responses (messages sent back to your application from the scheduler). The <a href='#ipp_t'><code>ipp_t</code></a> type holds a complete request or response and is allocated using the <a href='#ippNew'><code>ippNew</code></a> or <a href='#ippNewRequest'><code>ippNewRequest</code></a> functions and freed using the <a href='#ippDelete'><code>ippDelete</code></a> function.</p> - -<p>The second opaque structure is called <a href='#ipp_attribute_t'><code>ipp_attribute_t</code></a> and holds a single IPP attribute which consists of a group tag (<a href='#ippGetGroupTag'><code>ippGetGroupTag</code></a>), a value type tag (<a href='#ippGetValueTag'><code>ippGetValueTag</code></a>), the attribute name (<a href='#ippGetName'><code>ippGetName</code></a>), and 1 or more values (<a href='#ippGetCount'><code>ippGetCount</code></a>, <a href='#ippGetBoolean'><code>ippGetBoolean</code></a>, <a href='#ippGetCollection'><code>ippGetCollection</code></a>, <a href='#ippGetDate'><code>ippGetDate</code></a>, <a href='#ippGetInteger'><code>ippGetInteger</code></a>, <a href='#ippGetRange'><code>ippGetRange</code></a>, <a href='#ippGetResolution'><code>ippGetResolution</code></a>, and <a href='#ippGetString'><code>ippGetString</code></a>). Attributes are added to an <a href='#ipp_t'><code>ipp_t</code></a> pointer using one of the <code>ippAdd</code> functions. For example, use <a href='#ippAddString'><code>ippAddString</code></a> to add the "printer-uri" and "requesting-user-name" string attributes to a request:</p> - -<pre class='example'> -<a href='#ipp_t'>ipp_t</a> *request = <a href='#ippNewRequest'>ippNewRequest</a>(IPP_GET_JOBS); - -<a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", - NULL, "ipp://localhost/printers/"); -<a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name", - NULL, cupsUser()); -</pre> - -<p>Once you have created an IPP request, use the <code>cups</code> functions to send the request to and read the response from the server. For example, the <a href='#cupsDoRequest'><code>cupsDoRequest</code></a> function can be used for simple query operations that do not involve files:</p> - -<pre class='example'> -#include <cups/cups.h> - - -<a href='#ipp_t'>ipp_t</a> *<a name='get_jobs'>get_jobs</a>(void) -{ - <a href='#ipp_t'>ipp_t</a> *request = <a href='#ippNewRequest'>ippNewRequest</a>(IPP_GET_JOBS); - - <a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", - NULL, "ipp://localhost/printers/"); - <a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name", - NULL, cupsUser()); - - return (<a href='#cupsDoRequest'>cupsDoRequest</a>(CUPS_HTTP_DEFAULT, request, "/")); -} -</pre> - -<p>The <a href='#cupsDoRequest'><code>cupsDoRequest</code></a> function frees the request and returns an IPP response or <code>NULL</code> pointer if the request could not be sent to the server. Once you have a response from the server, you can either use the <a href='#ippFindAttribute'><code>ippFindAttribute</code></a> and <a href='#ippFindNextAttribute'><code>ippFindNextAttribute</code></a> functions to find specific attributes, for example:</p> - -<pre class='example'> -<a href='#ipp_t'>ipp_t</a> *response; -<a href='#ipp_attribute_t'>ipp_attribute_t</a> *attr; - -attr = <a href='#ippFindAttribute'>ippFindAttribute</a>(response, "printer-state", IPP_TAG_ENUM); -</pre> - -<p>You can also walk the list of attributes with a simple <code>for</code> loop like this:</p> - -<pre class='example'> -<a href='#ipp_t'>ipp_t</a> *response; -<a href='#ipp_attribute_t'>ipp_attribute_t</a> *attr; - -for (attr = <a href='#ippFirstAttribute'>ippFirstAttribute</a>(response); attr != NULL; attr = <a href='#ippNextAttribute'>ippNextAttribute</a>(response)) - if (ippGetName(attr) == NULL) - puts("--SEPARATOR--"); - else - puts(ippGetName(attr)); -</pre> - -<p>The <code>for</code> loop approach is normally used when collecting attributes for multiple objects (jobs, printers, etc.) in a response. Attributes with <code>NULL</code> names indicate a separator between the attributes of each object. For example, the following code will list the jobs returned from our previous <a href='#get_jobs'><code>get_jobs</code></a> example code:</p> - -<pre class='example'> -<a href='#ipp_t'>ipp_t</a> *response = <a href='#get_jobs'>get_jobs</a>(); - -if (response != NULL) -{ - <a href='#ipp_attribute_t'>ipp_attribute_t</a> *attr; - const char *attrname; - int job_id = 0; - const char *job_name = NULL; - const char *job_originating_user_name = NULL; - - puts("Job ID Owner Title"); - puts("------ ---------------- ---------------------------------"); - - for (attr = <a href='#ippFirstAttribute'>ippFirstAttribute</a>(response); attr != NULL; attr = <a href='#ippNextAttribute'>ippNextAttribute</a>(response)) - { - /* Attributes without names are separators between jobs */ - attrname = ippGetName(attr); - if (attrname == NULL) - { - if (job_id > 0) - { - if (job_name == NULL) - job_name = "(withheld)"; - - if (job_originating_user_name == NULL) - job_originating_user_name = "(withheld)"; - - printf("%5d %-16s %s\n", job_id, job_originating_user_name, job_name); - } - - job_id = 0; - job_name = NULL; - job_originating_user_name = NULL; - continue; - } - else if (!strcmp(attrname, "job-id") && ippGetValueTag(attr) == IPP_TAG_INTEGER) - job_id = ippGetInteger(attr, 0); - else if (!strcmp(attrname, "job-name") && ippGetValueTag(attr) == IPP_TAG_NAME) - job_name = ippGetString(attr, 0, NULL); - else if (!strcmp(attrname, "job-originating-user-name") && - ippGetValueTag(attr) == IPP_TAG_NAME) - job_originating_user_name = ippGetString(attr, 0, NULL); - } - - if (job_id > 0) - { - if (job_name == NULL) - job_name = "(withheld)"; - - if (job_originating_user_name == NULL) - job_originating_user_name = "(withheld)"; - - printf("%5d %-16s %s\n", job_id, job_originating_user_name, job_name); - } -} -</pre> - -<h3><a name='CREATING_URI_STRINGS'>Creating URI Strings</a></h3> - -<p>To ensure proper encoding, the -<a href='#httpAssembleURIf'><code>httpAssembleURIf</code></a> function must be -used to format a "printer-uri" string for all printer-based requests:</p> - -<pre class='example'> -const char *name = "Foo"; -char uri[1024]; -<a href='#ipp_t'>ipp_t</a> *request; - -<a href='#httpAssembleURIf'>httpAssembleURIf</a>(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL, cupsServer(), - ippPort(), "/printers/%s", name); -<a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, uri); -</pre> - -<h3><a name='SENDING_REQUESTS_WITH_FILES'>Sending Requests with Files</a></h3> - -<p>The <a href='#cupsDoFileRequest'><code>cupsDoFileRequest</code></a> and -<a href='#cupsDoIORequest'><code>cupsDoIORequest</code></a> functions are -used for requests involving files. The -<a href='#cupsDoFileRequest'><code>cupsDoFileRequest</code></a> function -attaches the named file to a request and is typically used when sending a print -file or changing a printer's PPD file:</p> - -<pre class='example'> -const char *filename = "/usr/share/cups/data/testprint.ps"; -const char *name = "Foo"; -char uri[1024]; -char resource[1024]; -<a href='#ipp_t'>ipp_t</a> *request = <a href='#ippNewRequest'>ippNewRequest</a>(IPP_PRINT_JOB); -<a href='#ipp_t'>ipp_t</a> *response; - -/* Use httpAssembleURIf for the printer-uri string */ -<a href='#httpAssembleURIf'>httpAssembleURIf</a>(HTTP_URI_CODING_ALL, uri, sizeof(uri), "ipp", NULL, cupsServer(), - ippPort(), "/printers/%s", name); -<a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, uri); -<a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name", - NULL, cupsUser()); -<a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "job-name", - NULL, "testprint.ps"); - -/* Use snprintf for the resource path */ -snprintf(resource, sizeof(resource), "/printers/%s", name); - -response = <a href='#cupsDoFileRequest'>cupsDoFileRequest</a>(CUPS_HTTP_DEFAULT, request, resource, filename); -</pre> - -<p>The <a href='#cupsDoIORequest'><code>cupsDoIORequest</code></a> function -optionally attaches a file to the request and optionally saves a file in the -response from the server. It is used when using a pipe for the request -attachment or when using a request that returns a file, currently only -<code>CUPS_GET_DOCUMENT</code> and <code>CUPS_GET_PPD</code>. For example, -the following code will download the PPD file for the sample HP LaserJet -printer driver:</p> - -<pre class='example'> -char tempfile[1024]; -int tempfd; -<a href='#ipp_t'>ipp_t</a> *request = <a href='#ippNewRequest'>ippNewRequest</a>(CUPS_GET_PPD); -<a href='#ipp_t'>ipp_t</a> *response; - -<a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name", - NULL, "laserjet.ppd"); - -tempfd = cupsTempFd(tempfile, sizeof(tempfile)); - -response = <a href='#cupsDoIORequest'>cupsDoIORequest</a>(CUPS_HTTP_DEFAULT, request, "/", -1, tempfd); -</pre> - -<p>The example passes <code>-1</code> for the input file descriptor to specify -that no file is to be attached to the request. The PPD file attached to the -response is written to the temporary file descriptor we created using the -<code>cupsTempFd</code> function.</p> - -<h3><a name='ASYNCHRONOUS_REQUEST_PROCESSING'>Asynchronous Request Processing</a></h3> - -<p>The <a href='#cupsSendRequest'><code>cupsSendRequest</code></a> and -<a href='#cupsGetResponse'><code>cupsGetResponse</code></a> support -asynchronous communications with the server. Unlike the other request -functions, the IPP request is not automatically freed, so remember to -free your request with the <a href='#ippDelete'><code>ippDelete</code></a> -function.</p> - -<p>File data is attached to the request using the -<a href='#cupsWriteRequestData'><code>cupsWriteRequestData</code></a> -function, while file data returned from the server is read using the -<a href='#cupsReadResponseData'><code>cupsReadResponseData</code></a> -function. We can rewrite the previous <code>CUPS_GET_PPD</code> example -to use the asynchronous functions quite easily:</p> - -<pre class='example'> -char tempfile[1024]; -int tempfd; -<a href='#ipp_t'>ipp_t</a> *request = <a href='#ippNewRequest'>ippNewRequest</a>(CUPS_GET_PPD); -<a href='#ipp_t'>ipp_t</a> *response; - -<a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name", - NULL, "laserjet.ppd"); - -tempfd = cupsTempFd(tempfile, sizeof(tempfile)); - -if (<a href='#cupsSendRequest'>cupsSendRequest</a>(CUPS_HTTP_DEFAULT, request, "/") == HTTP_CONTINUE) -{ - response = <a href='#cupsGetResponse'>cupsGetResponse</a>(CUPS_HTTP_DEFAULT, "/"); - - if (response != NULL) - { - ssize_t bytes; - char buffer[8192]; - - while ((bytes = <a href='#cupsReadResponseData'>cupsReadResponseData</a>(CUPS_HTTP_DEFAULT, buffer, sizeof(buffer))) > 0) - write(tempfd, buffer, bytes); - } -} - -/* Free the request! */ -<a href='#ippDelete'>ippDelete</a>(request); -</pre> - -<p>The <a href='#cupsSendRequest'><code>cupsSendRequest</code></a> function -returns the initial HTTP request status, typically either -<code>HTTP_CONTINUE</code> or <code>HTTP_UNAUTHORIZED</code>. The latter status -is returned when the request requires authentication of some sort. The -<a href='#cupsDoAuthentication'><code>cupsDoAuthentication</code></a> function -must be called when your see <code>HTTP_UNAUTHORIZED</code> and the request -re-sent. We can add authentication support to our example code by using a -<code>do ... while</code> loop:</p> - -<pre class='example'> -char tempfile[1024]; -int tempfd; -<a href='#ipp_t'>ipp_t</a> *request = <a href='#ippNewRequest'>ippNewRequest</a>(CUPS_GET_PPD); -<a href='#ipp_t'>ipp_t</a> *response; -http_status_t status; - -<a href='#ippAddString'>ippAddString</a>(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "ppd-name", - NULL, "laserjet.ppd"); - -tempfd = cupsTempFd(tempfile, sizeof(tempfile)); - -/* Loop for authentication */ -do -{ - status = <a href='#cupsSendRequest'>cupsSendRequest</a>(CUPS_HTTP_DEFAULT, request, "/"); - - if (status == HTTP_UNAUTHORIZED) - { - /* Try to authenticate, break out of the loop if that fails */ - if (<a href='#cupsDoAuthentication'>cupsDoAuthentication</a>(CUPS_HTTP_DEFAULT, "POST", "/")) - break; - } -} -while (status != HTTP_CONTINUE && status != HTTP_UNAUTHORIZED); - -if (status == HTTP_CONTINUE) -{ - response = <a href='#cupsGetResponse'>cupsGetResponse</a>(CUPS_HTTP_DEFAULT, "/"); - - if (response != NULL) - { - ssize_t bytes; - char buffer[8192]; - - while ((bytes = <a href='#cupsReadResponseData'>cupsReadResponseData</a>(CUPS_HTTP_DEFAULT, buffer, sizeof(buffer))) > 0) - write(tempfd, buffer, bytes); - } -} - -/* Free the request! */ -<a href='#ippDelete'>ippDelete</a>(request); -</pre> -<h2 class="title"><a name="FUNCTIONS">Functions</a></h2> -<h3 class="function"><span class="info"> CUPS 1.1.20/macOS 10.4 </span><a name="cupsDoAuthentication">cupsDoAuthentication</a></h3> -<p class="description">Authenticate a request.</p> -<p class="code"> -int cupsDoAuthentication (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *method,<br> - const char *resource<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>method</dt> -<dd class="description">Request method ("GET", "POST", "PUT")</dd> -<dt>resource</dt> -<dd class="description">Resource path</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">This function should be called in response to a <code>HTTP_STATUS_UNAUTHORIZED</code> -status, prior to resubmitting your request. - -</p> -<h3 class="function"><a name="cupsDoFileRequest">cupsDoFileRequest</a></h3> -<p class="description">Do an IPP request with a file.</p> -<p class="code"> -<a href="#ipp_t">ipp_t</a> *cupsDoFileRequest (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#ipp_t">ipp_t</a> *request,<br> - const char *resource,<br> - const char *filename<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>request</dt> -<dd class="description">IPP request</dd> -<dt>resource</dt> -<dd class="description">HTTP resource for POST</dd> -<dt>filename</dt> -<dd class="description">File to send or <code>NULL</code> for none</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Response data</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function sends the IPP request and attached file to the specified -server, retrying and authenticating as necessary. The request is freed with -<a href="#ippDelete"><code>ippDelete</code></a>.</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsDoIORequest">cupsDoIORequest</a></h3> -<p class="description">Do an IPP request with file descriptors.</p> -<p class="code"> -<a href="#ipp_t">ipp_t</a> *cupsDoIORequest (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#ipp_t">ipp_t</a> *request,<br> - const char *resource,<br> - int infile,<br> - int outfile<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>request</dt> -<dd class="description">IPP request</dd> -<dt>resource</dt> -<dd class="description">HTTP resource for POST</dd> -<dt>infile</dt> -<dd class="description">File to read from or -1 for none</dd> -<dt>outfile</dt> -<dd class="description">File to write to or -1 for none</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Response data</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function sends the IPP request with the optional input file "infile" to -the specified server, retrying and authenticating as necessary. The request -is freed with <a href="#ippDelete"><code>ippDelete</code></a>.<br> -<br> -If "infile" is a valid file descriptor, <code>cupsDoIORequest</code> copies -all of the data from the file after the IPP request message.<br> -<br> -If "outfile" is a valid file descriptor, <code>cupsDoIORequest</code> copies -all of the data after the IPP response message to the file. - -</p> -<h3 class="function"><a name="cupsDoRequest">cupsDoRequest</a></h3> -<p class="description">Do an IPP request.</p> -<p class="code"> -<a href="#ipp_t">ipp_t</a> *cupsDoRequest (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#ipp_t">ipp_t</a> *request,<br> - const char *resource<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>request</dt> -<dd class="description">IPP request</dd> -<dt>resource</dt> -<dd class="description">HTTP resource for POST</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Response data</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function sends the IPP request to the specified server, retrying -and authenticating as necessary. The request is freed with <a href="#ippDelete"><code>ippDelete</code></a>.</p> -<h3 class="function"><a name="cupsEncodeOptions">cupsEncodeOptions</a></h3> -<p class="description">Encode printer options into IPP attributes.</p> -<p class="code"> -void cupsEncodeOptions (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - int num_options,<br> - cups_option_t *options<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">Request to add to</dd> -<dt>num_options</dt> -<dd class="description">Number of options</dd> -<dt>options</dt> -<dd class="description">Options</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function adds operation, job, and then subscription attributes, -in that order. Use the cupsEncodeOptions2() function to add attributes -for a single group.</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsEncodeOptions2">cupsEncodeOptions2</a></h3> -<p class="description">Encode printer options into IPP attributes for a group.</p> -<p class="code"> -void cupsEncodeOptions2 (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - int num_options,<br> - cups_option_t *options,<br> - ipp_tag_t group_tag<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">Request to add to</dd> -<dt>num_options</dt> -<dd class="description">Number of options</dd> -<dt>options</dt> -<dd class="description">Options</dd> -<dt>group_tag</dt> -<dd class="description">Group to encode</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function only adds attributes for a single group. Call this -function multiple times for each group, or use cupsEncodeOptions() -to add the standard groups. - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsGetDevices">cupsGetDevices</a></h3> -<p class="description">Get available printer devices.</p> -<p class="code"> -ipp_status_t cupsGetDevices (<br> - <a href="#http_t">http_t</a> *http,<br> - int timeout,<br> - const char *include_schemes,<br> - const char *exclude_schemes,<br> - cups_device_cb_t callback,<br> - void *user_data<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>timeout</dt> -<dd class="description">Timeout in seconds or <code>CUPS_TIMEOUT_DEFAULT</code></dd> -<dt>include_schemes</dt> -<dd class="description">Comma-separated URI schemes to include or <code>CUPS_INCLUDE_ALL</code></dd> -<dt>exclude_schemes</dt> -<dd class="description">Comma-separated URI schemes to exclude or <code>CUPS_EXCLUDE_NONE</code></dd> -<dt>callback</dt> -<dd class="description">Callback function</dd> -<dt>user_data</dt> -<dd class="description">User data pointer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Request status - <code>IPP_OK</code> on success.</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function sends a CUPS-Get-Devices request and streams the discovered -devices to the specified callback function. The "timeout" parameter controls -how long the request lasts, while the "include_schemes" and "exclude_schemes" -parameters provide comma-delimited lists of backends to include or omit from -the request respectively. - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.20/macOS 10.4 </span><a name="cupsGetFd">cupsGetFd</a></h3> -<p class="description">Get a file from the server.</p> -<p class="code"> -http_status_t cupsGetFd (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *resource,<br> - int fd<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>resource</dt> -<dd class="description">Resource name</dd> -<dt>fd</dt> -<dd class="description">File descriptor</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns <code>HTTP_STATUS_OK</code> when the file is successfully retrieved. - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.20/macOS 10.4 </span><a name="cupsGetFile">cupsGetFile</a></h3> -<p class="description">Get a file from the server.</p> -<p class="code"> -http_status_t cupsGetFile (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *resource,<br> - const char *filename<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>resource</dt> -<dd class="description">Resource name</dd> -<dt>filename</dt> -<dd class="description">Filename</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns <code>HTTP_STATUS_OK</code> when the file is successfully retrieved. - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsGetResponse">cupsGetResponse</a></h3> -<p class="description">Get a response to an IPP request.</p> -<p class="code"> -<a href="#ipp_t">ipp_t</a> *cupsGetResponse (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *resource<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>resource</dt> -<dd class="description">HTTP resource for POST</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Response or <code>NULL</code> on HTTP error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Use this function to get the response for an IPP request sent using -<a href="#cupsSendRequest"><code>cupsSendRequest</code></a>. For requests that return additional data, use -<a href="#cupsReadResponseData"><code>cupsReadResponseData</code></a> after getting a successful response, -otherwise call <a href="#httpFlush"><code>httpFlush</code></a> to complete the response processing. - -</p> -<h3 class="function"><a name="cupsLastError">cupsLastError</a></h3> -<p class="description">Return the last IPP status code received on the current -thread.</p> -<p class="code"> -ipp_status_t cupsLastError (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">IPP status code from last request</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsLastErrorString">cupsLastErrorString</a></h3> -<p class="description">Return the last IPP status-message received on the -current thread.</p> -<p class="code"> -const char *cupsLastErrorString (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">status-message text from last request</p> -<h3 class="function"><span class="info"> CUPS 1.1.20/macOS 10.4 </span><a name="cupsPutFd">cupsPutFd</a></h3> -<p class="description">Put a file on the server.</p> -<p class="code"> -http_status_t cupsPutFd (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *resource,<br> - int fd<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>resource</dt> -<dd class="description">Resource name</dd> -<dt>fd</dt> -<dd class="description">File descriptor</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns <code>HTTP_STATUS_CREATED</code> when the file is stored -successfully. - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.20/macOS 10.4 </span><a name="cupsPutFile">cupsPutFile</a></h3> -<p class="description">Put a file on the server.</p> -<p class="code"> -http_status_t cupsPutFile (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *resource,<br> - const char *filename<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>resource</dt> -<dd class="description">Resource name</dd> -<dt>filename</dt> -<dd class="description">Filename</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns <code>HTTP_CREATED</code> when the file is stored -successfully. - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsReadResponseData">cupsReadResponseData</a></h3> -<p class="description">Read additional data after the IPP response.</p> -<p class="code"> -ssize_t cupsReadResponseData (<br> - <a href="#http_t">http_t</a> *http,<br> - char *buffer,<br> - size_t length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>buffer</dt> -<dd class="description">Buffer to use</dd> -<dt>length</dt> -<dd class="description">Number of bytes to read</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Bytes read, 0 on EOF, -1 on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is used after <a href="#cupsGetResponse"><code>cupsGetResponse</code></a> to read the PPD or document -files from <code>CUPS_GET_PPD</code> and <code>CUPS_GET_DOCUMENT</code> requests, -respectively. - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsSendRequest">cupsSendRequest</a></h3> -<p class="description">Send an IPP request.</p> -<p class="code"> -http_status_t cupsSendRequest (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#ipp_t">ipp_t</a> *request,<br> - const char *resource,<br> - size_t length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>request</dt> -<dd class="description">IPP request</dd> -<dt>resource</dt> -<dd class="description">Resource path</dd> -<dt>length</dt> -<dd class="description">Length of data to follow or <code>CUPS_LENGTH_VARIABLE</code></dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Initial HTTP status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Use <a href="#cupsWriteRequestData"><code>cupsWriteRequestData</code></a> to write any additional data (document, PPD -file, etc.) for the request, <a href="#cupsGetResponse"><code>cupsGetResponse</code></a> to get the IPP response, -and <a href="#cupsReadResponseData"><code>cupsReadResponseData</code></a> to read any additional data following the -response. Only one request can be sent/queued at a time per <code>http_t</code> -connection.<br> -<br> -Returns the initial HTTP status code, which will be <code>HTTP_STATUS_CONTINUE</code> -on a successful send of the request.<br> -<br> -Note: Unlike <a href="#cupsDoFileRequest"><code>cupsDoFileRequest</code></a>, <a href="#cupsDoIORequest"><code>cupsDoIORequest</code></a>, and -<a href="#cupsDoRequest"><code>cupsDoRequest</code></a>, the request is NOT freed with <a href="#ippDelete"><code>ippDelete</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsWriteRequestData">cupsWriteRequestData</a></h3> -<p class="description">Write additional data after an IPP request.</p> -<p class="code"> -http_status_t cupsWriteRequestData (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *buffer,<br> - size_t length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>buffer</dt> -<dd class="description">Bytes to write</dd> -<dt>length</dt> -<dd class="description">Number of bytes to write</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description"><code>HTTP_STATUS_CONTINUE</code> if OK or HTTP status on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is used after <a href="#cupsSendRequest"><code>cupsSendRequest</code></a> to provide a PPD and -after <a href="#cupsStartDocument"><code>cupsStartDocument</code></a> to provide a document file. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpAcceptConnection">httpAcceptConnection</a></h3> -<p class="description">Accept a new HTTP client connection from the -specified listening socket.</p> -<p class="code"> -<a href="#http_t">http_t</a> *httpAcceptConnection (<br> - int fd,<br> - int blocking<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fd</dt> -<dd class="description">Listen socket file descriptor</dd> -<dt>blocking</dt> -<dd class="description">1 if the connection should be -blocking, 0 otherwise</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP connection or <code>NULL</code></p> -<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="httpAddCredential">httpAddCredential</a></h3> -<p class="description">Allocates and adds a single credential to an array.</p> -<p class="code"> -int httpAddCredential (<br> - cups_array_t *credentials,<br> - const void *data,<br> - size_t datalen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>credentials</dt> -<dd class="description">Credentials array</dd> -<dt>data</dt> -<dd class="description">PEM-encoded X.509 data</dd> -<dt>datalen</dt> -<dd class="description">Length of data</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">Use <code>cupsArrayNew(NULL, NULL)</code> to create a credentials array. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpAddrAny">httpAddrAny</a></h3> -<p class="description">Check for the "any" address.</p> -<p class="code"> -int httpAddrAny (<br> - const <a href="#http_addr_t">http_addr_t</a> *addr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr</dt> -<dd class="description">Address to check</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if "any", 0 otherwise</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpAddrClose">httpAddrClose</a></h3> -<p class="description">Close a socket created by <a href="#httpAddrConnect"><code>httpAddrConnect</code></a> or -<a href="#httpAddrListen"><code>httpAddrListen</code></a>.</p> -<p class="code"> -int httpAddrClose (<br> - <a href="#http_addr_t">http_addr_t</a> *addr,<br> - int fd<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr</dt> -<dd class="description">Listen address or <code>NULL</code></dd> -<dt>fd</dt> -<dd class="description">Socket file descriptor</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">Pass <code>NULL</code> for sockets created with <a href="#httpAddrConnect"><code>httpAddrConnect</code></a> and the -listen address for sockets created with <a href="#httpAddrListen"><code>httpAddrListen</code></a>. This will -ensure that domain sockets are removed when closed. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpAddrEqual">httpAddrEqual</a></h3> -<p class="description">Compare two addresses.</p> -<p class="code"> -int httpAddrEqual (<br> - const <a href="#http_addr_t">http_addr_t</a> *addr1,<br> - const <a href="#http_addr_t">http_addr_t</a> *addr2<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr1</dt> -<dd class="description">First address</dd> -<dt>addr2</dt> -<dd class="description">Second address</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if equal, 0 if not</p> -<h3 class="function"><a name="httpAddrFamily">httpAddrFamily</a></h3> -<p class="description">Get the address family of an address.</p> -<p class="code"> -int httpAddrFamily (<br> - <a href="#http_addr_t">http_addr_t</a> *addr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr</dt> -<dd class="description">Address</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Address family</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpAddrLength">httpAddrLength</a></h3> -<p class="description">Return the length of the address in bytes.</p> -<p class="code"> -int httpAddrLength (<br> - const <a href="#http_addr_t">http_addr_t</a> *addr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr</dt> -<dd class="description">Address</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Length in bytes</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpAddrListen">httpAddrListen</a></h3> -<p class="description">Create a listening socket bound to the specified -address and port.</p> -<p class="code"> -int httpAddrListen (<br> - <a href="#http_addr_t">http_addr_t</a> *addr,<br> - int port<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr</dt> -<dd class="description">Address to bind to</dd> -<dt>port</dt> -<dd class="description">Port number to bind to</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Socket or -1 on error</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpAddrLocalhost">httpAddrLocalhost</a></h3> -<p class="description">Check for the local loopback address.</p> -<p class="code"> -int httpAddrLocalhost (<br> - const <a href="#http_addr_t">http_addr_t</a> *addr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr</dt> -<dd class="description">Address to check</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if local host, 0 otherwise</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpAddrLookup">httpAddrLookup</a></h3> -<p class="description">Lookup the hostname associated with the address.</p> -<p class="code"> -char *httpAddrLookup (<br> - const <a href="#http_addr_t">http_addr_t</a> *addr,<br> - char *name,<br> - int namelen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr</dt> -<dd class="description">Address to lookup</dd> -<dt>name</dt> -<dd class="description">Host name buffer</dd> -<dt>namelen</dt> -<dd class="description">Size of name buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Host name</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpAddrPort">httpAddrPort</a></h3> -<p class="description">Get the port number associated with an address.</p> -<p class="code"> -int httpAddrPort (<br> - <a href="#http_addr_t">http_addr_t</a> *addr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr</dt> -<dd class="description">Address</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Port number</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpAddrString">httpAddrString</a></h3> -<p class="description">Convert an address to a numeric string.</p> -<p class="code"> -char *httpAddrString (<br> - const <a href="#http_addr_t">http_addr_t</a> *addr,<br> - char *s,<br> - int slen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>addr</dt> -<dd class="description">Address to convert</dd> -<dt>s</dt> -<dd class="description">String buffer</dd> -<dt>slen</dt> -<dd class="description">Length of string</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Numeric address string</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpAssembleURI">httpAssembleURI</a></h3> -<p class="description">Assemble a uniform resource identifier from its -components.</p> -<p class="code"> -<a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURI (<br> - <a href="#http_uri_coding_t">http_uri_coding_t</a> encoding,<br> - char *uri,<br> - int urilen,<br> - const char *scheme,<br> - const char *username,<br> - const char *host,<br> - int port,<br> - const char *resource<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>encoding</dt> -<dd class="description">Encoding flags</dd> -<dt>uri</dt> -<dd class="description">URI buffer</dd> -<dt>urilen</dt> -<dd class="description">Size of URI buffer</dd> -<dt>scheme</dt> -<dd class="description">Scheme name</dd> -<dt>username</dt> -<dd class="description">Username</dd> -<dt>host</dt> -<dd class="description">Hostname or address</dd> -<dt>port</dt> -<dd class="description">Port number</dd> -<dt>resource</dt> -<dd class="description">Resource</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">URI status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function escapes reserved characters in the URI depending on the -value of the "encoding" argument. You should use this function in -place of traditional string functions whenever you need to create a -URI string. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpAssembleURIf">httpAssembleURIf</a></h3> -<p class="description">Assemble a uniform resource identifier from its -components with a formatted resource.</p> -<p class="code"> -<a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURIf (<br> - <a href="#http_uri_coding_t">http_uri_coding_t</a> encoding,<br> - char *uri,<br> - int urilen,<br> - const char *scheme,<br> - const char *username,<br> - const char *host,<br> - int port,<br> - const char *resourcef,<br> - ...<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>encoding</dt> -<dd class="description">Encoding flags</dd> -<dt>uri</dt> -<dd class="description">URI buffer</dd> -<dt>urilen</dt> -<dd class="description">Size of URI buffer</dd> -<dt>scheme</dt> -<dd class="description">Scheme name</dd> -<dt>username</dt> -<dd class="description">Username</dd> -<dt>host</dt> -<dd class="description">Hostname or address</dd> -<dt>port</dt> -<dd class="description">Port number</dd> -<dt>resourcef</dt> -<dd class="description">Printf-style resource</dd> -<dt>...</dt> -<dd class="description">Additional arguments as needed</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">URI status</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function creates a formatted version of the resource string -argument "resourcef" and escapes reserved characters in the URI -depending on the value of the "encoding" argument. You should use -this function in place of traditional string functions whenever -you need to create a URI string. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpAssembleUUID">httpAssembleUUID</a></h3> -<p class="description">Assemble a name-based UUID URN conforming to RFC 4122.</p> -<p class="code"> -char *httpAssembleUUID (<br> - const char *server,<br> - int port,<br> - const char *name,<br> - int number,<br> - char *buffer,<br> - size_t bufsize<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>server</dt> -<dd class="description">Server name</dd> -<dt>port</dt> -<dd class="description">Port number</dd> -<dt>name</dt> -<dd class="description">Object name or NULL</dd> -<dt>number</dt> -<dd class="description">Object number or 0</dd> -<dt>buffer</dt> -<dd class="description">String buffer</dd> -<dt>bufsize</dt> -<dd class="description">Size of buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">UUID string</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function creates a unique 128-bit identifying number using the server -name, port number, random data, and optionally an object name and/or object -number. The result is formatted as a UUID URN as defined in RFC 4122.<br> -<br> -The buffer needs to be at least 46 bytes in size. - -</p> -<h3 class="function"><a name="httpBlocking">httpBlocking</a></h3> -<p class="description">Set blocking/non-blocking behavior on a connection.</p> -<p class="code"> -void httpBlocking (<br> - <a href="#http_t">http_t</a> *http,<br> - int b<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>b</dt> -<dd class="description">1 = blocking, 0 = non-blocking</dd> -</dl> -<h3 class="function"><a name="httpCheck">httpCheck</a></h3> -<p class="description">Check to see if there is a pending response from the server.</p> -<p class="code"> -int httpCheck (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 = no data, 1 = data available</p> -<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="httpClearCookie">httpClearCookie</a></h3> -<p class="description">Clear the cookie value(s).</p> -<p class="code"> -void httpClearCookie (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h3 class="function"><a name="httpClearFields">httpClearFields</a></h3> -<p class="description">Clear HTTP request fields.</p> -<p class="code"> -void httpClearFields (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h3 class="function"><a name="httpClose">httpClose</a></h3> -<p class="description">Close an HTTP connection.</p> -<p class="code"> -void httpClose (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpCompareCredentials">httpCompareCredentials</a></h3> -<p class="description">Compare two sets of X.509 credentials.</p> -<p class="code"> -int httpCompareCredentials (<br> - cups_array_t *cred1,<br> - cups_array_t *cred2<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>cred1</dt> -<dd class="description">First set of X.509 credentials</dd> -<dt>cred2</dt> -<dd class="description">Second set of X.509 credentials</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if they match, 0 if they do not</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpConnect">httpConnect</a></h3> -<p class="description">Connect to a HTTP server.</p> -<p class="code"> -<a href="#http_t">http_t</a> *httpConnect (<br> - const char *host,<br> - int port<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>host</dt> -<dd class="description">Host to connect to</dd> -<dt>port</dt> -<dd class="description">Port number</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New HTTP connection</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated - use <a href="#httpConnect2"><code>httpConnect2</code></a> instead. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpConnect2">httpConnect2</a></h3> -<p class="description">Connect to a HTTP server.</p> -<p class="code"> -<a href="#http_t">http_t</a> *httpConnect2 (<br> - const char *host,<br> - int port,<br> - <a href="#http_addrlist_t">http_addrlist_t</a> *addrlist,<br> - int family,<br> - <a href="#http_encryption_t">http_encryption_t</a> encryption,<br> - int blocking,<br> - int msec,<br> - int *cancel<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>host</dt> -<dd class="description">Host to connect to</dd> -<dt>port</dt> -<dd class="description">Port number</dd> -<dt>addrlist</dt> -<dd class="description">List of addresses or NULL to lookup</dd> -<dt>family</dt> -<dd class="description">Address family to use or <code>AF_UNSPEC</code> for any</dd> -<dt>encryption</dt> -<dd class="description">Type of encryption to use</dd> -<dt>blocking</dt> -<dd class="description">1 for blocking connection, 0 for non-blocking</dd> -<dt>msec</dt> -<dd class="description">Connection timeout in milliseconds, 0 means don't connect</dd> -<dt>cancel</dt> -<dd class="description">Pointer to "cancel" variable</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New HTTP connection</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpConnectEncrypt">httpConnectEncrypt</a></h3> -<p class="description">Connect to a HTTP server using encryption.</p> -<p class="code"> -<a href="#http_t">http_t</a> *httpConnectEncrypt (<br> - const char *host,<br> - int port,<br> - <a href="#http_encryption_t">http_encryption_t</a> encryption<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>host</dt> -<dd class="description">Host to connect to</dd> -<dt>port</dt> -<dd class="description">Port number</dd> -<dt>encryption</dt> -<dd class="description">Type of encryption to use</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New HTTP connection</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is now deprecated. Please use the <a href="#httpConnect2"><code>httpConnect2</code></a> function -instead. - -</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpDecode64">httpDecode64</a></h3> -<p class="description">Base64-decode a string.</p> -<p class="code"> -char *httpDecode64 (<br> - char *out,<br> - const char *in<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>out</dt> -<dd class="description">String to write to</dd> -<dt>in</dt> -<dd class="description">String to read from</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Decoded string</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated. Use the httpDecode64_2() function instead -which provides buffer length arguments. - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="httpDecode64_2">httpDecode64_2</a></h3> -<p class="description">Base64-decode a string.</p> -<p class="code"> -char *httpDecode64_2 (<br> - char *out,<br> - int *outlen,<br> - const char *in<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>out</dt> -<dd class="description">String to write to</dd> -<dt>outlen</dt> -<dd class="description">Size of output string</dd> -<dt>in</dt> -<dd class="description">String to read from</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Decoded string</p> -<h3 class="function"><a name="httpDelete">httpDelete</a></h3> -<p class="description">Send a DELETE request to the server.</p> -<p class="code"> -int httpDelete (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *uri<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>uri</dt> -<dd class="description">URI to delete</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of call (0 = success)</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpEncode64">httpEncode64</a></h3> -<p class="description">Base64-encode a string.</p> -<p class="code"> -char *httpEncode64 (<br> - char *out,<br> - const char *in<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>out</dt> -<dd class="description">String to write to</dd> -<dt>in</dt> -<dd class="description">String to read from</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Encoded string</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated. Use the httpEncode64_2() function instead -which provides buffer length arguments. - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="httpEncode64_2">httpEncode64_2</a></h3> -<p class="description">Base64-encode a string.</p> -<p class="code"> -char *httpEncode64_2 (<br> - char *out,<br> - int outlen,<br> - const char *in,<br> - int inlen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>out</dt> -<dd class="description">String to write to</dd> -<dt>outlen</dt> -<dd class="description">Size of output string</dd> -<dt>in</dt> -<dd class="description">String to read from</dd> -<dt>inlen</dt> -<dd class="description">Size of input string</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Encoded string</p> -<h3 class="function"><a name="httpEncryption">httpEncryption</a></h3> -<p class="description">Set the required encryption on the link.</p> -<p class="code"> -int httpEncryption (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#http_encryption_t">http_encryption_t</a> e<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>e</dt> -<dd class="description">New encryption preference</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">-1 on error, 0 on success</p> -<h3 class="function"><a name="httpError">httpError</a></h3> -<p class="description">Get the last error on a connection.</p> -<p class="code"> -int httpError (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Error code (errno) value</p> -<h3 class="function"><a name="httpFieldValue">httpFieldValue</a></h3> -<p class="description">Return the HTTP field enumeration value for a field -name.</p> -<p class="code"> -<a href="#http_field_t">http_field_t</a> httpFieldValue (<br> - const char *name<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">String name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Field index</p> -<h3 class="function"><a name="httpFlush">httpFlush</a></h3> -<p class="description">Flush data from a HTTP connection.</p> -<p class="code"> -void httpFlush (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpFlushWrite">httpFlushWrite</a></h3> -<p class="description">Flush data in write buffer.</p> -<p class="code"> -int httpFlushWrite (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Bytes written or -1 on error</p> -<h3 class="function"><a name="httpFreeCredentials">httpFreeCredentials</a></h3> -<p class="description">Free an array of credentials.</p> -<p class="code"> -void httpFreeCredentials (<br> - cups_array_t *credentials<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>credentials</dt> -<dd class="description">Array of credentials</dd> -</dl> -<h3 class="function"><a name="httpGet">httpGet</a></h3> -<p class="description">Send a GET request to the server.</p> -<p class="code"> -int httpGet (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *uri<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>uri</dt> -<dd class="description">URI to get</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of call (0 = success)</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpGetActivity">httpGetActivity</a></h3> -<p class="description">Get the most recent activity for a connection.</p> -<p class="code"> -time_t httpGetActivity (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Time of last read or write</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The return value is the UNIX time of the last read or write. - -</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpGetAddress">httpGetAddress</a></h3> -<p class="description">Get the address of the connected peer of a connection.</p> -<p class="code"> -<a href="#http_addr_t">http_addr_t</a> *httpGetAddress (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Connected address or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Returns <code>NULL</code> if the socket is currently unconnected. - -</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="httpGetAuthString">httpGetAuthString</a></h3> -<p class="description">Get the current authorization string.</p> -<p class="code"> -char *httpGetAuthString (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Authorization string</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The authorization string is set by cupsDoAuthentication() and -httpSetAuthString(). Use httpGetAuthString() to retrieve the -string to use with httpSetField() for the HTTP_FIELD_AUTHORIZATION -value. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpGetBlocking">httpGetBlocking</a></h3> -<p class="description">Get the blocking/non-block state of a connection.</p> -<p class="code"> -int httpGetBlocking (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if blocking, 0 if non-blocking</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpGetContentEncoding">httpGetContentEncoding</a></h3> -<p class="description">Get a common content encoding, if any, between -the client and server.</p> -<p class="code"> -const char *httpGetContentEncoding (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Content-Coding value or -<code>NULL</code> for the identity -coding.</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function uses the value of the Accepts-Encoding HTTP header and must be -called after receiving a response from the server or a request from the -client. The value returned can be use in subsequent requests (for clients) -or in the response (for servers) in order to compress the content stream. - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="httpGetCookie">httpGetCookie</a></h3> -<p class="description">Get any cookie data from the response.</p> -<p class="code"> -const char *httpGetCookie (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Cookie data or NULL</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpGetDateString">httpGetDateString</a></h3> -<p class="description">Get a formatted date/time string from a time value.</p> -<p class="code"> -const char *httpGetDateString (<br> - time_t t<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>t</dt> -<dd class="description">UNIX time</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Date/time string</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpGetDateString2">httpGetDateString2</a></h3> -<p class="description">Get a formatted date/time string from a time value.</p> -<p class="code"> -const char *httpGetDateString2 (<br> - time_t t,<br> - char *s,<br> - int slen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>t</dt> -<dd class="description">UNIX time</dd> -<dt>s</dt> -<dd class="description">String buffer</dd> -<dt>slen</dt> -<dd class="description">Size of string buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Date/time string</p> -<h3 class="function"><a name="httpGetDateTime">httpGetDateTime</a></h3> -<p class="description">Get a time value from a formatted date/time string.</p> -<p class="code"> -time_t httpGetDateTime (<br> - const char *s<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>s</dt> -<dd class="description">Date/time string</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">UNIX time</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpGetEncryption">httpGetEncryption</a></h3> -<p class="description">Get the current encryption mode of a connection.</p> -<p class="code"> -<a href="#http_encryption_t">http_encryption_t</a> httpGetEncryption (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Current encryption mode</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns the encryption mode for the connection. Use the -<a href="#httpIsEncrypted"><code>httpIsEncrypted</code></a> function to determine whether a TLS session has -been established. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpGetExpect">httpGetExpect</a></h3> -<p class="description">Get the value of the Expect header, if any.</p> -<p class="code"> -http_status_t httpGetExpect (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Expect: status, if any</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Returns <code>HTTP_STATUS_NONE</code> if there is no Expect header, otherwise -returns the expected HTTP status code, typically <code>HTTP_STATUS_CONTINUE</code>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpGetFd">httpGetFd</a></h3> -<p class="description">Get the file descriptor associated with a connection.</p> -<p class="code"> -int httpGetFd (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">File descriptor or -1 if none</p> -<h3 class="function"><a name="httpGetField">httpGetField</a></h3> -<p class="description">Get a field value from a request/response.</p> -<p class="code"> -const char *httpGetField (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#http_field_t">http_field_t</a> field<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>field</dt> -<dd class="description">Field to get</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Field value</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpGetHostByName">httpGetHostByName</a></h3> -<p class="description">Lookup a hostname or IPv4 address, and return -address records for the specified name.</p> -<p class="code"> -struct hostent *httpGetHostByName (<br> - const char *name<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Hostname or IP address</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Host entry</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpGetHostname">httpGetHostname</a></h3> -<p class="description">Get the FQDN for the connection or local system.</p> -<p class="code"> -const char *httpGetHostname (<br> - <a href="#http_t">http_t</a> *http,<br> - char *s,<br> - int slen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection or NULL</dd> -<dt>s</dt> -<dd class="description">String buffer for name</dd> -<dt>slen</dt> -<dd class="description">Size of buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">FQDN for connection or system</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">When "http" points to a connected socket, return the hostname or -address that was used in the call to httpConnect() or httpConnectEncrypt(), -or the address of the client for the connection from httpAcceptConnection(). -Otherwise, return the FQDN for the local system using both gethostname() -and gethostbyname() to get the local hostname with domain. - -</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpGetKeepAlive">httpGetKeepAlive</a></h3> -<p class="description">Get the current Keep-Alive state of the connection.</p> -<p class="code"> -<a href="#http_keepalive_t">http_keepalive_t</a> httpGetKeepAlive (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Keep-Alive state</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpGetLength">httpGetLength</a></h3> -<p class="description">Get the amount of data remaining from the -content-length or transfer-encoding fields.</p> -<p class="code"> -int httpGetLength (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Content length</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated and will not return lengths larger than -2^31 - 1; use httpGetLength2() instead. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpGetLength2">httpGetLength2</a></h3> -<p class="description">Get the amount of data remaining from the -content-length or transfer-encoding fields.</p> -<p class="code"> -off_t httpGetLength2 (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Content length</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns the complete content length, even for -content larger than 2^31 - 1. - -</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpGetPending">httpGetPending</a></h3> -<p class="description">Get the number of bytes that are buffered for writing.</p> -<p class="code"> -size_t httpGetPending (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes buffered</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpGetReady">httpGetReady</a></h3> -<p class="description">Get the number of bytes that can be read without blocking.</p> -<p class="code"> -size_t httpGetReady (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes available</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpGetRemaining">httpGetRemaining</a></h3> -<p class="description">Get the number of remaining bytes in the message -body or current chunk.</p> -<p class="code"> -size_t httpGetRemaining (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Remaining bytes</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <a href="#httpIsChunked"><code>httpIsChunked</code></a> function can be used to determine whether the -message body is chunked or fixed-length. - -</p> -<h3 class="function"><a name="httpGetState">httpGetState</a></h3> -<p class="description">Get the current state of the HTTP request.</p> -<p class="code"> -<a href="#http_state_t">http_state_t</a> httpGetState (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP state</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpGetStatus">httpGetStatus</a></h3> -<p class="description">Get the status of the last HTTP request.</p> -<p class="code"> -http_status_t httpGetStatus (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpGetSubField">httpGetSubField</a></h3> -<p class="description">Get a sub-field value.</p> -<p class="code"> -char *httpGetSubField (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#http_field_t">http_field_t</a> field,<br> - const char *name,<br> - char *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>field</dt> -<dd class="description">Field index</dd> -<dt>name</dt> -<dd class="description">Name of sub-field</dd> -<dt>value</dt> -<dd class="description">Value string</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Value or NULL</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpGetSubField2">httpGetSubField2</a></h3> -<p class="description">Get a sub-field value.</p> -<p class="code"> -char *httpGetSubField2 (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#http_field_t">http_field_t</a> field,<br> - const char *name,<br> - char *value,<br> - int valuelen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>field</dt> -<dd class="description">Field index</dd> -<dt>name</dt> -<dd class="description">Name of sub-field</dd> -<dt>value</dt> -<dd class="description">Value string</dd> -<dt>valuelen</dt> -<dd class="description">Size of value buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Value or NULL</p> -<h3 class="function"><a name="httpGetVersion">httpGetVersion</a></h3> -<p class="description">Get the HTTP version at the other end.</p> -<p class="code"> -<a href="#http_version_t">http_version_t</a> httpGetVersion (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Version number</p> -<h3 class="function"><a name="httpGets">httpGets</a></h3> -<p class="description">Get a line of text from a HTTP connection.</p> -<p class="code"> -char *httpGets (<br> - char *line,<br> - int length,<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>line</dt> -<dd class="description">Line to read into</dd> -<dt>length</dt> -<dd class="description">Max length of buffer</dd> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Line or NULL</p> -<h3 class="function"><a name="httpHead">httpHead</a></h3> -<p class="description">Send a HEAD request to the server.</p> -<p class="code"> -int httpHead (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *uri<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>uri</dt> -<dd class="description">URI for head</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of call (0 = success)</p> -<h3 class="function"><a name="httpInitialize">httpInitialize</a></h3> -<p class="description">Initialize the HTTP interface library and set the -default HTTP proxy (if any).</p> -<p class="code"> -void httpInitialize (void);</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpIsChunked">httpIsChunked</a></h3> -<p class="description">Report whether a message body is chunked.</p> -<p class="code"> -int httpIsChunked (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if chunked, 0 if not</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns non-zero if the message body is composed of -variable-length chunks. - -</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpIsEncrypted">httpIsEncrypted</a></h3> -<p class="description">Report whether a connection is encrypted.</p> -<p class="code"> -int httpIsEncrypted (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if encrypted, 0 if not</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns non-zero if the connection is currently encrypted. - -</p> -<h3 class="function"><a name="httpMD5">httpMD5</a></h3> -<p class="description">Compute the MD5 sum of the username:group:password.</p> -<p class="code"> -char *httpMD5 (<br> - const char *username,<br> - const char *realm,<br> - const char *passwd,<br> - char md5[33]<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>username</dt> -<dd class="description">User name</dd> -<dt>realm</dt> -<dd class="description">Realm name</dd> -<dt>passwd</dt> -<dd class="description">Password string</dd> -<dt>md5[33]</dt> -<dd class="description">MD5 string</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">MD5 sum</p> -<h3 class="function"><a name="httpMD5Final">httpMD5Final</a></h3> -<p class="description">Combine the MD5 sum of the username, group, and password -with the server-supplied nonce value, method, and -request-uri.</p> -<p class="code"> -char *httpMD5Final (<br> - const char *nonce,<br> - const char *method,<br> - const char *resource,<br> - char md5[33]<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>nonce</dt> -<dd class="description">Server nonce value</dd> -<dt>method</dt> -<dd class="description">METHOD (GET, POST, etc.)</dd> -<dt>resource</dt> -<dd class="description">Resource path</dd> -<dt>md5[33]</dt> -<dd class="description">MD5 sum</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New sum</p> -<h3 class="function"><a name="httpMD5String">httpMD5String</a></h3> -<p class="description">Convert an MD5 sum to a character string.</p> -<p class="code"> -char *httpMD5String (<br> - const unsigned char *sum,<br> - char md5[33]<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>sum</dt> -<dd class="description">MD5 sum data</dd> -<dt>md5[33]</dt> -<dd class="description">MD5 sum in hex</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">MD5 sum in hex</p> -<h3 class="function"><a name="httpOptions">httpOptions</a></h3> -<p class="description">Send an OPTIONS request to the server.</p> -<p class="code"> -int httpOptions (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *uri<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>uri</dt> -<dd class="description">URI for options</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of call (0 = success)</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpPeek">httpPeek</a></h3> -<p class="description">Peek at data from a HTTP connection.</p> -<p class="code"> -ssize_t httpPeek (<br> - <a href="#http_t">http_t</a> *http,<br> - char *buffer,<br> - size_t length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>buffer</dt> -<dd class="description">Buffer for data</dd> -<dt>length</dt> -<dd class="description">Maximum number of bytes</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes copied</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function copies available data from the given HTTP connection, reading -a buffer as needed. The data is still available for reading using -<a href="#httpRead"><code>httpRead</code></a> or <a href="#httpRead2"><code>httpRead2</code></a>.<br> -<br> -For non-blocking connections the usual timeouts apply. - -</p> -<h3 class="function"><a name="httpPost">httpPost</a></h3> -<p class="description">Send a POST request to the server.</p> -<p class="code"> -int httpPost (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *uri<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>uri</dt> -<dd class="description">URI for post</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of call (0 = success)</p> -<h3 class="function"><a name="httpPut">httpPut</a></h3> -<p class="description">Send a PUT request to the server.</p> -<p class="code"> -int httpPut (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *uri<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>uri</dt> -<dd class="description">URI to put</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of call (0 = success)</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpRead">httpRead</a></h3> -<p class="description">Read data from a HTTP connection.</p> -<p class="code"> -int httpRead (<br> - <a href="#http_t">http_t</a> *http,<br> - char *buffer,<br> - int length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>buffer</dt> -<dd class="description">Buffer for data</dd> -<dt>length</dt> -<dd class="description">Maximum number of bytes</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes read</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated. Use the httpRead2() function which can -read more than 2GB of data. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpRead2">httpRead2</a></h3> -<p class="description">Read data from a HTTP connection.</p> -<p class="code"> -ssize_t httpRead2 (<br> - <a href="#http_t">http_t</a> *http,<br> - char *buffer,<br> - size_t length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>buffer</dt> -<dd class="description">Buffer for data</dd> -<dt>length</dt> -<dd class="description">Maximum number of bytes</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes read</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpReadRequest">httpReadRequest</a></h3> -<p class="description">Read a HTTP request from a connection.</p> -<p class="code"> -<a href="#http_state_t">http_state_t</a> httpReadRequest (<br> - <a href="#http_t">http_t</a> *http,<br> - char *uri,<br> - size_t urilen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>uri</dt> -<dd class="description">URI buffer</dd> -<dt>urilen</dt> -<dd class="description">Size of URI buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New state of connection</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpReconnect">httpReconnect</a></h3> -<p class="description">Reconnect to a HTTP server.</p> -<p class="code"> -int httpReconnect (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, non-zero on failure</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated. Please use the <a href="#httpReconnect2"><code>httpReconnect2</code></a> function -instead. - -</p> -<h3 class="function"><a name="httpReconnect2">httpReconnect2</a></h3> -<p class="description">Reconnect to a HTTP server with timeout and optional -cancel.</p> -<p class="code"> -int httpReconnect2 (<br> - <a href="#http_t">http_t</a> *http,<br> - int msec,<br> - int *cancel<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>msec</dt> -<dd class="description">Timeout in milliseconds</dd> -<dt>cancel</dt> -<dd class="description">Pointer to "cancel" variable</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, non-zero on failure</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpResolveHostname">httpResolveHostname</a></h3> -<p class="description">Resolve the hostname of the HTTP connection -address.</p> -<p class="code"> -const char *httpResolveHostname (<br> - <a href="#http_t">http_t</a> *http,<br> - char *buffer,<br> - size_t bufsize<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>buffer</dt> -<dd class="description">Hostname buffer</dd> -<dt>bufsize</dt> -<dd class="description">Size of buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Resolved hostname or <code>NULL</code></p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpSeparate">httpSeparate</a></h3> -<p class="description">Separate a Universal Resource Identifier into its -components.</p> -<p class="code"> -void httpSeparate (<br> - const char *uri,<br> - char *scheme,<br> - char *username,<br> - char *host,<br> - int *port,<br> - char *resource<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>uri</dt> -<dd class="description">Universal Resource Identifier</dd> -<dt>scheme</dt> -<dd class="description">Scheme [32] (http, https, etc.)</dd> -<dt>username</dt> -<dd class="description">Username [1024]</dd> -<dt>host</dt> -<dd class="description">Hostname [1024]</dd> -<dt>port</dt> -<dd class="description">Port number to use</dd> -<dt>resource</dt> -<dd class="description">Resource/filename [1024]</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated; use the httpSeparateURI() function instead. - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="httpSeparate2">httpSeparate2</a></h3> -<p class="description">Separate a Universal Resource Identifier into its -components.</p> -<p class="code"> -void httpSeparate2 (<br> - const char *uri,<br> - char *scheme,<br> - int schemelen,<br> - char *username,<br> - int usernamelen,<br> - char *host,<br> - int hostlen,<br> - int *port,<br> - char *resource,<br> - int resourcelen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>uri</dt> -<dd class="description">Universal Resource Identifier</dd> -<dt>scheme</dt> -<dd class="description">Scheme (http, https, etc.)</dd> -<dt>schemelen</dt> -<dd class="description">Size of scheme buffer</dd> -<dt>username</dt> -<dd class="description">Username</dd> -<dt>usernamelen</dt> -<dd class="description">Size of username buffer</dd> -<dt>host</dt> -<dd class="description">Hostname</dd> -<dt>hostlen</dt> -<dd class="description">Size of hostname buffer</dd> -<dt>port</dt> -<dd class="description">Port number to use</dd> -<dt>resource</dt> -<dd class="description">Resource/filename</dd> -<dt>resourcelen</dt> -<dd class="description">Size of resource buffer</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated; use the httpSeparateURI() function instead. - - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpSeparateURI">httpSeparateURI</a></h3> -<p class="description">Separate a Universal Resource Identifier into its -components.</p> -<p class="code"> -<a href="#http_uri_status_t">http_uri_status_t</a> httpSeparateURI (<br> - <a href="#http_uri_coding_t">http_uri_coding_t</a> decoding,<br> - const char *uri,<br> - char *scheme,<br> - int schemelen,<br> - char *username,<br> - int usernamelen,<br> - char *host,<br> - int hostlen,<br> - int *port,<br> - char *resource,<br> - int resourcelen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>decoding</dt> -<dd class="description">Decoding flags</dd> -<dt>uri</dt> -<dd class="description">Universal Resource Identifier</dd> -<dt>scheme</dt> -<dd class="description">Scheme (http, https, etc.)</dd> -<dt>schemelen</dt> -<dd class="description">Size of scheme buffer</dd> -<dt>username</dt> -<dd class="description">Username</dd> -<dt>usernamelen</dt> -<dd class="description">Size of username buffer</dd> -<dt>host</dt> -<dd class="description">Hostname</dd> -<dt>hostlen</dt> -<dd class="description">Size of hostname buffer</dd> -<dt>port</dt> -<dd class="description">Port number to use</dd> -<dt>resource</dt> -<dd class="description">Resource/filename</dd> -<dt>resourcelen</dt> -<dd class="description">Size of resource buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Result of separation</p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="httpSetAuthString">httpSetAuthString</a></h3> -<p class="description">Set the current authorization string.</p> -<p class="code"> -void httpSetAuthString (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *scheme,<br> - const char *data<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>scheme</dt> -<dd class="description">Auth scheme (NULL to clear it)</dd> -<dt>data</dt> -<dd class="description">Auth data (NULL for none)</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function just stores a copy of the current authorization string in -the HTTP connection object. You must still call httpSetField() to set -HTTP_FIELD_AUTHORIZATION prior to issuing a HTTP request using httpGet(), -httpHead(), httpOptions(), httpPost, or httpPut(). - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="httpSetCookie">httpSetCookie</a></h3> -<p class="description">Set the cookie value(s).</p> -<p class="code"> -void httpSetCookie (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *cookie<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection</dd> -<dt>cookie</dt> -<dd class="description">Cookie string</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="httpSetCredentials">httpSetCredentials</a></h3> -<p class="description">Set the credentials associated with an encrypted -connection.</p> -<p class="code"> -int httpSetCredentials (<br> - <a href="#http_t">http_t</a> *http,<br> - cups_array_t *credentials<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>credentials</dt> -<dd class="description">Array of credentials</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of call (0 = success)</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpSetDefaultField">httpSetDefaultField</a></h3> -<p class="description">Set the default value of an HTTP header.</p> -<p class="code"> -void httpSetDefaultField (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#http_field_t">http_field_t</a> field,<br> - const char *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>field</dt> -<dd class="description">Field index</dd> -<dt>value</dt> -<dd class="description">Value</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Currently only <code>HTTP_FIELD_ACCEPT_ENCODING</code>, <code>HTTP_FIELD_SERVER</code>, -and <code>HTTP_FIELD_USER_AGENT</code> can be set. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpSetExpect">httpSetExpect</a></h3> -<p class="description">Set the Expect: header in a request.</p> -<p class="code"> -void httpSetExpect (<br> - <a href="#http_t">http_t</a> *http,<br> - http_status_t expect<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>expect</dt> -<dd class="description">HTTP status to expect -(<code>HTTP_STATUS_CONTINUE</code>)</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Currently only <code>HTTP_STATUS_CONTINUE</code> is supported for the "expect" -argument. - -</p> -<h3 class="function"><a name="httpSetField">httpSetField</a></h3> -<p class="description">Set the value of an HTTP header.</p> -<p class="code"> -void httpSetField (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#http_field_t">http_field_t</a> field,<br> - const char *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>field</dt> -<dd class="description">Field index</dd> -<dt>value</dt> -<dd class="description">Value</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpSetKeepAlive">httpSetKeepAlive</a></h3> -<p class="description">Set the current Keep-Alive state of a connection.</p> -<p class="code"> -void httpSetKeepAlive (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#http_keepalive_t">http_keepalive_t</a> keep_alive<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>keep_alive</dt> -<dd class="description">New Keep-Alive value</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpSetLength">httpSetLength</a></h3> -<p class="description">Set the content-length and content-encoding.</p> -<p class="code"> -void httpSetLength (<br> - <a href="#http_t">http_t</a> *http,<br> - size_t length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>length</dt> -<dd class="description">Length (0 for chunked)</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="httpSetTimeout">httpSetTimeout</a></h3> -<p class="description">Set read/write timeouts and an optional callback.</p> -<p class="code"> -void httpSetTimeout (<br> - <a href="#http_t">http_t</a> *http,<br> - double timeout,<br> - <a href="#http_timeout_cb_t">http_timeout_cb_t</a> cb,<br> - void *user_data<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>timeout</dt> -<dd class="description">Number of seconds for timeout, -must be greater than 0</dd> -<dt>cb</dt> -<dd class="description">Callback function or NULL</dd> -<dt>user_data</dt> -<dd class="description">User data pointer</dd> -</dl> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The optional timeout callback receives both the HTTP connection and a user -data pointer and must return 1 to continue or 0 to error (time) out. - -</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpShutdown">httpShutdown</a></h3> -<p class="description">Shutdown one side of an HTTP connection.</p> -<p class="code"> -void httpShutdown (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpStateString">httpStateString</a></h3> -<p class="description">Return the string describing a HTTP state value.</p> -<p class="code"> -const char *httpStateString (<br> - <a href="#http_state_t">http_state_t</a> state<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>state</dt> -<dd class="description">HTTP state value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">State string</p> -<h3 class="function"><a name="httpStatus">httpStatus</a></h3> -<p class="description">Return a short string describing a HTTP status code.</p> -<p class="code"> -const char *httpStatus (<br> - http_status_t status<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>status</dt> -<dd class="description">HTTP status code</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Localized status string</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned string is localized to the current POSIX locale and is based -on the status strings defined in RFC 2616.</p> -<h3 class="function"><a name="httpTrace">httpTrace</a></h3> -<p class="description">Send an TRACE request to the server.</p> -<p class="code"> -int httpTrace (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *uri<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>uri</dt> -<dd class="description">URI for trace</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status of call (0 = success)</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="httpURIStatusString">httpURIStatusString</a></h3> -<p class="description">Return a string describing a URI status code.</p> -<p class="code"> -const char *httpURIStatusString (<br> - <a href="#http_uri_status_t">http_uri_status_t</a> status<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>status</dt> -<dd class="description">URI status code</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Localized status string</p> -<h3 class="function"><a name="httpUpdate">httpUpdate</a></h3> -<p class="description">Update the current HTTP state for incoming data.</p> -<p class="code"> -http_status_t httpUpdate (<br> - <a href="#http_t">http_t</a> *http<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> -<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="httpWait">httpWait</a></h3> -<p class="description">Wait for data available on a connection.</p> -<p class="code"> -int httpWait (<br> - <a href="#http_t">http_t</a> *http,<br> - int msec<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>msec</dt> -<dd class="description">Milliseconds to wait</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if data is available, 0 otherwise</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="httpWrite">httpWrite</a></h3> -<p class="description">Write data to a HTTP connection.</p> -<p class="code"> -int httpWrite (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *buffer,<br> - int length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>buffer</dt> -<dd class="description">Buffer for data</dd> -<dt>length</dt> -<dd class="description">Number of bytes to write</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes written</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated. Use the httpWrite2() function which can -write more than 2GB of data. - -</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="httpWrite2">httpWrite2</a></h3> -<p class="description">Write data to a HTTP connection.</p> -<p class="code"> -ssize_t httpWrite2 (<br> - <a href="#http_t">http_t</a> *http,<br> - const char *buffer,<br> - size_t length<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>buffer</dt> -<dd class="description">Buffer for data</dd> -<dt>length</dt> -<dd class="description">Number of bytes to write</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes written</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="httpWriteResponse">httpWriteResponse</a></h3> -<p class="description">Write a HTTP response to a client connection.</p> -<p class="code"> -int httpWriteResponse (<br> - <a href="#http_t">http_t</a> *http,<br> - http_status_t status<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>status</dt> -<dd class="description">Status code</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on error</p> -<h3 class="function"><a name="ippAddBoolean">ippAddBoolean</a></h3> -<p class="description">Add a boolean attribute to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBoolean (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - char value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>value</dt> -<dd class="description">Value of attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> -<h3 class="function"><a name="ippAddBooleans">ippAddBooleans</a></h3> -<p class="description">Add an array of boolean values.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBooleans (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - int num_values,<br> - const char *values<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>num_values</dt> -<dd class="description">Number of values</dd> -<dt>values</dt> -<dd class="description">Values</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> -<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="ippAddCollection">ippAddCollection</a></h3> -<p class="description">Add a collection value.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollection (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - <a href="#ipp_t">ipp_t</a> *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>value</dt> -<dd class="description">Value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). - -</p> -<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="ippAddCollections">ippAddCollections</a></h3> -<p class="description">Add an array of collection values.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollections (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - int num_values,<br> - const <a href="#ipp_t">ipp_t</a> **values<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>num_values</dt> -<dd class="description">Number of values</dd> -<dt>values</dt> -<dd class="description">Values</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). - -</p> -<h3 class="function"><a name="ippAddDate">ippAddDate</a></h3> -<p class="description">Add a date attribute to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddDate (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - const <a href="#ipp_uchar_t">ipp_uchar_t</a> *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>value</dt> -<dd class="description">Value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> -<h3 class="function"><a name="ippAddInteger">ippAddInteger</a></h3> -<p class="description">Add a integer attribute to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddInteger (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - ipp_tag_t value_tag,<br> - const char *name,<br> - int value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>value_tag</dt> -<dd class="description">Type of attribute</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>value</dt> -<dd class="description">Value of attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> -<br> -Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer -(<code>IPP_TAG_INTEGER</code>).</p> -<h3 class="function"><a name="ippAddIntegers">ippAddIntegers</a></h3> -<p class="description">Add an array of integer values.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddIntegers (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - ipp_tag_t value_tag,<br> - const char *name,<br> - int num_values,<br> - const int *values<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>value_tag</dt> -<dd class="description">Type of attribute</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>num_values</dt> -<dd class="description">Number of values</dd> -<dt>values</dt> -<dd class="description">Values</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> -<br> -Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer -(<code>IPP_TAG_INTEGER</code>).</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ippAddOctetString">ippAddOctetString</a></h3> -<p class="description">Add an octetString value to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddOctetString (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - const void *data,<br> - int datalen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>data</dt> -<dd class="description">octetString data</dd> -<dt>datalen</dt> -<dd class="description">Length of data in bytes</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippAddOutOfBand">ippAddOutOfBand</a></h3> -<p class="description">Add an out-of-band value to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddOutOfBand (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - ipp_tag_t value_tag,<br> - const char *name<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>value_tag</dt> -<dd class="description">Type of attribute</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> -<br> -Supported out-of-band values include unsupported-value -(<code>IPP_TAG_UNSUPPORTED_VALUE</code>), default (<code>IPP_TAG_DEFAULT</code>), unknown -(<code>IPP_TAG_UNKNOWN</code>), no-value (<code>IPP_TAG_NOVALUE</code>), not-settable -(<code>IPP_TAG_NOTSETTABLE</code>), delete-attribute (<code>IPP_TAG_DELETEATTR</code>), and -admin-define (<code>IPP_TAG_ADMINDEFINE</code>). - -</p> -<h3 class="function"><a name="ippAddRange">ippAddRange</a></h3> -<p class="description">Add a range of values to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRange (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - int lower,<br> - int upper<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>lower</dt> -<dd class="description">Lower value</dd> -<dt>upper</dt> -<dd class="description">Upper value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> -<br> -The <code>lower</code> parameter must be less than or equal to the <code>upper</code> parameter.</p> -<h3 class="function"><a name="ippAddRanges">ippAddRanges</a></h3> -<p class="description">Add ranges of values to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRanges (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - int num_values,<br> - const int *lower,<br> - const int *upper<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>num_values</dt> -<dd class="description">Number of values</dd> -<dt>lower</dt> -<dd class="description">Lower values</dd> -<dt>upper</dt> -<dd class="description">Upper values</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> -<h3 class="function"><a name="ippAddResolution">ippAddResolution</a></h3> -<p class="description">Add a resolution value to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolution (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - <a href="#ipp_res_t">ipp_res_t</a> units,<br> - int xres,<br> - int yres<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>units</dt> -<dd class="description">Units for resolution</dd> -<dt>xres</dt> -<dd class="description">X resolution</dd> -<dt>yres</dt> -<dd class="description">Y resolution</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> -<h3 class="function"><a name="ippAddResolutions">ippAddResolutions</a></h3> -<p class="description">Add resolution values to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolutions (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - const char *name,<br> - int num_values,<br> - <a href="#ipp_res_t">ipp_res_t</a> units,<br> - const int *xres,<br> - const int *yres<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>num_values</dt> -<dd class="description">Number of values</dd> -<dt>units</dt> -<dd class="description">Units for resolution</dd> -<dt>xres</dt> -<dd class="description">X resolutions</dd> -<dt>yres</dt> -<dd class="description">Y resolutions</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> -<h3 class="function"><a name="ippAddSeparator">ippAddSeparator</a></h3> -<p class="description">Add a group separator to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddSeparator (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.</p> -<h3 class="function"><a name="ippAddString">ippAddString</a></h3> -<p class="description">Add a language-encoded string to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddString (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - ipp_tag_t value_tag,<br> - const char *name,<br> - const char *language,<br> - const char *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>value_tag</dt> -<dd class="description">Type of attribute</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>language</dt> -<dd class="description">Language code</dd> -<dt>value</dt> -<dd class="description">Value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> -<br> -Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword -(<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType -(<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage -(<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage -(<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme -(<code>IPP_TAG_URISCHEME</code>).<br> -<br> -The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and -textWithLanguage string values and must be <code>NULL</code> for all other string values.</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippAddStringf">ippAddStringf</a></h3> -<p class="description">Add a formatted string to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStringf (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - ipp_tag_t value_tag,<br> - const char *name,<br> - const char *language,<br> - const char *format,<br> - ...<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>value_tag</dt> -<dd class="description">Type of attribute</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>language</dt> -<dd class="description">Language code (<code>NULL</code> for default)</dd> -<dt>format</dt> -<dd class="description">Printf-style format string</dd> -<dt>...</dt> -<dd class="description">Additional arguments as needed</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document -(<code>IPP_TAG_DOCUMENT</code>), event notification -(<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), -printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), -or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> -<br> -Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword -(<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType -(<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage -(<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage -(<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme -(<code>IPP_TAG_URISCHEME</code>).<br> -<br> -The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage -and textWithLanguage string values and must be <code>NULL</code> for all other -string values.<br> -<br> -The <code>format</code> parameter uses formatting characters compatible with the -printf family of standard functions. Additional arguments follow it as -needed. The formatted string is truncated as needed to the maximum length of -the corresponding value type. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippAddStringfv">ippAddStringfv</a></h3> -<p class="description">Add a formatted string to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStringfv (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - ipp_tag_t value_tag,<br> - const char *name,<br> - const char *language,<br> - const char *format,<br> - va_list ap<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>value_tag</dt> -<dd class="description">Type of attribute</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>language</dt> -<dd class="description">Language code (<code>NULL</code> for default)</dd> -<dt>format</dt> -<dd class="description">Printf-style format string</dd> -<dt>ap</dt> -<dd class="description">Additional arguments</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document -(<code>IPP_TAG_DOCUMENT</code>), event notification -(<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), -printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), -or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> -<br> -Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword -(<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType -(<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage -(<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage -(<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme -(<code>IPP_TAG_URISCHEME</code>).<br> -<br> -The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage -and textWithLanguage string values and must be <code>NULL</code> for all other -string values.<br> -<br> -The <code>format</code> parameter uses formatting characters compatible with the -printf family of standard functions. Additional arguments are passed in the -stdarg pointer <code>ap</code>. The formatted string is truncated as needed to the -maximum length of the corresponding value type. - -</p> -<h3 class="function"><a name="ippAddStrings">ippAddStrings</a></h3> -<p class="description">Add language-encoded strings to an IPP message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStrings (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_tag_t group,<br> - ipp_tag_t value_tag,<br> - const char *name,<br> - int num_values,<br> - const char *language,<br> - const char *const *values<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>group</dt> -<dd class="description">IPP group</dd> -<dt>value_tag</dt> -<dd class="description">Type of attribute</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>num_values</dt> -<dd class="description">Number of values</dd> -<dt>language</dt> -<dd class="description">Language code (<code>NULL</code> for default)</dd> -<dt>values</dt> -<dd class="description">Values</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> -<br> -Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword -(<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType -(<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage -(<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage -(<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme -(<code>IPP_TAG_URISCHEME</code>).<br> -<br> -The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and -textWithLanguage string values and must be <code>NULL</code> for all other string values.</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippAttributeString">ippAttributeString</a></h3> -<p class="description">Convert the attribute's value to a string.</p> -<p class="code"> -size_t ippAttributeString (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - char *buffer,<br> - size_t bufsize<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">Attribute</dd> -<dt>buffer</dt> -<dd class="description">String buffer or NULL</dd> -<dt>bufsize</dt> -<dd class="description">Size of string buffer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes less nul</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Returns the number of bytes that would be written, not including the -trailing nul. The buffer pointer can be NULL to get the required length, -just like (v)snprintf. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippContainsInteger">ippContainsInteger</a></h3> -<p class="description">Determine whether an attribute contains the -specified value or is within the list of ranges.</p> -<p class="code"> -int ippContainsInteger (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - int value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">Attribute</dd> -<dt>value</dt> -<dd class="description">Integer/enum value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 on a match, 0 on no match</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Returns non-zero when the attribute contains either a matching integer or -enum value, or the value falls within one of the rangeOfInteger values for -the attribute. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippContainsString">ippContainsString</a></h3> -<p class="description">Determine whether an attribute contains the -specified string value.</p> -<p class="code"> -int ippContainsString (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - const char *value<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">Attribute</dd> -<dt>value</dt> -<dd class="description">String value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 on a match, 0 on no match</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Returns non-zero when the attribute contains a matching charset, keyword, -language, mimeMediaType, name, text, URI, or URI scheme value. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippCopyAttribute">ippCopyAttribute</a></h3> -<p class="description">Copy an attribute.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippCopyAttribute (<br> - <a href="#ipp_t">ipp_t</a> *dst,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *srcattr,<br> - int quickcopy<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dst</dt> -<dd class="description">Destination IPP message</dd> -<dt>srcattr</dt> -<dd class="description">Attribute to copy</dd> -<dt>quickcopy</dt> -<dd class="description">1 for a referenced copy, 0 for normal</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The specified attribute, <code>attr</code>, is copied to the destination IPP message. -When <code>quickcopy</code> is non-zero, a "shallow" reference copy of the attribute is -created - this should only be done as long as the original source IPP message will -not be freed for the life of the destination. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippCopyAttributes">ippCopyAttributes</a></h3> -<p class="description">Copy attributes from one IPP message to another.</p> -<p class="code"> -int ippCopyAttributes (<br> - <a href="#ipp_t">ipp_t</a> *dst,<br> - <a href="#ipp_t">ipp_t</a> *src,<br> - int quickcopy,<br> - <a href="#ipp_copycb_t">ipp_copycb_t</a> cb,<br> - void *context<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dst</dt> -<dd class="description">Destination IPP message</dd> -<dt>src</dt> -<dd class="description">Source IPP message</dd> -<dt>quickcopy</dt> -<dd class="description">1 for a referenced copy, 0 for normal</dd> -<dt>cb</dt> -<dd class="description">Copy callback or <code>NULL</code> for none</dd> -<dt>context</dt> -<dd class="description">Context pointer</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Zero or more attributes are copied from the source IPP message, <code>src</code>, to the -destination IPP message, <code>dst</code>. When <code>quickcopy</code> is non-zero, a "shallow" -reference copy of the attribute is created - this should only be done as long as the -original source IPP message will not be freed for the life of the destination.<br> -<br> -The <code>cb</code> and <code>context</code> parameters provide a generic way to "filter" the -attributes that are copied - the function must return 1 to copy the attribute or -0 to skip it. The function may also choose to do a partial copy of the source attribute -itself. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippCreateRequestedArray">ippCreateRequestedArray</a></h3> -<p class="description">Create a CUPS array of attribute names from the -given requested-attributes attribute.</p> -<p class="code"> -cups_array_t *ippCreateRequestedArray (<br> - <a href="#ipp_t">ipp_t</a> *request<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>request</dt> -<dd class="description">IPP request</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">CUPS array or <code>NULL</code> if all</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function creates a (sorted) CUPS array of attribute names matching the -list of "requested-attribute" values supplied in an IPP request. All IANA- -registered values are supported in addition to the CUPS IPP extension -attributes.<br> -<br> -The <code>request</code> parameter specifies the request message that was read from -the client. - -<code>NULL</code> is returned if all attributes should be returned. Otherwise, the -result is a sorted array of attribute names, where <code>cupsArrayFind(array, -"attribute-name")</code> will return a non-NULL pointer. The array must be freed -using the <code>cupsArrayDelete</code> function. - -</p> -<h3 class="function"><a name="ippDateToTime">ippDateToTime</a></h3> -<p class="description">Convert from RFC 1903 Date/Time format to UNIX time -in seconds.</p> -<p class="code"> -time_t ippDateToTime (<br> - const <a href="#ipp_uchar_t">ipp_uchar_t</a> *date<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>date</dt> -<dd class="description">RFC 1903 date info</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">UNIX time value</p> -<h3 class="function"><a name="ippDelete">ippDelete</a></h3> -<p class="description">Delete an IPP message.</p> -<p class="code"> -void ippDelete (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="ippDeleteAttribute">ippDeleteAttribute</a></h3> -<p class="description">Delete a single attribute in an IPP message.</p> -<p class="code"> -void ippDeleteAttribute (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">Attribute to delete</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippDeleteValues">ippDeleteValues</a></h3> -<p class="description">Delete values in an attribute.</p> -<p class="code"> -int ippDeleteValues (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - int count<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">Attribute</dd> -<dt>element</dt> -<dd class="description">Index of first value to delete (0-based)</dd> -<dt>count</dt> -<dd class="description">Number of values to delete</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">The <code>element</code> parameter specifies the first value to delete, starting at -0. It must be less than the number of values returned by <a href="#ippGetCount"><code>ippGetCount</code></a>.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -Deleting all values in an attribute deletes the attribute. - -</p> -<h3 class="function"><a name="ippEnumString">ippEnumString</a></h3> -<p class="description">Return a string corresponding to the enum value.</p> -<p class="code"> -const char *ippEnumString (<br> - const char *attrname,<br> - int enumvalue<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attrname</dt> -<dd class="description">Attribute name</dd> -<dt>enumvalue</dt> -<dd class="description">Enum value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Enum string</p> -<h3 class="function"><a name="ippEnumValue">ippEnumValue</a></h3> -<p class="description">Return the value associated with a given enum string.</p> -<p class="code"> -int ippEnumValue (<br> - const char *attrname,<br> - const char *enumstring<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attrname</dt> -<dd class="description">Attribute name</dd> -<dt>enumstring</dt> -<dd class="description">Enum string</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Enum value or -1 if unknown</p> -<h3 class="function"><a name="ippErrorString">ippErrorString</a></h3> -<p class="description">Return a name for the given status code.</p> -<p class="code"> -const char *ippErrorString (<br> - ipp_status_t error<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>error</dt> -<dd class="description">Error status</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Text string</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ippErrorValue">ippErrorValue</a></h3> -<p class="description">Return a status code for the given name.</p> -<p class="code"> -ipp_status_t ippErrorValue (<br> - const char *name<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">IPP status code</p> -<h3 class="function"><a name="ippFindAttribute">ippFindAttribute</a></h3> -<p class="description">Find a named attribute in a request.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindAttribute (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - const char *name,<br> - ipp_tag_t type<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>type</dt> -<dd class="description">Type of attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Matching attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list -of attribute and member names separated by slashes, for example -"media-col/media-size".</p> -<h3 class="function"><a name="ippFindNextAttribute">ippFindNextAttribute</a></h3> -<p class="description">Find the next named attribute in a request.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindNextAttribute (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - const char *name,<br> - ipp_tag_t type<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>name</dt> -<dd class="description">Name of attribute</dd> -<dt>type</dt> -<dd class="description">Type of attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Matching attribute</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list -of attribute and member names separated by slashes, for example -"media-col/media-size".</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippFirstAttribute">ippFirstAttribute</a></h3> -<p class="description">Return the first attribute in the message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFirstAttribute (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">First attribute or <code>NULL</code> if none</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetBoolean">ippGetBoolean</a></h3> -<p class="description">Get a boolean value for an attribute.</p> -<p class="code"> -int ippGetBoolean (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - int element<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Boolean value or 0 on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a> - 1. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetCollection">ippGetCollection</a></h3> -<p class="description">Get a collection value for an attribute.</p> -<p class="code"> -<a href="#ipp_t">ipp_t</a> *ippGetCollection (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - int element<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Collection value or <code>NULL</code> on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a> - 1. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetCount">ippGetCount</a></h3> -<p class="description">Get the number of values in an attribute.</p> -<p class="code"> -int ippGetCount (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Number of values or 0 on error</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetDate">ippGetDate</a></h3> -<p class="description">Get a date value for an attribute.</p> -<p class="code"> -const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippGetDate (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - int element<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Date value or <code>NULL</code></p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a> - 1. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetGroupTag">ippGetGroupTag</a></h3> -<p class="description">Get the group associated with an attribute.</p> -<p class="code"> -ipp_tag_t ippGetGroupTag (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Group tag or <code>IPP_TAG_ZERO</code> on error</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetInteger">ippGetInteger</a></h3> -<p class="description">Get the integer/enum value for an attribute.</p> -<p class="code"> -int ippGetInteger (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - int element<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Value or 0 on error</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a> - 1. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetName">ippGetName</a></h3> -<p class="description">Get the attribute name.</p> -<p class="code"> -const char *ippGetName (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Attribute name or <code>NULL</code> for separators</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippGetOctetString">ippGetOctetString</a></h3> -<p class="description">Get an octetString value from an IPP attribute.</p> -<p class="code"> -void *ippGetOctetString (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - int element,<br> - int *datalen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>datalen</dt> -<dd class="description">Length of octetString data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Pointer to octetString data</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a> - 1. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetOperation">ippGetOperation</a></h3> -<p class="description">Get the operation ID in an IPP message.</p> -<p class="code"> -ipp_op_t ippGetOperation (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP request message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Operation ID or 0 on error</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetRange">ippGetRange</a></h3> -<p class="description">Get a rangeOfInteger value from an attribute.</p> -<p class="code"> -int ippGetRange (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - int element,<br> - int *uppervalue<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>uppervalue</dt> -<dd class="description">Upper value of range</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Lower value of range or 0</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a> - 1. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetRequestId">ippGetRequestId</a></h3> -<p class="description">Get the request ID from an IPP message.</p> -<p class="code"> -int ippGetRequestId (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Request ID or 0 on error</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetResolution">ippGetResolution</a></h3> -<p class="description">Get a resolution value for an attribute.</p> -<p class="code"> -int ippGetResolution (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - int element,<br> - int *yres,<br> - <a href="#ipp_res_t">ipp_res_t</a> *units<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>yres</dt> -<dd class="description">Vertical/feed resolution</dd> -<dt>units</dt> -<dd class="description">Units for resolution</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Horizontal/cross feed resolution or 0</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a> - 1. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetState">ippGetState</a></h3> -<p class="description">Get the IPP message state.</p> -<p class="code"> -<a href="#ipp_state_t">ipp_state_t</a> ippGetState (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">IPP message state value</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetStatusCode">ippGetStatusCode</a></h3> -<p class="description">Get the status code from an IPP response or event message.</p> -<p class="code"> -ipp_status_t ippGetStatusCode (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP response or event message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Status code in IPP message</p> -<h3 class="function"><a name="ippGetString">ippGetString</a></h3> -<p class="description">Return the value...</p> -<p class="code"> -const char *ippGetString (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr,<br> - int element,<br> - const char **language<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>language</dt> -<dd class="description">Language code (<code>NULL</code> for don't care)</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Get the string and optionally the language code for an attribute.</p> -<p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a> - 1. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetValueTag">ippGetValueTag</a></h3> -<p class="description">Get the value tag for an attribute.</p> -<p class="code"> -ipp_tag_t ippGetValueTag (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Value tag or <code>IPP_TAG_ZERO</code> on error</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippGetVersion">ippGetVersion</a></h3> -<p class="description">Get the major and minor version number from an IPP message.</p> -<p class="code"> -int ippGetVersion (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - int *minor<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>minor</dt> -<dd class="description">Minor version number or <code>NULL</code></dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Major version number or 0 on error</p> -<h3 class="function"><a name="ippLength">ippLength</a></h3> -<p class="description">Compute the length of an IPP message.</p> -<p class="code"> -size_t ippLength (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Size of IPP message</p> -<h3 class="function"><a name="ippNew">ippNew</a></h3> -<p class="description">Allocate a new IPP message.</p> -<p class="code"> -<a href="#ipp_t">ipp_t</a> *ippNew (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">New IPP message</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ippNewRequest">ippNewRequest</a></h3> -<p class="description">Allocate a new IPP request message.</p> -<p class="code"> -<a href="#ipp_t">ipp_t</a> *ippNewRequest (<br> - ipp_op_t op<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>op</dt> -<dd class="description">Operation code</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">IPP request message</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The new request message is initialized with the attributes-charset and -attributes-natural-language attributes added. The -attributes-natural-language value is derived from the current locale. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippNewResponse">ippNewResponse</a></h3> -<p class="description">Allocate a new IPP response message.</p> -<p class="code"> -<a href="#ipp_t">ipp_t</a> *ippNewResponse (<br> - <a href="#ipp_t">ipp_t</a> *request<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>request</dt> -<dd class="description">IPP request message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">IPP response message</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The new response message is initialized with the same version-number, -request-id, attributes-charset, and attributes-natural-language as the -provided request message. If the attributes-charset or -attributes-natural-language attributes are missing from the request, -"utf-8" and a value derived from the current locale are substituted, -respectively. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippNextAttribute">ippNextAttribute</a></h3> -<p class="description">Return the next attribute in the message.</p> -<p class="code"> -<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippNextAttribute (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Next attribute or <code>NULL</code> if none</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ippOpString">ippOpString</a></h3> -<p class="description">Return a name for the given operation id.</p> -<p class="code"> -const char *ippOpString (<br> - ipp_op_t op<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>op</dt> -<dd class="description">Operation ID</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Name</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ippOpValue">ippOpValue</a></h3> -<p class="description">Return an operation id for the given name.</p> -<p class="code"> -ipp_op_t ippOpValue (<br> - const char *name<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Textual name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Operation ID</p> -<h3 class="function"><a name="ippPort">ippPort</a></h3> -<p class="description">Return the default IPP port number.</p> -<p class="code"> -int ippPort (void);</p> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Port number</p> -<h3 class="function"><a name="ippRead">ippRead</a></h3> -<p class="description">Read data for an IPP message from a HTTP connection.</p> -<p class="code"> -<a href="#ipp_state_t">ipp_state_t</a> ippRead (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>ipp</dt> -<dd class="description">IPP data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Current state</p> -<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="ippReadFile">ippReadFile</a></h3> -<p class="description">Read data for an IPP message from a file.</p> -<p class="code"> -<a href="#ipp_state_t">ipp_state_t</a> ippReadFile (<br> - int fd,<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fd</dt> -<dd class="description">HTTP data</dd> -<dt>ipp</dt> -<dd class="description">IPP data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Current state</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ippReadIO">ippReadIO</a></h3> -<p class="description">Read data for an IPP message.</p> -<p class="code"> -<a href="#ipp_state_t">ipp_state_t</a> ippReadIO (<br> - void *src,<br> - <a href="#ipp_iocb_t">ipp_iocb_t</a> cb,<br> - int blocking,<br> - <a href="#ipp_t">ipp_t</a> *parent,<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>src</dt> -<dd class="description">Data source</dd> -<dt>cb</dt> -<dd class="description">Read callback function</dd> -<dt>blocking</dt> -<dd class="description">Use blocking IO?</dd> -<dt>parent</dt> -<dd class="description">Parent request, if any</dd> -<dt>ipp</dt> -<dd class="description">IPP data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Current state</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetBoolean">ippSetBoolean</a></h3> -<p class="description">Set a boolean value in an attribute.</p> -<p class="code"> -int ippSetBoolean (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - int boolvalue<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>boolvalue</dt> -<dd class="description">Boolean value</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetCollection">ippSetCollection</a></h3> -<p class="description">Set a collection value in an attribute.</p> -<p class="code"> -int ippSetCollection (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - <a href="#ipp_t">ipp_t</a> *colvalue<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>colvalue</dt> -<dd class="description">Collection value</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetDate">ippSetDate</a></h3> -<p class="description">Set a date value in an attribute.</p> -<p class="code"> -int ippSetDate (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - const <a href="#ipp_uchar_t">ipp_uchar_t</a> *datevalue<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>datevalue</dt> -<dd class="description">Date value</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetGroupTag">ippSetGroupTag</a></h3> -<p class="description">Set the group tag of an attribute.</p> -<p class="code"> -int ippSetGroupTag (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - ipp_tag_t group_tag<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">Attribute</dd> -<dt>group_tag</dt> -<dd class="description">Group tag</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>group</code> parameter specifies the IPP attribute group tag: none -(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), -event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation -(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription -(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetInteger">ippSetInteger</a></h3> -<p class="description">Set an integer or enum value in an attribute.</p> -<p class="code"> -int ippSetInteger (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - int intvalue<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>intvalue</dt> -<dd class="description">Integer/enum value</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetName">ippSetName</a></h3> -<p class="description">Set the name of an attribute.</p> -<p class="code"> -int ippSetName (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - const char *name<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>name</dt> -<dd class="description">Attribute name</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippSetOctetString">ippSetOctetString</a></h3> -<p class="description">Set an octetString value in an IPP attribute.</p> -<p class="code"> -int ippSetOctetString (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - const void *data,<br> - int datalen<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>data</dt> -<dd class="description">Pointer to octetString data</dd> -<dt>datalen</dt> -<dd class="description">Length of octetString data</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetOperation">ippSetOperation</a></h3> -<p class="description">Set the operation ID in an IPP request message.</p> -<p class="code"> -int ippSetOperation (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_op_t op<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP request message</dd> -<dt>op</dt> -<dd class="description">Operation ID</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. - -</p> -<h3 class="function"><a name="ippSetPort">ippSetPort</a></h3> -<p class="description">Set the default port number.</p> -<p class="code"> -void ippSetPort (<br> - int p<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>p</dt> -<dd class="description">Port number to use</dd> -</dl> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetRange">ippSetRange</a></h3> -<p class="description">Set a rangeOfInteger value in an attribute.</p> -<p class="code"> -int ippSetRange (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - int lowervalue,<br> - int uppervalue<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>lowervalue</dt> -<dd class="description">Lower bound for range</dd> -<dt>uppervalue</dt> -<dd class="description">Upper bound for range</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetRequestId">ippSetRequestId</a></h3> -<p class="description">Set the request ID in an IPP message.</p> -<p class="code"> -int ippSetRequestId (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - int request_id<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>request_id</dt> -<dd class="description">Request ID</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>request_id</code> parameter must be greater than 0. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetResolution">ippSetResolution</a></h3> -<p class="description">Set a resolution value in an attribute.</p> -<p class="code"> -int ippSetResolution (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - <a href="#ipp_res_t">ipp_res_t</a> unitsvalue,<br> - int xresvalue,<br> - int yresvalue<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>unitsvalue</dt> -<dd class="description">Resolution units</dd> -<dt>xresvalue</dt> -<dd class="description">Horizontal/cross feed resolution</dd> -<dt>yresvalue</dt> -<dd class="description">Vertical/feed resolution</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetState">ippSetState</a></h3> -<p class="description">Set the current state of the IPP message.</p> -<p class="code"> -int ippSetState (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_state_t">ipp_state_t</a> state<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>state</dt> -<dd class="description">IPP state value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetStatusCode">ippSetStatusCode</a></h3> -<p class="description">Set the status code in an IPP response or event message.</p> -<p class="code"> -int ippSetStatusCode (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - ipp_status_t status<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP response or event message</dd> -<dt>status</dt> -<dd class="description">Status code</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetString">ippSetString</a></h3> -<p class="description">Set a string value in an attribute.</p> -<p class="code"> -int ippSetString (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - const char *strvalue<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>strvalue</dt> -<dd class="description">String value</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippSetStringf">ippSetStringf</a></h3> -<p class="description">Set a formatted string value of an attribute.</p> -<p class="code"> -int ippSetStringf (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - const char *format,<br> - ...<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>format</dt> -<dd class="description">Printf-style format string</dd> -<dt>...</dt> -<dd class="description">Additional arguments as needed</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>.<br> -<br> -The <code>format</code> parameter uses formatting characters compatible with the -printf family of standard functions. Additional arguments follow it as -needed. The formatted string is truncated as needed to the maximum length of -the corresponding value type. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippSetStringfv">ippSetStringfv</a></h3> -<p class="description">Set a formatted string value of an attribute.</p> -<p class="code"> -int ippSetStringfv (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - int element,<br> - const char *format,<br> - va_list ap<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>element</dt> -<dd class="description">Value number (0-based)</dd> -<dt>format</dt> -<dd class="description">Printf-style format string</dd> -<dt>ap</dt> -<dd class="description">Pointer to additional arguments</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -The <code>element</code> parameter specifies which value to set from 0 to -<a href="#ippGetCount(attr)"><code>ippGetCount(attr)</code></a>.<br> -<br> -The <code>format</code> parameter uses formatting characters compatible with the -printf family of standard functions. Additional arguments follow it as -needed. The formatted string is truncated as needed to the maximum length of -the corresponding value type. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetValueTag">ippSetValueTag</a></h3> -<p class="description">Set the value tag of an attribute.</p> -<p class="code"> -int ippSetValueTag (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr,<br> - ipp_tag_t value_tag<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>attr</dt> -<dd class="description">IPP attribute</dd> -<dt>value_tag</dt> -<dd class="description">Value tag</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The <code>attr</code> parameter may be modified as a result of setting the value.<br> -<br> -Integer (<code>IPP_TAG_INTEGER</code>) values can be promoted to rangeOfInteger -(<code>IPP_TAG_RANGE</code>) values, the various string tags can be promoted to name -(<code>IPP_TAG_NAME</code>) or nameWithLanguage (<code>IPP_TAG_NAMELANG</code>) values, text -(<code>IPP_TAG_TEXT</code>) values can be promoted to textWithLanguage -(<code>IPP_TAG_TEXTLANG</code>) values, and all values can be demoted to the various -out-of-band value tags such as no-value (<code>IPP_TAG_NOVALUE</code>). All other changes -will be rejected.<br> -<br> -Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language -code in the "attributes-natural-language" attribute or, if not present, the language -code for the current locale. - -</p> -<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a name="ippSetVersion">ippSetVersion</a></h3> -<p class="description">Set the version number in an IPP message.</p> -<p class="code"> -int ippSetVersion (<br> - <a href="#ipp_t">ipp_t</a> *ipp,<br> - int major,<br> - int minor<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -<dt>major</dt> -<dd class="description">Major version number (major.minor)</dd> -<dt>minor</dt> -<dd class="description">Minor version number (major.minor)</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">The <code>ipp</code> parameter refers to an IPP message previously created using -the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> -<br> -The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2. - -</p> -<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="ippStateString">ippStateString</a></h3> -<p class="description">Return the name corresponding to a state value.</p> -<p class="code"> -const char *ippStateString (<br> - <a href="#ipp_state_t">ipp_state_t</a> state<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>state</dt> -<dd class="description">State value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">State name</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="ippTagString">ippTagString</a></h3> -<p class="description">Return the tag name corresponding to a tag value.</p> -<p class="code"> -const char *ippTagString (<br> - ipp_tag_t tag<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>tag</dt> -<dd class="description">Tag value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Tag name</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The returned names are defined in RFC 2911 and 3382. - -</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="ippTagValue">ippTagValue</a></h3> -<p class="description">Return the tag value corresponding to a tag name.</p> -<p class="code"> -ipp_tag_t ippTagValue (<br> - const char *name<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Tag name</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Tag value</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">The tag names are defined in RFC 2911 and 3382. - -</p> -<h3 class="function"><a name="ippTimeToDate">ippTimeToDate</a></h3> -<p class="description">Convert from UNIX time to RFC 1903 format.</p> -<p class="code"> -const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippTimeToDate (<br> - time_t t<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>t</dt> -<dd class="description">UNIX time value</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">RFC-1903 date/time data</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippValidateAttribute">ippValidateAttribute</a></h3> -<p class="description">Validate the contents of an attribute.</p> -<p class="code"> -int ippValidateAttribute (<br> - <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>attr</dt> -<dd class="description">Attribute</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if valid, 0 otherwise</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function validates the contents of an attribute based on the name and -value tag. 1 is returned if the attribute is valid, 0 otherwise. On -failure, cupsLastErrorString() is set to a human-readable message. - -</p> -<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a name="ippValidateAttributes">ippValidateAttributes</a></h3> -<p class="description">Validate all attributes in an IPP message.</p> -<p class="code"> -int ippValidateAttributes (<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>ipp</dt> -<dd class="description">IPP message</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">1 if valid, 0 otherwise</p> -<h4 class="discussion">Discussion</h4> -<p class="discussion">This function validates the contents of the IPP message, including each -attribute. Like <a href="#ippValidateAttribute"><code>ippValidateAttribute</code></a>, cupsLastErrorString() is set -to a human-readable message on failure. - -</p> -<h3 class="function"><a name="ippWrite">ippWrite</a></h3> -<p class="description">Write data for an IPP message to a HTTP connection.</p> -<p class="code"> -<a href="#ipp_state_t">ipp_state_t</a> ippWrite (<br> - <a href="#http_t">http_t</a> *http,<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection</dd> -<dt>ipp</dt> -<dd class="description">IPP data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Current state</p> -<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="ippWriteFile">ippWriteFile</a></h3> -<p class="description">Write data for an IPP message to a file.</p> -<p class="code"> -<a href="#ipp_state_t">ipp_state_t</a> ippWriteFile (<br> - int fd,<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>fd</dt> -<dd class="description">HTTP data</dd> -<dt>ipp</dt> -<dd class="description">IPP data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Current state</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ippWriteIO">ippWriteIO</a></h3> -<p class="description">Write data for an IPP message.</p> -<p class="code"> -<a href="#ipp_state_t">ipp_state_t</a> ippWriteIO (<br> - void *dst,<br> - <a href="#ipp_iocb_t">ipp_iocb_t</a> cb,<br> - int blocking,<br> - <a href="#ipp_t">ipp_t</a> *parent,<br> - <a href="#ipp_t">ipp_t</a> *ipp<br> -);</p> -<h4 class="parameters">Parameters</h4> -<dl> -<dt>dst</dt> -<dd class="description">Destination</dd> -<dt>cb</dt> -<dd class="description">Write callback function</dd> -<dt>blocking</dt> -<dd class="description">Use blocking IO?</dd> -<dt>parent</dt> -<dd class="description">Parent IPP message</dd> -<dt>ipp</dt> -<dd class="description">IPP data</dd> -</dl> -<h4 class="returnvalue">Return Value</h4> -<p class="description">Current state</p> -<h2 class="title"><a name="TYPES">Data Types</a></h2> -<h3 class="typedef"><a name="gss_auth_identity_desc">gss_auth_identity_desc</a></h3> -<p class="description">Local functions...</p> -<p class="code"> -typedef struct <a href="#gss_auth_identity">gss_auth_identity</a> gss_auth_identity_desc; -</p> -<h3 class="typedef"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="http_addr_t">http_addr_t</a></h3> -<p class="description">Socket address union, which -makes using IPv6 and other -address types easier and -more portable. </p> -<p class="code"> -typedef union _http_addr_u / http_addr_t; -</p> -<h3 class="typedef"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="http_addrlist_t">http_addrlist_t</a></h3> -<p class="description">Socket address list, which is -used to enumerate all of the -addresses that are associated -with a hostname. </p> -<p class="code"> -typedef struct <a href="#http_addrlist_s">http_addrlist_s</a> / http_addrlist_t; -</p> -<h3 class="typedef"><a name="http_auth_t">http_auth_t</a></h3> -<p class="description">HTTP authentication types</p> -<p class="code"> -typedef enum <a href="#http_auth_e">http_auth_e</a> http_auth_t; -</p> -<h3 class="typedef"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="http_credential_t">http_credential_t</a></h3> -<p class="description">HTTP credential data </p> -<p class="code"> -typedef struct <a href="#http_credential_s">http_credential_s</a> http_credential_t; -</p> -<h3 class="typedef"><a name="http_encoding_t">http_encoding_t</a></h3> -<p class="description">HTTP transfer encoding values</p> -<p class="code"> -typedef enum <a href="#http_encoding_e">http_encoding_e</a> http_encoding_t; -</p> -<h3 class="typedef"><a name="http_encryption_t">http_encryption_t</a></h3> -<p class="description">HTTP encryption values</p> -<p class="code"> -typedef enum <a href="#http_encryption_e">http_encryption_e</a> http_encryption_t; -</p> -<h3 class="typedef"><a name="http_field_t">http_field_t</a></h3> -<p class="description">HTTP field names</p> -<p class="code"> -typedef enum <a href="#http_field_e">http_field_e</a> http_field_t; -</p> -<h3 class="typedef"><a name="http_keepalive_t">http_keepalive_t</a></h3> -<p class="description">HTTP keep-alive values</p> -<p class="code"> -typedef enum <a href="#http_keepalive_e">http_keepalive_e</a> http_keepalive_t; -</p> -<h3 class="typedef"><a name="http_state_t">http_state_t</a></h3> -<p class="description">HTTP state values; states -are server-oriented...</p> -<p class="code"> -typedef enum <a href="#http_state_e">http_state_e</a> http_state_t; -</p> -<h3 class="typedef"><a name="http_t">http_t</a></h3> -<p class="description">HTTP connection type</p> -<p class="code"> -typedef struct _http_s http_t; -</p> -<h3 class="typedef"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="http_timeout_cb_t">http_timeout_cb_t</a></h3> -<p class="description">HTTP timeout callback </p> -<p class="code"> -typedef int (*http_timeout_cb_t)(<a href="#http_t">http_t</a> *http, void *user_data); -</p> -<h3 class="typedef"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="http_trust_t">http_trust_t</a></h3> -<p class="description">Level of trust for credentials </p> -<p class="code"> -typedef enum <a href="#http_trust_e">http_trust_e</a> http_trust_t; -</p> -<h3 class="typedef"><a name="http_uri_coding_t">http_uri_coding_t</a></h3> -<p class="description">URI en/decode flags</p> -<p class="code"> -typedef enum <a href="#http_uri_coding_e">http_uri_coding_e</a> http_uri_coding_t; -</p> -<h3 class="typedef"><span class="info"> CUPS 1.2 </span><a name="http_uri_status_t">http_uri_status_t</a></h3> -<p class="description">URI separation status </p> -<p class="code"> -typedef enum <a href="#http_uri_status_e">http_uri_status_e</a> http_uri_status_t; -</p> -<h3 class="typedef"><a name="http_version_t">http_version_t</a></h3> -<p class="description">HTTP version numbers</p> -<p class="code"> -typedef enum <a href="#http_version_e">http_version_e</a> http_version_t; -</p> -<h3 class="typedef"><a name="ipp_attribute_t">ipp_attribute_t</a></h3> -<p class="description">IPP attribute</p> -<p class="code"> -typedef struct _ipp_attribute_s ipp_attribute_t; -</p> -<h3 class="typedef"><a name="ipp_copycb_t">ipp_copycb_t</a></h3> -<p class="description">The following structures are PRIVATE starting with CUPS 1.6/macOS 10.8. -Please use the new accessor functions available in CUPS 1.6 and later, as -these definitions will be moved to a private header file in a future release.</p> -<p class="code"> -typedef int (*ipp_copycb_t)(void *context, <a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr); -</p> -<h3 class="typedef"><a name="ipp_dstate_t">ipp_dstate_t</a></h3> -<p class="description">Document states</p> -<p class="code"> -typedef enum <a href="#ipp_dstate_e">ipp_dstate_e</a> ipp_dstate_t; -</p> -<h3 class="typedef"><a name="ipp_finish_t">ipp_finish_t</a></h3> -<p class="description">Job collation types</p> -<p class="code"> -typedef enum <a href="#ipp_finishings_e">ipp_finishings_e</a> ipp_finish_t; -</p> -<h3 class="typedef"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ipp_iocb_t">ipp_iocb_t</a></h3> -<p class="description">IPP IO Callback Function </p> -<p class="code"> -typedef ssize_t (*ipp_iocb_t)(void *context, <a href="#ipp_uchar_t">ipp_uchar_t</a> *buffer, size_t bytes); -</p> -<h3 class="typedef"><a name="ipp_jcollate_t">ipp_jcollate_t</a></h3> -<p class="description">Job collation types</p> -<p class="code"> -typedef enum <a href="#ipp_jcollate_e">ipp_jcollate_e</a> ipp_jcollate_t; -</p> -<h3 class="typedef"><a name="ipp_orient_t">ipp_orient_t</a></h3> -<p class="description">Orientation values</p> -<p class="code"> -typedef enum <a href="#ipp_orient_e">ipp_orient_e</a> ipp_orient_t; -</p> -<h3 class="typedef"><a name="ipp_pstate_t">ipp_pstate_t</a></h3> -<p class="description">Printer states</p> -<p class="code"> -typedef enum <a href="#ipp_pstate_e">ipp_pstate_e</a> ipp_pstate_t; -</p> -<h3 class="typedef"><a name="ipp_quality_t">ipp_quality_t</a></h3> -<p class="description">Qualities</p> -<p class="code"> -typedef enum <a href="#ipp_quality_e">ipp_quality_e</a> ipp_quality_t; -</p> -<h3 class="typedef"><a name="ipp_res_t">ipp_res_t</a></h3> -<p class="description">Resolution units</p> -<p class="code"> -typedef enum <a href="#ipp_res_e">ipp_res_e</a> ipp_res_t; -</p> -<h3 class="typedef"><a name="ipp_state_t">ipp_state_t</a></h3> -<p class="description">IPP states</p> -<p class="code"> -typedef enum <a href="#ipp_state_e">ipp_state_e</a> ipp_state_t; -</p> -<h3 class="typedef"><a name="ipp_t">ipp_t</a></h3> -<p class="description">IPP request/response data</p> -<p class="code"> -typedef struct _ipp_s ipp_t; -</p> -<h3 class="typedef"><a name="ipp_uchar_t">ipp_uchar_t</a></h3> -<p class="description">Unsigned 8-bit integer/character</p> -<p class="code"> -typedef unsigned char ipp_uchar_t; -</p> -<h2 class="title"><a name="STRUCTURES">Structures</a></h2> -<h3 class="struct"><a name="gss_auth_identity">gss_auth_identity</a></h3> -<p class="description">Local functions...</p> -<p class="code">struct gss_auth_identity {<br> - gss_buffer_t *credentialsRef;<br> - uint32_t flags;<br> - char *password;<br> - char *realm;<br> - uint32_t type;<br> - char *username;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>credentialsRef </dt> -<dt>flags </dt> -<dt>password </dt> -<dt>realm </dt> -<dt>type </dt> -<dt>username </dt> -</dl> -<h3 class="struct"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="http_addrlist_s">http_addrlist_s</a></h3> -<p class="description">Socket address list, which is -used to enumerate all of the -addresses that are associated -with a hostname. </p> -<p class="code">struct http_addrlist_s {<br> - <a href="#http_addr_t">http_addr_t</a> addr;<br> - struct <a href="#http_addrlist_s">http_addrlist_s</a> *next;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>addr </dt> -<dd class="description">Address</dd> -<dt>next </dt> -<dd class="description">Pointer to next address in list</dd> -</dl> -<h3 class="struct"><span class="info"> CUPS 1.5/macOS 10.7 </span><a name="http_credential_s">http_credential_s</a></h3> -<p class="description">HTTP credential data </p> -<p class="code">struct http_credential_s {<br> - void *data;<br> - size_t datalen;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>data </dt> -<dd class="description">Pointer to credential data</dd> -<dt>datalen </dt> -<dd class="description">Credential length</dd> -</dl> -<h3 class="struct"><a name="pollfd">pollfd</a></h3> -<p class="description">User data (unused)</p> -<p class="code">struct pollfd *pollfds, unsigned int num_pollfds, int timeout, void *context) {<br> - void) context;<br> - void) timeout;<br> -};</p> -<h4 class="members">Members</h4> -<dl> -<dt>context </dt> -<dt>timeout </dt> -</dl> -<h2 class="title"><a name="ENUMERATIONS">Constants</a></h2> -<h3 class="enumeration"><a name="http_auth_e">http_auth_e</a></h3> -<p class="description">HTTP authentication types</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_AUTH_BASIC </dt> -<dd class="description">Basic authentication in use</dd> -<dt>HTTP_AUTH_MD5 </dt> -<dd class="description">Digest authentication in use</dd> -<dt>HTTP_AUTH_MD5_INT </dt> -<dd class="description">Digest authentication in use for body</dd> -<dt>HTTP_AUTH_MD5_SESS </dt> -<dd class="description">MD5-session authentication in use</dd> -<dt>HTTP_AUTH_MD5_SESS_INT </dt> -<dd class="description">MD5-session authentication in use for body</dd> -<dt>HTTP_AUTH_NEGOTIATE <span class="info"> CUPS 1.3/macOS 10.5 </span></dt> -<dd class="description">GSSAPI authentication in use </dd> -<dt>HTTP_AUTH_NONE </dt> -<dd class="description">No authentication in use</dd> -</dl> -<h3 class="enumeration"><a name="http_encoding_e">http_encoding_e</a></h3> -<p class="description">HTTP transfer encoding values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_ENCODING_CHUNKED </dt> -<dd class="description">Data is chunked</dd> -<dt>HTTP_ENCODING_FIELDS </dt> -<dd class="description">Sending HTTP fields</dd> -<dt>HTTP_ENCODING_LENGTH </dt> -<dd class="description">Data is sent with Content-Length</dd> -</dl> -<h3 class="enumeration"><a name="http_encryption_e">http_encryption_e</a></h3> -<p class="description">HTTP encryption values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_ENCRYPTION_ALWAYS </dt> -<dd class="description">Always encrypt (SSL)</dd> -<dt>HTTP_ENCRYPTION_IF_REQUESTED </dt> -<dd class="description">Encrypt if requested (TLS upgrade)</dd> -<dt>HTTP_ENCRYPTION_NEVER </dt> -<dd class="description">Never encrypt</dd> -<dt>HTTP_ENCRYPTION_REQUIRED </dt> -<dd class="description">Encryption is required (TLS upgrade)</dd> -</dl> -<h3 class="enumeration"><a name="http_field_e">http_field_e</a></h3> -<p class="description">HTTP field names</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_FIELD_ACCEPT_ENCODING <span class="info"> CUPS 1.7/macOS 10.9 </span></dt> -<dd class="description">Accepting-Encoding field </dd> -<dt>HTTP_FIELD_ACCEPT_LANGUAGE </dt> -<dd class="description">Accept-Language field</dd> -<dt>HTTP_FIELD_ACCEPT_RANGES </dt> -<dd class="description">Accept-Ranges field</dd> -<dt>HTTP_FIELD_ALLOW <span class="info"> CUPS 1.7/macOS 10.9 </span></dt> -<dd class="description">Allow field </dd> -<dt>HTTP_FIELD_AUTHORIZATION </dt> -<dd class="description">Authorization field</dd> -<dt>HTTP_FIELD_CONNECTION </dt> -<dd class="description">Connection field</dd> -<dt>HTTP_FIELD_CONTENT_ENCODING </dt> -<dd class="description">Content-Encoding field</dd> -<dt>HTTP_FIELD_CONTENT_LANGUAGE </dt> -<dd class="description">Content-Language field</dd> -<dt>HTTP_FIELD_CONTENT_LENGTH </dt> -<dd class="description">Content-Length field</dd> -<dt>HTTP_FIELD_CONTENT_LOCATION </dt> -<dd class="description">Content-Location field</dd> -<dt>HTTP_FIELD_CONTENT_MD5 </dt> -<dd class="description">Content-MD5 field</dd> -<dt>HTTP_FIELD_CONTENT_RANGE </dt> -<dd class="description">Content-Range field</dd> -<dt>HTTP_FIELD_CONTENT_TYPE </dt> -<dd class="description">Content-Type field</dd> -<dt>HTTP_FIELD_CONTENT_VERSION </dt> -<dd class="description">Content-Version field</dd> -<dt>HTTP_FIELD_DATE </dt> -<dd class="description">Date field</dd> -<dt>HTTP_FIELD_HOST </dt> -<dd class="description">Host field</dd> -<dt>HTTP_FIELD_IF_MODIFIED_SINCE </dt> -<dd class="description">If-Modified-Since field</dd> -<dt>HTTP_FIELD_IF_UNMODIFIED_SINCE </dt> -<dd class="description">If-Unmodified-Since field</dd> -<dt>HTTP_FIELD_KEEP_ALIVE </dt> -<dd class="description">Keep-Alive field</dd> -<dt>HTTP_FIELD_LAST_MODIFIED </dt> -<dd class="description">Last-Modified field</dd> -<dt>HTTP_FIELD_LINK </dt> -<dd class="description">Link field</dd> -<dt>HTTP_FIELD_LOCATION </dt> -<dd class="description">Location field</dd> -<dt>HTTP_FIELD_MAX </dt> -<dd class="description">Maximum field index</dd> -<dt>HTTP_FIELD_RANGE </dt> -<dd class="description">Range field</dd> -<dt>HTTP_FIELD_REFERER </dt> -<dd class="description">Referer field</dd> -<dt>HTTP_FIELD_RETRY_AFTER </dt> -<dd class="description">Retry-After field</dd> -<dt>HTTP_FIELD_SERVER <span class="info"> CUPS 1.7/macOS 10.9 </span></dt> -<dd class="description">Server field </dd> -<dt>HTTP_FIELD_TRANSFER_ENCODING </dt> -<dd class="description">Transfer-Encoding field</dd> -<dt>HTTP_FIELD_UNKNOWN </dt> -<dd class="description">Unknown field</dd> -<dt>HTTP_FIELD_UPGRADE </dt> -<dd class="description">Upgrade field</dd> -<dt>HTTP_FIELD_USER_AGENT </dt> -<dd class="description">User-Agent field</dd> -<dt>HTTP_FIELD_WWW_AUTHENTICATE </dt> -<dd class="description">WWW-Authenticate field</dd> -</dl> -<h3 class="enumeration"><a name="http_keepalive_e">http_keepalive_e</a></h3> -<p class="description">HTTP keep-alive values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_KEEPALIVE_OFF </dt> -<dd class="description">No keep alive support</dd> -<dt>HTTP_KEEPALIVE_ON </dt> -<dd class="description">Use keep alive</dd> -</dl> -<h3 class="enumeration"><a name="http_state_e">http_state_e</a></h3> -<p class="description">HTTP state values; states -are server-oriented...</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_STATE_CONNECT </dt> -<dd class="description">CONNECT command, waiting for blank line</dd> -<dt>HTTP_STATE_DELETE </dt> -<dd class="description">DELETE command, waiting for blank line</dd> -<dt>HTTP_STATE_ERROR </dt> -<dd class="description">Error on socket</dd> -<dt>HTTP_STATE_GET </dt> -<dd class="description">GET command, waiting for blank line</dd> -<dt>HTTP_STATE_GET_SEND </dt> -<dd class="description">GET command, sending data</dd> -<dt>HTTP_STATE_HEAD </dt> -<dd class="description">HEAD command, waiting for blank line</dd> -<dt>HTTP_STATE_OPTIONS </dt> -<dd class="description">OPTIONS command, waiting for blank line</dd> -<dt>HTTP_STATE_POST </dt> -<dd class="description">POST command, waiting for blank line</dd> -<dt>HTTP_STATE_POST_RECV </dt> -<dd class="description">POST command, receiving data</dd> -<dt>HTTP_STATE_POST_SEND </dt> -<dd class="description">POST command, sending data</dd> -<dt>HTTP_STATE_PUT </dt> -<dd class="description">PUT command, waiting for blank line</dd> -<dt>HTTP_STATE_PUT_RECV </dt> -<dd class="description">PUT command, receiving data</dd> -<dt>HTTP_STATE_STATUS </dt> -<dd class="description">Command complete, sending status</dd> -<dt>HTTP_STATE_TRACE </dt> -<dd class="description">TRACE command, waiting for blank line</dd> -<dt>HTTP_STATE_UNKNOWN_METHOD <span class="info"> CUPS 1.7/macOS 10.9 </span></dt> -<dd class="description">Unknown request method, waiting for blank line </dd> -<dt>HTTP_STATE_UNKNOWN_VERSION <span class="info"> CUPS 1.7/macOS 10.9 </span></dt> -<dd class="description">Unknown request method, waiting for blank line </dd> -<dt>HTTP_STATE_WAITING </dt> -<dd class="description">Waiting for command</dd> -</dl> -<h3 class="enumeration"><a name="http_status_e">http_status_e</a></h3> -<p class="description">HTTP status codes</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_STATUS_ACCEPTED </dt> -<dd class="description">DELETE command was successful</dd> -<dt>HTTP_STATUS_BAD_GATEWAY </dt> -<dd class="description">Bad gateway</dd> -<dt>HTTP_STATUS_BAD_REQUEST </dt> -<dd class="description">Bad request</dd> -<dt>HTTP_STATUS_CONFLICT </dt> -<dd class="description">Request is self-conflicting</dd> -<dt>HTTP_STATUS_CONTINUE </dt> -<dd class="description">Everything OK, keep going...</dd> -<dt>HTTP_STATUS_CREATED </dt> -<dd class="description">PUT command was successful</dd> -<dt>HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED <span class="info"> CUPS 1.4 </span></dt> -<dd class="description">User canceled authorization </dd> -<dt>HTTP_STATUS_CUPS_PKI_ERROR <span class="info"> CUPS 1.5/macOS 10.7 </span></dt> -<dd class="description">Error negotiating a secure connection </dd> -<dt>HTTP_STATUS_ERROR </dt> -<dd class="description">An error response from httpXxxx()</dd> -<dt>HTTP_STATUS_EXPECTATION_FAILED </dt> -<dd class="description">The expectation given in an Expect header field was not met</dd> -<dt>HTTP_STATUS_FORBIDDEN </dt> -<dd class="description">Forbidden to access this URI</dd> -<dt>HTTP_STATUS_GATEWAY_TIMEOUT </dt> -<dd class="description">Gateway connection timed out</dd> -<dt>HTTP_STATUS_GONE </dt> -<dd class="description">Server has gone away</dd> -<dt>HTTP_STATUS_LENGTH_REQUIRED </dt> -<dd class="description">A content length or encoding is required</dd> -<dt>HTTP_STATUS_METHOD_NOT_ALLOWED </dt> -<dd class="description">Method is not allowed</dd> -<dt>HTTP_STATUS_MOVED_PERMANENTLY </dt> -<dd class="description">Document has moved permanently</dd> -<dt>HTTP_STATUS_MOVED_TEMPORARILY </dt> -<dd class="description">Document has moved temporarily</dd> -<dt>HTTP_STATUS_MULTIPLE_CHOICES </dt> -<dd class="description">Multiple files match request</dd> -<dt>HTTP_STATUS_NONE <span class="info"> CUPS 1.7/macOS 10.9 </span></dt> -<dd class="description">No Expect value </dd> -<dt>HTTP_STATUS_NOT_ACCEPTABLE </dt> -<dd class="description">Not Acceptable</dd> -<dt>HTTP_STATUS_NOT_AUTHORITATIVE </dt> -<dd class="description">Information isn't authoritative</dd> -<dt>HTTP_STATUS_NOT_FOUND </dt> -<dd class="description">URI was not found</dd> -<dt>HTTP_STATUS_NOT_IMPLEMENTED </dt> -<dd class="description">Feature not implemented</dd> -<dt>HTTP_STATUS_NOT_MODIFIED </dt> -<dd class="description">File not modified</dd> -<dt>HTTP_STATUS_NOT_SUPPORTED </dt> -<dd class="description">HTTP version not supported</dd> -<dt>HTTP_STATUS_NO_CONTENT </dt> -<dd class="description">Successful command, no new data</dd> -<dt>HTTP_STATUS_OK </dt> -<dd class="description">OPTIONS/GET/HEAD/POST/TRACE command was successful</dd> -<dt>HTTP_STATUS_PARTIAL_CONTENT </dt> -<dd class="description">Only a partial file was received/sent</dd> -<dt>HTTP_STATUS_PAYMENT_REQUIRED </dt> -<dd class="description">Payment required</dd> -<dt>HTTP_STATUS_PRECONDITION </dt> -<dd class="description">Precondition failed</dd> -<dt>HTTP_STATUS_PROXY_AUTHENTICATION </dt> -<dd class="description">Proxy Authentication is Required</dd> -<dt>HTTP_STATUS_REQUESTED_RANGE </dt> -<dd class="description">The requested range is not satisfiable</dd> -<dt>HTTP_STATUS_REQUEST_TIMEOUT </dt> -<dd class="description">Request timed out</dd> -<dt>HTTP_STATUS_REQUEST_TOO_LARGE </dt> -<dd class="description">Request entity too large</dd> -<dt>HTTP_STATUS_RESET_CONTENT </dt> -<dd class="description">Content was reset/recreated</dd> -<dt>HTTP_STATUS_SEE_OTHER </dt> -<dd class="description">See this other link...</dd> -<dt>HTTP_STATUS_SERVER_ERROR </dt> -<dd class="description">Internal server error</dd> -<dt>HTTP_STATUS_SERVICE_UNAVAILABLE </dt> -<dd class="description">Service is unavailable</dd> -<dt>HTTP_STATUS_SWITCHING_PROTOCOLS </dt> -<dd class="description">HTTP upgrade to TLS/SSL</dd> -<dt>HTTP_STATUS_UNAUTHORIZED </dt> -<dd class="description">Unauthorized to access host</dd> -<dt>HTTP_STATUS_UNSUPPORTED_MEDIATYPE </dt> -<dd class="description">The requested media type is unsupported</dd> -<dt>HTTP_STATUS_UPGRADE_REQUIRED </dt> -<dd class="description">Upgrade to SSL/TLS required</dd> -<dt>HTTP_STATUS_URI_TOO_LONG </dt> -<dd class="description">URI too long</dd> -<dt>HTTP_STATUS_USE_PROXY </dt> -<dd class="description">Must use a proxy to access this URI</dd> -</dl> -<h3 class="enumeration"><span class="info"> CUPS 2.0/OS 10.10 </span><a name="http_trust_e">http_trust_e</a></h3> -<p class="description">Level of trust for credentials </p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_TRUST_CHANGED </dt> -<dd class="description">Credentials have changed</dd> -<dt>HTTP_TRUST_EXPIRED </dt> -<dd class="description">Credentials are expired</dd> -<dt>HTTP_TRUST_INVALID </dt> -<dd class="description">Credentials are invalid</dd> -<dt>HTTP_TRUST_OK </dt> -<dd class="description">Credentials are OK/trusted</dd> -<dt>HTTP_TRUST_RENEWED </dt> -<dd class="description">Credentials have been renewed</dd> -<dt>HTTP_TRUST_UNKNOWN </dt> -<dd class="description">Credentials are unknown/new</dd> -</dl> -<h3 class="enumeration"><a name="http_uri_coding_e">http_uri_coding_e</a></h3> -<p class="description">URI en/decode flags</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_URI_CODING_ALL </dt> -<dd class="description">En/decode everything</dd> -<dt>HTTP_URI_CODING_HOSTNAME </dt> -<dd class="description">En/decode the hostname portion</dd> -<dt>HTTP_URI_CODING_MOST </dt> -<dd class="description">En/decode all but the query</dd> -<dt>HTTP_URI_CODING_NONE </dt> -<dd class="description">Don't en/decode anything</dd> -<dt>HTTP_URI_CODING_QUERY </dt> -<dd class="description">En/decode the query portion</dd> -<dt>HTTP_URI_CODING_RESOURCE </dt> -<dd class="description">En/decode the resource portion</dd> -<dt>HTTP_URI_CODING_RFC6874 </dt> -<dd class="description">Use RFC 6874 address format</dd> -<dt>HTTP_URI_CODING_USERNAME </dt> -<dd class="description">En/decode the username portion</dd> -</dl> -<h3 class="enumeration"><span class="info"> CUPS 1.2 </span><a name="http_uri_status_e">http_uri_status_e</a></h3> -<p class="description">URI separation status </p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_URI_STATUS_BAD_ARGUMENTS </dt> -<dd class="description">Bad arguments to function (error)</dd> -<dt>HTTP_URI_STATUS_BAD_HOSTNAME </dt> -<dd class="description">Bad hostname in URI (error)</dd> -<dt>HTTP_URI_STATUS_BAD_PORT </dt> -<dd class="description">Bad port number in URI (error)</dd> -<dt>HTTP_URI_STATUS_BAD_RESOURCE </dt> -<dd class="description">Bad resource in URI (error)</dd> -<dt>HTTP_URI_STATUS_BAD_SCHEME </dt> -<dd class="description">Bad scheme in URI (error)</dd> -<dt>HTTP_URI_STATUS_BAD_URI </dt> -<dd class="description">Bad/empty URI (error)</dd> -<dt>HTTP_URI_STATUS_BAD_USERNAME </dt> -<dd class="description">Bad username in URI (error)</dd> -<dt>HTTP_URI_STATUS_MISSING_RESOURCE </dt> -<dd class="description">Missing resource in URI (warning)</dd> -<dt>HTTP_URI_STATUS_MISSING_SCHEME </dt> -<dd class="description">Missing scheme in URI (warning)</dd> -<dt>HTTP_URI_STATUS_OK </dt> -<dd class="description">URI decoded OK</dd> -<dt>HTTP_URI_STATUS_OVERFLOW </dt> -<dd class="description">URI buffer for httpAssembleURI is too small</dd> -<dt>HTTP_URI_STATUS_UNKNOWN_SCHEME </dt> -<dd class="description">Unknown scheme in URI (warning)</dd> -</dl> -<h3 class="enumeration"><a name="http_version_e">http_version_e</a></h3> -<p class="description">HTTP version numbers</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>HTTP_VERSION_0_9 </dt> -<dd class="description">HTTP/0.9</dd> -<dt>HTTP_VERSION_1_0 </dt> -<dd class="description">HTTP/1.0</dd> -<dt>HTTP_VERSION_1_1 </dt> -<dd class="description">HTTP/1.1</dd> -</dl> -<h3 class="enumeration"><a name="ipp_dstate_e">ipp_dstate_e</a></h3> -<p class="description">Document states</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_DOCUMENT_ABORTED </dt> -<dd class="description">Document is aborted</dd> -<dt>IPP_DOCUMENT_CANCELED </dt> -<dd class="description">Document is canceled</dd> -<dt>IPP_DOCUMENT_COMPLETED </dt> -<dd class="description">Document is completed</dd> -<dt>IPP_DOCUMENT_PENDING </dt> -<dd class="description">Document is pending</dd> -<dt>IPP_DOCUMENT_PROCESSING </dt> -<dd class="description">Document is processing</dd> -</dl> -<h3 class="enumeration"><a name="ipp_finishings_e">ipp_finishings_e</a></h3> -<p class="description">Finishings</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_FINISHINGS_BALE </dt> -<dd class="description">Bale (any type)</dd> -<dt>IPP_FINISHINGS_BIND </dt> -<dd class="description">Bind</dd> -<dt>IPP_FINISHINGS_BIND_BOTTOM </dt> -<dd class="description">Bind on bottom</dd> -<dt>IPP_FINISHINGS_BIND_LEFT </dt> -<dd class="description">Bind on left</dd> -<dt>IPP_FINISHINGS_BIND_RIGHT </dt> -<dd class="description">Bind on right</dd> -<dt>IPP_FINISHINGS_BIND_TOP </dt> -<dd class="description">Bind on top</dd> -<dt>IPP_FINISHINGS_BOOKLET_MAKER </dt> -<dd class="description">Fold to make booklet</dd> -<dt>IPP_FINISHINGS_COAT </dt> -<dd class="description">Apply protective liquid or powder coating</dd> -<dt>IPP_FINISHINGS_COVER </dt> -<dd class="description">Add cover</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_ACCORDIAN </dt> -<dd class="description">Accordian-fold the paper vertically into four sections</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_DOUBLE_GATE </dt> -<dd class="description">Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_GATE </dt> -<dd class="description">Fold the top and bottom quarters of the paper towards the midline</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_HALF </dt> -<dd class="description">Fold the paper in half vertically</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_HALF_Z </dt> -<dd class="description">Fold the paper in half horizontally, then Z-fold the paper vertically</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_LEFT_GATE </dt> -<dd class="description">Fold the top quarter of the paper towards the midline</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_LETTER </dt> -<dd class="description">Fold the paper into three sections vertically; sometimes also known as a C fold</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_PARALLEL </dt> -<dd class="description">Fold the paper in half vertically two times, yielding four sections</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_POSTER </dt> -<dd class="description">Fold the paper in half horizontally and vertically; sometimes also called a cross fold</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_RIGHT_GATE </dt> -<dd class="description">Fold the bottom quarter of the paper towards the midline</dd> -<dt>IPP_FINISHINGS_CUPS_FOLD_Z </dt> -<dd class="description">Fold the paper vertically into three sections, forming a Z</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_LEFT </dt> -<dd class="description">Punch 1 hole bottom left</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_RIGHT </dt> -<dd class="description">Punch 1 hole bottom right</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_DUAL_BOTTOM </dt> -<dd class="description">Punch 2 holes bottom edge</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_DUAL_LEFT </dt> -<dd class="description">Punch 2 holes left side</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_DUAL_RIGHT </dt> -<dd class="description">Punch 2 holes right side</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_DUAL_TOP </dt> -<dd class="description">Punch 2 holes top edge</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_QUAD_BOTTOM </dt> -<dd class="description">Punch 4 holes bottom edge</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_QUAD_LEFT </dt> -<dd class="description">Punch 4 holes left side</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_QUAD_RIGHT </dt> -<dd class="description">Punch 4 holes right side</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_QUAD_TOP </dt> -<dd class="description">Punch 4 holes top edge</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_TOP_LEFT </dt> -<dd class="description">Punch 1 hole top left</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_TOP_RIGHT </dt> -<dd class="description">Punch 1 hole top right</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_BOTTOM </dt> -<dd class="description">Punch 3 holes bottom edge</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_LEFT </dt> -<dd class="description">Punch 3 holes left side</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_RIGHT </dt> -<dd class="description">Punch 3 holes right side</dd> -<dt>IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_TOP </dt> -<dd class="description">Punch 3 holes top edge</dd> -<dt>IPP_FINISHINGS_EDGE_STITCH </dt> -<dd class="description">Stitch along any side</dd> -<dt>IPP_FINISHINGS_EDGE_STITCH_BOTTOM </dt> -<dd class="description">Stitch along bottom edge</dd> -<dt>IPP_FINISHINGS_EDGE_STITCH_LEFT </dt> -<dd class="description">Stitch along left side</dd> -<dt>IPP_FINISHINGS_EDGE_STITCH_RIGHT </dt> -<dd class="description">Stitch along right side</dd> -<dt>IPP_FINISHINGS_EDGE_STITCH_TOP </dt> -<dd class="description">Stitch along top edge</dd> -<dt>IPP_FINISHINGS_FOLD </dt> -<dd class="description">Fold (any type)</dd> -<dt>IPP_FINISHINGS_FOLD_ACCORDIAN </dt> -<dd class="description">Accordian-fold the paper vertically into four sections</dd> -<dt>IPP_FINISHINGS_FOLD_DOUBLE_GATE </dt> -<dd class="description">Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically</dd> -<dt>IPP_FINISHINGS_FOLD_ENGINEERING_Z </dt> -<dd class="description">Fold the paper vertically into two small sections and one larger, forming an elongated Z</dd> -<dt>IPP_FINISHINGS_FOLD_GATE </dt> -<dd class="description">Fold the top and bottom quarters of the paper towards the midline</dd> -<dt>IPP_FINISHINGS_FOLD_HALF </dt> -<dd class="description">Fold the paper in half vertically</dd> -<dt>IPP_FINISHINGS_FOLD_HALF_Z </dt> -<dd class="description">Fold the paper in half horizontally, then Z-fold the paper vertically</dd> -<dt>IPP_FINISHINGS_FOLD_LEFT_GATE </dt> -<dd class="description">Fold the top quarter of the paper towards the midline</dd> -<dt>IPP_FINISHINGS_FOLD_LETTER </dt> -<dd class="description">Fold the paper into three sections vertically; sometimes also known as a C fold</dd> -<dt>IPP_FINISHINGS_FOLD_PARALLEL </dt> -<dd class="description">Fold the paper in half vertically two times, yielding four sections</dd> -<dt>IPP_FINISHINGS_FOLD_POSTER </dt> -<dd class="description">Fold the paper in half horizontally and vertically; sometimes also called a cross fold</dd> -<dt>IPP_FINISHINGS_FOLD_RIGHT_GATE </dt> -<dd class="description">Fold the bottom quarter of the paper towards the midline</dd> -<dt>IPP_FINISHINGS_FOLD_Z </dt> -<dd class="description">Fold the paper vertically into three sections, forming a Z</dd> -<dt>IPP_FINISHINGS_JOG_OFFSET </dt> -<dd class="description">Offset for binding (any type)</dd> -<dt>IPP_FINISHINGS_LAMINATE </dt> -<dd class="description">Apply protective (solid) material</dd> -<dt>IPP_FINISHINGS_NONE </dt> -<dd class="description">No finishing</dd> -<dt>IPP_FINISHINGS_PUNCH </dt> -<dd class="description">Punch (any location/count)</dd> -<dt>IPP_FINISHINGS_PUNCH_BOTTOM_LEFT </dt> -<dd class="description">Punch 1 hole bottom left</dd> -<dt>IPP_FINISHINGS_PUNCH_BOTTOM_RIGHT </dt> -<dd class="description">Punch 1 hole bottom right</dd> -<dt>IPP_FINISHINGS_PUNCH_DUAL_BOTTOM </dt> -<dd class="description">Punch 2 holes bottom edge</dd> -<dt>IPP_FINISHINGS_PUNCH_DUAL_LEFT </dt> -<dd class="description">Punch 2 holes left side</dd> -<dt>IPP_FINISHINGS_PUNCH_DUAL_RIGHT </dt> -<dd class="description">Punch 2 holes right side</dd> -<dt>IPP_FINISHINGS_PUNCH_DUAL_TOP </dt> -<dd class="description">Punch 2 holes top edge</dd> -<dt>IPP_FINISHINGS_PUNCH_MULTIPLE_BOTTOM </dt> -<dd class="description">Pucnh multiple holes bottom edge</dd> -<dt>IPP_FINISHINGS_PUNCH_MULTIPLE_LEFT </dt> -<dd class="description">Pucnh multiple holes left side</dd> -<dt>IPP_FINISHINGS_PUNCH_MULTIPLE_RIGHT </dt> -<dd class="description">Pucnh multiple holes right side</dd> -<dt>IPP_FINISHINGS_PUNCH_MULTIPLE_TOP </dt> -<dd class="description">Pucnh multiple holes top edge</dd> -<dt>IPP_FINISHINGS_PUNCH_QUAD_BOTTOM </dt> -<dd class="description">Punch 4 holes bottom edge</dd> -<dt>IPP_FINISHINGS_PUNCH_QUAD_LEFT </dt> -<dd class="description">Punch 4 holes left side</dd> -<dt>IPP_FINISHINGS_PUNCH_QUAD_RIGHT </dt> -<dd class="description">Punch 4 holes right side</dd> -<dt>IPP_FINISHINGS_PUNCH_QUAD_TOP </dt> -<dd class="description">Punch 4 holes top edge</dd> -<dt>IPP_FINISHINGS_PUNCH_TOP_LEFT </dt> -<dd class="description">Punch 1 hole top left</dd> -<dt>IPP_FINISHINGS_PUNCH_TOP_RIGHT </dt> -<dd class="description">Punch 1 hole top right</dd> -<dt>IPP_FINISHINGS_PUNCH_TRIPLE_BOTTOM </dt> -<dd class="description">Punch 3 holes bottom edge</dd> -<dt>IPP_FINISHINGS_PUNCH_TRIPLE_LEFT </dt> -<dd class="description">Punch 3 holes left side</dd> -<dt>IPP_FINISHINGS_PUNCH_TRIPLE_RIGHT </dt> -<dd class="description">Punch 3 holes right side</dd> -<dt>IPP_FINISHINGS_PUNCH_TRIPLE_TOP </dt> -<dd class="description">Punch 3 holes top edge</dd> -<dt>IPP_FINISHINGS_SADDLE_STITCH </dt> -<dd class="description">Staple interior</dd> -<dt>IPP_FINISHINGS_STAPLE </dt> -<dd class="description">Staple (any location)</dd> -<dt>IPP_FINISHINGS_STAPLE_BOTTOM_LEFT </dt> -<dd class="description">Staple bottom left corner</dd> -<dt>IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT </dt> -<dd class="description">Staple bottom right corner</dd> -<dt>IPP_FINISHINGS_STAPLE_DUAL_BOTTOM </dt> -<dd class="description">Two staples on bottom</dd> -<dt>IPP_FINISHINGS_STAPLE_DUAL_LEFT </dt> -<dd class="description">Two staples on left</dd> -<dt>IPP_FINISHINGS_STAPLE_DUAL_RIGHT </dt> -<dd class="description">Two staples on right</dd> -<dt>IPP_FINISHINGS_STAPLE_DUAL_TOP </dt> -<dd class="description">Two staples on top</dd> -<dt>IPP_FINISHINGS_STAPLE_TOP_LEFT </dt> -<dd class="description">Staple top left corner</dd> -<dt>IPP_FINISHINGS_STAPLE_TOP_RIGHT </dt> -<dd class="description">Staple top right corner</dd> -<dt>IPP_FINISHINGS_STAPLE_TRIPLE_BOTTOM </dt> -<dd class="description">Three staples on bottom</dd> -<dt>IPP_FINISHINGS_STAPLE_TRIPLE_LEFT </dt> -<dd class="description">Three staples on left</dd> -<dt>IPP_FINISHINGS_STAPLE_TRIPLE_RIGHT </dt> -<dd class="description">Three staples on right</dd> -<dt>IPP_FINISHINGS_STAPLE_TRIPLE_TOP </dt> -<dd class="description">Three staples on top</dd> -<dt>IPP_FINISHINGS_TRIM </dt> -<dd class="description">Trim (any type)</dd> -<dt>IPP_FINISHINGS_TRIM_AFTER_COPIES </dt> -<dd class="description">Trim output after each copy</dd> -<dt>IPP_FINISHINGS_TRIM_AFTER_DOCUMENTS </dt> -<dd class="description">Trim output after each document</dd> -<dt>IPP_FINISHINGS_TRIM_AFTER_JOB </dt> -<dd class="description">Trim output after job</dd> -<dt>IPP_FINISHINGS_TRIM_AFTER_PAGES </dt> -<dd class="description">Trim output after each page</dd> -</dl> -<h3 class="enumeration"><a name="ipp_jcollate_e">ipp_jcollate_e</a></h3> -<p class="description">Job collation types</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_JCOLLATE_COLLATED_DOCUMENTS </dt> -<dt>IPP_JCOLLATE_UNCOLLATED_DOCUMENTS </dt> -<dt>IPP_JCOLLATE_UNCOLLATED_SHEETS </dt> -</dl> -<h3 class="enumeration"><a name="ipp_jstate_e">ipp_jstate_e</a></h3> -<p class="description">Job states</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_JSTATE_ABORTED </dt> -<dd class="description">Job has aborted due to error</dd> -<dt>IPP_JSTATE_CANCELED </dt> -<dd class="description">Job has been canceled</dd> -<dt>IPP_JSTATE_COMPLETED </dt> -<dd class="description">Job has completed successfully</dd> -<dt>IPP_JSTATE_HELD </dt> -<dd class="description">Job is held for printing</dd> -<dt>IPP_JSTATE_PENDING </dt> -<dd class="description">Job is waiting to be printed</dd> -<dt>IPP_JSTATE_PROCESSING </dt> -<dd class="description">Job is currently printing</dd> -<dt>IPP_JSTATE_STOPPED </dt> -<dd class="description">Job has been stopped</dd> -</dl> -<h3 class="enumeration"><a name="ipp_op_e">ipp_op_e</a></h3> -<p class="description">IPP operations</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_OP_ACKNOWLEDGE_DOCUMENT </dt> -<dd class="description">Acknowledge-Document</dd> -<dt>IPP_OP_ACKNOWLEDGE_IDENTIFY_PRINTER </dt> -<dd class="description">Acknowledge-Identify-Printer</dd> -<dt>IPP_OP_ACKNOWLEDGE_JOB </dt> -<dd class="description">Acknowledge-Job</dd> -<dt>IPP_OP_ACTIVATE_PRINTER </dt> -<dd class="description">Start a printer</dd> -<dt>IPP_OP_ADD_DOCUMENT_IMAGES </dt> -<dd class="description">Add-Document-Images</dd> -<dt>IPP_OP_CANCEL_CURRENT_JOB </dt> -<dd class="description">Cancel the current job</dd> -<dt>IPP_OP_CANCEL_DOCUMENT </dt> -<dd class="description">Cancel-Document</dd> -<dt>IPP_OP_CANCEL_JOB </dt> -<dd class="description">Cancel a job</dd> -<dt>IPP_OP_CANCEL_JOBS </dt> -<dd class="description">Cancel-Jobs</dd> -<dt>IPP_OP_CANCEL_MY_JOBS </dt> -<dd class="description">Cancel-My-Jobs</dd> -<dt>IPP_OP_CANCEL_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Cancel a subscription </dd> -<dt>IPP_OP_CLOSE_JOB </dt> -<dd class="description">Close-Job</dd> -<dt>IPP_OP_CREATE_JOB </dt> -<dd class="description">Create an empty print job</dd> -<dt>IPP_OP_CREATE_JOB_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Create one of more job subscriptions </dd> -<dt>IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Create one or more printer subscriptions </dd> -<dt>IPP_OP_CUPS_ACCEPT_JOBS </dt> -<dd class="description">Accept new jobs on a printer</dd> -<dt>IPP_OP_CUPS_ADD_MODIFY_CLASS </dt> -<dd class="description">Add or modify a class</dd> -<dt>IPP_OP_CUPS_ADD_MODIFY_PRINTER </dt> -<dd class="description">Add or modify a printer</dd> -<dt>IPP_OP_CUPS_AUTHENTICATE_JOB <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Authenticate a job </dd> -<dt>IPP_OP_CUPS_CREATE_LOCAL_PRINTER <span class="info"> CUPS 2.2 </span></dt> -<dd class="description">Create a local (temporary) printer <dt>IPP_OP_CUPS_DELETE_CLASS </dt> -<dd class="description">Delete a class</dd> -<dt>IPP_OP_CUPS_DELETE_PRINTER </dt> -<dd class="description">Delete a printer</dd> -<dt>IPP_OP_CUPS_GET_CLASSES <span class="info"> DEPRECATED </span></dt> -<dd class="description">Get a list of classes </dd> -<dt>IPP_OP_CUPS_GET_DEFAULT </dt> -<dd class="description">Get the default printer</dd> -<dt>IPP_OP_CUPS_GET_DEVICES <span class="info"> DEPRECATED </span></dt> -<dd class="description">Get a list of supported devices </dd> -<dt>IPP_OP_CUPS_GET_DOCUMENT <span class="info"> CUPS 1.4/macOS 10.6 </span></dt> -<dd class="description">Get a document file </dd> -<dt>IPP_OP_CUPS_GET_PPD <span class="info"> DEPRECATED </span></dt> -<dd class="description">Get a PPD file </dd> -<dt>IPP_OP_CUPS_GET_PPDS <span class="info"> DEPRECATED </span></dt> -<dd class="description">Get a list of supported drivers </dd> -<dt>IPP_OP_CUPS_GET_PRINTERS </dt> -<dd class="description">Get a list of printers and/or classes</dd> -<dt>IPP_OP_CUPS_INVALID </dt> -<dd class="description">Invalid operation name for <a href="#ippOpValue"><code>ippOpValue</code></a></dd> -<dt>IPP_OP_CUPS_MOVE_JOB </dt> -<dd class="description">Move a job to a different printer</dd> -<dt>IPP_OP_CUPS_REJECT_JOBS </dt> -<dd class="description">Reject new jobs on a printer</dd> -<dt>IPP_OP_CUPS_SET_DEFAULT </dt> -<dd class="description">Set the default printer</dd> -<dt>IPP_OP_DEACTIVATE_PRINTER </dt> -<dd class="description">Stop a printer</dd> -<dt>IPP_OP_DELETE_DOCUMENT </dt> -<dd class="description">Delete-Document</dd> -<dt>IPP_OP_DEREGISTER_OUTPUT_DEVICE </dt> -<dd class="description">Deregister-Output-Device</dd> -<dt>IPP_OP_DISABLE_PRINTER </dt> -<dd class="description">Stop a printer</dd> -<dt>IPP_OP_ENABLE_PRINTER </dt> -<dd class="description">Start a printer</dd> -<dt>IPP_OP_FETCH_DOCUMENT </dt> -<dd class="description">Fetch-Document</dd> -<dt>IPP_OP_FETCH_JOB </dt> -<dd class="description">Fetch-Job</dd> -<dt>IPP_OP_GET_DOCUMENTS </dt> -<dd class="description">Get-Documents</dd> -<dt>IPP_OP_GET_DOCUMENT_ATTRIBUTES </dt> -<dd class="description">Get-Document-Attributes</dd> -<dt>IPP_OP_GET_JOBS </dt> -<dd class="description">Get a list of jobs</dd> -<dt>IPP_OP_GET_JOB_ATTRIBUTES </dt> -<dd class="description">Get job attributes</dd> -<dt>IPP_OP_GET_NEXT_DOCUMENT_DATA </dt> -<dd class="description">Get-Next-Document-Data</dd> -<dt>IPP_OP_GET_NOTIFICATIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Get notification events </dd> -<dt>IPP_OP_GET_OUTPUT_DEVICE_ATTRIBUTES </dt> -<dd class="description">Get-Output-Device-Attributes</dd> -<dt>IPP_OP_GET_PRINTER_ATTRIBUTES </dt> -<dd class="description">Get printer attributes</dd> -<dt>IPP_OP_GET_PRINTER_SUPPORTED_VALUES </dt> -<dd class="description">Get supported attribute values</dd> -<dt>IPP_OP_GET_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Get list of subscriptions </dd> -<dt>IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Get subscription attributes </dd> -<dt>IPP_OP_HOLD_JOB </dt> -<dd class="description">Hold a job for printing</dd> -<dt>IPP_OP_HOLD_NEW_JOBS </dt> -<dd class="description">Hold new jobs</dd> -<dt>IPP_OP_IDENTIFY_PRINTER </dt> -<dd class="description">Identify-Printer</dd> -<dt>IPP_OP_PAUSE_PRINTER </dt> -<dd class="description">Stop a printer</dd> -<dt>IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB </dt> -<dd class="description">Stop printer after the current job</dd> -<dt>IPP_OP_PRINT_JOB </dt> -<dd class="description">Print a single file</dd> -<dt>IPP_OP_PRINT_URI </dt> -<dd class="description">Print a single URL</dd> -<dt>IPP_OP_PROMOTE_JOB </dt> -<dd class="description">Promote a job to print sooner</dd> -<dt>IPP_OP_PURGE_JOBS </dt> -<dd class="description">Cancel all jobs</dd> -<dt>IPP_OP_RELEASE_HELD_NEW_JOBS </dt> -<dd class="description">Release new jobs</dd> -<dt>IPP_OP_RELEASE_JOB </dt> -<dd class="description">Release a job for printing</dd> -<dt>IPP_OP_RENEW_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Renew a printer subscription </dd> -<dt>IPP_OP_REPROCESS_JOB </dt> -<dd class="description">Reprint a job</dd> -<dt>IPP_OP_RESTART_JOB </dt> -<dd class="description">Reprint a job</dd> -<dt>IPP_OP_RESTART_PRINTER </dt> -<dd class="description">Restart a printer</dd> -<dt>IPP_OP_RESUBMIT_JOB </dt> -<dd class="description">Resubmit-Job</dd> -<dt>IPP_OP_RESUME_JOB </dt> -<dd class="description">Resume the current job</dd> -<dt>IPP_OP_RESUME_PRINTER </dt> -<dd class="description">Start a printer</dd> -<dt>IPP_OP_SCHEDULE_JOB_AFTER </dt> -<dd class="description">Schedule a job to print after another</dd> -<dt>IPP_OP_SEND_DOCUMENT </dt> -<dd class="description">Add a file to a job</dd> -<dt>IPP_OP_SEND_URI </dt> -<dd class="description">Add a URL to a job</dd> -<dt>IPP_OP_SET_DOCUMENT_ATTRIBUTES </dt> -<dd class="description">Set-Document-Attributes</dd> -<dt>IPP_OP_SET_JOB_ATTRIBUTES </dt> -<dd class="description">Set job attributes</dd> -<dt>IPP_OP_SET_PRINTER_ATTRIBUTES </dt> -<dd class="description">Set printer attributes</dd> -<dt>IPP_OP_SHUTDOWN_PRINTER </dt> -<dd class="description">Turn a printer off</dd> -<dt>IPP_OP_STARTUP_PRINTER </dt> -<dd class="description">Turn a printer on</dd> -<dt>IPP_OP_SUSPEND_CURRENT_JOB </dt> -<dd class="description">Suspend the current job</dd> -<dt>IPP_OP_UPDATE_ACTIVE_JOBS </dt> -<dd class="description">Update-Active-Jobs</dd> -<dt>IPP_OP_UPDATE_DOCUMENT_STATUS </dt> -<dd class="description">Update-Document-Status</dd> -<dt>IPP_OP_UPDATE_JOB_STATUS </dt> -<dd class="description">Update-Job-Status</dd> -<dt>IPP_OP_UPDATE_OUTPUT_DEVICE_ATTRIBUTES </dt> -<dd class="description">Update-Output-Device-Attributes</dd> -<dt>IPP_OP_VALIDATE_DOCUMENT </dt> -<dd class="description">Validate-Document</dd> -<dt>IPP_OP_VALIDATE_JOB </dt> -<dd class="description">Validate job options</dd> -</dl> -<h3 class="enumeration"><a name="ipp_orient_e">ipp_orient_e</a></h3> -<p class="description">Orientation values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_ORIENT_LANDSCAPE </dt> -<dd class="description">90 degrees counter-clockwise</dd> -<dt>IPP_ORIENT_NONE </dt> -<dd class="description">No rotation</dd> -<dt>IPP_ORIENT_PORTRAIT </dt> -<dd class="description">No rotation</dd> -<dt>IPP_ORIENT_REVERSE_LANDSCAPE </dt> -<dd class="description">90 degrees clockwise</dd> -<dt>IPP_ORIENT_REVERSE_PORTRAIT </dt> -<dd class="description">180 degrees</dd> -</dl> -<h3 class="enumeration"><a name="ipp_pstate_e">ipp_pstate_e</a></h3> -<p class="description">Printer states</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_PSTATE_IDLE </dt> -<dd class="description">Printer is idle</dd> -<dt>IPP_PSTATE_PROCESSING </dt> -<dd class="description">Printer is working</dd> -<dt>IPP_PSTATE_STOPPED </dt> -<dd class="description">Printer is stopped</dd> -</dl> -<h3 class="enumeration"><a name="ipp_quality_e">ipp_quality_e</a></h3> -<p class="description">Qualities</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_QUALITY_DRAFT </dt> -<dd class="description">Draft quality</dd> -<dt>IPP_QUALITY_HIGH </dt> -<dd class="description">High quality</dd> -<dt>IPP_QUALITY_NORMAL </dt> -<dd class="description">Normal quality</dd> -</dl> -<h3 class="enumeration"><a name="ipp_res_e">ipp_res_e</a></h3> -<p class="description">Resolution units</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_RES_PER_CM </dt> -<dd class="description">Pixels per centimeter</dd> -<dt>IPP_RES_PER_INCH </dt> -<dd class="description">Pixels per inch</dd> -</dl> -<h3 class="enumeration"><a name="ipp_state_e">ipp_state_e</a></h3> -<p class="description">IPP states</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_STATE_ATTRIBUTE </dt> -<dd class="description">One or more attributes need to be sent/received</dd> -<dt>IPP_STATE_DATA </dt> -<dd class="description">IPP request data needs to be sent/received</dd> -<dt>IPP_STATE_ERROR </dt> -<dd class="description">An error occurred</dd> -<dt>IPP_STATE_HEADER </dt> -<dd class="description">The request header needs to be sent/received</dd> -<dt>IPP_STATE_IDLE </dt> -<dd class="description">Nothing is happening/request completed</dd> -</dl> -<h3 class="enumeration"><a name="ipp_status_e">ipp_status_e</a></h3> -<p class="description">IPP status codes</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_STATUS_CUPS_INVALID </dt> -<dd class="description">Invalid status name for <a href="#ippErrorValue"><code>ippErrorValue</code></a></dd> -<dt>IPP_STATUS_CUPS_SEE_OTHER </dt> -<dd class="description">cups-see-other</dd> -<dt>IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED </dt> -<dd class="description">client-error-account-authorization-failed</dd> -<dt>IPP_STATUS_ERROR_ACCOUNT_CLOSED </dt> -<dd class="description">client-error-account-closed</dd> -<dt>IPP_STATUS_ERROR_ACCOUNT_INFO_NEEDED </dt> -<dd class="description">client-error-account-info-needed</dd> -<dt>IPP_STATUS_ERROR_ACCOUNT_LIMIT_REACHED </dt> -<dd class="description">client-error-account-limit-reached</dd> -<dt>IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE </dt> -<dd class="description">client-error-attributes-not-settable</dd> -<dt>IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES </dt> -<dd class="description">client-error-attributes-or-values-not-supported</dd> -<dt>IPP_STATUS_ERROR_BAD_REQUEST </dt> -<dd class="description">client-error-bad-request</dd> -<dt>IPP_STATUS_ERROR_BUSY </dt> -<dd class="description">server-error-busy</dd> -<dt>IPP_STATUS_ERROR_CHARSET </dt> -<dd class="description">client-error-charset-not-supported</dd> -<dt>IPP_STATUS_ERROR_COMPRESSION_ERROR </dt> -<dd class="description">client-error-compression-error</dd> -<dt>IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED </dt> -<dd class="description">client-error-compression-not-supported</dd> -<dt>IPP_STATUS_ERROR_CONFLICTING </dt> -<dd class="description">client-error-conflicting-attributes</dd> -<dt>IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED <span class="info"> DEPRECATED </span></dt> -<dd class="description">cups-error-account-authorization-failed </dd> -<dt>IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED </dt> -<dd class="description">cups-error-account-closed @deprecate@</dd> -<dt>IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED <span class="info"> DEPRECATED </span></dt> -<dd class="description">cups-error-account-info-needed </dd> -<dt>IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED <span class="info"> DEPRECATED </span></dt> -<dd class="description">cups-error-account-limit-reached </dd> -<dt>IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED <span class="info"> CUPS 1.5/macOS 10.7 </span></dt> -<dd class="description">cups-authentication-canceled - Authentication canceled by user </dd> -<dt>IPP_STATUS_ERROR_CUPS_PKI <span class="info"> CUPS 1.5/macOS 10.7 </span></dt> -<dd class="description">cups-pki-error - Error negotiating a secure connection </dd> -<dt>IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED </dt> -<dd class="description">cups-upgrade-required - TLS upgrade required</dd> -<dt>IPP_STATUS_ERROR_DEVICE </dt> -<dd class="description">server-error-device-error</dd> -<dt>IPP_STATUS_ERROR_DOCUMENT_ACCESS </dt> -<dd class="description">client-error-document-access-error</dd> -<dt>IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR </dt> -<dd class="description">client-error-document-format-error</dd> -<dt>IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED </dt> -<dd class="description">client-error-document-format-not-supported</dd> -<dt>IPP_STATUS_ERROR_DOCUMENT_PASSWORD </dt> -<dd class="description">client-error-document-password-error</dd> -<dt>IPP_STATUS_ERROR_DOCUMENT_PERMISSION </dt> -<dd class="description">client-error-document-permission-error</dd> -<dt>IPP_STATUS_ERROR_DOCUMENT_SECURITY </dt> -<dd class="description">client-error-document-security-error</dd> -<dt>IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE </dt> -<dd class="description">client-error-document-unprintable-error</dd> -<dt>IPP_STATUS_ERROR_FORBIDDEN </dt> -<dd class="description">client-error-forbidden</dd> -<dt>IPP_STATUS_ERROR_GONE </dt> -<dd class="description">client-error-gone</dd> -<dt>IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS </dt> -<dd class="description">client-error-ignored-all-subscriptions</dd> -<dt>IPP_STATUS_ERROR_INTERNAL </dt> -<dd class="description">server-error-internal-error</dd> -<dt>IPP_STATUS_ERROR_JOB_CANCELED </dt> -<dd class="description">server-error-job-canceled</dd> -<dt>IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED </dt> -<dd class="description">server-error-multiple-document-jobs-not-supported</dd> -<dt>IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS </dt> -<dd class="description">server-error-not-accepting-jobs</dd> -<dt>IPP_STATUS_ERROR_NOT_AUTHENTICATED </dt> -<dd class="description">client-error-not-authenticated</dd> -<dt>IPP_STATUS_ERROR_NOT_AUTHORIZED </dt> -<dd class="description">client-error-not-authorized</dd> -<dt>IPP_STATUS_ERROR_NOT_FETCHABLE </dt> -<dd class="description">client-error-not-fetchable</dd> -<dt>IPP_STATUS_ERROR_NOT_FOUND </dt> -<dd class="description">client-error-not-found</dd> -<dt>IPP_STATUS_ERROR_NOT_POSSIBLE </dt> -<dd class="description">client-error-not-possible</dd> -<dt>IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED </dt> -<dd class="description">server-error-operation-not-supported</dd> -<dt>IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED </dt> -<dd class="description">server-error-printer-is-deactivated</dd> -<dt>IPP_STATUS_ERROR_REQUEST_ENTITY </dt> -<dd class="description">client-error-request-entity-too-large</dd> -<dt>IPP_STATUS_ERROR_REQUEST_VALUE </dt> -<dd class="description">client-error-request-value-too-long</dd> -<dt>IPP_STATUS_ERROR_SERVICE_UNAVAILABLE </dt> -<dd class="description">server-error-service-unavailable</dd> -<dt>IPP_STATUS_ERROR_TEMPORARY </dt> -<dd class="description">server-error-temporary-error</dd> -<dt>IPP_STATUS_ERROR_TIMEOUT </dt> -<dd class="description">client-error-timeout</dd> -<dt>IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS </dt> -<dd class="description">server-error-too-many-documents</dd> -<dt>IPP_STATUS_ERROR_TOO_MANY_JOBS </dt> -<dd class="description">server-error-too-many-jobs</dd> -<dt>IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS </dt> -<dd class="description">client-error-too-many-subscriptions</dd> -<dt>IPP_STATUS_ERROR_URI_SCHEME </dt> -<dd class="description">client-error-uri-scheme-not-supported</dd> -<dt>IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED </dt> -<dd class="description">server-error-version-not-supported</dd> -<dt>IPP_STATUS_OK </dt> -<dd class="description">successful-ok</dd> -<dt>IPP_STATUS_OK_CONFLICTING </dt> -<dd class="description">successful-ok-conflicting-attributes</dd> -<dt>IPP_STATUS_OK_EVENTS_COMPLETE </dt> -<dd class="description">successful-ok-events-complete</dd> -<dt>IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED </dt> -<dd class="description">successful-ok-ignored-or-substituted-attributes</dd> -<dt>IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS </dt> -<dd class="description">successful-ok-ignored-subscriptions</dd> -<dt>IPP_STATUS_OK_TOO_MANY_EVENTS </dt> -<dd class="description">successful-ok-too-many-events</dd> -</dl> -<h3 class="enumeration"><a name="ipp_tag_e">ipp_tag_e</a></h3> -<p class="description">Format tags for attributes</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>IPP_TAG_ADMINDEFINE </dt> -<dd class="description">Admin-defined value</dd> -<dt>IPP_TAG_BEGIN_COLLECTION </dt> -<dd class="description">Beginning of collection value</dd> -<dt>IPP_TAG_BOOLEAN </dt> -<dd class="description">Boolean value</dd> -<dt>IPP_TAG_CHARSET </dt> -<dd class="description">Character set value</dd> -<dt>IPP_TAG_CUPS_INVALID </dt> -<dd class="description">Invalid tag name for <a href="#ippTagValue"><code>ippTagValue</code></a></dd> -<dt>IPP_TAG_DATE </dt> -<dd class="description">Date/time value</dd> -<dt>IPP_TAG_DEFAULT </dt> -<dd class="description">Default value</dd> -<dt>IPP_TAG_DELETEATTR </dt> -<dd class="description">Delete-attribute value</dd> -<dt>IPP_TAG_DOCUMENT </dt> -<dd class="description">Document group</dd> -<dt>IPP_TAG_END </dt> -<dd class="description">End-of-attributes</dd> -<dt>IPP_TAG_END_COLLECTION </dt> -<dd class="description">End of collection value</dd> -<dt>IPP_TAG_ENUM </dt> -<dd class="description">Enumeration value</dd> -<dt>IPP_TAG_EVENT_NOTIFICATION </dt> -<dd class="description">Event group</dd> -<dt>IPP_TAG_EXTENSION </dt> -<dd class="description">Extension point for 32-bit tags</dd> -<dt>IPP_TAG_INTEGER </dt> -<dd class="description">Integer value</dd> -<dt>IPP_TAG_JOB </dt> -<dd class="description">Job group</dd> -<dt>IPP_TAG_KEYWORD </dt> -<dd class="description">Keyword value</dd> -<dt>IPP_TAG_LANGUAGE </dt> -<dd class="description">Language value</dd> -<dt>IPP_TAG_MEMBERNAME </dt> -<dd class="description">Collection member name value</dd> -<dt>IPP_TAG_MIMETYPE </dt> -<dd class="description">MIME media type value</dd> -<dt>IPP_TAG_NAME </dt> -<dd class="description">Name value</dd> -<dt>IPP_TAG_NAMELANG </dt> -<dd class="description">Name-with-language value</dd> -<dt>IPP_TAG_NOTSETTABLE </dt> -<dd class="description">Not-settable value</dd> -<dt>IPP_TAG_NOVALUE </dt> -<dd class="description">No-value value</dd> -<dt>IPP_TAG_OPERATION </dt> -<dd class="description">Operation group</dd> -<dt>IPP_TAG_PRINTER </dt> -<dd class="description">Printer group</dd> -<dt>IPP_TAG_RANGE </dt> -<dd class="description">Range value</dd> -<dt>IPP_TAG_RESOLUTION </dt> -<dd class="description">Resolution value</dd> -<dt>IPP_TAG_STRING </dt> -<dd class="description">Octet string value</dd> -<dt>IPP_TAG_SUBSCRIPTION </dt> -<dd class="description">Subscription group</dd> -<dt>IPP_TAG_TEXT </dt> -<dd class="description">Text value</dd> -<dt>IPP_TAG_TEXTLANG </dt> -<dd class="description">Text-with-language value</dd> -<dt>IPP_TAG_UNKNOWN </dt> -<dd class="description">Unknown value</dd> -<dt>IPP_TAG_UNSUPPORTED_GROUP </dt> -<dd class="description">Unsupported attributes group</dd> -<dt>IPP_TAG_UNSUPPORTED_VALUE </dt> -<dd class="description">Unsupported value</dd> -<dt>IPP_TAG_URI </dt> -<dd class="description">URI value</dd> -<dt>IPP_TAG_URISCHEME </dt> -<dd class="description">URI scheme value</dd> -<dt>IPP_TAG_ZERO </dt> -<dd class="description">Zero tag - used for separators</dd> -</dl> -</div> -</body> -</html> diff --git a/doc/help/api-overview.html b/doc/help/api-overview.html deleted file mode 100644 index d6d5140..0000000 --- a/doc/help/api-overview.html +++ /dev/null @@ -1,512 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- SECTION: Programming --> -<head> - <title>Introduction to CUPS Programming </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<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 { - border: dotted thin #7f7f7f; - margin-left: 36pt; - padding: 10px; -} - -P.compact { - margin: 0; -} - -P.example { - font-style: italic; - margin-left: 36pt; -} - -DL.man DD { - margin-left: 5em; -} - -DL.man DT { - margin-left: 0; -} - -PRE.man { - margin: 0; -} - -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: inherit; - 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'> -<!-- - Introduction to CUPS programming header for CUPS. - - Copyright 2008-2016 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'>Introduction to CUPS Programming</h1> - -<div class='summary'><table summary='General Information'> -<thead> -<tr> - <th>Headers</th> - <th>cups/cups.h<br> - cups/adminutil.h<br> - cups/array.h<br> - cups/dir.h<br> - cups/file.h<br> - cups/http.h<br> - cups/ipp.h<br> - cups/language.h<br> - cups/ppd.h<br> - cups/pwg.h<br> - cups/raster.h</th> -</tr> -</thead> -<tbody> -<tr> - <th>Libraries</th> - <td>-lcups</td> -</tr> -<tr> - <th>See Also</th> - <td>Programming: <a href='raster-driver.html' target='_top'>Developing Raster Printer Drivers</a><br> - Programming: <a href='postscript-driver.html' target='_top'>Developing PostScript Printer Drivers</a><br> - Programming: <a href='api-filter.html' target='_top'>Filter and Backend Programming</a><br> - Programming: <a href='ppd-compiler.html' target='_top'>Introduction to the PPD Compiler</a><br> - Programming: <a href='api-admin.html' target='_top'>Administrative APIs</a><br> - Programming: <a href='api-array.html' target='_top'>Array API</a><br> - Programming: <a href='api-cups.html' target='_top'>CUPS API</a><br> - Programming: <a href='api-filedir.html' target='_top'>File and Directory APIs</a><br> - Programming: <a href='api-httpipp.html' target='_top'>HTTP and IPP APIs</a><br> - Programming: <a href='api-ppd.html' target='_top'>PPD API (DEPRECATED)</a><br> - Programming: <a href='api-raster.html' target='_top'>Raster API</a><br> - References: <a href='ref-ppdcfile.html' target='_top'>PPD Compiler Driver Information File Reference</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"> -<li><a href="#OVERVIEW">Overview</a></li> -<li><a href="#COMPILING">Compiling Programs</a><ul class="subcontents"> - <li><a href="#XCODE">Compiling with Xcode</a></li> - <li><a href="#COMMANDLINE">Compiling with GCC</a></li> -</ul></li> -<li><a href="#WHERETOGO">Where to Go Next</a></li> -</ul> -<!-- - Introduction to CUPS programming content for CUPS. - - Copyright 2008-2011 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/". ---> - -<h2 class="title"><a name="OVERVIEW">Overview</a></h2> - -<p>CUPS provides two libraries that interface with the different parts of the -printing system. The "cups" library provides all of the common application and -filter functions while the "cupsimage" library provides all of the imaging -functions used in raster printer drivers. The "cups" library functions are -accessed by including the <var><cups/cups.h></var> header, while -"cupsimage" functions are found in the <var><cups/raster.h></var> -header.</p> - -<h2 class="title"><a name="COMPILING">Compiling Programs</a></h2> - -<p>The CUPS libraries can be used from any C, C++, or Objective C program. -The method of compiling against the libraries varies depending on the -operating system and installation of CUPS. The following sections show how -to compile a simple program (shown below) in two common environments.</p> - -<p>The following simple program lists the available printers on the system:</p> - -<pre class="example"> -#include <stdio.h> -#include <cups/cups.h> - -int main(void) -{ - int i; - cups_dest_t *dests, *dest; - int num_dests = cupsGetDests(&dests); - - for (i = num_dests, dest = dests; i > 0; i --, dest ++) - { - if (dest->instance) - printf("%s/%s\n", dest->name, dest->instance); - else - puts(dest->name); - } - - return (0); -} -</pre> - -<h3><a name="XCODE">Compiling with Xcode</a></h3> - -<p>In Xcode, choose <var>New Project...</var> from the <var>File</var> menu, -then select the <var>Standard Tool</var> project type under <var>Command Line -Utility</var>. Click <var>Next</var> and choose a project directory. Click -<var>Next</var> to create the project.</p> - -<p>In the project window, double-click on the <var>Targets</var> group and -control-click on the simple target to show the context menu. Choose -<var>Existing Framework...</var> from the <var>Add</var> submenu. When the file -chooser sheet appears, press the <kbd>/</kbd> key and enter "/usr/lib". Scroll -down the file list and select the <var>libcups.dylib</var> file. Click the -<var>Add</var> button in the file chooser and attributes sheets.</p> - -<p>In the project window, double-click on the <var>main.c</var> source file. -Replace the template source code with the listing above and save it. Click the -<var>Build and Go</var> button to build the sample program and run it.</p> - -<h3><a name="COMMANDLINE">Compiling with GCC</a></h3> - -<p>From the command-line, create a file called <var>sample.c</var> using your -favorite editor and then run the following command to compile it with GCC and -run it:</p> - -<pre class="command"> -gcc -o simple `cups-config --cflags` simple.c `cups-config --libs` -./simple -</pre> - -<p>The <code>cups-config</code> command provides the compiler flags -("cups-config --cflags") and libraries ("cups-config --libs") needed for the -local system.</p> - -<h2 class="title"><a name="WHERETOGO">Where to Go Next</a></h2> - -<p>If you are developing a print filter, driver, or backend, see the -<a href="api-filter.html" target="_top">Filter and Backend Programming</a> -guide. Raster printer driver developers should also read the -<a href="api-raster.html" target="_top">Raster API</a> reference.</p> -</div> -</body> -</html> diff --git a/doc/help/api-ppd.html b/doc/help/api-ppd.html index 55fd0ac..7e60ec4 100644 --- a/doc/help/api-ppd.html +++ b/doc/help/api-ppd.html @@ -1,12 +1,15 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!doctype html> <html> <!-- SECTION: Programming --> -<head> - <title>PPD API (DEPRECATED) </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<style type="text/css"><!-- + <head> + <title>PPD API (DEPRECATED)</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="Mini-XML v2.11"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- BODY { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } @@ -349,9 +352,8 @@ div.contents ul.subcontents li { text-indent: -1em; } --></style> -</head> -<body> -<div class='body'> + </head> + <body> <!-- PPD API header for CUPS. @@ -388,110 +390,105 @@ div.contents ul.subcontents li { </tr> </tbody> </table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<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="#cupsGetPPD" title="Get the PPD file for a printer on the default server.">cupsGetPPD</a></li> - <li><a href="#cupsGetPPD2" title="Get the PPD file for a printer from the specified server.">cupsGetPPD2</a></li> - <li><a href="#cupsGetPPD3" title="Get the PPD file for a printer on the specified -server if it has changed.">cupsGetPPD3</a></li> - <li><a href="#cupsGetServerPPD" title="Get an available PPD file from the server.">cupsGetServerPPD</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="#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="#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="#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="#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 named 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> -</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_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> -</ul> + <div class="contents"> + <h2 class="title">Contents</h2> + <ul class="contents"> + <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="subcontents"> + <li><a href="#cupsGetConflicts">cupsGetConflicts</a></li> + <li><a href="#cupsGetPPD">cupsGetPPD</a></li> + <li><a href="#cupsGetPPD2">cupsGetPPD2</a></li> + <li><a href="#cupsGetPPD3">cupsGetPPD3</a></li> + <li><a href="#cupsGetServerPPD">cupsGetServerPPD</a></li> + <li><a href="#cupsMarkOptions">cupsMarkOptions</a></li> + <li><a href="#cupsResolveConflicts">cupsResolveConflicts</a></li> + <li><a href="#ppdCollect">ppdCollect</a></li> + <li><a href="#ppdCollect2">ppdCollect2</a></li> + <li><a href="#ppdConflicts">ppdConflicts</a></li> + <li><a href="#ppdEmit">ppdEmit</a></li> + <li><a href="#ppdEmitAfterOrder">ppdEmitAfterOrder</a></li> + <li><a href="#ppdEmitFd">ppdEmitFd</a></li> + <li><a href="#ppdEmitJCL">ppdEmitJCL</a></li> + <li><a href="#ppdEmitJCLEnd">ppdEmitJCLEnd</a></li> + <li><a href="#ppdEmitString">ppdEmitString</a></li> + <li><a href="#ppdFindAttr">ppdFindAttr</a></li> + <li><a href="#ppdFindChoice">ppdFindChoice</a></li> + <li><a href="#ppdFindCustomOption">ppdFindCustomOption</a></li> + <li><a href="#ppdFindCustomParam">ppdFindCustomParam</a></li> + <li><a href="#ppdFindMarkedChoice">ppdFindMarkedChoice</a></li> + <li><a href="#ppdFindNextAttr">ppdFindNextAttr</a></li> + <li><a href="#ppdFindOption">ppdFindOption</a></li> + <li><a href="#ppdFirstCustomParam">ppdFirstCustomParam</a></li> + <li><a href="#ppdFirstOption">ppdFirstOption</a></li> + <li><a href="#ppdInstallableConflict">ppdInstallableConflict</a></li> + <li><a href="#ppdIsMarked">ppdIsMarked</a></li> + <li><a href="#ppdLocalize">ppdLocalize</a></li> + <li><a href="#ppdLocalizeAttr">ppdLocalizeAttr</a></li> + <li><a href="#ppdLocalizeIPPReason">ppdLocalizeIPPReason</a></li> + <li><a href="#ppdLocalizeMarkerName">ppdLocalizeMarkerName</a></li> + <li><a href="#ppdMarkDefaults">ppdMarkDefaults</a></li> + <li><a href="#ppdMarkOption">ppdMarkOption</a></li> + <li><a href="#ppdNextCustomParam">ppdNextCustomParam</a></li> + <li><a href="#ppdNextOption">ppdNextOption</a></li> + <li><a href="#ppdPageLength">ppdPageLength</a></li> + <li><a href="#ppdPageSize">ppdPageSize</a></li> + <li><a href="#ppdPageSizeLimits">ppdPageSizeLimits</a></li> + <li><a href="#ppdPageWidth">ppdPageWidth</a></li> + </ul></li> + <li><a href="#TYPES">Data Types</a><ul class="subcontents"> + <li><a href="#ppd_attr_t">ppd_attr_t</a></li> + <li><a href="#ppd_choice_t">ppd_choice_t</a></li> + <li><a href="#ppd_conform_t">ppd_conform_t</a></li> + <li><a href="#ppd_const_t">ppd_const_t</a></li> + <li><a href="#ppd_coption_t">ppd_coption_t</a></li> + <li><a href="#ppd_cparam_t">ppd_cparam_t</a></li> + <li><a href="#ppd_cplimit_t">ppd_cplimit_t</a></li> + <li><a href="#ppd_cptype_t">ppd_cptype_t</a></li> + <li><a href="#ppd_cpvalue_t">ppd_cpvalue_t</a></li> + <li><a href="#ppd_cs_t">ppd_cs_t</a></li> + <li><a href="#ppd_emul_t">ppd_emul_t</a></li> + <li><a href="#ppd_file_t">ppd_file_t</a></li> + <li><a href="#ppd_group_t">ppd_group_t</a></li> + <li><a href="#ppd_option_t">ppd_option_t</a></li> + <li><a href="#ppd_profile_t">ppd_profile_t</a></li> + <li><a href="#ppd_section_t">ppd_section_t</a></li> + <li><a href="#ppd_size_t">ppd_size_t</a></li> + <li><a href="#ppd_status_t">ppd_status_t</a></li> + <li><a href="#ppd_ui_t">ppd_ui_t</a></li> + </ul></li> + <li><a href="#STRUCTURES">Structures</a><ul class="subcontents"> + <li><a href="#ppd_attr_s">ppd_attr_s</a></li> + <li><a href="#ppd_choice_s">ppd_choice_s</a></li> + <li><a href="#ppd_const_s">ppd_const_s</a></li> + <li><a href="#ppd_coption_s">ppd_coption_s</a></li> + <li><a href="#ppd_cparam_s">ppd_cparam_s</a></li> + <li><a href="#ppd_emul_s">ppd_emul_s</a></li> + <li><a href="#ppd_file_s">ppd_file_s</a></li> + <li><a href="#ppd_group_s">ppd_group_s</a></li> + <li><a href="#ppd_option_s">ppd_option_s</a></li> + <li><a href="#ppd_profile_s">ppd_profile_s</a></li> + <li><a href="#ppd_size_s">ppd_size_s</a></li> + </ul></li> + <li><a href="#UNIONS">Unions</a><ul class="subcontents"> + <li><a href="#ppd_cplimit_u">ppd_cplimit_u</a></li> + <li><a href="#ppd_cpvalue_u">ppd_cpvalue_u</a></li> + </ul></li> + <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> + <li><a href="#ppd_conform_e">ppd_conform_e</a></li> + <li><a href="#ppd_cs_e">ppd_cs_e</a></li> + <li><a href="#ppd_section_e">ppd_section_e</a></li> + <li><a href="#ppd_status_e">ppd_status_e</a></li> + <li><a href="#ppd_ui_e">ppd_ui_e</a></li> + </ul></li> + </ul> + </div> + <div class="body"> <!-- PPD API introduction for CUPS. @@ -709,31 +706,26 @@ for (attr = <a href="#ppdFindAttr">ppdFindAttr</a>(ppd, "Product", 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/macOS 10.6 </span><a name="cupsGetConflicts">cupsGetConflicts</a></h3> -<p class="description">Get a list of conflicting options in a marked PPD.</p> + <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="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> +int cupsGetConflicts(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *option, const char *choice, cups_option_t **options);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>option</th> + <td class="description">Option to test</td></tr> +<tr><th>choice</th> + <td class="description">Choice to test</td></tr> +<tr><th>options</th> + <td class="description">Conflicting options</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Number of conflicting options</p> + <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 + <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> @@ -743,44 +735,39 @@ the conflicting options. The returned option array must be freed using <a href="#cupsFreeOptions"><code>cupsFreeOptions</code></a>. </p> -<h3 class="function"><a name="cupsGetPPD">cupsGetPPD</a></h3> -<p class="description">Get the PPD file for a printer on the default server.</p> +<h3 class="function"><a id="cupsGetPPD">cupsGetPPD</a></h3> + <p class="description">Get the PPD file for a printer on the default server.</p> <p class="code"> -const char *cupsGetPPD (<br> - const char *name<br> -);</p> +const char *cupsGetPPD(const char *name);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>name</dt> -<dd class="description">Destination name</dd> -</dl> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Destination name</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Filename for PPD file</p> + <p class="description">Filename for PPD file</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">For classes, <code>cupsGetPPD</code> returns the PPD file for the first printer + <p class="discussion">For classes, <code>cupsGetPPD</code> returns the PPD file for the first printer in the class.<br> <br> The returned filename is stored in a static buffer and is overwritten with each call to <code>cupsGetPPD</code> or <a href="#cupsGetPPD2"><code>cupsGetPPD2</code></a>. The caller "owns" the file that is created and must <code>unlink</code> the returned filename.</p> -<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a name="cupsGetPPD2">cupsGetPPD2</a></h3> -<p class="description">Get the PPD file for a printer from the specified server.</p> +<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsGetPPD2">cupsGetPPD2</a></h3> + <p class="description">Get the PPD file for a printer from the specified server.</p> <p class="code"> -const char *cupsGetPPD2 (<br> - http_t *http,<br> - const char *name<br> -);</p> +const char *cupsGetPPD2(http_t *http, const char *name);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>name</dt> -<dd class="description">Destination name</dd> -</dl> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>name</th> + <td class="description">Destination name</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Filename for PPD file</p> + <p class="description">Filename for PPD file</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">For classes, <code>cupsGetPPD2</code> returns the PPD file for the first printer + <p class="discussion">For classes, <code>cupsGetPPD2</code> returns the PPD file for the first printer in the class.<br> <br> The returned filename is stored in a static buffer and is overwritten with @@ -788,34 +775,28 @@ each call to <a href="#cupsGetPPD"><code>cupsGetPPD</code></a> or <code>cupsGetP file that is created and must <code>unlink</code> the returned filename. </p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsGetPPD3">cupsGetPPD3</a></h3> -<p class="description">Get the PPD file for a printer on the specified +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsGetPPD3">cupsGetPPD3</a></h3> + <p class="description">Get the PPD file for a printer on the specified server if it has changed.</p> <p class="code"> -http_status_t cupsGetPPD3 (<br> - http_t *http,<br> - const char *name,<br> - time_t *modtime,<br> - char *buffer,<br> - size_t bufsize<br> -);</p> +http_status_t cupsGetPPD3(http_t *http, const char *name, time_t *modtime, char *buffer, size_t bufsize);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">HTTP connection or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>name</dt> -<dd class="description">Destination name</dd> -<dt>modtime</dt> -<dd class="description">Modification time</dd> -<dt>buffer</dt> -<dd class="description">Filename buffer</dd> -<dt>bufsize</dt> -<dd class="description">Size of filename buffer</dd> -</dl> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>name</th> + <td class="description">Destination name</td></tr> +<tr><th>modtime</th> + <td class="description">Modification time</td></tr> +<tr><th>buffer</th> + <td class="description">Filename buffer</td></tr> +<tr><th>bufsize</th> + <td class="description">Size of filename buffer</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">HTTP status</p> + <p class="description">HTTP status</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">The "modtime" parameter contains the modification time of any + <p class="discussion">The "modtime" parameter contains the modification time of any locally-cached content and is updated with the time from the PPD file on the server.<br> <br> @@ -832,24 +813,21 @@ For classes, <code>cupsGetPPD3</code> returns the PPD file for the first printer in the class. </p> -<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a name="cupsGetServerPPD">cupsGetServerPPD</a></h3> -<p class="description">Get an available PPD file from the server.</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsGetServerPPD">cupsGetServerPPD</a></h3> + <p class="description">Get an available PPD file from the server.</p> <p class="code"> -char *cupsGetServerPPD (<br> - http_t *http,<br> - const char *name<br> -);</p> +char *cupsGetServerPPD(http_t *http, const char *name);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>http</dt> -<dd class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></dd> -<dt>name</dt> -<dd class="description">Name of PPD file ("ppd-name")</dd> -</dl> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>name</th> + <td class="description">Name of PPD file ("ppd-name")</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Name of PPD file or <code>NULL</code> on error</p> + <p class="description">Name of PPD file or <code>NULL</code> on error</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function returns the named PPD file from the server. The + <p class="discussion">This function returns the named PPD file from the server. The list of available PPDs is provided by the IPP <code>CUPS_GET_PPDS</code> operation.<br> <br> @@ -859,57 +837,47 @@ overwritten on the next call to <a href="#cupsGetPPD"><code>cupsGetPPD</code></a or <a href="#cupsGetServerPPD"><code>cupsGetServerPPD</code></a>. </p> -<h3 class="function"><a name="cupsMarkOptions">cupsMarkOptions</a></h3> -<p class="description">Mark command-line options in a PPD file.</p> +<h3 class="function"><a id="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> +int cupsMarkOptions(<a href="#ppd_file_t">ppd_file_t</a> *ppd, int num_options, cups_option_t *options);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Options</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 if conflicts exist, 0 otherwise</p> + <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", + <p class="discussion">This function maps the IPP "finishings", "media", "mirror", "multiple-document-handling", "output-bin", "print-color-mode", "print-quality", "printer-resolution", and "sides" attributes to their corresponding PPD options and choices.</p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="cupsResolveConflicts">cupsResolveConflicts</a></h3> -<p class="description">Resolve conflicts in a marked PPD.</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="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> +int cupsResolveConflicts(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *option, const char *choice, int *num_options, cups_option_t **options);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>option</th> + <td class="description">Newly selected option or <code>NULL</code> for none</td></tr> +<tr><th>choice</th> + <td class="description">Newly selected choice or <code>NULL</code> for none</td></tr> +<tr><th>num_options</th> + <td class="description">Number of additional selected options</td></tr> +<tr><th>options</th> + <td class="description">Additional selected options</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> + <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 + <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 @@ -941,205 +909,167 @@ 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="ppdCollect">ppdCollect</a></h3> -<p class="description">Collect all marked options that reside in the specified +<h3 class="function"><a id="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> +int ppdCollect(<a href="#ppd_file_t">ppd_file_t</a> *ppd, <a href="#ppd_section_t">ppd_section_t</a> section, <a href="#ppd_choice_t">ppd_choice_t</a> ***choices);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file data</td></tr> +<tr><th>section</th> + <td class="description">Section to collect</td></tr> +<tr><th>choices</th> + <td class="description">Pointers to choices</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Number of options marked</p> + <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 + <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/macOS 10.5 </span><a name="ppdCollect2">ppdCollect2</a></h3> -<p class="description">Collect all marked options that reside in the +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +int ppdCollect2(<a href="#ppd_file_t">ppd_file_t</a> *ppd, <a href="#ppd_section_t">ppd_section_t</a> section, float min_order, <a href="#ppd_choice_t">ppd_choice_t</a> ***choices);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file data</td></tr> +<tr><th>section</th> + <td class="description">Section to collect</td></tr> +<tr><th>min_order</th> + <td class="description">Minimum OrderDependency value</td></tr> +<tr><th>choices</th> + <td class="description">Pointers to choices</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Number of options marked</p> + <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 + <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 +<h3 class="function"><a id="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> +int ppdConflicts(<a href="#ppd_file_t">ppd_file_t</a> *ppd);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>ppd</dt> -<dd class="description">PPD to check</dd> -</dl> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD to check</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Number of conflicts found</p> + <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="discussion">The returned value is the same as returned by <a href="#ppdMarkOption"><code>ppdMarkOption</code></a>.</p> +<h3 class="function"><a id="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> +int ppdEmit(<a href="#ppd_file_t">ppd_file_t</a> *ppd, FILE *fp, <a href="#ppd_section_t">ppd_section_t</a> section);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>fp</th> + <td class="description">File to write to</td></tr> +<tr><th>section</th> + <td class="description">Section to write</td></tr> +</tbody></table> <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/macOS 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="description">0 on success, -1 on failure</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +int ppdEmitAfterOrder(<a href="#ppd_file_t">ppd_file_t</a> *ppd, FILE *fp, <a href="#ppd_section_t">ppd_section_t</a> section, int limit, float min_order);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>fp</th> + <td class="description">File to write to</td></tr> +<tr><th>section</th> + <td class="description">Section to write</td></tr> +<tr><th>limit</th> + <td class="description">Non-zero to use min_order</td></tr> +<tr><th>min_order</th> + <td class="description">Lowest OrderDependency</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on failure</p> + <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 + <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> +<h3 class="function"><a id="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> +int ppdEmitFd(<a href="#ppd_file_t">ppd_file_t</a> *ppd, int fd, <a href="#ppd_section_t">ppd_section_t</a> section);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>fd</th> + <td class="description">File to write to</td></tr> +<tr><th>section</th> + <td class="description">Section to write</td></tr> +</tbody></table> <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="description">0 on success, -1 on failure</p> +<h3 class="function"><a id="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> +int ppdEmitJCL(<a href="#ppd_file_t">ppd_file_t</a> *ppd, FILE *fp, int job_id, const char *user, const char *title);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>fp</th> + <td class="description">File to write to</td></tr> +<tr><th>job_id</th> + <td class="description">Job ID</td></tr> +<tr><th>user</th> + <td class="description">Username</td></tr> +<tr><th>title</th> + <td class="description">Title</td></tr> +</tbody></table> <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/macOS 10.5 </span><a name="ppdEmitJCLEnd">ppdEmitJCLEnd</a></h3> -<p class="description">Emit JCLEnd code to a file.</p> + <p class="description">0 on success, -1 on failure</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +int ppdEmitJCLEnd(<a href="#ppd_file_t">ppd_file_t</a> *ppd, FILE *fp);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>fp</th> + <td class="description">File to write to</td></tr> +</tbody></table> <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/macOS 10.5 </span><a name="ppdEmitString">ppdEmitString</a></h3> -<p class="description">Get a string containing the code for marked options.</p> + <p class="description">0 on success, -1 on failure</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +char *ppdEmitString(<a href="#ppd_file_t">ppd_file_t</a> *ppd, <a href="#ppd_section_t">ppd_section_t</a> section, float min_order);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>section</th> + <td class="description">Section to write</td></tr> +<tr><th>min_order</th> + <td class="description">Lowest OrderDependency</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">String containing option code or <code>NULL</code> if there is no option code</p> + <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 + <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> @@ -1148,268 +1078,221 @@ 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/macOS 10.3 </span><a name="ppdFindAttr">ppdFindAttr</a></h3> -<p class="description">Find the first matching attribute.</p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="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> +<a href="#ppd_attr_t">ppd_attr_t</a> *ppdFindAttr(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *name, const char *spec);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file data</td></tr> +<tr><th>name</th> + <td class="description">Attribute name</td></tr> +<tr><th>spec</th> + <td class="description">Specifier string or <code>NULL</code></td></tr> +</tbody></table> <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="description">Attribute or <code>NULL</code> if not found</p> +<h3 class="function"><a id="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> +<a href="#ppd_choice_t">ppd_choice_t</a> *ppdFindChoice(<a href="#ppd_option_t">ppd_option_t</a> *o, const char *choice);</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> +<table class="list"><tbody> +<tr><th>o</th> + <td class="description">Pointer to option</td></tr> +<tr><th>choice</th> + <td class="description">Name of choice</td></tr> +</tbody></table> <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/macOS 10.5 </span><a name="ppdFindCustomOption">ppdFindCustomOption</a></h3> -<p class="description">Find a custom option.</p> + <p class="description">Choice pointer or <code>NULL</code></p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +<a href="#ppd_coption_t">ppd_coption_t</a> *ppdFindCustomOption(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *keyword);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>keyword</th> + <td class="description">Custom option name</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Custom option or NULL</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ppdFindCustomParam">ppdFindCustomParam</a></h3> -<p class="description">Find a parameter for a custom option.</p> + <p class="description">Custom option or NULL</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +<a href="#ppd_cparam_t">ppd_cparam_t</a> *ppdFindCustomParam(<a href="#ppd_coption_t">ppd_coption_t</a> *opt, const char *name);</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> +<table class="list"><tbody> +<tr><th>opt</th> + <td class="description">Custom option</td></tr> +<tr><th>name</th> + <td class="description">Parameter name</td></tr> +</tbody></table> <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="description">Custom parameter or NULL</p> +<h3 class="function"><a id="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> +<a href="#ppd_choice_t">ppd_choice_t</a> *ppdFindMarkedChoice(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *option);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>option</th> + <td class="description">Keyword/option name</td></tr> +</tbody></table> <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/macOS 10.3 </span><a name="ppdFindNextAttr">ppdFindNextAttr</a></h3> -<p class="description">Find the next matching attribute.</p> + <p class="description">Pointer to choice or <code>NULL</code></p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="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> +<a href="#ppd_attr_t">ppd_attr_t</a> *ppdFindNextAttr(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *name, const char *spec);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file data</td></tr> +<tr><th>name</th> + <td class="description">Attribute name</td></tr> +<tr><th>spec</th> + <td class="description">Specifier string or <code>NULL</code></td></tr> +</tbody></table> <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="description">Attribute or <code>NULL</code> if not found</p> +<h3 class="function"><a id="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> +<a href="#ppd_option_t">ppd_option_t</a> *ppdFindOption(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *option);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file data</td></tr> +<tr><th>option</th> + <td class="description">Option/Keyword name</td></tr> +</tbody></table> <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/macOS 10.5 </span><a name="ppdFirstCustomParam">ppdFirstCustomParam</a></h3> -<p class="description">Return the first parameter for a custom option.</p> + <p class="description">Pointer to option or <code>NULL</code></p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +<a href="#ppd_cparam_t">ppd_cparam_t</a> *ppdFirstCustomParam(<a href="#ppd_coption_t">ppd_coption_t</a> *opt);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>opt</dt> -<dd class="description">Custom option</dd> -</dl> +<table class="list"><tbody> +<tr><th>opt</th> + <td class="description">Custom option</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Custom parameter or NULL</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ppdFirstOption">ppdFirstOption</a></h3> -<p class="description">Return the first option in the PPD file.</p> + <p class="description">Custom parameter or NULL</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +<a href="#ppd_option_t">ppd_option_t</a> *ppdFirstOption(<a href="#ppd_file_t">ppd_file_t</a> *ppd);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>ppd</dt> -<dd class="description">PPD file</dd> -</dl> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">First option or <code>NULL</code></p> + <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 class="discussion">Options are returned from all groups in ascending alphanumeric order. </p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="ppdInstallableConflict">ppdInstallableConflict</a></h3> -<p class="description">Test whether an option choice conflicts with +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="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> +int ppdInstallableConflict(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *option, const char *choice);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>option</th> + <td class="description">Option</td></tr> +<tr><th>choice</th> + <td class="description">Choice</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 if conflicting, 0 if not conflicting</p> + <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 + <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> +<h3 class="function"><a id="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> +int ppdIsMarked(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *option, const char *choice);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file data</td></tr> +<tr><th>option</th> + <td class="description">Option/Keyword name</td></tr> +<tr><th>choice</th> + <td class="description">Choice name</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Non-zero if option is marked</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ppdLocalize">ppdLocalize</a></h3> -<p class="description">Localize the PPD file to the current locale.</p> + <p class="description">Non-zero if option is marked</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +int ppdLocalize(<a href="#ppd_file_t">ppd_file_t</a> *ppd);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>ppd</dt> -<dd class="description">PPD file</dd> -</dl> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on error</p> + <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 + <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> +<h3 class="function"><a id="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> +<a href="#ppd_attr_t">ppd_attr_t</a> *ppdLocalizeAttr(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *keyword, const char *spec);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>keyword</th> + <td class="description">Main keyword</td></tr> +<tr><th>spec</th> + <td class="description">Option keyword or <code>NULL</code> for none</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Localized attribute or <code>NULL</code> if none exists</p> + <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 + <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/macOS 10.5 </span><a name="ppdLocalizeIPPReason">ppdLocalizeIPPReason</a></h3> -<p class="description">Get the localized version of a cupsIPPReason +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="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> +const char *ppdLocalizeIPPReason(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *reason, const char *scheme, char *buffer, size_t bufsize);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>reason</th> + <td class="description">IPP reason keyword to look up</td></tr> +<tr><th>scheme</th> + <td class="description">URI scheme or NULL for text</td></tr> +<tr><th>buffer</th> + <td class="description">Value buffer</td></tr> +<tr><th>bufsize</th> + <td class="description">Size of value buffer</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Value or NULL if not found</p> + <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 + <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> @@ -1417,798 +1300,731 @@ string or attribute value. Otherwise the corresponding URI is returned.<br> If no value of the requested scheme can be found, NULL is returned. </p> -<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a name="ppdLocalizeMarkerName">ppdLocalizeMarkerName</a></h3> -<p class="description">Get the localized version of a marker-names +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="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> +const char *ppdLocalizeMarkerName(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *name);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>name</th> + <td class="description">Marker name to look up</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Value or <code>NULL</code> if not found</p> + <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 + <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> +<h3 class="function"><a id="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> +void ppdMarkDefaults(<a href="#ppd_file_t">ppd_file_t</a> *ppd);</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 +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +</tbody></table> +<h3 class="function"><a id="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> +int ppdMarkOption(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *option, const char *choice);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>option</th> + <td class="description">Keyword</td></tr> +<tr><th>choice</th> + <td class="description">Option name</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Number of conflicts</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ppdNextCustomParam">ppdNextCustomParam</a></h3> -<p class="description">Return the next parameter for a custom option.</p> + <p class="description">Number of conflicts</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +<a href="#ppd_cparam_t">ppd_cparam_t</a> *ppdNextCustomParam(<a href="#ppd_coption_t">ppd_coption_t</a> *opt);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>opt</dt> -<dd class="description">Custom option</dd> -</dl> +<table class="list"><tbody> +<tr><th>opt</th> + <td class="description">Custom option</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Custom parameter or NULL</p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ppdNextOption">ppdNextOption</a></h3> -<p class="description">Return the next option in the PPD file.</p> + <p class="description">Custom parameter or NULL</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +<a href="#ppd_option_t">ppd_option_t</a> *ppdNextOption(<a href="#ppd_file_t">ppd_file_t</a> *ppd);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>ppd</dt> -<dd class="description">PPD file</dd> -</dl> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Next option or <code>NULL</code></p> + <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 class="discussion">Options are returned from all groups in ascending alphanumeric order. </p> -<h3 class="function"><a name="ppdPageLength">ppdPageLength</a></h3> -<p class="description">Get the page length for the given size.</p> +<h3 class="function"><a id="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> +float ppdPageLength(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *name);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>name</th> + <td class="description">Size name</td></tr> +</tbody></table> <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 named size.</p> + <p class="description">Length of page in points or 0.0</p> +<h3 class="function"><a id="ppdPageSize">ppdPageSize</a></h3> + <p class="description">Get the page size record for the named 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> +<a href="#ppd_size_t">ppd_size_t</a> *ppdPageSize(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *name);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>name</th> + <td class="description">Size name</td></tr> +</tbody></table> <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/macOS 10.6 </span><a name="ppdPageSizeLimits">ppdPageSizeLimits</a></h3> -<p class="description">Return the custom page size limits.</p> + <p class="description">Size record for page or NULL</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="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> +int ppdPageSizeLimits(<a href="#ppd_file_t">ppd_file_t</a> *ppd, <a href="#ppd_size_t">ppd_size_t</a> *minimum, <a href="#ppd_size_t">ppd_size_t</a> *maximum);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>minimum</th> + <td class="description">Minimum custom size</td></tr> +<tr><th>maximum</th> + <td class="description">Maximum custom size</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 if custom sizes are supported, 0 otherwise</p> + <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 + <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> +<h3 class="function"><a id="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> +float ppdPageWidth(<a href="#ppd_file_t">ppd_file_t</a> *ppd, const char *name);</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> +<table class="list"><tbody> +<tr><th>ppd</th> + <td class="description">PPD file record</td></tr> +<tr><th>name</th> + <td class="description">Size name</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Width of page in points or 0.0</p> -<h2 class="title"><a name="TYPES">Data Types</a></h2> -<h3 class="typedef"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a name="ppd_attr_t">ppd_attr_t</a></h3> -<p class="description">PPD Attribute Structure </p> -<p class="code"> + <p class="description">Width of page in points or 0.0</p> + <h2 class="title"><a id="TYPES">Data Types</a></h2> + <h3 class="typedef"><a id="ppd_attr_t"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>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"> + <h3 class="typedef"><a id="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/macOS 10.3 </span><a name="ppd_conform_t">ppd_conform_t</a></h3> -<p class="description">Conformance Levels </p> -<p class="code"> + <h3 class="typedef"><a id="ppd_conform_t"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>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"> + <h3 class="typedef"><a id="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/macOS 10.5 </span><a name="ppd_coption_t">ppd_coption_t</a></h3> -<p class="description">Custom Option </p> -<p class="code"> + <h3 class="typedef"><a id="ppd_coption_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>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/macOS 10.5 </span><a name="ppd_cparam_t">ppd_cparam_t</a></h3> -<p class="description">Custom Parameter </p> -<p class="code"> + <h3 class="typedef"><a id="ppd_cparam_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>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/macOS 10.5 </span><a name="ppd_cplimit_t">ppd_cplimit_t</a></h3> -<p class="description">Custom Parameter Limit </p> -<p class="code"> + <h3 class="typedef"><a id="ppd_cplimit_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>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/macOS 10.5 </span><a name="ppd_cptype_t">ppd_cptype_t</a></h3> -<p class="description">Custom Parameter Type </p> -<p class="code"> + <h3 class="typedef"><a id="ppd_cptype_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ppd_cptype_t</a></h3> + <p class="description">Custom Parameter Type </p> + <p class="code"> typedef enum ppd_cptype_e ppd_cptype_t; </p> -<h3 class="typedef"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="ppd_cpvalue_t">ppd_cpvalue_t</a></h3> -<p class="description">Custom Parameter Value </p> -<p class="code"> + <h3 class="typedef"><a id="ppd_cpvalue_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>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"> + <h3 class="typedef"><a id="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"> + <h3 class="typedef"><a id="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"> + <h3 class="typedef"><a id="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"> + <h3 class="typedef"><a id="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"> + <h3 class="typedef"><a id="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"> + <h3 class="typedef"><a id="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"> + <h3 class="typedef"><a id="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"> + <h3 class="typedef"><a id="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/macOS 10.3 </span><a name="ppd_status_t">ppd_status_t</a></h3> -<p class="description">Status Codes </p> -<p class="code"> + <h3 class="typedef"><a id="ppd_status_t"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>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"> + <h3 class="typedef"><a id="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/macOS 10.3 </span><a name="ppd_attr_s">ppd_attr_s</a></h3> -<p class="description">PPD Attribute Structure </p> + <h2 class="title"><a id="STRUCTURES">Structures</a></h2> +<h3 class="struct"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="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> +    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> +<table class="list"><tbody> +<tr><th>name[PPD_MAX_NAME] </th> + <td class="description">Name of attribute (cupsXYZ)</td></tr> +<tr><th>spec[PPD_MAX_NAME] </th> + <td class="description">Specifier string, if any</td></tr> +<tr><th>text[PPD_MAX_TEXT] </th> + <td class="description">Human-readable text, if any</td></tr> +<tr><th>value </th> + <td class="description">Value string</td></tr> +</tbody></table> +<h3 class="struct"><a id="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> +    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> +<table class="list"><tbody> +<tr><th>choice[PPD_MAX_NAME] </th> + <td class="description">Computer-readable option name</td></tr> +<tr><th>code </th> + <td class="description">Code to send for this option</td></tr> +<tr><th>marked </th> + <td class="description">0 if not selected, 1 otherwise</td></tr> +<tr><th>option </th> + <td class="description">Pointer to parent option structure</td></tr> +<tr><th>text[PPD_MAX_TEXT] </th> + <td class="description">Human-readable option name</td></tr> +</tbody></table> +<h3 class="struct"><a id="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> +    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/macOS 10.5 </span><a name="ppd_coption_s">ppd_coption_s</a></h3> -<p class="description">Custom Option </p> +<table class="list"><tbody> +<tr><th>choice1[PPD_MAX_NAME] </th> + <td class="description">First option/choice (blank for all)</td></tr> +<tr><th>choice2[PPD_MAX_NAME] </th> + <td class="description">Second option/choice (blank for all)</td></tr> +<tr><th>option1[PPD_MAX_NAME] </th> + <td class="description">First keyword</td></tr> +<tr><th>option2[PPD_MAX_NAME] </th> + <td class="description">Second keyword</td></tr> +</tbody></table> +<h3 class="struct"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +    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/macOS 10.5 </span><a name="ppd_cparam_s">ppd_cparam_s</a></h3> -<p class="description">Custom Parameter </p> +<table class="list"><tbody> +<tr><th>keyword[PPD_MAX_NAME] </th> + <td class="description">Name of option that is being extended...</td></tr> +<tr><th>marked </th> + <td class="description">Extended option is marked</td></tr> +<tr><th>option </th> + <td class="description">Option that is being extended...</td></tr> +<tr><th>params </th> + <td class="description">Parameters</td></tr> +</tbody></table> +<h3 class="struct"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +    <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> +<table class="list"><tbody> +<tr><th>current </th> + <td class="description">Current value</td></tr> +<tr><th>maximum </th> + <td class="description">Maximum value</td></tr> +<tr><th>name[PPD_MAX_NAME] </th> + <td class="description">Parameter name</td></tr> +<tr><th>order </th> + <td class="description">Order (0 to N)</td></tr> +<tr><th>text[PPD_MAX_TEXT] </th> + <td class="description">Human-readable text</td></tr> +<tr><th>type </th> + <td class="description">Parameter type</td></tr> +</tbody></table> +<h3 class="struct"><a id="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> +    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> +<table class="list"><tbody> +<tr><th>name[PPD_MAX_NAME] </th> + <td class="description">Emulator name</td></tr> +<tr><th>start </th> + <td class="description">Code to switch to this emulation</td></tr> +<tr><th>stop </th> + <td class="description">Code to stop this emulation</td></tr> +</tbody></table> +<h3 class="struct"><a id="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> - char *shortnickname;<br> - <a href="#ppd_size_t">ppd_size_t</a> *sizes;<br> - int throughput;<br> - char *ttrasterizer;<br> - int variable_sizes;<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> +    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/macOS 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/macOS 10.3 </span></dt> -<dd class="description">Protocols (BCP, TBCP) string </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> +<table class="list"><tbody> +<tr><th>accurate_screens </th> + <td class="description">1 = supports accurate screens, 0 = not</td></tr> +<tr><th>color_device </th> + <td class="description">1 = color device, 0 = grayscale</td></tr> +<tr><th>colorspace </th> + <td class="description">Default colorspace</td></tr> +<tr><th>consts </th> + <td class="description">UI/Non-UI constraints</td></tr> +<tr><th>contone_only </th> + <td class="description">1 = continuous tone only, 0 = not</td></tr> +<tr><th>custom_margins[4] </th> + <td class="description">Margins around page</td></tr> +<tr><th>custom_max[2] </th> + <td class="description">Maximum variable page size</td></tr> +<tr><th>custom_min[2] </th> + <td class="description">Minimum variable page size</td></tr> +<tr><th>emulations </th> + <td class="description">Emulations and the code to invoke them</td></tr> +<tr><th>filters </th> + <td class="description">Filter strings...</td></tr> +<tr><th>flip_duplex <span class="info"> DEPRECATED </span></th> + <td class="description">1 = Flip page for back sides </td></tr> +<tr><th>fonts </th> + <td class="description">Pre-loaded fonts</td></tr> +<tr><th>groups </th> + <td class="description">UI groups</td></tr> +<tr><th>jcl_begin </th> + <td class="description">Start JCL commands</td></tr> +<tr><th>jcl_end </th> + <td class="description">End JCL commands</td></tr> +<tr><th>jcl_ps </th> + <td class="description">Enter PostScript interpreter</td></tr> +<tr><th>landscape </th> + <td class="description">-90 or 90</td></tr> +<tr><th>lang_encoding </th> + <td class="description">Language encoding</td></tr> +<tr><th>lang_version </th> + <td class="description">Language version (English, Spanish, etc.)</td></tr> +<tr><th>language_level </th> + <td class="description">Language level of device</td></tr> +<tr><th>manual_copies </th> + <td class="description">1 = Copies done manually, 0 = hardware</td></tr> +<tr><th>manufacturer </th> + <td class="description">Manufacturer name</td></tr> +<tr><th>model_number </th> + <td class="description">Device-specific model number</td></tr> +<tr><th>modelname </th> + <td class="description">Model name (general)</td></tr> +<tr><th>nickname </th> + <td class="description">Nickname (specific)</td></tr> +<tr><th>num_consts </th> + <td class="description">Number of UI/Non-UI constraints</td></tr> +<tr><th>num_emulations </th> + <td class="description">Number of emulations supported</td></tr> +<tr><th>num_filters </th> + <td class="description">Number of filters</td></tr> +<tr><th>num_fonts </th> + <td class="description">Number of pre-loaded fonts</td></tr> +<tr><th>num_groups </th> + <td class="description">Number of UI groups</td></tr> +<tr><th>num_profiles <span class="info"> DEPRECATED </span></th> + <td class="description">Number of sRGB color profiles </td></tr> +<tr><th>num_sizes </th> + <td class="description">Number of page sizes</td></tr> +<tr><th>patches </th> + <td class="description">Patch commands to be sent to printer</td></tr> +<tr><th>pcfilename <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> + <td class="description">PCFileName string </td></tr> +<tr><th>product </th> + <td class="description">Product name (from PS RIP/interpreter)</td></tr> +<tr><th>profiles <span class="info"> DEPRECATED </span></th> + <td class="description">sRGB color profiles </td></tr> +<tr><th>protocols <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> + <td class="description">Protocols (BCP, TBCP) string </td></tr> +<tr><th>shortnickname </th> + <td class="description">Short version of nickname</td></tr> +<tr><th>sizes </th> + <td class="description">Page sizes</td></tr> +<tr><th>throughput </th> + <td class="description">Pages per minute</td></tr> +<tr><th>ttrasterizer </th> + <td class="description">Truetype rasterizer</td></tr> +<tr><th>variable_sizes </th> + <td class="description">1 = supports variable sizes, 0 = doesn't</td></tr> +</tbody></table> +<h3 class="struct"><a id="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> +    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/macOS 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> +<table class="list"><tbody> +<tr><th>PPD_MAX_NAME] </th> + <td class="description">Human-readable group name</td></tr> +<tr><th>name[PPD_MAX_NAME] <span class="info"> CUPS 1.1.18/macOS 10.3 </span></th> + <td class="description">Group name </td></tr> +<tr><th>num_options </th> + <td class="description">Number of options</td></tr> +<tr><th>num_subgroups </th> + <td class="description">Number of sub-groups</td></tr> +<tr><th>options </th> + <td class="description">Options</td></tr> +<tr><th>subgroups </th> + <td class="description">Sub-groups (max depth = 1)</td></tr> +</tbody></table> +<h3 class="struct"><a id="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> +    <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> +<table class="list"><tbody> +<tr><th>choices </th> + <td class="description">Option choices</td></tr> +<tr><th>conflicted </th> + <td class="description">0 if no conflicts exist, 1 otherwise</td></tr> +<tr><th>defchoice[PPD_MAX_NAME] </th> + <td class="description">Default option choice</td></tr> +<tr><th>keyword[PPD_MAX_NAME] </th> + <td class="description">Option keyword name ("PageSize", etc.)</td></tr> +<tr><th>num_choices </th> + <td class="description">Number of option choices</td></tr> +<tr><th>order </th> + <td class="description">Order number</td></tr> +<tr><th>section </th> + <td class="description">Section for command</td></tr> +<tr><th>text[PPD_MAX_TEXT] </th> + <td class="description">Human-readable text</td></tr> +<tr><th>ui </th> + <td class="description">Type of UI option</td></tr> +</tbody></table> +<h3 class="struct"><a id="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> +    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> +<table class="list"><tbody> +<tr><th>density </th> + <td class="description">Ink density to use</td></tr> +<tr><th>gamma </th> + <td class="description">Gamma correction to use</td></tr> +<tr><th>matrix[3][3] </th> + <td class="description">Transform matrix</td></tr> +<tr><th>media_type[PPD_MAX_NAME] </th> + <td class="description">Media type or "-"</td></tr> +<tr><th>resolution[PPD_MAX_NAME] </th> + <td class="description">Resolution or "-"</td></tr> +</tbody></table> +<h3 class="struct"><a id="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> +    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/macOS 10.5 </span><a name="ppd_cplimit_u">ppd_cplimit_u</a></h3> -<p class="description">Custom Parameter Limit </p> +<table class="list"><tbody> +<tr><th>bottom </th> + <td class="description">Bottom printable margin in points</td></tr> +<tr><th>left </th> + <td class="description">Left printable margin in points</td></tr> +<tr><th>length </th> + <td class="description">Length of media in points</td></tr> +<tr><th>marked </th> + <td class="description">Page size selected?</td></tr> +<tr><th>name[PPD_MAX_NAME] </th> + <td class="description">Media size option</td></tr> +<tr><th>right </th> + <td class="description">Right printable margin in points</td></tr> +<tr><th>top </th> + <td class="description">Top printable margin in points</td></tr> +<tr><th>width </th> + <td class="description">Width of media in points</td></tr> +</tbody></table> + <h2 class="title"><a id="UNIONS">Unions</a></h2> +<h3 class="union"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +    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/macOS 10.5 </span><a name="ppd_cpvalue_u">ppd_cpvalue_u</a></h3> -<p class="description">Custom Parameter Value </p> +<table class="list"><tbody> +<tr><th>custom_curve </th> + <td class="description">Gamma value</td></tr> +<tr><th>custom_int </th> + <td class="description">Integer value</td></tr> +<tr><th>custom_invcurve </th> + <td class="description">Gamma value</td></tr> +<tr><th>custom_passcode </th> + <td class="description">Passcode length</td></tr> +<tr><th>custom_password </th> + <td class="description">Password length</td></tr> +<tr><th>custom_points </th> + <td class="description">Measurement value</td></tr> +<tr><th>custom_real </th> + <td class="description">Real value</td></tr> +<tr><th>custom_string </th> + <td class="description">String length</td></tr> +</tbody></table> +<h3 class="union"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="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> +    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/macOS 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"><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/macOS 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_CLOSE_GROUP </dt> -<dd class="description">Missing CloseGroup</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> +<table class="list"><tbody> +<tr><th>custom_curve </th> + <td class="description">Gamma value</td></tr> +<tr><th>custom_int </th> + <td class="description">Integer value</td></tr> +<tr><th>custom_invcurve </th> + <td class="description">Gamma value</td></tr> +<tr><th>custom_passcode </th> + <td class="description">Passcode value</td></tr> +<tr><th>custom_password </th> + <td class="description">Password value</td></tr> +<tr><th>custom_points </th> + <td class="description">Measurement value</td></tr> +<tr><th>custom_real </th> + <td class="description">Real value</td></tr> +<tr><th>custom_string </th> + <td class="description">String value</td></tr> +</tbody></table> + <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> + <h3 class="enumeration"><a id="ppd_conform_e"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>ppd_conform_e</a></h3> + <p class="description">Conformance Levels </p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>PPD_CONFORM_RELAXED </th> <td class="description">Relax whitespace and control char</td></tr> + <tr><th>PPD_CONFORM_STRICT </th> <td class="description">Require strict conformance</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ppd_cs_e">ppd_cs_e</a></h3> + <p class="description">Colorspaces</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>PPD_CS_CMY </th> <td class="description">CMY colorspace</td></tr> + <tr><th>PPD_CS_CMYK </th> <td class="description">CMYK colorspace</td></tr> + <tr><th>PPD_CS_GRAY </th> <td class="description">Grayscale colorspace</td></tr> + <tr><th>PPD_CS_N </th> <td class="description">DeviceN colorspace</td></tr> + <tr><th>PPD_CS_RGB </th> <td class="description">RGB colorspace</td></tr> + <tr><th>PPD_CS_RGBK </th> <td class="description">RGBK (K = gray) colorspace</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ppd_section_e">ppd_section_e</a></h3> + <p class="description">Order dependency sections</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>PPD_ORDER_ANY </th> <td class="description">Option code can be anywhere in the file</td></tr> + <tr><th>PPD_ORDER_DOCUMENT </th> <td class="description">... must be in the DocumentSetup section</td></tr> + <tr><th>PPD_ORDER_EXIT </th> <td class="description">... must be sent prior to the document</td></tr> + <tr><th>PPD_ORDER_JCL </th> <td class="description">... must be sent as a JCL command</td></tr> + <tr><th>PPD_ORDER_PAGE </th> <td class="description">... must be in the PageSetup section</td></tr> + <tr><th>PPD_ORDER_PROLOG </th> <td class="description">... must be in the Prolog section</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ppd_status_e"><span class="info"> CUPS 1.1.19/macOS 10.3 </span>ppd_status_e</a></h3> + <p class="description">Status Codes </p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>PPD_ALLOC_ERROR </th> <td class="description">Memory allocation error</td></tr> + <tr><th>PPD_BAD_CUSTOM_PARAM </th> <td class="description">Bad custom parameter</td></tr> + <tr><th>PPD_BAD_OPEN_GROUP </th> <td class="description">Bad OpenGroup</td></tr> + <tr><th>PPD_BAD_OPEN_UI </th> <td class="description">Bad OpenUI/JCLOpenUI</td></tr> + <tr><th>PPD_BAD_ORDER_DEPENDENCY </th> <td class="description">Bad OrderDependency</td></tr> + <tr><th>PPD_BAD_UI_CONSTRAINTS </th> <td class="description">Bad UIConstraints</td></tr> + <tr><th>PPD_BAD_VALUE </th> <td class="description">Bad value string</td></tr> + <tr><th>PPD_FILE_OPEN_ERROR </th> <td class="description">Unable to open PPD file</td></tr> + <tr><th>PPD_ILLEGAL_CHARACTER </th> <td class="description">Illegal control character</td></tr> + <tr><th>PPD_ILLEGAL_MAIN_KEYWORD </th> <td class="description">Illegal main keyword string</td></tr> + <tr><th>PPD_ILLEGAL_OPTION_KEYWORD </th> <td class="description">Illegal option keyword string</td></tr> + <tr><th>PPD_ILLEGAL_TRANSLATION </th> <td class="description">Illegal translation string</td></tr> + <tr><th>PPD_ILLEGAL_WHITESPACE </th> <td class="description">Illegal whitespace character</td></tr> + <tr><th>PPD_INTERNAL_ERROR </th> <td class="description">Internal error</td></tr> + <tr><th>PPD_LINE_TOO_LONG </th> <td class="description">Line longer than 255 chars</td></tr> + <tr><th>PPD_MISSING_ASTERISK </th> <td class="description">Missing asterisk in column 0</td></tr> + <tr><th>PPD_MISSING_CLOSE_GROUP </th> <td class="description">Missing CloseGroup</td></tr> + <tr><th>PPD_MISSING_OPTION_KEYWORD </th> <td class="description">Missing option keyword</td></tr> + <tr><th>PPD_MISSING_PPDADOBE4 </th> <td class="description">Missing PPD-Adobe-4.x header</td></tr> + <tr><th>PPD_MISSING_VALUE </th> <td class="description">Missing value string</td></tr> + <tr><th>PPD_NESTED_OPEN_GROUP </th> <td class="description">OpenGroup without a CloseGroup first</td></tr> + <tr><th>PPD_NESTED_OPEN_UI </th> <td class="description">OpenUI/JCLOpenUI without a CloseUI/JCLCloseUI first</td></tr> + <tr><th>PPD_NULL_FILE </th> <td class="description">NULL PPD file pointer</td></tr> + <tr><th>PPD_OK </th> <td class="description">OK</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ppd_ui_e">ppd_ui_e</a></h3> + <p class="description">UI Types</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>PPD_UI_BOOLEAN </th> <td class="description">True or False option</td></tr> + <tr><th>PPD_UI_PICKMANY </th> <td class="description">Pick zero or more from a list</td></tr> + <tr><th>PPD_UI_PICKONE </th> <td class="description">Pick one from a list</td></tr> +</tbody></table> + </div> + </body> </html> diff --git a/doc/help/api-raster.html b/doc/help/api-raster.html index 00617be..39b91da 100644 --- a/doc/help/api-raster.html +++ b/doc/help/api-raster.html @@ -1,12 +1,15 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!doctype html> <html> <!-- SECTION: Programming --> -<head> - <title>Raster API </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<style type="text/css"><!-- + <head> + <title>Raster API</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="Mini-XML v2.11"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- BODY { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } @@ -349,9 +352,8 @@ div.contents ul.subcontents li { text-indent: -1em; } --></style> -</head> -<body> -<div class='body'> + </head> + <body> <!-- Raster API documentation for CUPS. @@ -387,63 +389,62 @@ div.contents ul.subcontents li { </tr> </tbody> </table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#OVERVIEW">Overview</a></li> -<li><a href="#TASKS">Functions by Task</a><ul class="subcontents"> - <li><a href="#OPENCLOSE">Opening and Closing Raster Streams</a></li> - <li><a href="#READING">Reading Raster Streams</a></li> - <li><a href="#WRITING">Writing Raster Streams</a></li> -</ul></li> -<li><a href="#FUNCTIONS">Functions</a><ul class="code"> - <li><a href="#cupsRasterClose" title="Close a raster stream.">cupsRasterClose</a></li> - <li><a href="#cupsRasterInitPWGHeader" title="Initialize a page header for PWG Raster output.">cupsRasterInitPWGHeader</a></li> - <li><a href="#cupsRasterInterpretPPD" title="Interpret PPD commands to create a page header.">cupsRasterInterpretPPD</a></li> - <li><a href="#cupsRasterOpen" title="Open a raster stream using a file descriptor.">cupsRasterOpen</a></li> - <li><a href="#cupsRasterOpenIO" title="Open a raster stream using a callback function.">cupsRasterOpenIO</a></li> - <li><a href="#cupsRasterReadHeader" title="Read a raster page header and store it in a -version 1 page header structure.">cupsRasterReadHeader</a></li> - <li><a href="#cupsRasterReadHeader2" title="Read a raster page header and store it in a -version 2 page header structure.">cupsRasterReadHeader2</a></li> - <li><a href="#cupsRasterReadPixels" title="Read raster pixels.">cupsRasterReadPixels</a></li> - <li><a href="#cupsRasterWriteHeader" title="Write a raster page header from a version 1 page -header structure.">cupsRasterWriteHeader</a></li> - <li><a href="#cupsRasterWriteHeader2" title="Write a raster page header from a version 2 -page header structure.">cupsRasterWriteHeader2</a></li> - <li><a href="#cupsRasterWritePixels" title="Write raster pixels.">cupsRasterWritePixels</a></li> -</ul></li> -<li><a href="#TYPES">Data Types</a><ul class="code"> - <li><a href="#cups_adv_t" title="AdvanceMedia attribute values">cups_adv_t</a></li> - <li><a href="#cups_bool_t" title="Boolean type">cups_bool_t</a></li> - <li><a href="#cups_cspace_t" title="cupsColorSpace attribute values">cups_cspace_t</a></li> - <li><a href="#cups_cut_t" title="CutMedia attribute values">cups_cut_t</a></li> - <li><a href="#cups_edge_t" title="LeadingEdge attribute values">cups_edge_t</a></li> - <li><a href="#cups_interpret_cb_t" title="cupsRasterInterpretPPD callback function">cups_interpret_cb_t</a></li> - <li><a href="#cups_jog_t" title="Jog attribute values">cups_jog_t</a></li> - <li><a href="#cups_mode_t" title="cupsRasterOpen modes">cups_mode_t</a></li> - <li><a href="#cups_order_t" title="cupsColorOrder attribute values">cups_order_t</a></li> - <li><a href="#cups_orient_t" title="Orientation attribute values">cups_orient_t</a></li> - <li><a href="#cups_page_header2_t" title="Version 2 page header ">cups_page_header2_t</a></li> - <li><a href="#cups_page_header_t" title="Version 1 page header ">cups_page_header_t</a></li> - <li><a href="#cups_raster_iocb_t" title="cupsRasterOpenIO callback function">cups_raster_iocb_t</a></li> - <li><a href="#cups_raster_t" title="Raster stream data">cups_raster_t</a></li> -</ul></li> -<li><a href="#STRUCTURES">Structures</a><ul class="code"> - <li><a href="#cups_page_header2_s" title="Version 2 page header ">cups_page_header2_s</a></li> - <li><a href="#cups_page_header_s" title="Version 1 page header ">cups_page_header_s</a></li> -</ul></li> -<li><a href="#ENUMERATIONS">Constants</a><ul class="code"> - <li><a href="#cups_adv_e" title="AdvanceMedia attribute values">cups_adv_e</a></li> - <li><a href="#cups_bool_e" title="Boolean type">cups_bool_e</a></li> - <li><a href="#cups_cspace_e" title="cupsColorSpace attribute values">cups_cspace_e</a></li> - <li><a href="#cups_cut_e" title="CutMedia attribute values">cups_cut_e</a></li> - <li><a href="#cups_edge_e" title="LeadingEdge attribute values">cups_edge_e</a></li> - <li><a href="#cups_jog_e" title="Jog attribute values">cups_jog_e</a></li> - <li><a href="#cups_mode_e" title="cupsRasterOpen modes">cups_mode_e</a></li> - <li><a href="#cups_order_e" title="cupsColorOrder attribute values">cups_order_e</a></li> - <li><a href="#cups_orient_e" title="Orientation attribute values">cups_orient_e</a></li> -</ul></li> -</ul> + <div class="contents"> + <h2 class="title">Contents</h2> + <ul class="contents"> + <li><a href="#OVERVIEW">Overview</a></li> + <li><a href="#TASKS">Functions by Task</a><ul class="subcontents"> + <li><a href="#OPENCLOSE">Opening and Closing Raster Streams</a></li> + <li><a href="#READING">Reading Raster Streams</a></li> + <li><a href="#WRITING">Writing Raster Streams</a></li> + </ul></li> + <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents"> + <li><a href="#cupsRasterClose">cupsRasterClose</a></li> + <li><a href="#cupsRasterInitPWGHeader">cupsRasterInitPWGHeader</a></li> + <li><a href="#cupsRasterInterpretPPD">cupsRasterInterpretPPD</a></li> + <li><a href="#cupsRasterOpen">cupsRasterOpen</a></li> + <li><a href="#cupsRasterOpenIO">cupsRasterOpenIO</a></li> + <li><a href="#cupsRasterReadHeader">cupsRasterReadHeader</a></li> + <li><a href="#cupsRasterReadHeader2">cupsRasterReadHeader2</a></li> + <li><a href="#cupsRasterReadPixels">cupsRasterReadPixels</a></li> + <li><a href="#cupsRasterWriteHeader">cupsRasterWriteHeader</a></li> + <li><a href="#cupsRasterWriteHeader2">cupsRasterWriteHeader2</a></li> + <li><a href="#cupsRasterWritePixels">cupsRasterWritePixels</a></li> + </ul></li> + <li><a href="#TYPES">Data Types</a><ul class="subcontents"> + <li><a href="#cups_adv_t">cups_adv_t</a></li> + <li><a href="#cups_bool_t">cups_bool_t</a></li> + <li><a href="#cups_cspace_t">cups_cspace_t</a></li> + <li><a href="#cups_cut_t">cups_cut_t</a></li> + <li><a href="#cups_edge_t">cups_edge_t</a></li> + <li><a href="#cups_interpret_cb_t">cups_interpret_cb_t</a></li> + <li><a href="#cups_jog_t">cups_jog_t</a></li> + <li><a href="#cups_mode_t">cups_mode_t</a></li> + <li><a href="#cups_order_t">cups_order_t</a></li> + <li><a href="#cups_orient_t">cups_orient_t</a></li> + <li><a href="#cups_page_header2_t">cups_page_header2_t</a></li> + <li><a href="#cups_page_header_t">cups_page_header_t</a></li> + <li><a href="#cups_raster_iocb_t">cups_raster_iocb_t</a></li> + <li><a href="#cups_raster_t">cups_raster_t</a></li> + </ul></li> + <li><a href="#STRUCTURES">Structures</a><ul class="subcontents"> + <li><a href="#cups_page_header2_s">cups_page_header2_s</a></li> + <li><a href="#cups_page_header_s">cups_page_header_s</a></li> + </ul></li> + <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> + <li><a href="#cups_adv_e">cups_adv_e</a></li> + <li><a href="#cups_bool_e">cups_bool_e</a></li> + <li><a href="#cups_cspace_e">cups_cspace_e</a></li> + <li><a href="#cups_cut_e">cups_cut_e</a></li> + <li><a href="#cups_edge_e">cups_edge_e</a></li> + <li><a href="#cups_jog_e">cups_jog_e</a></li> + <li><a href="#cups_mode_e">cups_mode_e</a></li> + <li><a href="#cups_order_e">cups_order_e</a></li> + <li><a href="#cups_orient_e">cups_orient_e</a></li> + </ul></li> + </ul> + </div> + <div class="body"> <!-- Raster API introduction for CUPS. @@ -602,54 +603,44 @@ the memory used to read the raster file:</p> <li><a href="#cupsRasterWritePixels" title="Write raster pixels.">cupsRasterWritePixels</a></li> </ul> -<h2 class="title"><a name="FUNCTIONS">Functions</a></h2> -<h3 class="function"><a name="cupsRasterClose">cupsRasterClose</a></h3> -<p class="description">Close a raster stream.</p> + <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> +<h3 class="function"><a id="cupsRasterClose">cupsRasterClose</a></h3> + <p class="description">Close a raster stream.</p> <p class="code"> -void cupsRasterClose (<br> - <a href="#cups_raster_t">cups_raster_t</a> *r<br> -);</p> +void cupsRasterClose(<a href="#cups_raster_t">cups_raster_t</a> *r);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>r</dt> -<dd class="description">Stream to close</dd> -</dl> +<table class="list"><tbody> +<tr><th>r</th> + <td class="description">Stream to close</td></tr> +</tbody></table> <h4 class="discussion">Discussion</h4> -<p class="discussion">The file descriptor associated with the raster stream must be closed + <p class="discussion">The file descriptor associated with the raster stream must be closed separately as needed.</p> -<h3 class="function"><span class="info"> CUPS 2.2/macOS 10.12 </span><a name="cupsRasterInitPWGHeader">cupsRasterInitPWGHeader</a></h3> -<p class="description">Initialize a page header for PWG Raster output.</p> +<h3 class="function"><span class="info"> CUPS 2.2/macOS 10.12 </span><a id="cupsRasterInitPWGHeader">cupsRasterInitPWGHeader</a></h3> + <p class="description">Initialize a page header for PWG Raster output.</p> <p class="code"> -int cupsRasterInitPWGHeader (<br> - <a href="#cups_page_header2_t">cups_page_header2_t</a> *h,<br> - pwg_media_t *media,<br> - const char *type,<br> - int xdpi,<br> - int ydpi,<br> - const char *sides,<br> - const char *sheet_back<br> -);</p> +int cupsRasterInitPWGHeader(<a href="#cups_page_header2_t">cups_page_header2_t</a> *h, pwg_media_t *media, const char *type, int xdpi, int ydpi, const char *sides, const char *sheet_back);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>h</dt> -<dd class="description">Page header</dd> -<dt>media</dt> -<dd class="description">PWG media information</dd> -<dt>type</dt> -<dd class="description">PWG raster type string</dd> -<dt>xdpi</dt> -<dd class="description">Cross-feed direction (horizontal) resolution</dd> -<dt>ydpi</dt> -<dd class="description">Feed direction (vertical) resolution</dd> -<dt>sides</dt> -<dd class="description">IPP "sides" option value</dd> -<dt>sheet_back</dt> -<dd class="description">Transform for back side or <code>NULL</code> for none</dd> -</dl> +<table class="list"><tbody> +<tr><th>h</th> + <td class="description">Page header</td></tr> +<tr><th>media</th> + <td class="description">PWG media information</td></tr> +<tr><th>type</th> + <td class="description">PWG raster type string</td></tr> +<tr><th>xdpi</th> + <td class="description">Cross-feed direction (horizontal) resolution</td></tr> +<tr><th>ydpi</th> + <td class="description">Feed direction (vertical) resolution</td></tr> +<tr><th>sides</th> + <td class="description">IPP "sides" option value</td></tr> +<tr><th>sheet_back</th> + <td class="description">Transform for back side or <code>NULL</code> for none</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> + <p class="description">1 on success, 0 on failure</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">The "media" argument specifies the media to use.<br> + <p class="discussion">The "media" argument specifies the media to use.<br> <br> The "type" argument specifies a "pwg-raster-document-type-supported" value that controls the color space and bit depth of the raster data.<br> @@ -661,33 +652,27 @@ The "sheet_back" argument specifies a "pwg-raster-document-sheet- to apply for the back side of a page. Pass <code>NULL</code> for the front side. </p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsRasterInterpretPPD">cupsRasterInterpretPPD</a></h3> -<p class="description">Interpret PPD commands to create a page header.</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsRasterInterpretPPD">cupsRasterInterpretPPD</a></h3> + <p class="description">Interpret PPD commands to create a page header.</p> <p class="code"> -int cupsRasterInterpretPPD (<br> - <a href="#cups_page_header2_t">cups_page_header2_t</a> *h,<br> - ppd_file_t *ppd,<br> - int num_options,<br> - cups_option_t *options,<br> - <a href="#cups_interpret_cb_t">cups_interpret_cb_t</a> func<br> -);</p> +int cupsRasterInterpretPPD(<a href="#cups_page_header2_t">cups_page_header2_t</a> *h, ppd_file_t *ppd, int num_options, cups_option_t *options, <a href="#cups_interpret_cb_t">cups_interpret_cb_t</a> func);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>h</dt> -<dd class="description">Page header to create</dd> -<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> -<dt>func</dt> -<dd class="description">Optional page header callback (<code>NULL</code> for none)</dd> -</dl> +<table class="list"><tbody> +<tr><th>h</th> + <td class="description">Page header to create</td></tr> +<tr><th>ppd</th> + <td class="description">PPD file</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Options</td></tr> +<tr><th>func</th> + <td class="description">Optional page header callback (<code>NULL</code> for none)</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">0 on success, -1 on failure</p> + <p class="description">0 on success, -1 on failure</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function is used by raster image processing (RIP) filters like + <p class="discussion">This function is used by raster image processing (RIP) filters like cgpdftoraster and imagetoraster when writing CUPS raster data for a page. It is not used by raster printer driver filters which only read CUPS raster data.<br> @@ -712,27 +697,24 @@ Currently only the <code>[</code>, <code>]</code>, <code><<</code>, <code> are supported. </p> -<h3 class="function"><a name="cupsRasterOpen">cupsRasterOpen</a></h3> -<p class="description">Open a raster stream using a file descriptor.</p> +<h3 class="function"><a id="cupsRasterOpen">cupsRasterOpen</a></h3> + <p class="description">Open a raster stream using a file descriptor.</p> <p class="code"> -<a href="#cups_raster_t">cups_raster_t</a> *cupsRasterOpen (<br> - int fd,<br> - <a href="#cups_mode_t">cups_mode_t</a> mode<br> -);</p> +<a href="#cups_raster_t">cups_raster_t</a> *cupsRasterOpen(int fd, <a href="#cups_mode_t">cups_mode_t</a> mode);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>fd</dt> -<dd class="description">File descriptor</dd> -<dt>mode</dt> -<dd class="description">Mode - <code>CUPS_RASTER_READ</code>, +<table class="list"><tbody> +<tr><th>fd</th> + <td class="description">File descriptor</td></tr> +<tr><th>mode</th> + <td class="description">Mode - <code>CUPS_RASTER_READ</code>, <code>CUPS_RASTER_WRITE</code>, <code>CUPS_RASTER_WRITE_COMPRESSED</code>, -or <code>CUPS_RASTER_WRITE_PWG</code></dd> -</dl> +or <code>CUPS_RASTER_WRITE_PWG</code></td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">New stream</p> + <p class="description">New stream</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function associates a raster stream with the given file descriptor. + <p class="discussion">This function associates a raster stream with the given file descriptor. For most printer driver filters, "fd" will be 0 (stdin). For most raster image processor (RIP) filters that generate raster data, "fd" will be 1 (stdout).<br> @@ -741,729 +723,623 @@ When writing raster data, the <code>CUPS_RASTER_WRITE</code>, <code>CUPS_RASTER_WRITE_COMPRESS</code>, or <code>CUPS_RASTER_WRITE_PWG</code> mode can be used - compressed and PWG output is generally 25-50% smaller but adds a 100-300% execution time overhead.</p> -<h3 class="function"><a name="cupsRasterOpenIO">cupsRasterOpenIO</a></h3> -<p class="description">Open a raster stream using a callback function.</p> +<h3 class="function"><a id="cupsRasterOpenIO">cupsRasterOpenIO</a></h3> + <p class="description">Open a raster stream using a callback function.</p> <p class="code"> -<a href="#cups_raster_t">cups_raster_t</a> *cupsRasterOpenIO (<br> - <a href="#cups_raster_iocb_t">cups_raster_iocb_t</a> iocb,<br> - void *ctx,<br> - <a href="#cups_mode_t">cups_mode_t</a> mode<br> -);</p> +<a href="#cups_raster_t">cups_raster_t</a> *cupsRasterOpenIO(<a href="#cups_raster_iocb_t">cups_raster_iocb_t</a> iocb, void *ctx, <a href="#cups_mode_t">cups_mode_t</a> mode);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>iocb</dt> -<dd class="description">Read/write callback</dd> -<dt>ctx</dt> -<dd class="description">Context pointer for callback</dd> -<dt>mode</dt> -<dd class="description">Mode - <code>CUPS_RASTER_READ</code>, +<table class="list"><tbody> +<tr><th>iocb</th> + <td class="description">Read/write callback</td></tr> +<tr><th>ctx</th> + <td class="description">Context pointer for callback</td></tr> +<tr><th>mode</th> + <td class="description">Mode - <code>CUPS_RASTER_READ</code>, <code>CUPS_RASTER_WRITE</code>, <code>CUPS_RASTER_WRITE_COMPRESSED</code>, -or <code>CUPS_RASTER_WRITE_PWG</code></dd> -</dl> +or <code>CUPS_RASTER_WRITE_PWG</code></td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">New stream</p> + <p class="description">New stream</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function associates a raster stream with the given callback function and + <p class="discussion">This function associates a raster stream with the given callback function and context pointer.<br> <br> When writing raster data, the <code>CUPS_RASTER_WRITE</code>, <code>CUPS_RASTER_WRITE_COMPRESS</code>, or <code>CUPS_RASTER_WRITE_PWG</code> mode can be used - compressed and PWG output is generally 25-50% smaller but adds a 100-300% execution time overhead.</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="cupsRasterReadHeader">cupsRasterReadHeader</a></h3> -<p class="description">Read a raster page header and store it in a +<h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsRasterReadHeader">cupsRasterReadHeader</a></h3> + <p class="description">Read a raster page header and store it in a version 1 page header structure.</p> <p class="code"> -unsigned cupsRasterReadHeader (<br> - <a href="#cups_raster_t">cups_raster_t</a> *r,<br> - <a href="#cups_page_header_t">cups_page_header_t</a> *h<br> -);</p> +unsigned cupsRasterReadHeader(<a href="#cups_raster_t">cups_raster_t</a> *r, <a href="#cups_page_header_t">cups_page_header_t</a> *h);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>r</dt> -<dd class="description">Raster stream</dd> -<dt>h</dt> -<dd class="description">Pointer to header data</dd> -</dl> +<table class="list"><tbody> +<tr><th>r</th> + <td class="description">Raster stream</td></tr> +<tr><th>h</th> + <td class="description">Pointer to header data</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure/end-of-file</p> + <p class="description">1 on success, 0 on failure/end-of-file</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated. Use <a href="#cupsRasterReadHeader2"><code>cupsRasterReadHeader2</code></a> instead.<br> + <p class="discussion">This function is deprecated. Use <a href="#cupsRasterReadHeader2"><code>cupsRasterReadHeader2</code></a> instead.<br> <br> Version 1 page headers were used in CUPS 1.0 and 1.1 and contain a subset of the version 2 page header data. This function handles reading version 2 page headers and copying only the version 1 data into the provided buffer. </p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsRasterReadHeader2">cupsRasterReadHeader2</a></h3> -<p class="description">Read a raster page header and store it in a +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsRasterReadHeader2">cupsRasterReadHeader2</a></h3> + <p class="description">Read a raster page header and store it in a version 2 page header structure.</p> <p class="code"> -unsigned cupsRasterReadHeader2 (<br> - <a href="#cups_raster_t">cups_raster_t</a> *r,<br> - <a href="#cups_page_header2_t">cups_page_header2_t</a> *h<br> -);</p> +unsigned cupsRasterReadHeader2(<a href="#cups_raster_t">cups_raster_t</a> *r, <a href="#cups_page_header2_t">cups_page_header2_t</a> *h);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>r</dt> -<dd class="description">Raster stream</dd> -<dt>h</dt> -<dd class="description">Pointer to header data</dd> -</dl> +<table class="list"><tbody> +<tr><th>r</th> + <td class="description">Raster stream</td></tr> +<tr><th>h</th> + <td class="description">Pointer to header data</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure/end-of-file</p> -<h3 class="function"><a name="cupsRasterReadPixels">cupsRasterReadPixels</a></h3> -<p class="description">Read raster pixels.</p> + <p class="description">1 on success, 0 on failure/end-of-file</p> +<h3 class="function"><a id="cupsRasterReadPixels">cupsRasterReadPixels</a></h3> + <p class="description">Read raster pixels.</p> <p class="code"> -unsigned cupsRasterReadPixels (<br> - <a href="#cups_raster_t">cups_raster_t</a> *r,<br> - unsigned char *p,<br> - unsigned len<br> -);</p> +unsigned cupsRasterReadPixels(<a href="#cups_raster_t">cups_raster_t</a> *r, unsigned char *p, unsigned len);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>r</dt> -<dd class="description">Raster stream</dd> -<dt>p</dt> -<dd class="description">Pointer to pixel buffer</dd> -<dt>len</dt> -<dd class="description">Number of bytes to read</dd> -</dl> +<table class="list"><tbody> +<tr><th>r</th> + <td class="description">Raster stream</td></tr> +<tr><th>p</th> + <td class="description">Pointer to pixel buffer</td></tr> +<tr><th>len</th> + <td class="description">Number of bytes to read</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes read</p> + <p class="description">Number of bytes read</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">For best performance, filters should read one or more whole lines. + <p class="discussion">For best performance, filters should read one or more whole lines. The "cupsBytesPerLine" value from the page header can be used to allocate the line buffer and as the number of bytes to read.</p> -<h3 class="function"><span class="info"> DEPRECATED </span><a name="cupsRasterWriteHeader">cupsRasterWriteHeader</a></h3> -<p class="description">Write a raster page header from a version 1 page +<h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsRasterWriteHeader">cupsRasterWriteHeader</a></h3> + <p class="description">Write a raster page header from a version 1 page header structure.</p> <p class="code"> -unsigned cupsRasterWriteHeader (<br> - <a href="#cups_raster_t">cups_raster_t</a> *r,<br> - <a href="#cups_page_header_t">cups_page_header_t</a> *h<br> -);</p> +unsigned cupsRasterWriteHeader(<a href="#cups_raster_t">cups_raster_t</a> *r, <a href="#cups_page_header_t">cups_page_header_t</a> *h);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>r</dt> -<dd class="description">Raster stream</dd> -<dt>h</dt> -<dd class="description">Raster page header</dd> -</dl> +<table class="list"><tbody> +<tr><th>r</th> + <td class="description">Raster stream</td></tr> +<tr><th>h</th> + <td class="description">Raster page header</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> + <p class="description">1 on success, 0 on failure</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">This function is deprecated. Use <a href="#cupsRasterWriteHeader2"><code>cupsRasterWriteHeader2</code></a> instead. + <p class="discussion">This function is deprecated. Use <a href="#cupsRasterWriteHeader2"><code>cupsRasterWriteHeader2</code></a> instead. </p> -<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cupsRasterWriteHeader2">cupsRasterWriteHeader2</a></h3> -<p class="description">Write a raster page header from a version 2 +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsRasterWriteHeader2">cupsRasterWriteHeader2</a></h3> + <p class="description">Write a raster page header from a version 2 page header structure.</p> <p class="code"> -unsigned cupsRasterWriteHeader2 (<br> - <a href="#cups_raster_t">cups_raster_t</a> *r,<br> - <a href="#cups_page_header2_t">cups_page_header2_t</a> *h<br> -);</p> +unsigned cupsRasterWriteHeader2(<a href="#cups_raster_t">cups_raster_t</a> *r, <a href="#cups_page_header2_t">cups_page_header2_t</a> *h);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>r</dt> -<dd class="description">Raster stream</dd> -<dt>h</dt> -<dd class="description">Raster page header</dd> -</dl> +<table class="list"><tbody> +<tr><th>r</th> + <td class="description">Raster stream</td></tr> +<tr><th>h</th> + <td class="description">Raster page header</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">1 on success, 0 on failure</p> + <p class="description">1 on success, 0 on failure</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">The page header can be initialized using <a href="#cupsRasterInitPWGHeader"><code>cupsRasterInitPWGHeader</code></a>. + <p class="discussion">The page header can be initialized using <a href="#cupsRasterInitPWGHeader"><code>cupsRasterInitPWGHeader</code></a>. </p> -<h3 class="function"><a name="cupsRasterWritePixels">cupsRasterWritePixels</a></h3> -<p class="description">Write raster pixels.</p> +<h3 class="function"><a id="cupsRasterWritePixels">cupsRasterWritePixels</a></h3> + <p class="description">Write raster pixels.</p> <p class="code"> -unsigned cupsRasterWritePixels (<br> - <a href="#cups_raster_t">cups_raster_t</a> *r,<br> - unsigned char *p,<br> - unsigned len<br> -);</p> +unsigned cupsRasterWritePixels(<a href="#cups_raster_t">cups_raster_t</a> *r, unsigned char *p, unsigned len);</p> <h4 class="parameters">Parameters</h4> -<dl> -<dt>r</dt> -<dd class="description">Raster stream</dd> -<dt>p</dt> -<dd class="description">Bytes to write</dd> -<dt>len</dt> -<dd class="description">Number of bytes to write</dd> -</dl> +<table class="list"><tbody> +<tr><th>r</th> + <td class="description">Raster stream</td></tr> +<tr><th>p</th> + <td class="description">Bytes to write</td></tr> +<tr><th>len</th> + <td class="description">Number of bytes to write</td></tr> +</tbody></table> <h4 class="returnvalue">Return Value</h4> -<p class="description">Number of bytes written</p> + <p class="description">Number of bytes written</p> <h4 class="discussion">Discussion</h4> -<p class="discussion">For best performance, filters should write one or more whole lines. + <p class="discussion">For best performance, filters should write one or more whole lines. The "cupsBytesPerLine" value from the page header can be used to allocate the line buffer and as the number of bytes to write.</p> -<h2 class="title"><a name="TYPES">Data Types</a></h2> -<h3 class="typedef"><a name="cups_adv_t">cups_adv_t</a></h3> -<p class="description">AdvanceMedia attribute values</p> -<p class="code"> + <h2 class="title"><a id="TYPES">Data Types</a></h2> + <h3 class="typedef"><a id="cups_adv_t">cups_adv_t</a></h3> + <p class="description">AdvanceMedia attribute values</p> + <p class="code"> typedef enum <a href="#cups_adv_e">cups_adv_e</a> cups_adv_t; </p> -<h3 class="typedef"><a name="cups_bool_t">cups_bool_t</a></h3> -<p class="description">Boolean type</p> -<p class="code"> + <h3 class="typedef"><a id="cups_bool_t">cups_bool_t</a></h3> + <p class="description">Boolean type</p> + <p class="code"> typedef enum <a href="#cups_bool_e">cups_bool_e</a> cups_bool_t; </p> -<h3 class="typedef"><a name="cups_cspace_t">cups_cspace_t</a></h3> -<p class="description">cupsColorSpace attribute values</p> -<p class="code"> + <h3 class="typedef"><a id="cups_cspace_t">cups_cspace_t</a></h3> + <p class="description">cupsColorSpace attribute values</p> + <p class="code"> typedef enum <a href="#cups_cspace_e">cups_cspace_e</a> cups_cspace_t; </p> -<h3 class="typedef"><a name="cups_cut_t">cups_cut_t</a></h3> -<p class="description">CutMedia attribute values</p> -<p class="code"> + <h3 class="typedef"><a id="cups_cut_t">cups_cut_t</a></h3> + <p class="description">CutMedia attribute values</p> + <p class="code"> typedef enum <a href="#cups_cut_e">cups_cut_e</a> cups_cut_t; </p> -<h3 class="typedef"><a name="cups_edge_t">cups_edge_t</a></h3> -<p class="description">LeadingEdge attribute values</p> -<p class="code"> + <h3 class="typedef"><a id="cups_edge_t">cups_edge_t</a></h3> + <p class="description">LeadingEdge attribute values</p> + <p class="code"> typedef enum <a href="#cups_edge_e">cups_edge_e</a> cups_edge_t; </p> -<h3 class="typedef"><a name="cups_interpret_cb_t">cups_interpret_cb_t</a></h3> -<p class="description">cupsRasterInterpretPPD callback function</p> -<p class="code"> + <h3 class="typedef"><a id="cups_interpret_cb_t">cups_interpret_cb_t</a></h3> + <p class="description">cupsRasterInterpretPPD callback function</p> + <p class="code"> typedef int (*cups_interpret_cb_t)(<a href="#cups_page_header2_t">cups_page_header2_t</a> *header, int preferred_bits); </p> -<h3 class="typedef"><a name="cups_jog_t">cups_jog_t</a></h3> -<p class="description">Jog attribute values</p> -<p class="code"> + <h3 class="typedef"><a id="cups_jog_t">cups_jog_t</a></h3> + <p class="description">Jog attribute values</p> + <p class="code"> typedef enum <a href="#cups_jog_e">cups_jog_e</a> cups_jog_t; </p> -<h3 class="typedef"><a name="cups_mode_t">cups_mode_t</a></h3> -<p class="description">cupsRasterOpen modes</p> -<p class="code"> + <h3 class="typedef"><a id="cups_mode_t">cups_mode_t</a></h3> + <p class="description">cupsRasterOpen modes</p> + <p class="code"> typedef enum <a href="#cups_mode_e">cups_mode_e</a> cups_mode_t; </p> -<h3 class="typedef"><a name="cups_order_t">cups_order_t</a></h3> -<p class="description">cupsColorOrder attribute values</p> -<p class="code"> + <h3 class="typedef"><a id="cups_order_t">cups_order_t</a></h3> + <p class="description">cupsColorOrder attribute values</p> + <p class="code"> typedef enum <a href="#cups_order_e">cups_order_e</a> cups_order_t; </p> -<h3 class="typedef"><a name="cups_orient_t">cups_orient_t</a></h3> -<p class="description">Orientation attribute values</p> -<p class="code"> + <h3 class="typedef"><a id="cups_orient_t">cups_orient_t</a></h3> + <p class="description">Orientation attribute values</p> + <p class="code"> typedef enum <a href="#cups_orient_e">cups_orient_e</a> cups_orient_t; </p> -<h3 class="typedef"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cups_page_header2_t">cups_page_header2_t</a></h3> -<p class="description">Version 2 page header </p> -<p class="code"> + <h3 class="typedef"><a id="cups_page_header2_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>cups_page_header2_t</a></h3> + <p class="description">Version 2 page header </p> + <p class="code"> typedef struct <a href="#cups_page_header2_s">cups_page_header2_s</a> cups_page_header2_t; </p> -<h3 class="typedef"><span class="info"> DEPRECATED </span><a name="cups_page_header_t">cups_page_header_t</a></h3> -<p class="description">Version 1 page header </p> -<p class="code"> + <h3 class="typedef"><a id="cups_page_header_t"><span class="info"> DEPRECATED </span>cups_page_header_t</a></h3> + <p class="description">Version 1 page header </p> + <p class="code"> typedef struct <a href="#cups_page_header_s">cups_page_header_s</a> cups_page_header_t; </p> -<h3 class="typedef"><a name="cups_raster_iocb_t">cups_raster_iocb_t</a></h3> -<p class="description">cupsRasterOpenIO callback function</p> -<p class="code"> + <h3 class="typedef"><a id="cups_raster_iocb_t">cups_raster_iocb_t</a></h3> + <p class="description">cupsRasterOpenIO callback function</p> + <p class="code"> typedef ssize_t (*cups_raster_iocb_t)(void *ctx, unsigned char *buffer, size_t length); </p> -<h3 class="typedef"><a name="cups_raster_t">cups_raster_t</a></h3> -<p class="description">Raster stream data</p> -<p class="code"> + <h3 class="typedef"><a id="cups_raster_t">cups_raster_t</a></h3> + <p class="description">Raster stream data</p> + <p class="code"> typedef struct _cups_raster_s cups_raster_t; </p> -<h2 class="title"><a name="STRUCTURES">Structures</a></h2> -<h3 class="struct"><span class="info"> CUPS 1.2/macOS 10.5 </span><a name="cups_page_header2_s">cups_page_header2_s</a></h3> -<p class="description">Version 2 page header </p> + <h2 class="title"><a id="STRUCTURES">Structures</a></h2> +<h3 class="struct"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cups_page_header2_s">cups_page_header2_s</a></h3> + <p class="description">Version 2 page header </p> <p class="code">struct cups_page_header2_s {<br> - unsigned AdvanceDistance;<br> - <a href="#cups_adv_t">cups_adv_t</a> AdvanceMedia;<br> - <a href="#cups_bool_t">cups_bool_t</a> Collate;<br> - <a href="#cups_cut_t">cups_cut_t</a> CutMedia;<br> - <a href="#cups_bool_t">cups_bool_t</a> Duplex;<br> - unsigned HWResolution[2];<br> - unsigned ImagingBoundingBox[4];<br> - <a href="#cups_bool_t">cups_bool_t</a> InsertSheet;<br> - <a href="#cups_jog_t">cups_jog_t</a> Jog;<br> - <a href="#cups_edge_t">cups_edge_t</a> LeadingEdge;<br> - <a href="#cups_bool_t">cups_bool_t</a> ManualFeed;<br> - unsigned Margins[2];<br> - char MediaClass[64];<br> - char MediaColor[64];<br> - unsigned MediaPosition;<br> - char MediaType[64];<br> - unsigned MediaWeight;<br> - <a href="#cups_bool_t">cups_bool_t</a> MirrorPrint;<br> - <a href="#cups_bool_t">cups_bool_t</a> NegativePrint;<br> - unsigned NumCopies;<br> - <a href="#cups_orient_t">cups_orient_t</a> Orientation;<br> - <a href="#cups_bool_t">cups_bool_t</a> OutputFaceUp;<br> - char OutputType[64];<br> - unsigned PageSize[2];<br> - <a href="#cups_bool_t">cups_bool_t</a> Separations;<br> - <a href="#cups_bool_t">cups_bool_t</a> TraySwitch;<br> - <a href="#cups_bool_t">cups_bool_t</a> Tumble;<br> - unsigned cupsBitsPerColor;<br> - unsigned cupsBitsPerPixel;<br> - float cupsBorderlessScalingFactor;<br> - unsigned cupsBytesPerLine;<br> - <a href="#cups_order_t">cups_order_t</a> cupsColorOrder;<br> - <a href="#cups_cspace_t">cups_cspace_t</a> cupsColorSpace;<br> - unsigned cupsCompression;<br> - unsigned cupsHeight;<br> - float cupsImagingBBox[4];<br> - unsigned cupsInteger[16];<br> - char cupsMarkerType[64];<br> - unsigned cupsMediaType;<br> - unsigned cupsNumColors;<br> - char cupsPageSizeName[64];<br> - float cupsPageSize[2];<br> - float cupsReal[16];<br> - char cupsRenderingIntent[64];<br> - unsigned cupsRowCount;<br> - unsigned cupsRowFeed;<br> - unsigned cupsRowStep;<br> - char cupsString[16][64];<br> - unsigned cupsWidth;<br> +    unsigned AdvanceDistance;<br> +    <a href="#cups_adv_t">cups_adv_t</a> AdvanceMedia;<br> +    <a href="#cups_bool_t">cups_bool_t</a> Collate;<br> +    <a href="#cups_cut_t">cups_cut_t</a> CutMedia;<br> +    <a href="#cups_bool_t">cups_bool_t</a> Duplex;<br> +    unsigned HWResolution[2];<br> +    unsigned ImagingBoundingBox[4];<br> +    <a href="#cups_bool_t">cups_bool_t</a> InsertSheet;<br> +    <a href="#cups_jog_t">cups_jog_t</a> Jog;<br> +    <a href="#cups_edge_t">cups_edge_t</a> LeadingEdge;<br> +    <a href="#cups_bool_t">cups_bool_t</a> ManualFeed;<br> +    unsigned Margins[2];<br> +    char MediaClass[64];<br> +    char MediaColor[64];<br> +    unsigned MediaPosition;<br> +    char MediaType[64];<br> +    unsigned MediaWeight;<br> +    <a href="#cups_bool_t">cups_bool_t</a> MirrorPrint;<br> +    <a href="#cups_bool_t">cups_bool_t</a> NegativePrint;<br> +    unsigned NumCopies;<br> +    <a href="#cups_orient_t">cups_orient_t</a> Orientation;<br> +    <a href="#cups_bool_t">cups_bool_t</a> OutputFaceUp;<br> +    char OutputType[64];<br> +    unsigned PageSize[2];<br> +    <a href="#cups_bool_t">cups_bool_t</a> Separations;<br> +    <a href="#cups_bool_t">cups_bool_t</a> TraySwitch;<br> +    <a href="#cups_bool_t">cups_bool_t</a> Tumble;<br> +    unsigned cupsBitsPerColor;<br> +    unsigned cupsBitsPerPixel;<br> +    float cupsBorderlessScalingFactor;<br> +    unsigned cupsBytesPerLine;<br> +    <a href="#cups_order_t">cups_order_t</a> cupsColorOrder;<br> +    <a href="#cups_cspace_t">cups_cspace_t</a> cupsColorSpace;<br> +    unsigned cupsCompression;<br> +    unsigned cupsHeight;<br> +    float cupsImagingBBox[4];<br> +    unsigned cupsInteger[16];<br> +    char cupsMarkerType[64];<br> +    unsigned cupsMediaType;<br> +    unsigned cupsNumColors;<br> +    char cupsPageSizeName[64];<br> +    float cupsPageSize[2];<br> +    float cupsReal[16];<br> +    char cupsRenderingIntent[64];<br> +    unsigned cupsRowCount;<br> +    unsigned cupsRowFeed;<br> +    unsigned cupsRowStep;<br> +    char cupsString[16][64];<br> +    unsigned cupsWidth;<br> };</p> <h4 class="members">Members</h4> -<dl> -<dt>AdvanceDistance </dt> -<dd class="description">AdvanceDistance value in points</dd> -<dt>AdvanceMedia </dt> -<dd class="description">AdvanceMedia value (<a href="#cups_adv_t"><code>cups_adv_t</code></a>)</dd> -<dt>Collate </dt> -<dd class="description">Collated copies value</dd> -<dt>CutMedia </dt> -<dd class="description">CutMedia value (<a href="#cups_cut_t"><code>cups_cut_t</code></a>)</dd> -<dt>Duplex </dt> -<dd class="description">Duplexed (double-sided) value</dd> -<dt>HWResolution[2] </dt> -<dd class="description">Resolution in dots-per-inch</dd> -<dt>ImagingBoundingBox[4] </dt> -<dd class="description">Pixel region that is painted (points, left, bottom, right, top)</dd> -<dt>InsertSheet </dt> -<dd class="description">InsertSheet value</dd> -<dt>Jog </dt> -<dd class="description">Jog value (<a href="#cups_jog_t"><code>cups_jog_t</code></a>)</dd> -<dt>LeadingEdge </dt> -<dd class="description">LeadingEdge value (<a href="#cups_edge_t"><code>cups_edge_t</code></a>)</dd> -<dt>ManualFeed </dt> -<dd class="description">ManualFeed value</dd> -<dt>Margins[2] </dt> -<dd class="description">Lower-lefthand margins in points</dd> -<dt>MediaClass[64] </dt> -<dd class="description">MediaClass string</dd> -<dt>MediaColor[64] </dt> -<dd class="description">MediaColor string</dd> -<dt>MediaPosition </dt> -<dd class="description">MediaPosition value</dd> -<dt>MediaType[64] </dt> -<dd class="description">MediaType string</dd> -<dt>MediaWeight </dt> -<dd class="description">MediaWeight value in grams/m^2</dd> -<dt>MirrorPrint </dt> -<dd class="description">MirrorPrint value</dd> -<dt>NegativePrint </dt> -<dd class="description">NegativePrint value</dd> -<dt>NumCopies </dt> -<dd class="description">Number of copies to produce</dd> -<dt>Orientation </dt> -<dd class="description">Orientation value (<a href="#cups_orient_t"><code>cups_orient_t</code></a>)</dd> -<dt>OutputFaceUp </dt> -<dd class="description">OutputFaceUp value</dd> -<dt>OutputType[64] </dt> -<dd class="description">OutputType string</dd> -<dt>PageSize[2] </dt> -<dd class="description">Width and length of page in points</dd> -<dt>Separations </dt> -<dd class="description">Separations value</dd> -<dt>TraySwitch </dt> -<dd class="description">TraySwitch value</dd> -<dt>Tumble </dt> -<dd class="description">Tumble value</dd> -<dt>cupsBitsPerColor </dt> -<dd class="description">Number of bits for each color</dd> -<dt>cupsBitsPerPixel </dt> -<dd class="description">Number of bits for each pixel</dd> -<dt>cupsBorderlessScalingFactor <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Scaling that was applied to page data </dd> -<dt>cupsBytesPerLine </dt> -<dd class="description">Number of bytes per line</dd> -<dt>cupsColorOrder </dt> -<dd class="description">Order of colors</dd> -<dt>cupsColorSpace </dt> -<dd class="description">True colorspace</dd> -<dt>cupsCompression </dt> -<dd class="description">Device compression to use</dd> -<dt>cupsHeight </dt> -<dd class="description">Height of page image in pixels</dd> -<dt>cupsImagingBBox[4] <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Floating point ImagingBoundingBox +<table class="list"><tbody> +<tr><th>AdvanceDistance </th> + <td class="description">AdvanceDistance value in points</td></tr> +<tr><th>AdvanceMedia </th> + <td class="description">AdvanceMedia value (<a href="#cups_adv_t"><code>cups_adv_t</code></a>)</td></tr> +<tr><th>Collate </th> + <td class="description">Collated copies value</td></tr> +<tr><th>CutMedia </th> + <td class="description">CutMedia value (<a href="#cups_cut_t"><code>cups_cut_t</code></a>)</td></tr> +<tr><th>Duplex </th> + <td class="description">Duplexed (double-sided) value</td></tr> +<tr><th>HWResolution[2] </th> + <td class="description">Resolution in dots-per-inch</td></tr> +<tr><th>ImagingBoundingBox[4] </th> + <td class="description">Pixel region that is painted (points, left, bottom, right, top)</td></tr> +<tr><th>InsertSheet </th> + <td class="description">InsertSheet value</td></tr> +<tr><th>Jog </th> + <td class="description">Jog value (<a href="#cups_jog_t"><code>cups_jog_t</code></a>)</td></tr> +<tr><th>LeadingEdge </th> + <td class="description">LeadingEdge value (<a href="#cups_edge_t"><code>cups_edge_t</code></a>)</td></tr> +<tr><th>ManualFeed </th> + <td class="description">ManualFeed value</td></tr> +<tr><th>Margins[2] </th> + <td class="description">Lower-lefthand margins in points</td></tr> +<tr><th>MediaClass[64] </th> + <td class="description">MediaClass string</td></tr> +<tr><th>MediaColor[64] </th> + <td class="description">MediaColor string</td></tr> +<tr><th>MediaPosition </th> + <td class="description">MediaPosition value</td></tr> +<tr><th>MediaType[64] </th> + <td class="description">MediaType string</td></tr> +<tr><th>MediaWeight </th> + <td class="description">MediaWeight value in grams/m^2</td></tr> +<tr><th>MirrorPrint </th> + <td class="description">MirrorPrint value</td></tr> +<tr><th>NegativePrint </th> + <td class="description">NegativePrint value</td></tr> +<tr><th>NumCopies </th> + <td class="description">Number of copies to produce</td></tr> +<tr><th>Orientation </th> + <td class="description">Orientation value (<a href="#cups_orient_t"><code>cups_orient_t</code></a>)</td></tr> +<tr><th>OutputFaceUp </th> + <td class="description">OutputFaceUp value</td></tr> +<tr><th>OutputType[64] </th> + <td class="description">OutputType string</td></tr> +<tr><th>PageSize[2] </th> + <td class="description">Width and length of page in points</td></tr> +<tr><th>Separations </th> + <td class="description">Separations value</td></tr> +<tr><th>TraySwitch </th> + <td class="description">TraySwitch value</td></tr> +<tr><th>Tumble </th> + <td class="description">Tumble value</td></tr> +<tr><th>cupsBitsPerColor </th> + <td class="description">Number of bits for each color</td></tr> +<tr><th>cupsBitsPerPixel </th> + <td class="description">Number of bits for each pixel</td></tr> +<tr><th>cupsBorderlessScalingFactor <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">Scaling that was applied to page data </td></tr> +<tr><th>cupsBytesPerLine </th> + <td class="description">Number of bytes per line</td></tr> +<tr><th>cupsColorOrder </th> + <td class="description">Order of colors</td></tr> +<tr><th>cupsColorSpace </th> + <td class="description">True colorspace</td></tr> +<tr><th>cupsCompression </th> + <td class="description">Device compression to use</td></tr> +<tr><th>cupsHeight </th> + <td class="description">Height of page image in pixels</td></tr> +<tr><th>cupsImagingBBox[4] <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">Floating point ImagingBoundingBox (scaling factor not applied, left, -bottom, right, top) </dd> -<dt>cupsInteger[16] <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">User-defined integer values </dd> -<dt>cupsMarkerType[64] <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Ink/toner type </dd> -<dt>cupsMediaType </dt> -<dd class="description">Media type code</dd> -<dt>cupsNumColors <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Number of color compoents </dd> -<dt>cupsPageSizeName[64] <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">PageSize name </dd> -<dt>cupsPageSize[2] <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Floating point PageSize (scaling * -factor not applied) </dd> -<dt>cupsReal[16] <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">User-defined floating-point values </dd> -<dt>cupsRenderingIntent[64] <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Color rendering intent </dd> -<dt>cupsRowCount </dt> -<dd class="description">Rows per band</dd> -<dt>cupsRowFeed </dt> -<dd class="description">Feed between bands</dd> -<dt>cupsRowStep </dt> -<dd class="description">Spacing between lines</dd> -<dt>cupsString[16][64] <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">User-defined string values </dd> -<dt>cupsWidth </dt> -<dd class="description">Width of page image in pixels</dd> -</dl> -<h3 class="struct"><span class="info"> DEPRECATED </span><a name="cups_page_header_s">cups_page_header_s</a></h3> -<p class="description">Version 1 page header </p> +bottom, right, top) </td></tr> +<tr><th>cupsInteger[16] <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">User-defined integer values </td></tr> +<tr><th>cupsMarkerType[64] <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">Ink/toner type </td></tr> +<tr><th>cupsMediaType </th> + <td class="description">Media type code</td></tr> +<tr><th>cupsNumColors <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">Number of color compoents </td></tr> +<tr><th>cupsPageSizeName[64] <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">PageSize name </td></tr> +<tr><th>cupsPageSize[2] <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">Floating point PageSize (scaling * +factor not applied) </td></tr> +<tr><th>cupsReal[16] <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">User-defined floating-point values </td></tr> +<tr><th>cupsRenderingIntent[64] <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">Color rendering intent </td></tr> +<tr><th>cupsRowCount </th> + <td class="description">Rows per band</td></tr> +<tr><th>cupsRowFeed </th> + <td class="description">Feed between bands</td></tr> +<tr><th>cupsRowStep </th> + <td class="description">Spacing between lines</td></tr> +<tr><th>cupsString[16][64] <span class="info"> CUPS 1.2/macOS 10.5 </span></th> + <td class="description">User-defined string values </td></tr> +<tr><th>cupsWidth </th> + <td class="description">Width of page image in pixels</td></tr> +</tbody></table> +<h3 class="struct"><span class="info"> DEPRECATED </span><a id="cups_page_header_s">cups_page_header_s</a></h3> + <p class="description">Version 1 page header </p> <p class="code">struct cups_page_header_s {<br> - unsigned AdvanceDistance;<br> - <a href="#cups_adv_t">cups_adv_t</a> AdvanceMedia;<br> - <a href="#cups_bool_t">cups_bool_t</a> Collate;<br> - <a href="#cups_cut_t">cups_cut_t</a> CutMedia;<br> - <a href="#cups_bool_t">cups_bool_t</a> Duplex;<br> - unsigned HWResolution[2];<br> - unsigned ImagingBoundingBox[4];<br> - <a href="#cups_bool_t">cups_bool_t</a> InsertSheet;<br> - <a href="#cups_jog_t">cups_jog_t</a> Jog;<br> - <a href="#cups_edge_t">cups_edge_t</a> LeadingEdge;<br> - <a href="#cups_bool_t">cups_bool_t</a> ManualFeed;<br> - unsigned Margins[2];<br> - char MediaClass[64];<br> - char MediaColor[64];<br> - unsigned MediaPosition;<br> - char MediaType[64];<br> - unsigned MediaWeight;<br> - <a href="#cups_bool_t">cups_bool_t</a> MirrorPrint;<br> - <a href="#cups_bool_t">cups_bool_t</a> NegativePrint;<br> - unsigned NumCopies;<br> - <a href="#cups_orient_t">cups_orient_t</a> Orientation;<br> - <a href="#cups_bool_t">cups_bool_t</a> OutputFaceUp;<br> - char OutputType[64];<br> - unsigned PageSize[2];<br> - <a href="#cups_bool_t">cups_bool_t</a> Separations;<br> - <a href="#cups_bool_t">cups_bool_t</a> TraySwitch;<br> - <a href="#cups_bool_t">cups_bool_t</a> Tumble;<br> - unsigned cupsBitsPerColor;<br> - unsigned cupsBitsPerPixel;<br> - unsigned cupsBytesPerLine;<br> - <a href="#cups_order_t">cups_order_t</a> cupsColorOrder;<br> - <a href="#cups_cspace_t">cups_cspace_t</a> cupsColorSpace;<br> - unsigned cupsCompression;<br> - unsigned cupsHeight;<br> - unsigned cupsMediaType;<br> - unsigned cupsRowCount;<br> - unsigned cupsRowFeed;<br> - unsigned cupsRowStep;<br> - unsigned cupsWidth;<br> +    unsigned AdvanceDistance;<br> +    <a href="#cups_adv_t">cups_adv_t</a> AdvanceMedia;<br> +    <a href="#cups_bool_t">cups_bool_t</a> Collate;<br> +    <a href="#cups_cut_t">cups_cut_t</a> CutMedia;<br> +    <a href="#cups_bool_t">cups_bool_t</a> Duplex;<br> +    unsigned HWResolution[2];<br> +    unsigned ImagingBoundingBox[4];<br> +    <a href="#cups_bool_t">cups_bool_t</a> InsertSheet;<br> +    <a href="#cups_jog_t">cups_jog_t</a> Jog;<br> +    <a href="#cups_edge_t">cups_edge_t</a> LeadingEdge;<br> +    <a href="#cups_bool_t">cups_bool_t</a> ManualFeed;<br> +    unsigned Margins[2];<br> +    char MediaClass[64];<br> +    char MediaColor[64];<br> +    unsigned MediaPosition;<br> +    char MediaType[64];<br> +    unsigned MediaWeight;<br> +    <a href="#cups_bool_t">cups_bool_t</a> MirrorPrint;<br> +    <a href="#cups_bool_t">cups_bool_t</a> NegativePrint;<br> +    unsigned NumCopies;<br> +    <a href="#cups_orient_t">cups_orient_t</a> Orientation;<br> +    <a href="#cups_bool_t">cups_bool_t</a> OutputFaceUp;<br> +    char OutputType[64];<br> +    unsigned PageSize[2];<br> +    <a href="#cups_bool_t">cups_bool_t</a> Separations;<br> +    <a href="#cups_bool_t">cups_bool_t</a> TraySwitch;<br> +    <a href="#cups_bool_t">cups_bool_t</a> Tumble;<br> +    unsigned cupsBitsPerColor;<br> +    unsigned cupsBitsPerPixel;<br> +    unsigned cupsBytesPerLine;<br> +    <a href="#cups_order_t">cups_order_t</a> cupsColorOrder;<br> +    <a href="#cups_cspace_t">cups_cspace_t</a> cupsColorSpace;<br> +    unsigned cupsCompression;<br> +    unsigned cupsHeight;<br> +    unsigned cupsMediaType;<br> +    unsigned cupsRowCount;<br> +    unsigned cupsRowFeed;<br> +    unsigned cupsRowStep;<br> +    unsigned cupsWidth;<br> };</p> <h4 class="members">Members</h4> -<dl> -<dt>AdvanceDistance </dt> -<dd class="description">AdvanceDistance value in points</dd> -<dt>AdvanceMedia </dt> -<dd class="description">AdvanceMedia value (<a href="#cups_adv_t"><code>cups_adv_t</code></a>)</dd> -<dt>Collate </dt> -<dd class="description">Collated copies value</dd> -<dt>CutMedia </dt> -<dd class="description">CutMedia value (<a href="#cups_cut_t"><code>cups_cut_t</code></a>)</dd> -<dt>Duplex </dt> -<dd class="description">Duplexed (double-sided) value</dd> -<dt>HWResolution[2] </dt> -<dd class="description">Resolution in dots-per-inch</dd> -<dt>ImagingBoundingBox[4] </dt> -<dd class="description">Pixel region that is painted (points, left, bottom, right, top)</dd> -<dt>InsertSheet </dt> -<dd class="description">InsertSheet value</dd> -<dt>Jog </dt> -<dd class="description">Jog value (<a href="#cups_jog_t"><code>cups_jog_t</code></a>)</dd> -<dt>LeadingEdge </dt> -<dd class="description">LeadingEdge value (<a href="#cups_edge_t"><code>cups_edge_t</code></a>)</dd> -<dt>ManualFeed </dt> -<dd class="description">ManualFeed value</dd> -<dt>Margins[2] </dt> -<dd class="description">Lower-lefthand margins in points</dd> -<dt>MediaClass[64] </dt> -<dd class="description">MediaClass string</dd> -<dt>MediaColor[64] </dt> -<dd class="description">MediaColor string</dd> -<dt>MediaPosition </dt> -<dd class="description">MediaPosition value</dd> -<dt>MediaType[64] </dt> -<dd class="description">MediaType string</dd> -<dt>MediaWeight </dt> -<dd class="description">MediaWeight value in grams/m^2</dd> -<dt>MirrorPrint </dt> -<dd class="description">MirrorPrint value</dd> -<dt>NegativePrint </dt> -<dd class="description">NegativePrint value</dd> -<dt>NumCopies </dt> -<dd class="description">Number of copies to produce</dd> -<dt>Orientation </dt> -<dd class="description">Orientation value (<a href="#cups_orient_t"><code>cups_orient_t</code></a>)</dd> -<dt>OutputFaceUp </dt> -<dd class="description">OutputFaceUp value</dd> -<dt>OutputType[64] </dt> -<dd class="description">OutputType string</dd> -<dt>PageSize[2] </dt> -<dd class="description">Width and length of page in points</dd> -<dt>Separations </dt> -<dd class="description">Separations value</dd> -<dt>TraySwitch </dt> -<dd class="description">TraySwitch value</dd> -<dt>Tumble </dt> -<dd class="description">Tumble value</dd> -<dt>cupsBitsPerColor </dt> -<dd class="description">Number of bits for each color</dd> -<dt>cupsBitsPerPixel </dt> -<dd class="description">Number of bits for each pixel</dd> -<dt>cupsBytesPerLine </dt> -<dd class="description">Number of bytes per line</dd> -<dt>cupsColorOrder </dt> -<dd class="description">Order of colors</dd> -<dt>cupsColorSpace </dt> -<dd class="description">True colorspace</dd> -<dt>cupsCompression </dt> -<dd class="description">Device compression to use</dd> -<dt>cupsHeight </dt> -<dd class="description">Height of page image in pixels</dd> -<dt>cupsMediaType </dt> -<dd class="description">Media type code</dd> -<dt>cupsRowCount </dt> -<dd class="description">Rows per band</dd> -<dt>cupsRowFeed </dt> -<dd class="description">Feed between bands</dd> -<dt>cupsRowStep </dt> -<dd class="description">Spacing between lines</dd> -<dt>cupsWidth </dt> -<dd class="description">Width of page image in pixels</dd> -</dl> -<h2 class="title"><a name="ENUMERATIONS">Constants</a></h2> -<h3 class="enumeration"><a name="cups_adv_e">cups_adv_e</a></h3> -<p class="description">AdvanceMedia attribute values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_ADVANCE_FILE </dt> -<dd class="description">Advance the roll after this file</dd> -<dt>CUPS_ADVANCE_JOB </dt> -<dd class="description">Advance the roll after this job</dd> -<dt>CUPS_ADVANCE_NONE </dt> -<dd class="description">Never advance the roll</dd> -<dt>CUPS_ADVANCE_PAGE </dt> -<dd class="description">Advance the roll after this page</dd> -<dt>CUPS_ADVANCE_SET </dt> -<dd class="description">Advance the roll after this set</dd> -</dl> -<h3 class="enumeration"><a name="cups_bool_e">cups_bool_e</a></h3> -<p class="description">Boolean type</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_FALSE </dt> -<dd class="description">Logical false</dd> -<dt>CUPS_TRUE </dt> -<dd class="description">Logical true</dd> -</dl> -<h3 class="enumeration"><a name="cups_cspace_e">cups_cspace_e</a></h3> -<p class="description">cupsColorSpace attribute values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_CSPACE_ADOBERGB <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">Red, green, blue (Adobe RGB) </dd> -<dt>CUPS_CSPACE_CIELab <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">CIE Lab </dd> -<dt>CUPS_CSPACE_CIEXYZ <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">CIE XYZ </dd> -<dt>CUPS_CSPACE_CMY </dt> -<dd class="description">Cyan, magenta, yellow (DeviceCMY)</dd> -<dt>CUPS_CSPACE_CMYK </dt> -<dd class="description">Cyan, magenta, yellow, black (DeviceCMYK)</dd> -<dt>CUPS_CSPACE_DEVICE1 <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 1 color </dd> -<dt>CUPS_CSPACE_DEVICE2 <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 2 colors </dd> -<dt>CUPS_CSPACE_DEVICE3 <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 3 colors </dd> -<dt>CUPS_CSPACE_DEVICE4 <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 4 colors </dd> -<dt>CUPS_CSPACE_DEVICE5 <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 5 colors </dd> -<dt>CUPS_CSPACE_DEVICE6 <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 6 colors </dd> -<dt>CUPS_CSPACE_DEVICE7 <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 7 colors </dd> -<dt>CUPS_CSPACE_DEVICE8 <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 8 colors </dd> -<dt>CUPS_CSPACE_DEVICE9 <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 9 colors </dd> -<dt>CUPS_CSPACE_DEVICEA <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 10 colors </dd> -<dt>CUPS_CSPACE_DEVICEB <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 11 colors </dd> -<dt>CUPS_CSPACE_DEVICEC <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 12 colors </dd> -<dt>CUPS_CSPACE_DEVICED <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 13 colors </dd> -<dt>CUPS_CSPACE_DEVICEE <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 14 colors </dd> -<dt>CUPS_CSPACE_DEVICEF <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">DeviceN, 15 colors </dd> -<dt>CUPS_CSPACE_GMCK <span class="info"> DEPRECATED </span></dt> -<dd class="description">Gold, magenta, yellow, black </dd> -<dt>CUPS_CSPACE_GMCS <span class="info"> DEPRECATED </span></dt> -<dd class="description">Gold, magenta, yellow, silver </dd> -<dt>CUPS_CSPACE_GOLD <span class="info"> DEPRECATED </span></dt> -<dd class="description">Gold foil </dd> -<dt>CUPS_CSPACE_ICC1 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 1 color </dd> -<dt>CUPS_CSPACE_ICC2 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 2 colors </dd> -<dt>CUPS_CSPACE_ICC3 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 3 colors </dd> -<dt>CUPS_CSPACE_ICC4 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 4 colors </dd> -<dt>CUPS_CSPACE_ICC5 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 5 colors </dd> -<dt>CUPS_CSPACE_ICC6 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 6 colors </dd> -<dt>CUPS_CSPACE_ICC7 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 7 colors </dd> -<dt>CUPS_CSPACE_ICC8 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 8 colors </dd> -<dt>CUPS_CSPACE_ICC9 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 9 colors </dd> -<dt>CUPS_CSPACE_ICCA <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 10 colors </dd> -<dt>CUPS_CSPACE_ICCB <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 11 colors </dd> -<dt>CUPS_CSPACE_ICCC <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 12 colors </dd> -<dt>CUPS_CSPACE_ICCD <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 13 colors </dd> -<dt>CUPS_CSPACE_ICCE <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 14 colors </dd> -<dt>CUPS_CSPACE_ICCF <span class="info"> CUPS 1.1.19/macOS 10.3 </span></dt> -<dd class="description">ICC-based, 15 colors </dd> -<dt>CUPS_CSPACE_K </dt> -<dd class="description">Black (DeviceK)</dd> -<dt>CUPS_CSPACE_KCMY <span class="info"> DEPRECATED </span></dt> -<dd class="description">Black, cyan, magenta, yellow </dd> -<dt>CUPS_CSPACE_KCMYcm <span class="info"> DEPRECATED </span></dt> -<dd class="description">Black, cyan, magenta, yellow, light-cyan, light-magenta </dd> -<dt>CUPS_CSPACE_RGB </dt> -<dd class="description">Red, green, blue (DeviceRGB, sRGB by default)</dd> -<dt>CUPS_CSPACE_RGBA </dt> -<dd class="description">Red, green, blue, alpha (DeviceRGB, sRGB by default)</dd> -<dt>CUPS_CSPACE_RGBW <span class="info"> CUPS 1.2/macOS 10.5 </span></dt> -<dd class="description">Red, green, blue, white (DeviceRGB, sRGB by default) </dd> -<dt>CUPS_CSPACE_SILVER <span class="info"> DEPRECATED </span></dt> -<dd class="description">Silver foil </dd> -<dt>CUPS_CSPACE_SRGB <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">Red, green, blue (sRGB) </dd> -<dt>CUPS_CSPACE_SW <span class="info"> CUPS 1.4.5 </span></dt> -<dd class="description">Luminance (gamma 2.2) </dd> -<dt>CUPS_CSPACE_W </dt> -<dd class="description">Luminance (DeviceGray, gamma 2.2 by default)</dd> -<dt>CUPS_CSPACE_WHITE <span class="info"> DEPRECATED </span></dt> -<dd class="description">White ink (as black) </dd> -<dt>CUPS_CSPACE_YMC <span class="info"> DEPRECATED </span></dt> -<dd class="description">Yellow, magenta, cyan </dd> -<dt>CUPS_CSPACE_YMCK <span class="info"> DEPRECATED </span></dt> -<dd class="description">Yellow, magenta, cyan, black </dd> -</dl> -<h3 class="enumeration"><a name="cups_cut_e">cups_cut_e</a></h3> -<p class="description">CutMedia attribute values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_CUT_FILE </dt> -<dd class="description">Cut the roll after this file</dd> -<dt>CUPS_CUT_JOB </dt> -<dd class="description">Cut the roll after this job</dd> -<dt>CUPS_CUT_NONE </dt> -<dd class="description">Never cut the roll</dd> -<dt>CUPS_CUT_PAGE </dt> -<dd class="description">Cut the roll after this page</dd> -<dt>CUPS_CUT_SET </dt> -<dd class="description">Cut the roll after this set</dd> -</dl> -<h3 class="enumeration"><a name="cups_edge_e">cups_edge_e</a></h3> -<p class="description">LeadingEdge attribute values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_EDGE_BOTTOM </dt> -<dd class="description">Leading edge is the bottom of the page</dd> -<dt>CUPS_EDGE_LEFT </dt> -<dd class="description">Leading edge is the left of the page</dd> -<dt>CUPS_EDGE_RIGHT </dt> -<dd class="description">Leading edge is the right of the page</dd> -<dt>CUPS_EDGE_TOP </dt> -<dd class="description">Leading edge is the top of the page</dd> -</dl> -<h3 class="enumeration"><a name="cups_jog_e">cups_jog_e</a></h3> -<p class="description">Jog attribute values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_JOG_FILE </dt> -<dd class="description">Move pages after this file</dd> -<dt>CUPS_JOG_JOB </dt> -<dd class="description">Move pages after this job</dd> -<dt>CUPS_JOG_NONE </dt> -<dd class="description">Never move pages</dd> -<dt>CUPS_JOG_SET </dt> -<dd class="description">Move pages after this set</dd> -</dl> -<h3 class="enumeration"><a name="cups_mode_e">cups_mode_e</a></h3> -<p class="description">cupsRasterOpen modes</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_RASTER_READ </dt> -<dd class="description">Open stream for reading</dd> -<dt>CUPS_RASTER_WRITE </dt> -<dd class="description">Open stream for writing</dd> -<dt>CUPS_RASTER_WRITE_COMPRESSED <span class="info"> CUPS 1.3/macOS 10.5 </span></dt> -<dd class="description">Open stream for compressed writing </dd> -<dt>CUPS_RASTER_WRITE_PWG <span class="info"> CUPS 1.5/macOS 10.7 </span></dt> -<dd class="description">Open stream for compressed writing in PWG Raster mode </dd> -</dl> -<h3 class="enumeration"><a name="cups_order_e">cups_order_e</a></h3> -<p class="description">cupsColorOrder attribute values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_ORDER_BANDED </dt> -<dd class="description">CCC MMM YYY KKK ...</dd> -<dt>CUPS_ORDER_CHUNKED </dt> -<dd class="description">CMYK CMYK CMYK ...</dd> -<dt>CUPS_ORDER_PLANAR </dt> -<dd class="description">CCC ... MMM ... YYY ... KKK ...</dd> -</dl> -<h3 class="enumeration"><a name="cups_orient_e">cups_orient_e</a></h3> -<p class="description">Orientation attribute values</p> -<h4 class="constants">Constants</h4> -<dl> -<dt>CUPS_ORIENT_0 </dt> -<dd class="description">Don't rotate the page</dd> -<dt>CUPS_ORIENT_180 </dt> -<dd class="description">Turn the page upside down</dd> -<dt>CUPS_ORIENT_270 </dt> -<dd class="description">Rotate the page clockwise</dd> -<dt>CUPS_ORIENT_90 </dt> -<dd class="description">Rotate the page counter-clockwise</dd> -</dl> -</div> -</body> +<table class="list"><tbody> +<tr><th>AdvanceDistance </th> + <td class="description">AdvanceDistance value in points</td></tr> +<tr><th>AdvanceMedia </th> + <td class="description">AdvanceMedia value (<a href="#cups_adv_t"><code>cups_adv_t</code></a>)</td></tr> +<tr><th>Collate </th> + <td class="description">Collated copies value</td></tr> +<tr><th>CutMedia </th> + <td class="description">CutMedia value (<a href="#cups_cut_t"><code>cups_cut_t</code></a>)</td></tr> +<tr><th>Duplex </th> + <td class="description">Duplexed (double-sided) value</td></tr> +<tr><th>HWResolution[2] </th> + <td class="description">Resolution in dots-per-inch</td></tr> +<tr><th>ImagingBoundingBox[4] </th> + <td class="description">Pixel region that is painted (points, left, bottom, right, top)</td></tr> +<tr><th>InsertSheet </th> + <td class="description">InsertSheet value</td></tr> +<tr><th>Jog </th> + <td class="description">Jog value (<a href="#cups_jog_t"><code>cups_jog_t</code></a>)</td></tr> +<tr><th>LeadingEdge </th> + <td class="description">LeadingEdge value (<a href="#cups_edge_t"><code>cups_edge_t</code></a>)</td></tr> +<tr><th>ManualFeed </th> + <td class="description">ManualFeed value</td></tr> +<tr><th>Margins[2] </th> + <td class="description">Lower-lefthand margins in points</td></tr> +<tr><th>MediaClass[64] </th> + <td class="description">MediaClass string</td></tr> +<tr><th>MediaColor[64] </th> + <td class="description">MediaColor string</td></tr> +<tr><th>MediaPosition </th> + <td class="description">MediaPosition value</td></tr> +<tr><th>MediaType[64] </th> + <td class="description">MediaType string</td></tr> +<tr><th>MediaWeight </th> + <td class="description">MediaWeight value in grams/m^2</td></tr> +<tr><th>MirrorPrint </th> + <td class="description">MirrorPrint value</td></tr> +<tr><th>NegativePrint </th> + <td class="description">NegativePrint value</td></tr> +<tr><th>NumCopies </th> + <td class="description">Number of copies to produce</td></tr> +<tr><th>Orientation </th> + <td class="description">Orientation value (<a href="#cups_orient_t"><code>cups_orient_t</code></a>)</td></tr> +<tr><th>OutputFaceUp </th> + <td class="description">OutputFaceUp value</td></tr> +<tr><th>OutputType[64] </th> + <td class="description">OutputType string</td></tr> +<tr><th>PageSize[2] </th> + <td class="description">Width and length of page in points</td></tr> +<tr><th>Separations </th> + <td class="description">Separations value</td></tr> +<tr><th>TraySwitch </th> + <td class="description">TraySwitch value</td></tr> +<tr><th>Tumble </th> + <td class="description">Tumble value</td></tr> +<tr><th>cupsBitsPerColor </th> + <td class="description">Number of bits for each color</td></tr> +<tr><th>cupsBitsPerPixel </th> + <td class="description">Number of bits for each pixel</td></tr> +<tr><th>cupsBytesPerLine </th> + <td class="description">Number of bytes per line</td></tr> +<tr><th>cupsColorOrder </th> + <td class="description">Order of colors</td></tr> +<tr><th>cupsColorSpace </th> + <td class="description">True colorspace</td></tr> +<tr><th>cupsCompression </th> + <td class="description">Device compression to use</td></tr> +<tr><th>cupsHeight </th> + <td class="description">Height of page image in pixels</td></tr> +<tr><th>cupsMediaType </th> + <td class="description">Media type code</td></tr> +<tr><th>cupsRowCount </th> + <td class="description">Rows per band</td></tr> +<tr><th>cupsRowFeed </th> + <td class="description">Feed between bands</td></tr> +<tr><th>cupsRowStep </th> + <td class="description">Spacing between lines</td></tr> +<tr><th>cupsWidth </th> + <td class="description">Width of page image in pixels</td></tr> +</tbody></table> + <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> + <h3 class="enumeration"><a id="cups_adv_e">cups_adv_e</a></h3> + <p class="description">AdvanceMedia attribute values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_ADVANCE_FILE </th> <td class="description">Advance the roll after this file</td></tr> + <tr><th>CUPS_ADVANCE_JOB </th> <td class="description">Advance the roll after this job</td></tr> + <tr><th>CUPS_ADVANCE_NONE </th> <td class="description">Never advance the roll</td></tr> + <tr><th>CUPS_ADVANCE_PAGE </th> <td class="description">Advance the roll after this page</td></tr> + <tr><th>CUPS_ADVANCE_SET </th> <td class="description">Advance the roll after this set</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_bool_e">cups_bool_e</a></h3> + <p class="description">Boolean type</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_FALSE </th> <td class="description">Logical false</td></tr> + <tr><th>CUPS_TRUE </th> <td class="description">Logical true</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_cspace_e">cups_cspace_e</a></h3> + <p class="description">cupsColorSpace attribute values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_CSPACE_ADOBERGB <span class="info"> CUPS 1.4.5 </span></th> <td class="description">Red, green, blue (Adobe RGB) </td></tr> + <tr><th>CUPS_CSPACE_CIELab <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">CIE Lab </td></tr> + <tr><th>CUPS_CSPACE_CIEXYZ <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">CIE XYZ </td></tr> + <tr><th>CUPS_CSPACE_CMY </th> <td class="description">Cyan, magenta, yellow (DeviceCMY)</td></tr> + <tr><th>CUPS_CSPACE_CMYK </th> <td class="description">Cyan, magenta, yellow, black (DeviceCMYK)</td></tr> + <tr><th>CUPS_CSPACE_DEVICE1 <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 1 color </td></tr> + <tr><th>CUPS_CSPACE_DEVICE2 <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 2 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICE3 <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 3 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICE4 <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 4 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICE5 <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 5 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICE6 <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 6 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICE7 <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 7 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICE8 <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 8 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICE9 <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 9 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICEA <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 10 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICEB <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 11 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICEC <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 12 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICED <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 13 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICEE <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 14 colors </td></tr> + <tr><th>CUPS_CSPACE_DEVICEF <span class="info"> CUPS 1.4.5 </span></th> <td class="description">DeviceN, 15 colors </td></tr> + <tr><th>CUPS_CSPACE_GMCK <span class="info"> DEPRECATED </span></th> <td class="description">Gold, magenta, yellow, black </td></tr> + <tr><th>CUPS_CSPACE_GMCS <span class="info"> DEPRECATED </span></th> <td class="description">Gold, magenta, yellow, silver </td></tr> + <tr><th>CUPS_CSPACE_GOLD <span class="info"> DEPRECATED </span></th> <td class="description">Gold foil </td></tr> + <tr><th>CUPS_CSPACE_ICC1 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 1 color </td></tr> + <tr><th>CUPS_CSPACE_ICC2 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 2 colors </td></tr> + <tr><th>CUPS_CSPACE_ICC3 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 3 colors </td></tr> + <tr><th>CUPS_CSPACE_ICC4 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 4 colors </td></tr> + <tr><th>CUPS_CSPACE_ICC5 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 5 colors </td></tr> + <tr><th>CUPS_CSPACE_ICC6 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 6 colors </td></tr> + <tr><th>CUPS_CSPACE_ICC7 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 7 colors </td></tr> + <tr><th>CUPS_CSPACE_ICC8 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 8 colors </td></tr> + <tr><th>CUPS_CSPACE_ICC9 <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 9 colors </td></tr> + <tr><th>CUPS_CSPACE_ICCA <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 10 colors </td></tr> + <tr><th>CUPS_CSPACE_ICCB <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 11 colors </td></tr> + <tr><th>CUPS_CSPACE_ICCC <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 12 colors </td></tr> + <tr><th>CUPS_CSPACE_ICCD <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 13 colors </td></tr> + <tr><th>CUPS_CSPACE_ICCE <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 14 colors </td></tr> + <tr><th>CUPS_CSPACE_ICCF <span class="info"> CUPS 1.1.19/macOS 10.3 </span></th> <td class="description">ICC-based, 15 colors </td></tr> + <tr><th>CUPS_CSPACE_K </th> <td class="description">Black (DeviceK)</td></tr> + <tr><th>CUPS_CSPACE_KCMY <span class="info"> DEPRECATED </span></th> <td class="description">Black, cyan, magenta, yellow </td></tr> + <tr><th>CUPS_CSPACE_KCMYcm <span class="info"> DEPRECATED </span></th> <td class="description">Black, cyan, magenta, yellow, light-cyan, light-magenta </td></tr> + <tr><th>CUPS_CSPACE_RGB </th> <td class="description">Red, green, blue (DeviceRGB, sRGB by default)</td></tr> + <tr><th>CUPS_CSPACE_RGBA </th> <td class="description">Red, green, blue, alpha (DeviceRGB, sRGB by default)</td></tr> + <tr><th>CUPS_CSPACE_RGBW <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Red, green, blue, white (DeviceRGB, sRGB by default) </td></tr> + <tr><th>CUPS_CSPACE_SILVER <span class="info"> DEPRECATED </span></th> <td class="description">Silver foil </td></tr> + <tr><th>CUPS_CSPACE_SRGB <span class="info"> CUPS 1.4.5 </span></th> <td class="description">Red, green, blue (sRGB) </td></tr> + <tr><th>CUPS_CSPACE_SW <span class="info"> CUPS 1.4.5 </span></th> <td class="description">Luminance (gamma 2.2) </td></tr> + <tr><th>CUPS_CSPACE_W </th> <td class="description">Luminance (DeviceGray, gamma 2.2 by default)</td></tr> + <tr><th>CUPS_CSPACE_WHITE <span class="info"> DEPRECATED </span></th> <td class="description">White ink (as black) </td></tr> + <tr><th>CUPS_CSPACE_YMC <span class="info"> DEPRECATED </span></th> <td class="description">Yellow, magenta, cyan </td></tr> + <tr><th>CUPS_CSPACE_YMCK <span class="info"> DEPRECATED </span></th> <td class="description">Yellow, magenta, cyan, black </td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_cut_e">cups_cut_e</a></h3> + <p class="description">CutMedia attribute values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_CUT_FILE </th> <td class="description">Cut the roll after this file</td></tr> + <tr><th>CUPS_CUT_JOB </th> <td class="description">Cut the roll after this job</td></tr> + <tr><th>CUPS_CUT_NONE </th> <td class="description">Never cut the roll</td></tr> + <tr><th>CUPS_CUT_PAGE </th> <td class="description">Cut the roll after this page</td></tr> + <tr><th>CUPS_CUT_SET </th> <td class="description">Cut the roll after this set</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_edge_e">cups_edge_e</a></h3> + <p class="description">LeadingEdge attribute values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_EDGE_BOTTOM </th> <td class="description">Leading edge is the bottom of the page</td></tr> + <tr><th>CUPS_EDGE_LEFT </th> <td class="description">Leading edge is the left of the page</td></tr> + <tr><th>CUPS_EDGE_RIGHT </th> <td class="description">Leading edge is the right of the page</td></tr> + <tr><th>CUPS_EDGE_TOP </th> <td class="description">Leading edge is the top of the page</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_jog_e">cups_jog_e</a></h3> + <p class="description">Jog attribute values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_JOG_FILE </th> <td class="description">Move pages after this file</td></tr> + <tr><th>CUPS_JOG_JOB </th> <td class="description">Move pages after this job</td></tr> + <tr><th>CUPS_JOG_NONE </th> <td class="description">Never move pages</td></tr> + <tr><th>CUPS_JOG_SET </th> <td class="description">Move pages after this set</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_mode_e">cups_mode_e</a></h3> + <p class="description">cupsRasterOpen modes</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_RASTER_READ </th> <td class="description">Open stream for reading</td></tr> + <tr><th>CUPS_RASTER_WRITE </th> <td class="description">Open stream for writing</td></tr> + <tr><th>CUPS_RASTER_WRITE_COMPRESSED <span class="info"> CUPS 1.3/macOS 10.5 </span></th> <td class="description">Open stream for compressed writing </td></tr> + <tr><th>CUPS_RASTER_WRITE_PWG <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">Open stream for compressed writing in PWG Raster mode </td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_order_e">cups_order_e</a></h3> + <p class="description">cupsColorOrder attribute values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_ORDER_BANDED </th> <td class="description">CCC MMM YYY KKK ...</td></tr> + <tr><th>CUPS_ORDER_CHUNKED </th> <td class="description">CMYK CMYK CMYK ...</td></tr> + <tr><th>CUPS_ORDER_PLANAR </th> <td class="description">CCC ... MMM ... YYY ... KKK ...</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="cups_orient_e">cups_orient_e</a></h3> + <p class="description">Orientation attribute values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_ORIENT_0 </th> <td class="description">Don't rotate the page</td></tr> + <tr><th>CUPS_ORIENT_180 </th> <td class="description">Turn the page upside down</td></tr> + <tr><th>CUPS_ORIENT_270 </th> <td class="description">Rotate the page clockwise</td></tr> + <tr><th>CUPS_ORIENT_90 </th> <td class="description">Rotate the page counter-clockwise</td></tr> +</tbody></table> + </div> + </body> </html> diff --git a/doc/help/cupspm.epub b/doc/help/cupspm.epub Binary files differnew file mode 100644 index 0000000..91b73d9 --- /dev/null +++ b/doc/help/cupspm.epub diff --git a/doc/help/cupspm.html b/doc/help/cupspm.html new file mode 100644 index 0000000..d0d6600 --- /dev/null +++ b/doc/help/cupspm.html @@ -0,0 +1,6493 @@ +<!doctype html> +<html> +<!-- SECTION: Programming --> + <head> + <title>CUPS Programming Manual</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="Mini-XML v2.11"> + <meta name="author" content="Michael R Sweet"> + <meta name="copyright" content="Copyright © 2007-2017 by Apple Inc. All Rights Reserved."> + <meta name="version" content="2.2.4"> + <style type="text/css"><!-- +body, p, h1, h2, h3, h4 { + font-family: sans-serif; +} +div.body h1 { + font-size: 250%; + font-weight: bold; + margin: 0; +} +div.body h2 { + font-size: 250%; + margin-top: 1.5em; +} +div.body h3 { + font-size: 150%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h4 { + font-size: 110%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +div.body h5 { + font-size: 100%; + margin-bottom: 0.5em; + margin-top: 1.5em; +} +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%; +} +.class { + border-bottom: solid 2px gray; +} +.constants { +} +.description { + margin-top: 0.5em; +} +.discussion { +} +.enumeration { + border-bottom: solid 2px gray; +} +.function { + border-bottom: solid 2px gray; + margin-bottom: 0; +} +.members { +} +.method { +} +.parameters { +} +.returnvalue { +} +.struct { + border-bottom: solid 2px gray; +} +.typedef { + border-bottom: solid 2px gray; +} +.union { + border-bottom: solid 2px gray; +} +.variable { +} +h1, h2, h3, h4, h5, h6 { + page-break-inside: avoid; +} +blockquote { + border: solid thin gray; + box-shadow: 3px 3px 5px rgba(0,0,0,0.5); + padding: 0px 10px; + page-break-inside: avoid; +} +p code, li code, p.code, pre, ul.code li { + background: rgba(127,127,127,0.1); + border: thin dotted gray; + font-family: monospace; + font-size: 90%; + hyphens: manual; + -webkit-hyphens: manual; + page-break-inside: avoid; +} +p.code, pre, ul.code li { + padding: 10px; +} +p code, li code { + padding: 2px 5px; +} +a:link, a:visited { + text-decoration: none; +} +span.info { + background: black; + border: solid thin black; + color: white; + font-size: 80%; + font-style: italic; + font-weight: bold; + white-space: nowrap; +} +h3 span.info, h4 span.info { + border-top-left-radius: 10px; + border-top-right-radius: 10px; + float: right; + padding: 3px 6px; +} +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; +} +table.list { + border-collapse: collapse; + width: 100%; +} +table.list tr:nth-child(even) { + background: rgba(127,127,127,0.1);]n} +table.list th { + border-right: 2px solid gray; + font-family: monospace; + padding: 5px 10px 5px 2px; + text-align: right; + vertical-align: top; +} +table.list td { + padding: 5px 2px 5px 10px; + text-align: left; + vertical-align: top; +} +h1.title { +} +h2.title { + border-bottom: solid 2px black; +} +h3.title { + border-bottom: solid 2px black; +} +--></style> + </head> + <body> + <h1 class="title">CUPS Programming Manual</h1> + <p>Michael R Sweet</p> + <p>Copyright © 2007-2017 by Apple Inc. All Rights Reserved.</p> + <div class="contents"> + <h2 class="title">Contents</h2> + <ul class="contents"> + <li><a href="#introduction">Introduction</a><ul class="subcontents"> + <li><a href="#guidelines">Guidelines</a></li> + <li><a href="#terms-used-in-this-document">Terms Used in This Document</a></li> + <li><a href="#compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></li> + </ul></li> + <li><a href="#working-with-destinations">Working with Destinations</a><ul class="subcontents"> + <li><a href="#finding-available-destinations">Finding Available Destinations</a></li> + <li><a href="#basic-destination-information">Basic Destination Information</a></li> + <li><a href="#detailed-destination-information">Detailed Destination Information</a></li> + <li><a href="#submitting-a-print-job">Submitting a Print Job</a></li> + </ul></li> + <li><a href="#sending-ipp-requests">Sending IPP Requests</a><ul class="subcontents"> + <li><a href="#connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</a></li> + <li><a href="#creating-an-ipp-request">Creating an IPP Request</a></li> + <li><a href="#sending-the-ipp-request">Sending the IPP Request</a></li> + <li><a href="#processing-the-ipp-response">Processing the IPP Response</a></li> + <li><a href="#authentication">Authentication</a></li> + </ul></li> + <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents"> + <li><a href="#cupsAddDest">cupsAddDest</a></li> + <li><a href="#cupsAddIntegerOption">cupsAddIntegerOption</a></li> + <li><a href="#cupsAddOption">cupsAddOption</a></li> + <li><a href="#cupsCancelDestJob">cupsCancelDestJob</a></li> + <li><a href="#cupsCheckDestSupported">cupsCheckDestSupported</a></li> + <li><a href="#cupsCloseDestJob">cupsCloseDestJob</a></li> + <li><a href="#cupsConnectDest">cupsConnectDest</a></li> + <li><a href="#cupsCopyDest">cupsCopyDest</a></li> + <li><a href="#cupsCopyDestConflicts">cupsCopyDestConflicts</a></li> + <li><a href="#cupsCopyDestInfo">cupsCopyDestInfo</a></li> + <li><a href="#cupsCreateDestJob">cupsCreateDestJob</a></li> + <li><a href="#cupsDoAuthentication">cupsDoAuthentication</a></li> + <li><a href="#cupsEncodeOptions">cupsEncodeOptions</a></li> + <li><a href="#cupsEncodeOptions2">cupsEncodeOptions2</a></li> + <li><a href="#cupsEncryption">cupsEncryption</a></li> + <li><a href="#cupsEnumDests">cupsEnumDests</a></li> + <li><a href="#cupsFindDestDefault">cupsFindDestDefault</a></li> + <li><a href="#cupsFindDestReady">cupsFindDestReady</a></li> + <li><a href="#cupsFindDestSupported">cupsFindDestSupported</a></li> + <li><a href="#cupsFinishDestDocument">cupsFinishDestDocument</a></li> + <li><a href="#cupsFreeDestInfo">cupsFreeDestInfo</a></li> + <li><a href="#cupsFreeDests">cupsFreeDests</a></li> + <li><a href="#cupsFreeJobs">cupsFreeJobs</a></li> + <li><a href="#cupsFreeOptions">cupsFreeOptions</a></li> + <li><a href="#cupsGetDest">cupsGetDest</a></li> + <li><a href="#cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></li> + <li><a href="#cupsGetDestMediaByName">cupsGetDestMediaByName</a></li> + <li><a href="#cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></li> + <li><a href="#cupsGetDestMediaCount">cupsGetDestMediaCount</a></li> + <li><a href="#cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></li> + <li><a href="#cupsGetDestWithURI">cupsGetDestWithURI</a></li> + <li><a href="#cupsGetDests2">cupsGetDests2</a></li> + <li><a href="#cupsGetIntegerOption">cupsGetIntegerOption</a></li> + <li><a href="#cupsGetJobs2">cupsGetJobs2</a></li> + <li><a href="#cupsGetNamedDest">cupsGetNamedDest</a></li> + <li><a href="#cupsGetOption">cupsGetOption</a></li> + <li><a href="#cupsGetPassword2">cupsGetPassword2</a></li> + <li><a href="#cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></li> + <li><a href="#cupsLocalizeDestOption">cupsLocalizeDestOption</a></li> + <li><a href="#cupsLocalizeDestValue">cupsLocalizeDestValue</a></li> + <li><a href="#cupsMakeServerCredentials">cupsMakeServerCredentials</a></li> + <li><a href="#cupsParseOptions">cupsParseOptions</a></li> + <li><a href="#cupsRemoveDest">cupsRemoveDest</a></li> + <li><a href="#cupsRemoveOption">cupsRemoveOption</a></li> + <li><a href="#cupsServer">cupsServer</a></li> + <li><a href="#cupsSetClientCertCB">cupsSetClientCertCB</a></li> + <li><a href="#cupsSetCredentials">cupsSetCredentials</a></li> + <li><a href="#cupsSetDefaultDest">cupsSetDefaultDest</a></li> + <li><a href="#cupsSetDests2">cupsSetDests2</a></li> + <li><a href="#cupsSetEncryption">cupsSetEncryption</a></li> + <li><a href="#cupsSetPasswordCB2">cupsSetPasswordCB2</a></li> + <li><a href="#cupsSetServer">cupsSetServer</a></li> + <li><a href="#cupsSetServerCertCB">cupsSetServerCertCB</a></li> + <li><a href="#cupsSetServerCredentials">cupsSetServerCredentials</a></li> + <li><a href="#cupsSetUser">cupsSetUser</a></li> + <li><a href="#cupsSetUserAgent">cupsSetUserAgent</a></li> + <li><a href="#cupsStartDestDocument">cupsStartDestDocument</a></li> + <li><a href="#cupsUser">cupsUser</a></li> + <li><a href="#cupsUserAgent">cupsUserAgent</a></li> + <li><a href="#httpAcceptConnection">httpAcceptConnection</a></li> + <li><a href="#httpAddCredential">httpAddCredential</a></li> + <li><a href="#httpAddrAny">httpAddrAny</a></li> + <li><a href="#httpAddrClose">httpAddrClose</a></li> + <li><a href="#httpAddrConnect2">httpAddrConnect2</a></li> + <li><a href="#httpAddrCopyList">httpAddrCopyList</a></li> + <li><a href="#httpAddrEqual">httpAddrEqual</a></li> + <li><a href="#httpAddrFamily">httpAddrFamily</a></li> + <li><a href="#httpAddrFreeList">httpAddrFreeList</a></li> + <li><a href="#httpAddrGetList">httpAddrGetList</a></li> + <li><a href="#httpAddrLength">httpAddrLength</a></li> + <li><a href="#httpAddrListen">httpAddrListen</a></li> + <li><a href="#httpAddrLocalhost">httpAddrLocalhost</a></li> + <li><a href="#httpAddrLookup">httpAddrLookup</a></li> + <li><a href="#httpAddrPort">httpAddrPort</a></li> + <li><a href="#httpAddrString">httpAddrString</a></li> + <li><a href="#httpAssembleURI">httpAssembleURI</a></li> + <li><a href="#httpAssembleURIf">httpAssembleURIf</a></li> + <li><a href="#httpAssembleUUID">httpAssembleUUID</a></li> + <li><a href="#httpBlocking">httpBlocking</a></li> + <li><a href="#httpCheck">httpCheck</a></li> + <li><a href="#httpClearCookie">httpClearCookie</a></li> + <li><a href="#httpClearFields">httpClearFields</a></li> + <li><a href="#httpClose">httpClose</a></li> + <li><a href="#httpCompareCredentials">httpCompareCredentials</a></li> + <li><a href="#httpConnect2">httpConnect2</a></li> + <li><a href="#httpCopyCredentials">httpCopyCredentials</a></li> + <li><a href="#httpCredentialsAreValidForName">httpCredentialsAreValidForName</a></li> + <li><a href="#httpCredentialsGetExpiration">httpCredentialsGetExpiration</a></li> + <li><a href="#httpCredentialsGetTrust">httpCredentialsGetTrust</a></li> + <li><a href="#httpCredentialsString">httpCredentialsString</a></li> + <li><a href="#httpDecode64_2">httpDecode64_2</a></li> + <li><a href="#httpDelete">httpDelete</a></li> + <li><a href="#httpEncode64_2">httpEncode64_2</a></li> + <li><a href="#httpEncryption">httpEncryption</a></li> + <li><a href="#httpError">httpError</a></li> + <li><a href="#httpFieldValue">httpFieldValue</a></li> + <li><a href="#httpFlush">httpFlush</a></li> + <li><a href="#httpFlushWrite">httpFlushWrite</a></li> + <li><a href="#httpFreeCredentials">httpFreeCredentials</a></li> + <li><a href="#httpGet">httpGet</a></li> + <li><a href="#httpGetActivity">httpGetActivity</a></li> + <li><a href="#httpGetAddress">httpGetAddress</a></li> + <li><a href="#httpGetAuthString">httpGetAuthString</a></li> + <li><a href="#httpGetBlocking">httpGetBlocking</a></li> + <li><a href="#httpGetContentEncoding">httpGetContentEncoding</a></li> + <li><a href="#httpGetCookie">httpGetCookie</a></li> + <li><a href="#httpGetDateString2">httpGetDateString2</a></li> + <li><a href="#httpGetDateTime">httpGetDateTime</a></li> + <li><a href="#httpGetEncryption">httpGetEncryption</a></li> + <li><a href="#httpGetExpect">httpGetExpect</a></li> + <li><a href="#httpGetFd">httpGetFd</a></li> + <li><a href="#httpGetField">httpGetField</a></li> + <li><a href="#httpGetHostname">httpGetHostname</a></li> + <li><a href="#httpGetKeepAlive">httpGetKeepAlive</a></li> + <li><a href="#httpGetLength2">httpGetLength2</a></li> + <li><a href="#httpGetPending">httpGetPending</a></li> + <li><a href="#httpGetReady">httpGetReady</a></li> + <li><a href="#httpGetRemaining">httpGetRemaining</a></li> + <li><a href="#httpGetState">httpGetState</a></li> + <li><a href="#httpGetStatus">httpGetStatus</a></li> + <li><a href="#httpGetSubField2">httpGetSubField2</a></li> + <li><a href="#httpGetVersion">httpGetVersion</a></li> + <li><a href="#httpGets">httpGets</a></li> + <li><a href="#httpHead">httpHead</a></li> + <li><a href="#httpInitialize">httpInitialize</a></li> + <li><a href="#httpIsChunked">httpIsChunked</a></li> + <li><a href="#httpIsEncrypted">httpIsEncrypted</a></li> + <li><a href="#httpLoadCredentials">httpLoadCredentials</a></li> + <li><a href="#httpOptions">httpOptions</a></li> + <li><a href="#httpPeek">httpPeek</a></li> + <li><a href="#httpPost">httpPost</a></li> + <li><a href="#httpPut">httpPut</a></li> + <li><a href="#httpRead2">httpRead2</a></li> + <li><a href="#httpReadRequest">httpReadRequest</a></li> + <li><a href="#httpReconnect2">httpReconnect2</a></li> + <li><a href="#httpResolveHostname">httpResolveHostname</a></li> + <li><a href="#httpSaveCredentials">httpSaveCredentials</a></li> + <li><a href="#httpSeparateURI">httpSeparateURI</a></li> + <li><a href="#httpSetAuthString">httpSetAuthString</a></li> + <li><a href="#httpSetCookie">httpSetCookie</a></li> + <li><a href="#httpSetCredentials">httpSetCredentials</a></li> + <li><a href="#httpSetDefaultField">httpSetDefaultField</a></li> + <li><a href="#httpSetExpect">httpSetExpect</a></li> + <li><a href="#httpSetField">httpSetField</a></li> + <li><a href="#httpSetKeepAlive">httpSetKeepAlive</a></li> + <li><a href="#httpSetLength">httpSetLength</a></li> + <li><a href="#httpSetTimeout">httpSetTimeout</a></li> + <li><a href="#httpShutdown">httpShutdown</a></li> + <li><a href="#httpStateString">httpStateString</a></li> + <li><a href="#httpStatus">httpStatus</a></li> + <li><a href="#httpURIStatusString">httpURIStatusString</a></li> + <li><a href="#httpUpdate">httpUpdate</a></li> + <li><a href="#httpWait">httpWait</a></li> + <li><a href="#httpWrite2">httpWrite2</a></li> + <li><a href="#httpWriteResponse">httpWriteResponse</a></li> + <li><a href="#ippAddBoolean">ippAddBoolean</a></li> + <li><a href="#ippAddBooleans">ippAddBooleans</a></li> + <li><a href="#ippAddCollection">ippAddCollection</a></li> + <li><a href="#ippAddCollections">ippAddCollections</a></li> + <li><a href="#ippAddDate">ippAddDate</a></li> + <li><a href="#ippAddInteger">ippAddInteger</a></li> + <li><a href="#ippAddIntegers">ippAddIntegers</a></li> + <li><a href="#ippAddOctetString">ippAddOctetString</a></li> + <li><a href="#ippAddOutOfBand">ippAddOutOfBand</a></li> + <li><a href="#ippAddRange">ippAddRange</a></li> + <li><a href="#ippAddRanges">ippAddRanges</a></li> + <li><a href="#ippAddResolution">ippAddResolution</a></li> + <li><a href="#ippAddResolutions">ippAddResolutions</a></li> + <li><a href="#ippAddSeparator">ippAddSeparator</a></li> + <li><a href="#ippAddString">ippAddString</a></li> + <li><a href="#ippAddStringf">ippAddStringf</a></li> + <li><a href="#ippAddStringfv">ippAddStringfv</a></li> + <li><a href="#ippAddStrings">ippAddStrings</a></li> + <li><a href="#ippAttributeString">ippAttributeString</a></li> + <li><a href="#ippContainsInteger">ippContainsInteger</a></li> + <li><a href="#ippContainsString">ippContainsString</a></li> + <li><a href="#ippCopyAttribute">ippCopyAttribute</a></li> + <li><a href="#ippCopyAttributes">ippCopyAttributes</a></li> + <li><a href="#ippCreateRequestedArray">ippCreateRequestedArray</a></li> + <li><a href="#ippDateToTime">ippDateToTime</a></li> + <li><a href="#ippDelete">ippDelete</a></li> + <li><a href="#ippDeleteAttribute">ippDeleteAttribute</a></li> + <li><a href="#ippDeleteValues">ippDeleteValues</a></li> + <li><a href="#ippEnumString">ippEnumString</a></li> + <li><a href="#ippEnumValue">ippEnumValue</a></li> + <li><a href="#ippErrorString">ippErrorString</a></li> + <li><a href="#ippErrorValue">ippErrorValue</a></li> + <li><a href="#ippFindAttribute">ippFindAttribute</a></li> + <li><a href="#ippFindNextAttribute">ippFindNextAttribute</a></li> + <li><a href="#ippFirstAttribute">ippFirstAttribute</a></li> + <li><a href="#ippGetBoolean">ippGetBoolean</a></li> + <li><a href="#ippGetCollection">ippGetCollection</a></li> + <li><a href="#ippGetCount">ippGetCount</a></li> + <li><a href="#ippGetDate">ippGetDate</a></li> + <li><a href="#ippGetGroupTag">ippGetGroupTag</a></li> + <li><a href="#ippGetInteger">ippGetInteger</a></li> + <li><a href="#ippGetName">ippGetName</a></li> + <li><a href="#ippGetOctetString">ippGetOctetString</a></li> + <li><a href="#ippGetOperation">ippGetOperation</a></li> + <li><a href="#ippGetRange">ippGetRange</a></li> + <li><a href="#ippGetRequestId">ippGetRequestId</a></li> + <li><a href="#ippGetResolution">ippGetResolution</a></li> + <li><a href="#ippGetState">ippGetState</a></li> + <li><a href="#ippGetStatusCode">ippGetStatusCode</a></li> + <li><a href="#ippGetString">ippGetString</a></li> + <li><a href="#ippGetValueTag">ippGetValueTag</a></li> + <li><a href="#ippGetVersion">ippGetVersion</a></li> + <li><a href="#ippLength">ippLength</a></li> + <li><a href="#ippNew">ippNew</a></li> + <li><a href="#ippNewRequest">ippNewRequest</a></li> + <li><a href="#ippNewResponse">ippNewResponse</a></li> + <li><a href="#ippNextAttribute">ippNextAttribute</a></li> + <li><a href="#ippOpString">ippOpString</a></li> + <li><a href="#ippOpValue">ippOpValue</a></li> + <li><a href="#ippPort">ippPort</a></li> + <li><a href="#ippRead">ippRead</a></li> + <li><a href="#ippReadFile">ippReadFile</a></li> + <li><a href="#ippReadIO">ippReadIO</a></li> + <li><a href="#ippSetBoolean">ippSetBoolean</a></li> + <li><a href="#ippSetCollection">ippSetCollection</a></li> + <li><a href="#ippSetDate">ippSetDate</a></li> + <li><a href="#ippSetGroupTag">ippSetGroupTag</a></li> + <li><a href="#ippSetInteger">ippSetInteger</a></li> + <li><a href="#ippSetName">ippSetName</a></li> + <li><a href="#ippSetOctetString">ippSetOctetString</a></li> + <li><a href="#ippSetOperation">ippSetOperation</a></li> + <li><a href="#ippSetPort">ippSetPort</a></li> + <li><a href="#ippSetRange">ippSetRange</a></li> + <li><a href="#ippSetRequestId">ippSetRequestId</a></li> + <li><a href="#ippSetResolution">ippSetResolution</a></li> + <li><a href="#ippSetState">ippSetState</a></li> + <li><a href="#ippSetStatusCode">ippSetStatusCode</a></li> + <li><a href="#ippSetString">ippSetString</a></li> + <li><a href="#ippSetStringf">ippSetStringf</a></li> + <li><a href="#ippSetStringfv">ippSetStringfv</a></li> + <li><a href="#ippSetValueTag">ippSetValueTag</a></li> + <li><a href="#ippSetVersion">ippSetVersion</a></li> + <li><a href="#ippStateString">ippStateString</a></li> + <li><a href="#ippTagString">ippTagString</a></li> + <li><a href="#ippTagValue">ippTagValue</a></li> + <li><a href="#ippTimeToDate">ippTimeToDate</a></li> + <li><a href="#ippValidateAttribute">ippValidateAttribute</a></li> + <li><a href="#ippValidateAttributes">ippValidateAttributes</a></li> + <li><a href="#ippWrite">ippWrite</a></li> + <li><a href="#ippWriteFile">ippWriteFile</a></li> + <li><a href="#ippWriteIO">ippWriteIO</a></li> + </ul></li> + <li><a href="#TYPES">Data Types</a><ul class="subcontents"> + <li><a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a></li> + <li><a href="#cups_dest_cb_t">cups_dest_cb_t</a></li> + <li><a href="#cups_dest_t">cups_dest_t</a></li> + <li><a href="#cups_dinfo_t">cups_dinfo_t</a></li> + <li><a href="#cups_job_t">cups_job_t</a></li> + <li><a href="#cups_option_t">cups_option_t</a></li> + <li><a href="#cups_password_cb2_t">cups_password_cb2_t</a></li> + <li><a href="#cups_ptype_t">cups_ptype_t</a></li> + <li><a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a></li> + <li><a href="#cups_size_t">cups_size_t</a></li> + <li><a href="#http_addr_t">http_addr_t</a></li> + <li><a href="#http_encoding_t">http_encoding_t</a></li> + <li><a href="#http_encryption_t">http_encryption_t</a></li> + <li><a href="#http_field_t">http_field_t</a></li> + <li><a href="#http_keepalive_t">http_keepalive_t</a></li> + <li><a href="#http_state_t">http_state_t</a></li> + <li><a href="#http_t">http_t</a></li> + <li><a href="#http_timeout_cb_t">http_timeout_cb_t</a></li> + <li><a href="#http_trust_t">http_trust_t</a></li> + <li><a href="#http_uri_coding_t">http_uri_coding_t</a></li> + <li><a href="#http_uri_status_t">http_uri_status_t</a></li> + <li><a href="#ipp_attribute_t">ipp_attribute_t</a></li> + <li><a href="#ipp_copycb_t">ipp_copycb_t</a></li> + <li><a href="#ipp_iocb_t">ipp_iocb_t</a></li> + <li><a href="#ipp_orient_t">ipp_orient_t</a></li> + <li><a href="#ipp_pstate_t">ipp_pstate_t</a></li> + <li><a href="#ipp_quality_t">ipp_quality_t</a></li> + <li><a href="#ipp_res_t">ipp_res_t</a></li> + <li><a href="#ipp_state_t">ipp_state_t</a></li> + <li><a href="#ipp_t">ipp_t</a></li> + </ul></li> + <li><a href="#STRUCTURES">Structures</a><ul class="subcontents"> + <li><a href="#cups_dest_s">cups_dest_s</a></li> + <li><a href="#cups_job_s">cups_job_s</a></li> + <li><a href="#cups_option_s">cups_option_s</a></li> + <li><a href="#cups_size_s">cups_size_s</a></li> + </ul></li> + <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> + <li><a href="#cups_ptype_e">cups_ptype_e</a></li> + <li><a href="#http_encoding_e">http_encoding_e</a></li> + <li><a href="#http_encryption_e">http_encryption_e</a></li> + <li><a href="#http_field_e">http_field_e</a></li> + <li><a href="#http_keepalive_e">http_keepalive_e</a></li> + <li><a href="#http_state_e">http_state_e</a></li> + <li><a href="#http_status_e">http_status_e</a></li> + <li><a href="#http_trust_e">http_trust_e</a></li> + <li><a href="#http_uri_coding_e">http_uri_coding_e</a></li> + <li><a href="#http_uri_status_e">http_uri_status_e</a></li> + <li><a href="#ipp_finishings_e">ipp_finishings_e</a></li> + <li><a href="#ipp_jstate_e">ipp_jstate_e</a></li> + <li><a href="#ipp_op_e">ipp_op_e</a></li> + <li><a href="#ipp_orient_e">ipp_orient_e</a></li> + <li><a href="#ipp_pstate_e">ipp_pstate_e</a></li> + <li><a href="#ipp_quality_e">ipp_quality_e</a></li> + <li><a href="#ipp_res_e">ipp_res_e</a></li> + <li><a href="#ipp_state_e">ipp_state_e</a></li> + <li><a href="#ipp_status_e">ipp_status_e</a></li> + <li><a href="#ipp_tag_e">ipp_tag_e</a></li> + </ul></li> + </ul> + </div> + <div class="body"> + <blockquote> + <p>Please <a href="https://github.com/apple/cups/issues">file issues on Github</a> to provide feedback on this document.</p> +</blockquote> + <h2><a id="introduction">Introduction</a></h2> + <p>CUPS provides the "cups" library to talk to the different parts of CUPS and with Internet Printing Protocol (IPP) printers. The "cups" library functions are accessed by including the <code><cups/cups.h></code> header.</p> + <p>CUPS is based on the Internet Printing Protocol ("IPP"), which allows clients (applications) to communicate with a server (the scheduler, printers, etc.) to get a list of destinations, send print jobs, and so forth. You identify which server you want to communicate with using a pointer to the opaque structure <code>http_t</code>. The <code>CUPS_HTTP_DEFAULT</code> constant can be used when you want to talk to the CUPS scheduler.</p> + <h3><a id="guidelines">Guidelines</a></h3> + <p>When writing software that uses the "cups" library:</p> + <ul> + <li>Do not use undocumented or deprecated APIs,</li> + <li>Do not rely on pre-configured printers,</li> + <li>Do not assume that printers support specific features or formats, and</li> + <li>Do not rely on implementation details (PPDs, etc.)</li> +</ul> + <p>CUPS is designed to insulate users and developers from the implementation details of printers and file formats. The goal is to allow an application to supply a print file in a standard format with the user intent ("print four copies, two-sided on A4 media, and staple each copy") and have the printing system manage the printer communication and format conversion needed.</p> + <p>Similarly, printer and job management applications can use standard query operations to obtain the status information in a common, generic form and use standard management operations to control the state of those printers and jobs.</p> + <h3><a id="terms-used-in-this-document">Terms Used in This Document</a></h3> + <p>A <em>Destination</em> is a printer or print queue that accepts print jobs. A <em>Print</em> <em>Job</em> is one or more documents that are processed by a destination using options supplied when creating the job. A <em>Document</em> is a file (JPEG image, PDF file, etc.) suitable for printing. An <em>Option</em> controls some aspect of printing, such as the media used. <em>Media</em> is the sheets or roll that is printed on. An <em>Attribute</em> is an option encoded for an Internet Printing Protocol (IPP) request.</p> + <h3><a id="compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></h3> + <p>The CUPS libraries can be used from any C, C++, or Objective C program. The method of compiling against the libraries varies depending on the operating system and installation of CUPS. The following sections show how to compile a simple program (shown below) in two common environments.</p> + <p>The following simple program lists the available destinations:</p> + <pre><code>#include <stdio.h> +#include <cups/cups.h> + +int print_dest(void *user_data, unsigned flags, cups_dest_t *dest) +{ + if (dest->instance) + printf("%s/%s\n", dest->name, dest->instance); + else + puts(dest->name); + + return (1); +} + +int main(void) +{ + cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, 0, 0, print_dest, NULL); + + return (0); +} +</code></pre> + <h4><a id="compiling-with-xcode">Compiling with Xcode</a></h4> + <p>In Xcode, choose <em>New</em> <em>Project...</em> from the <em>File</em> menu (or press SHIFT+CMD+N), then select the <em>Command</em> <em>Line</em> <em>Tool</em> under the macOS Application project type. Click <em>Next</em> and enter a name for the project, for example "firstcups". Click <em>Next</em> and choose a project directory. The click <em>Next</em> to create the project.</p> + <p>In the project window, click on the <em>Build</em> <em>Phases</em> group and expand the <em>Link</em> <em>Binary</em> <em>with</em> <em>Libraries</em> section. Click <em>+</em>, type "libcups" to show the library, and then double-click on <code>libcups.tbd</code>.</p> + <p>Finally, click on the <code>main.c</code> file in the sidebar and copy the example program to the file. Build and run (CMD+R) to see the list of destinations.</p> + <h4><a id="compiling-with-gcc">Compiling with GCC</a></h4> + <p>From the command-line, create a file called <code>sample.c</code> using your favorite editor, copy the example to this file, and save. Then run the following command to compile it with GCC and run it:</p> + <pre><code>gcc -o simple `cups-config --cflags` simple.c `cups-config --libs` +./simple +</code></pre> + <p>The <code>cups-config</code> command provides the compiler flags (<code>cups-config --cflags</code>) and libraries (<code>cups-config --libs</code>) needed for the local system.</p> + <h2><a id="working-with-destinations">Working with Destinations</a></h2> + <p>Destinations, which in CUPS represent individual printers or classes (collections or pools) of printers, are represented by the <code>cups_dest_t</code> structure which includes the name (<code>name</code>), instance (<code>instance</code>, saved options/settings), whether the destination is the default for the user (<code>is_default</code>), and the options and basic information associated with that destination (<code>num_options</code> and <code>options</code>).</p> + <p>Historically destinations have been manually maintained by the administrator of a system or network, but CUPS also supports dynamic discovery of destinations on the current network.</p> + <h3><a id="finding-available-destinations">Finding Available Destinations</a></h3> + <p>The <code>cupsEnumDests</code> function finds all of the available destinations:</p> + <pre><code> int + cupsEnumDests(unsigned flags, int msec, int *cancel, + cups_ptype_t type, cups_ptype_t mask, + cups_dest_cb_t cb, void *user_data) +</code></pre> + <p>The <code>flags</code> argument specifies enumeration options, which at present must be <code>CUPS_DEST_FLAGS_NONE</code>.</p> + <p>The <code>msec</code> argument specifies the maximum amount of time that should be used for enumeration in milliseconds - interactive applications should keep this value to 5000 or less when run on the main thread.</p> + <p>The <code>cancel</code> argument points to an integer variable that, when set to a non-zero value, will cause enumeration to stop as soon as possible. It can be <code>NULL</code> if not needed.</p> + <p>The <code>type</code> and <code>mask</code> arguments are bitfields that allow the caller to filter the destinations based on categories and/or capabilities. The destination's "printer-type" value is masked by the <code>mask</code> value and compared to the <code>type</code> value when filtering. For example, to only enumerate destinations that are hosted on the local system, pass <code>CUPS_PRINTER_LOCAL</code> for the <code>type</code> argument and <code>CUPS_PRINTER_DISCOVERED</code> for the <code>mask</code> argument. The following constants can be used for filtering:</p> + <ul> + <li><code>CUPS_PRINTER_CLASS</code>: A collection of destinations.</li> + <li><code>CUPS_PRINTER_FAX</code>: A facsimile device.</li> + <li><code>CUPS_PRINTER_LOCAL</code>: A local printer or class. This constant has the value 0 (no bits set) and is only used for the <code>type</code> argument and is paired with the <code>CUPS_PRINTER_REMOTE</code> or <code>CUPS_PRINTER_DISCOVERED</code> constant passed in the <code>mask</code> argument.</li> + <li><code>CUPS_PRINTER_REMOTE</code>: A remote (shared) printer or class.</li> + <li><code>CUPS_PRINTER_DISCOVERED</code>: An available network printer or class.</li> + <li><code>CUPS_PRINTER_BW</code>: Can do B&W printing.</li> + <li><code>CUPS_PRINTER_COLOR</code>: Can do color printing.</li> + <li><code>CUPS_PRINTER_DUPLEX</code>: Can do two-sided printing.</li> + <li><code>CUPS_PRINTER_STAPLE</code>: Can staple output.</li> + <li><code>CUPS_PRINTER_COLLATE</code>: Can quickly collate copies.</li> + <li><code>CUPS_PRINTER_PUNCH</code>: Can punch output.</li> + <li><code>CUPS_PRINTER_COVER</code>: Can cover output.</li> + <li><code>CUPS_PRINTER_BIND</code>: Can bind output.</li> + <li><code>CUPS_PRINTER_SORT</code>: Can sort output (mailboxes, etc.)</li> + <li><code>CUPS_PRINTER_SMALL</code>: Can print on Letter/Legal/A4-size media.</li> + <li><code>CUPS_PRINTER_MEDIUM</code>: Can print on Tabloid/B/C/A3/A2-size media.</li> + <li><code>CUPS_PRINTER_LARGE</code>: Can print on D/E/A1/A0-size media.</li> + <li><code>CUPS_PRINTER_VARIABLE</code>: Can print on rolls and custom-size media.</li> +</ul> + <p>The <code>cb</code> argument specifies a function to call for every destination that is found:</p> + <pre><code>typedef int (*cups_dest_cb_t)(void *user_data, + unsigned flags, + cups_dest_t *dest); +</code></pre> + <p>The callback function receives a copy of the <code>user_data</code> argument along with a bitfield (<code>flags</code>) and the destination that was found. The <code>flags</code> argument can have any of the following constant (bit) values set:</p> + <ul> + <li><code>CUPS_DEST_FLAGS_MORE</code>: There are more destinations coming.</li> + <li><code>CUPS_DEST_FLAGS_REMOVED</code>: The destination has gone away and should be removed from the list of destinations a user can select.</li> + <li><code>CUPS_DEST_FLAGS_ERROR</code>: An error occurred. The reason for the error can be found by calling the <code>cupsLastError</code> and/or <code>cupsLastErrorString</code> functions.</li> +</ul> + <p>The callback function returns 0 to stop enumeration or 1 to continue.</p> + <blockquote> + <p>Note that the callback function will likely be called multiple times for the same destination, so it is up to the caller to suppress any duplicate destinations.</p> +</blockquote> + <p>The following example shows how to use <code>cupsEnumDests</code> to get a filtered array of destinations:</p> + <pre><code>typedef struct +{ + int num_dests; + cups_dest_t *dests; +} my_user_data_t; + +int +my_dest_cb(my_user_data_t *user_data, unsigned flags, + cups_dest_t *dest) +{ + if (flags & CUPS_DEST_FLAGS_REMOVED) + { + /* + * Remove destination from array... + */ + + user_data->num_dests = + cupsRemoveDest(dest->name, dest->instance, + user_data->num_dests, + &(user_data->dests)); + } + else + { + /* + * Add destination to array... + */ + + user_data->num_dests = + cupsCopyDest(dest, user_data->num_dests, + &(user_data->dests)); + } + + return (1); +} + +int +my_get_dests(cups_ptype_t type, cups_ptype_t mask, + cups_dest_t **dests) +{ + my_user_data_t user_data = { 0, NULL }; + + if (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, type, + mask, (cups_dest_cb_t)my_dest_cb, + &user_data)) + { + /* + * An error occurred, free all of the destinations and + * return... + */ + + cupsFreeDests(user_data.num_dests, user_dasta.dests); + + *dests = NULL; + + return (0); + } + + /* + * Return the destination array... + */ + + *dests = user_data.dests; + + return (user_data.num_dests); +} +</code></pre> + <h3><a id="basic-destination-information">Basic Destination Information</a></h3> + <p>The <code>num_options</code> and <code>options</code> members of the <code>cups_dest_t</code> structure provide basic attributes about the destination in addition to the user default options and values for that destination. The following names are predefined for various destination attributes:</p> + <ul> + <li>"auth-info-required": The type of authentication required for printing to this destination: "none", "username,password", "domain,username,password", or "negotiate" (Kerberos).</li> + <li>"printer-info": The human-readable description of the destination such as "My Laser Printer".</li> + <li>"printer-is-accepting-jobs": "true" if the destination is accepting new jobs, "false" otherwise.</li> + <li>"printer-is-shared": "true" if the destination is being shared with other computers, "false" otherwise.</li> + <li>"printer-location": The human-readable location of the destination such as "Lab 4".</li> + <li>"printer-make-and-model": The human-readable make and model of the destination such as "ExampleCorp LaserPrinter 4000 Series".</li> + <li>"printer-state": "3" if the destination is idle, "4" if the destination is printing a job, and "5" if the destination is stopped.</li> + <li>"printer-state-change-time": The UNIX time when the destination entered the current state.</li> + <li>"printer-state-reasons": Additional comma-delimited state keywords for the destination such as "media-tray-empty-error" and "toner-low-warning".</li> + <li>"printer-type": The <code>cups_ptype_t</code> value associated with the destination.</li> + <li>"printer-uri-supported": The URI associated with the destination; if not set, this destination was discovered but is not yet setup as a local printer.</li> +</ul> + <p>Use the <code>cupsGetOption</code> function to retrieve the value. For example, the following code gets the make and model of a destination:</p> + <pre><code>const char *model = cupsGetOption("printer-make-and-model", + dest->num_options, + dest->options); +</code></pre> + <h3><a id="detailed-destination-information">Detailed Destination Information</a></h3> + <p>Once a destination has been chosen, the <code>cupsCopyDestInfo</code> function can be used to gather detailed information about the destination:</p> + <pre><code>cups_dinfo_t * +cupsCopyDestInfo(http_t *http, cups_dest_t *dest); +</code></pre> + <p>The <code>http</code> argument specifies a connection to the CUPS scheduler and is typically the constant <code>CUPS_HTTP_DEFAULT</code>. The <code>dest</code> argument specifies the destination to query.</p> + <p>The <code>cups_dinfo_t</code> structure that is returned contains a snapshot of the supported options and their supported, ready, and default values. It also can report constraints between different options and values, and recommend changes to resolve those constraints.</p> + <h4><a id="getting-supported-options-and-values">Getting Supported Options and Values</a></h4> + <p>The <code>cupsCheckDestSupported</code> function can be used to test whether a particular option or option and value is supported:</p> + <pre><code>int +cupsCheckDestSupported(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, + const char *option, + const char *value); +</code></pre> + <p>The <code>option</code> argument specifies the name of the option to check. The following constants can be used to check the various standard options:</p> + <ul> + <li><code>CUPS_COPIES</code>: Controls the number of copies that are produced.</li> + <li><code>CUPS_FINISHINGS</code>: A comma-delimited list of integer constants that control the finishing processes that are applied to the job, including stapling, punching, and folding.</li> + <li><code>CUPS_MEDIA</code>: Controls the media size that is used, typically one of the following: <code>CUPS_MEDIA_3X5</code>, <code>CUPS_MEDIA_4X6</code>, <code>CUPS_MEDIA_5X7</code>, <code>CUPS_MEDIA_8X10</code>, <code>CUPS_MEDIA_A3</code>, <code>CUPS_MEDIA_A4</code>, <code>CUPS_MEDIA_A5</code>, <code>CUPS_MEDIA_A6</code>, <code>CUPS_MEDIA_ENV10</code>, <code>CUPS_MEDIA_ENVDL</code>, <code>CUPS_MEDIA_LEGAL</code>, <code>CUPS_MEDIA_LETTER</code>, <code>CUPS_MEDIA_PHOTO_L</code>, <code>CUPS_MEDIA_SUPERBA3</code>, or <code>CUPS_MEDIA_TABLOID</code>.</li> + <li><code>CUPS_MEDIA_SOURCE</code>: Controls where the media is pulled from, typically either <code>CUPS_MEDIA_SOURCE_AUTO</code> or <code>CUPS_MEDIA_SOURCE_MANUAL</code>.</li> + <li><code>CUPS_MEDIA_TYPE</code>: Controls the type of media that is used, typically one of the following: <code>CUPS_MEDIA_TYPE_AUTO</code>, <code>CUPS_MEDIA_TYPE_ENVELOPE</code>, <code>CUPS_MEDIA_TYPE_LABELS</code>, <code>CUPS_MEDIA_TYPE_LETTERHEAD</code>, <code>CUPS_MEDIA_TYPE_PHOTO</code>, <code>CUPS_MEDIA_TYPE_PHOTO_GLOSSY</code>, <code>CUPS_MEDIA_TYPE_PHOTO_MATTE</code>, <code>CUPS_MEDIA_TYPE_PLAIN</code>, or <code>CUPS_MEDIA_TYPE_TRANSPARENCY</code>.</li> + <li><code>CUPS_NUMBER_UP</code>: Controls the number of document pages that are placed on each media side.</li> + <li><code>CUPS_ORIENTATION</code>: Controls the orientation of document pages placed on the media: <code>CUPS_ORIENTATION_PORTRAIT</code> or <code>CUPS_ORIENTATION_LANDSCAPE</code>.</li> + <li><code>CUPS_PRINT_COLOR_MODE</code>: Controls whether the output is in color (<code>CUPS_PRINT_COLOR_MODE_COLOR</code>), grayscale (<code>CUPS_PRINT_COLOR_MODE_MONOCHROME</code>), or either (<code>CUPS_PRINT_COLOR_MODE_AUTO</code>).</li> + <li><code>CUPS_PRINT_QUALITY</code>: Controls the generate quality of the output: <code>CUPS_PRINT_QUALITY_DRAFT</code>, <code>CUPS_PRINT_QUALITY_NORMAL</code>, or <code>CUPS_PRINT_QUALITY_HIGH</code>.</li> + <li><code>CUPS_SIDES</code>: Controls whether prints are placed on one or both sides of the media: <code>CUPS_SIDES_ONE_SIDED</code>, <code>CUPS_SIDES_TWO_SIDED_PORTRAIT</code>, or <code>CUPS_SIDES_TWO_SIDED_LANDSCAPE</code>.</li> +</ul> + <p>If the <code>value</code> argument is <code>NULL</code>, the <code>cupsCheckDestSupported</code> function returns whether the option is supported by the destination. Otherwise, the function returns whether the specified value of the option is supported.</p> + <p>The <code>cupsFindDestSupported</code> function returns the IPP attribute containing the supported values for a given option:</p> + <pre><code> ipp_attribute_t * + cupsFindDestSupported(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, + const char *option); +</code></pre> + <p>For example, the following code prints the supported finishing processes for a destination, if any, to the standard output:</p> + <pre><code>cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT, + dest); + +if (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info, + CUPS_FINISHINGS, NULL)) +{ + ipp_attribute_t *finishings = + cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, + CUPS_FINISHINGS); + int i, count = ippGetCount(finishings); + + puts("finishings supported:"); + for (i = 0; i < count; i ++) + printf(" %d\n", ippGetInteger(finishings, i)); +} +else + puts("finishings not supported."); +</code></pre> + <p>The "job-creation-attributes" option can be queried to get a list of supported options. For example, the following code prints the list of supported options to the standard output:</p> + <pre><code>ipp_attribute_t *attrs = + cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, + "job-creation-attributes"); +int i, count = ippGetCount(attrs); + +for (i = 0; i < count; i ++) + puts(ippGetString(attrs, i, NULL)); +</code></pre> + <h4><a id="getting-default-values">Getting Default Values</a></h4> + <p>There are two sets of default values - user defaults that are available via the <code>num_options</code> and <code>options</code> members of the <code>cups_dest_t</code> structure, and destination defaults that available via the <code>cups_dinfo_t</code> structure and the <code>cupsFindDestDefault</code> function which returns the IPP attribute containing the default value(s) for a given option:</p> + <pre><code>ipp_attribute_t * +cupsFindDestDefault(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, + const char *option); +</code></pre> + <p>The user defaults from <code>cupsGetOption</code> should always take preference over the destination defaults. For example, the following code prints the default finishings value(s) to the standard output:</p> + <pre><code>const char *def_value = + cupsGetOption(CUPS_FINISHINGS, dest->num_options, + dest->options); +ipp_attribute_t *def_attr = + cupsFindDestDefault(CUPS_HTTP_DEFAULT, dest, info, + CUPS_FINISHINGS); + +if (def_value != NULL) +{ + printf("Default finishings: %s\n", def_value); +} +else +{ + int i, count = ippGetCount(def_attr); + + printf("Default finishings: %d", + ippGetInteger(def_attr, 0)); + for (i = 1; i < count; i ++) + printf(",%d", ippGetInteger(def_attr, i)); + putchar('\n'); +} +</code></pre> + <h4><a id="getting-ready-loaded-values">Getting Ready (Loaded) Values</a></h4> + <p>The finishings and media options also support queries for the ready, or loaded, values. For example, a printer may have punch and staple finishers installed but be out of staples - the supported values will list both punch and staple finishing processes but the ready values will only list the punch processes. Similarly, a printer may support hundreds of different sizes of media but only have a single size loaded at any given time - the ready values are limited to the media that is actually in the printer.</p> + <p>The <code>cupsFindDestReady</code> function finds the IPP attribute containing the ready values for a given option:</p> + <pre><code>ipp_attribute_t * +cupsFindDestReady(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, const char *option); +</code></pre> + <p>For example, the following code lists the ready finishing processes:</p> + <pre><code>ipp_attribute_t *ready_finishings = + cupsFindDestReady(CUPS_HTTP_DEFAULT, dest, info, + CUPS_FINISHINGS); + +if (ready_finishings != NULL) +{ + int i, count = ippGetCount(ready_finishings); + + puts("finishings ready:"); + for (i = 0; i < count; i ++) + printf(" %d\n", ippGetInteger(ready_finishings, i)); +} +else + puts("no finishings are ready."); +</code></pre> + <h4><a id="media-size-options">Media Size Options</a></h4> + <p>CUPS provides functions for querying the dimensions and margins for each of the supported media size options. The <code>cups_size_t</code> structure is used to describe a media size:</p> + <pre><code>typedef struct cups_size_s +{ + char media[128]; + int width, length; + int bottom, left, right, top; +} cups_size_t; +</code></pre> + <p>The <code>width</code> and <code>length</code> members specify the dimensions of the media in hundredths of millimeters (1/2540th of an inch). The <code>bottom</code>, <code>left</code>, <code>right</code>, and <code>top</code> members specify the margins of the printable area, also in hundredths of millimeters.</p> + <p>The <code>cupsGetDestMediaByName</code> and <code>cupsGetDestMediaBySize</code> functions lookup the media size information using a standard media size name or dimensions in hundredths of millimeters:</p> + <pre><code>int +cupsGetDestMediaByName(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, + const char *media, + unsigned flags, cups_size_t *size); + +int +cupsGetDestMediaBySize(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, + int width, int length, + unsigned flags, cups_size_t *size); +</code></pre> + <p>The <code>media</code>, <code>width</code>, and <code>length</code> arguments specify the size to lookup. The <code>flags</code> argument specifies a bitfield controlling various lookup options:</p> + <ul> + <li><code>CUPS_MEDIA_FLAGS_DEFAULT</code>: Find the closest size supported by the printer.</li> + <li><code>CUPS_MEDIA_FLAGS_BORDERLESS</code>: Find a borderless size.</li> + <li><code>CUPS_MEDIA_FLAGS_DUPLEX</code>: Find a size compatible with two-sided printing.</li> + <li><code>CUPS_MEDIA_FLAGS_EXACT</code>: Find an exact match for the size.</li> + <li><code>CUPS_MEDIA_FLAGS_READY</code>: If the printer supports media sensing or configuration of the media in each tray/source, find the size amongst the "ready" media.</li> +</ul> + <p>If a matching size is found for the destination, the size information is stored in the structure pointed to by the <code>size</code> argument and 1 is returned. Otherwise 0 is returned.</p> + <p>For example, the following code prints the margins for two-sided printing on US Letter media:</p> + <pre><code>cups_size_t size; + +if (cupsGetDestMediaByName(CUPS_HTTP_DEFAULT, dest, info, + CUPS_MEDIA_LETTER, + CUPS_MEDIA_FLAGS_DUPLEX, &size)) +{ + puts("Margins for duplex US Letter:"); + printf(" Bottom: %.2fin\n", size.bottom / 2540.0); + printf(" Left: %.2fin\n", size.left / 2540.0); + printf(" Right: %.2fin\n", size.right / 2540.0); + printf(" Top: %.2fin\n", size.top / 2540.0); +} +else + puts("Margins for duplex US Letter are not available."); +</code></pre> + <p>You can also enumerate all of the sizes that match a given <code>flags</code> value using the <code>cupsGetDestMediaByIndex</code> and <code>cupsGetDestMediaCount</code> functions:</p> + <pre><code>int +cupsGetDestMediaByIndex(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, int n, + unsigned flags, cups_size_t *size); + +int +cupsGetDestMediaCount(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, unsigned flags); +</code></pre> + <p>For example, the following code prints the list of ready media and corresponding margins:</p> + <pre><code>cups_size_t size; +int i; +int count = cupsGetDestMediaCount(CUPS_HTTP_DEFAULT, + dest, info, + CUPS_MEDIA_FLAGS_READY); + +for (i = 0; i < count; i ++) +{ + if (cupsGetDestMediaByIndex(CUPS_HTTP_DEFAULT, dest, info, + i, CUPS_MEDIA_FLAGS_READY, + &size)) + { + printf("%s:\n", size.name); + printf(" Width: %.2fin\n", size.width / 2540.0); + printf(" Length: %.2fin\n", size.length / 2540.0); + printf(" Bottom: %.2fin\n", size.bottom / 2540.0); + printf(" Left: %.2fin\n", size.left / 2540.0); + printf(" Right: %.2fin\n", size.right / 2540.0); + printf(" Top: %.2fin\n", size.top / 2540.0); + } +} +</code></pre> + <p>Finally, the <code>cupsGetDestMediaDefault</code> function returns the default media size:</p> + <pre><code>int +cupsGetDestMediaDefault(http_t *http, cups_dest_t *dest, + cups_dinfo_t *dinfo, unsigned flags, + cups_size_t *size); +</code></pre> + <h4><a id="localizing-options-and-values">Localizing Options and Values</a></h4> + <p>CUPS provides three functions to get localized, human-readable strings in the user's current locale for options and values: <code>cupsLocalizeDestMedia</code>, <code>cupsLocalizeDestOption</code>, and <code>cupsLocalizeDestValue</code>:</p> + <pre><code>const char * +cupsLocalizeDestMedia(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, unsigned flags, + cups_size_t *size); + +const char * +cupsLocalizeDestOption(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, + const char *option); + +const char * +cupsLocalizeDestValue(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, + const char *option, const char *value); +</code></pre> + <h3><a id="submitting-a-print-job">Submitting a Print Job</a></h3> + <p>Once you are ready to submit a print job, you create a job using the <code>cupsCreateDestJob</code> function:</p> + <pre><code>ipp_status_t +cupsCreateDestJob(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, int *job_id, + const char *title, int num_options, + cups_option_t *options); +</code></pre> + <p>The <code>title</code> argument specifies a name for the print job such as "My Document". The <code>num_options</code> and <code>options</code> arguments specify the options for the print job which are allocated using the <code>cupsAddOption</code> function.</p> + <p>When successful, the job's numeric identifier is stored in the integer pointed to by the <code>job_id</code> argument and <code>IPP_STATUS_OK</code> is returned. Otherwise, an IPP error status is returned.</p> + <p>For example, the following code creates a new job that will print 42 copies of a two-sided US Letter document:</p> + <pre><code>int job_id = 0; +int num_options = 0; +cups_option_t *options = NULL; + +num_options = cupsAddOption(CUPS_COPIES, "42", + num_options, &options); +num_options = cupsAddOption(CUPS_MEDIA, CUPS_MEDIA_LETTER, + num_options, &options); +num_options = cupsAddOption(CUPS_SIDES, + CUPS_SIDES_TWO_SIDED_PORTRAIT, + num_options, &options); + +if (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info, + &job_id, "My Document", num_options, + options) == IPP_STATUS_OK) + printf("Created job: %d\n", job_id); +else + printf("Unable to create job: %s\n", + cupsLastErrorString()); +</code></pre> + <p>Once the job is created, you submit documents for the job using the <code>cupsStartDestDocument</code>, <code>cupsWriteRequestData</code>, and <code>cupsFinishDestDocument</code> functions:</p> + <pre><code>http_status_t +cupsStartDestDocument(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info, int job_id, + const char *docname, + const char *format, + int num_options, + cups_option_t *options, + int last_document); + +http_status_t +cupsWriteRequestData(http_t *http, const char *buffer, + size_t length); + +ipp_status_t +cupsFinishDestDocument(http_t *http, cups_dest_t *dest, + cups_dinfo_t *info); +</code></pre> + <p>The <code>docname</code> argument specifies the name of the document, typically the original filename. The <code>format</code> argument specifies the MIME media type of the document, including the following constants:</p> + <ul> + <li><code>CUPS_FORMAT_JPEG</code>: "image/jpeg"</li> + <li><code>CUPS_FORMAT_PDF</code>: "application/pdf"</li> + <li><code>CUPS_FORMAT_POSTSCRIPT</code>: "application/postscript"</li> + <li><code>CUPS_FORMAT_TEXT</code>: "text/plain"</li> +</ul> + <p>The <code>num_options</code> and <code>options</code> arguments specify per-document print options, which at present must be 0 and <code>NULL</code>. The <code>last_document</code> argument specifies whether this is the last document in the job.</p> + <p>For example, the following code submits a PDF file to the job that was just created:</p> + <pre><code>FILE *fp = fopen("filename.pdf", "rb"); +size_t bytes; +char buffer[65536]; + +if (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info, + job_id, "filename.pdf", 0, NULL, + 1) == HTTP_STATUS_CONTINUE) +{ + while ((bytes = fread(buffer, 1, sizeof(buffer), fp)) > 0) + if (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer, + bytes) != HTTP_STATUS_CONTINUE) + break; + + if (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest, + info) == IPP_STATUS_OK) + puts("Document send succeeded."); + else + printf("Document send failed: %s\n", + cupsLastErrorString()); +} + +fclose(fp); +</code></pre> + <h2><a id="sending-ipp-requests">Sending IPP Requests</a></h2> + <p>CUPS provides a rich API for sending IPP requests to the scheduler or printers, typically from management or utility applications whose primary purpose is not to send print jobs.</p> + <h3><a id="connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</a></h3> + <p>The connection to the scheduler or printer is represented by the HTTP connection type <code>http_t</code>. The <code>cupsConnectDest</code> function connects to the scheduler or printer associated with the destination:</p> + <pre><code>http_t * +cupsConnectDest(cups_dest_t *dest, unsigned flags, int msec, + int *cancel, char *resource, + size_t resourcesize, cups_dest_cb_t cb, + void *user_data); +</code></pre> + <p>The <code>dest</code> argument specifies the destination to connect to.</p> + <p>The <code>flags</code> argument specifies whether you want to connect to the scheduler (<code>CUPS_DEST_FLAGS_NONE</code>) or device/printer (<code>CUPS_DEST_FLAGS_DEVICE</code>) associated with the destination.</p> + <p>The <code>msec</code> argument specifies how long you are willing to wait for the connection to be established in milliseconds. Specify a value of <code>-1</code> to wait indefinitely.</p> + <p>The <code>cancel</code> argument specifies the address of an integer variable that can be set to a non-zero value to cancel the connection. Specify a value of <code>NULL</code> to not provide a cancel variable.</p> + <p>The <code>resource</code> and <code>resourcesize</code> arguments specify the address and size of a character string array to hold the path to use when sending an IPP request.</p> + <p>The <code>cb</code> and <code>user_data</code> arguments specify a destination callback function that returns 1 to continue connecting or 0 to stop. The destination callback work the same way as the one used for the <code>cupsEnumDests</code> function.</p> + <p>On success, a HTTP connection is returned that can be used to send IPP requests and get IPP responses.</p> + <p>For example, the following code connects to the printer associated with a destination with a 30 second timeout:</p> + <pre><code>char resource[256]; +http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_DEVICE, + 30000, NULL, resource, + sizeof(resource), NULL, NULL); +</code></pre> + <h3><a id="creating-an-ipp-request">Creating an IPP Request</a></h3> + <p>IPP requests are represented by the IPP message type <code>ipp_t</code> and each IPP attribute in the request is representing using the type <code>ipp_attribute_t</code>. Each IPP request includes an operation code (<code>IPP_OP_CREATE_JOB</code>, <code>IPP_OP_GET_PRINTER_ATTRIBUTES</code>, etc.) and a 32-bit integer identifier.</p> + <p>The <code>ippNewRequest</code> function creates a new IPP request:</p> + <pre><code>ipp_t * +ippNewRequest(ipp_op_t op); +</code></pre> + <p>The <code>op</code> argument specifies the IPP operation code for the request. For example, the following code creates an IPP Get-Printer-Attributes request:</p> + <pre><code>ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES); +</code></pre> + <p>The request identifier is automatically set to a unique value for the current process.</p> + <p>Each IPP request starts with two IPP attributes, "attributes-charset" and "attributes-natural-language", followed by IPP attribute(s) that specify the target of the operation. The <code>ippNewRequest</code> automatically adds the correct "attributes-charset" and "attributes-natural-language" attributes, but you must add the target attribute(s). For example, the following code adds the "printer-uri" attribute to the IPP Get-Printer-Attributes request to specify which printer is being queried:</p> + <pre><code>const char *printer_uri = cupsGetOption("device-uri", + dest->num_options, + dest->options); + +ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, + "printer-uri", NULL, printer_uri); +</code></pre> + <blockquote> + <p>Note: If we wanted to query the scheduler instead of the device, we would look up the "printer-uri-supported" option instead of the "device-uri" value.</p> +</blockquote> + <p>The <code>ippAddString</code> function adds the "printer-uri" attribute the the IPP request. The <code>IPP_TAG_OPERATION</code> argument specifies that the attribute is part of the operation. The <code>IPP_TAG_URI</code> argument specifies that the value is a Universal Resource Identifier (URI) string. The <code>NULL</code> argument specifies there is no language (English, French, Japanese, etc.) associated with the string, and the <code>printer_uri</code> argument specifies the string value.</p> + <p>The IPP Get-Printer-Attributes request also supports an IPP attribute called "requested-attributes" that lists the attributes and values you are interested in. For example, the following code requests the printer state attributes:</p> + <pre><code>static const char * const requested_attributes[] = +{ + "printer-state", + "printer-state-message", + "printer-state-reasons" +}; + +ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD, + "requested-attributes", 3, NULL, + requested_attributes); +</code></pre> + <p>The <code>ippAddStrings</code> function adds an attribute with one or more strings, in this case three. The <code>IPP_TAG_KEYWORD</code> argument specifies that the strings are keyword values, which are used for attribute names. All strings use the same language (<code>NULL</code>), and the attribute will contain the three strings in the array <code>requested_attributes</code>.</p> + <p>CUPS provides many functions to adding attributes of different types:</p> + <ul> + <li><code>ippAddBoolean</code> adds a boolean (<code>IPP_TAG_BOOLEAN</code>) attribute with one value.</li> + <li><code>ippAddInteger</code> adds an enum (<code>IPP_TAG_ENUM</code>) or integer (<code>IPP_TAG_INTEGER</code>) attribute with one value.</li> + <li><code>ippAddIntegers</code> adds an enum or integer attribute with one or more values.</li> + <li><code>ippAddOctetString</code> adds an octetString attribute with one value.</li> + <li><code>ippAddOutOfBand</code> adds a admin-defined (<code>IPP_TAG_ADMINDEFINE</code>), default (<code>IPP_TAG_DEFAULT</code>), delete-attribute (<code>IPP_TAG_DELETEATTR</code>), no-value (<code>IPP_TAG_NOVALUE</code>), not-settable (<code>IPP_TAG_NOTSETTABLE</code>), unknown (<code>IPP_TAG_UNKNOWN</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_VALUE</code>) out-of-band attribute.</li> + <li><code>ippAddRange</code> adds a rangeOfInteger attribute with one range.</li> + <li><code>ippAddRanges</code> adds a rangeOfInteger attribute with one or more ranges.</li> + <li><code>ippAddResolution</code> adds a resolution attribute with one resolution.</li> + <li><code>ippAddResolutions</code> adds a resolution attribute with one or more resolutions.</li> + <li><code>ippAddString</code> adds a charset (<code>IPP_TAG_CHARSET</code>), keyword (<code>IPP_TAG_KEYWORD</code>), mimeMediaType (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code> and <code>IPP_TAG_NAMELANG</code>), naturalLanguage (<code>IPP_TAG_NATURAL_LANGUAGE</code>), text (<code>IPP_TAG_TEXT</code> and <code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), or uriScheme (<code>IPP_TAG_URISCHEME</code>) attribute with one value.</li> + <li><code>ippAddStrings</code> adds a charset, keyword, mimeMediaType, name, naturalLanguage, text, uri, or uriScheme attribute with one or more values.</li> +</ul> + <h3><a id="sending-the-ipp-request">Sending the IPP Request</a></h3> + <p>Once you have created the IPP request, you can send it using the <code>cupsDoRequest</code> function. For example, the following code sends the IPP Get-Printer-Attributes request to the destination and saves the response:</p> + <pre><code>ipp_t *response = cupsDoRequest(http, request, resource); +</code></pre> + <p>For requests like Send-Document that include a file, the <code>cupsDoFileRequest</code> function should be used:</p> + <pre><code>ipp_t *response = cupsDoFileRequest(http, request, resource, + filename); +</code></pre> + <p>Both <code>cupsDoRequest</code> and <code>cupsDoFileRequest</code> free the IPP request. If a valid IPP response is received, it is stored in a new IPP message (<code>ipp_t</code>) and returned to the caller. Otherwise <code>NULL</code> is returned.</p> + <p>The status from the most recent request can be queried using the <code>cupsLastError</code> function, for example:</p> + <pre><code>if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST) +{ + /* request failed */ +} +</code></pre> + <p>A human-readable error message is also available using the <code>cupsLastErrorString</code> function:</p> + <pre><code>if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST) +{ + /* request failed */ + printf("Request failed: %s\n", cupsLastErrorString()); +} +</code></pre> + <h3><a id="processing-the-ipp-response">Processing the IPP Response</a></h3> + <p>Each response to an IPP request is also an IPP message (<code>ipp_t</code>) with its own IPP attributes (<code>ipp_attribute_t</code>) that includes a status code (<code>IPP_STATUS_OK</code>, <code>IPP_STATUS_ERROR_BAD_REQUEST</code>, etc.) and the corresponding 32-bit integer identifier from the request.</p> + <p>For example, the following code finds the printer state attributes and prints their values:</p> + <pre><code>ipp_attribute_t *attr; + +if ((attr = ippFindAttribute(response, "printer-state", + IPP_TAG_ENUM)) != NULL) +{ + printf("printer-state=%s\n", + ippTagString("printer-state", ippGetInteger(attr, 0))); +} +else + puts("printer-state=unknown"); + +if ((attr = ippFindAttribute(response, "printer-state-message", + IPP_TAG_TEXT)) != NULL) +{ + printf("printer-state-message=\"%s\"\n", + ippGetString(attr, 0, NULL))); +} + +if ((attr = ippFindAttribute(response, "printer-state-reasons", + IPP_TAG_KEYWORD)) != NULL) +{ + int i, count = ippGetCount(attr); + + puts("printer-state-reasons="); + for (i = 0; i < count; i ++) + printf(" %s\n", ippGetString(attr, i, NULL))); +} +</code></pre> + <p>The <code>ippGetCount</code> function returns the number of values in an attribute.</p> + <p>The <code>ippGetInteger</code> and <code>ippGetString</code> functions return a single integer or string value from an attribute.</p> + <p>The <code>ippTagString</code> function converts a enum value to its keyword (string) equivalent.</p> + <p>Once you are done using the IPP response message, free it using the <code>ippDelete</code> function:</p> + <pre><code>ippDelete(response); +</code></pre> + <h3><a id="authentication">Authentication</a></h3> + <p>CUPS normally handles authentication through the console. GUI applications should set a password callback using the <code>cupsSetPasswordCB2</code> function:</p> + <pre><code>void +cupsSetPasswordCB2(cups_password_cb2_t cb, void *user_data); +</code></pre> + <p>The password callback will be called when needed and is responsible for setting the current user name using <code>cupsSetUser</code> and returning a string:</p> + <pre><code>const char * +cups_password_cb2(const char *prompt, http_t *http, + const char *method, const char *resource, + void *user_data); +</code></pre> + <p>The <code>prompt</code> argument is a string from CUPS that should be displayed to the user.</p> + <p>The <code>http</code> argument is the connection hosting the request that is being authenticated. The password callback can call the <code>httpGetField</code> and <code>httpGetSubField</code> functions to look for additional details concerning the authentication challenge.</p> + <p>The <code>method</code> argument specifies the HTTP method used for the request and is typically "POST".</p> + <p>The <code>resource</code> argument specifies the path used for the request.</p> + <p>The <code>user_data</code> argument provides the user data pointer from the <code>cupsSetPasswordCB2</code> call.</p> + <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> +<h3 class="function"><a id="cupsAddDest">cupsAddDest</a></h3> + <p class="description">Add a destination to the list of destinations.</p> +<p class="code"> +int cupsAddDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Destination name</td></tr> +<tr><th>instance</th> + <td class="description">Instance name or <code>NULL</code> for none/primary</td></tr> +<tr><th>num_dests</th> + <td class="description">Number of destinations</td></tr> +<tr><th>dests</th> + <td class="description">Destinations</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New number of destinations</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function cannot be used to add a new class or printer queue, +it only adds a new container of saved options for the named +destination or instance.<br> +<br> +If the named destination already exists, the destination list is +returned unchanged. Adding a new instance of a destination creates +a copy of that destination's options.<br> +<br> +Use the <a href="#cupsSaveDests"><code>cupsSaveDests</code></a> function to save the updated list of +destinations to the user's lpoptions file.</p> +<h3 class="function"><span class="info"> CUPS 2.2.4/macOS 10.13 </span><a id="cupsAddIntegerOption">cupsAddIntegerOption</a></h3> + <p class="description">Add an integer option to an option array.</p> +<p class="code"> +int cupsAddIntegerOption(const char *name, int value, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Name of option</td></tr> +<tr><th>value</th> + <td class="description">Value of option</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Pointer to options</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of options</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">New option arrays can be initialized simply by passing 0 for the +"num_options" parameter. + +</p> +<h3 class="function"><a id="cupsAddOption">cupsAddOption</a></h3> + <p class="description">Add an option to an option array.</p> +<p class="code"> +int cupsAddOption(const char *name, const char *value, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Name of option</td></tr> +<tr><th>value</th> + <td class="description">Value of option</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Pointer to options</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of options</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">New option arrays can be initialized simply by passing 0 for the +"num_options" parameter.</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCancelDestJob">cupsCancelDestJob</a></h3> + <p class="description">Cancel a job on a destination.</p> +<p class="code"> +ipp_status_t cupsCancelDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, int job_id);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>job_id</th> + <td class="description">Job ID</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of cancel operation</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The "job_id" is the number returned by cupsCreateDestJob.<br> +<br> +Returns <code>IPP_STATUS_OK</code> on success and +<code>IPP_STATUS_ERROR_NOT_AUTHORIZED</code> or +<code>IPP_STATUS_ERROR_FORBIDDEN</code> on failure. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCheckDestSupported">cupsCheckDestSupported</a></h3> + <p class="description">Check that the option and value are supported +by the destination.</p> +<p class="code"> +int cupsCheckDestSupported(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option, const char *value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>option</th> + <td class="description">Option</td></tr> +<tr><th>value</th> + <td class="description">Value or <code>NULL</code></td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if supported, 0 otherwise</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Returns 1 if supported, 0 otherwise. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCloseDestJob">cupsCloseDestJob</a></h3> + <p class="description">Close a job and start printing.</p> +<p class="code"> +ipp_status_t cupsCloseDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info, int job_id);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>info</th> + <td class="description">Destination information</td></tr> +<tr><th>job_id</th> + <td class="description">Job ID</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">IPP status code</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Use when the last call to cupsStartDocument passed 0 for "last_document". +"job_id" is the job ID returned by cupsCreateDestJob. Returns <code>IPP_STATUS_OK</code> +on success. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsConnectDest">cupsConnectDest</a></h3> + <p class="description">Open a conection to the destination.</p> +<p class="code"> +<a href="#http_t">http_t</a> *cupsConnectDest(<a href="#cups_dest_t">cups_dest_t</a> *dest, unsigned flags, int msec, int *cancel, char *resource, size_t resourcesize, <a href="#cups_dest_cb_t">cups_dest_cb_t</a> cb, void *user_data);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>flags</th> + <td class="description">Connection flags</td></tr> +<tr><th>msec</th> + <td class="description">Timeout in milliseconds</td></tr> +<tr><th>cancel</th> + <td class="description">Pointer to "cancel" variable</td></tr> +<tr><th>resource</th> + <td class="description">Resource buffer</td></tr> +<tr><th>resourcesize</th> + <td class="description">Size of resource buffer</td></tr> +<tr><th>cb</th> + <td class="description">Callback function</td></tr> +<tr><th>user_data</th> + <td class="description">User data pointer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Connection to destination or <code>NULL</code></p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Connect to the destination, returning a new <code>http_t</code> connection object +and optionally the resource path to use for the destination. These calls +will block until a connection is made, the timeout expires, the integer +pointed to by "cancel" is non-zero, or the callback function (or block) +returns 0. The caller is responsible for calling <a href="#httpClose"><code>httpClose</code></a> on the +returned connection.<br> +<br> +Starting with CUPS 2.2.4, the caller can pass <code>CUPS_DEST_FLAGS_DEVICE</code> +for the "flags" argument to connect directly to the device associated with +the destination. Otherwise, the connection is made to the CUPS scheduler +associated with the destination. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCopyDest">cupsCopyDest</a></h3> + <p class="description">Copy a destination.</p> +<p class="code"> +int cupsCopyDest(<a href="#cups_dest_t">cups_dest_t</a> *dest, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>dest</th> + <td class="description">Destination to copy</td></tr> +<tr><th>num_dests</th> + <td class="description">Number of destinations</td></tr> +<tr><th>dests</th> + <td class="description">Destination array</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New number of destinations</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Make a copy of the destination to an array of destinations (or just a single +copy) - for use with the cupsEnumDests* functions. The caller is responsible +for calling cupsFreeDests() on the returned object(s). + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCopyDestConflicts">cupsCopyDestConflicts</a></h3> + <p class="description">Get conflicts and resolutions for a new +option/value pair.</p> +<p class="code"> +int cupsCopyDestConflicts(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, int num_options, <a href="#cups_option_t">cups_option_t</a> *options, const char *new_option, const char *new_value, int *num_conflicts, <a href="#cups_option_t">cups_option_t</a> **conflicts, int *num_resolved, <a href="#cups_option_t">cups_option_t</a> **resolved);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>num_options</th> + <td class="description">Number of current options</td></tr> +<tr><th>options</th> + <td class="description">Current options</td></tr> +<tr><th>new_option</th> + <td class="description">New option</td></tr> +<tr><th>new_value</th> + <td class="description">New value</td></tr> +<tr><th>num_conflicts</th> + <td class="description">Number of conflicting options</td></tr> +<tr><th>conflicts</th> + <td class="description">Conflicting options</td></tr> +<tr><th>num_resolved</th> + <td class="description">Number of options to resolve</td></tr> +<tr><th>resolved</th> + <td class="description">Resolved options</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if there is a conflict, 0 if none, -1 on error</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">"num_options" and "options" represent the currently selected options by the +user. "new_option" and "new_value" are the setting the user has just +changed.<br> +<br> +Returns 1 if there is a conflict, 0 if there are no conflicts, and -1 if +there was an unrecoverable error such as a resolver loop.<br> +<br> +If "num_conflicts" and "conflicts" are not <code>NULL</code>, they are set to +contain the list of conflicting option/value pairs. Similarly, if +"num_resolved" and "resolved" are not <code>NULL</code> they will be set to the +list of changes needed to resolve the conflict.<br> +<br> +If cupsCopyDestConflicts returns 1 but "num_resolved" and "resolved" are set +to 0 and <code>NULL</code>, respectively, then the conflict cannot be resolved. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCopyDestInfo">cupsCopyDestInfo</a></h3> + <p class="description">Get the supported values/capabilities for the +destination.</p> +<p class="code"> +<a href="#cups_dinfo_t">cups_dinfo_t</a> *cupsCopyDestInfo(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Destination information</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The caller is responsible for calling <a href="#cupsFreeDestInfo"><code>cupsFreeDestInfo</code></a> on the return +value. <code>NULL</code> is returned on error. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCreateDestJob">cupsCreateDestJob</a></h3> + <p class="description">Create a job on a destination.</p> +<p class="code"> +ipp_status_t cupsCreateDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info, int *job_id, const char *title, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>info</th> + <td class="description">Destination information</td></tr> +<tr><th>job_id</th> + <td class="description">Job ID or 0 on error</td></tr> +<tr><th>title</th> + <td class="description">Job name</td></tr> +<tr><th>num_options</th> + <td class="description">Number of job options</td></tr> +<tr><th>options</th> + <td class="description">Job options</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">IPP status code</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success, saving the job ID +in the variable pointed to by "job_id". + +</p> +<h3 class="function"><span class="info"> CUPS 1.1.20/macOS 10.4 </span><a id="cupsDoAuthentication">cupsDoAuthentication</a></h3> + <p class="description">Authenticate a request.</p> +<p class="code"> +int cupsDoAuthentication(<a href="#http_t">http_t</a> *http, const char *method, const char *resource);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>method</th> + <td class="description">Request method ("GET", "POST", "PUT")</td></tr> +<tr><th>resource</th> + <td class="description">Resource path</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">0 on success, -1 on error</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function should be called in response to a <code>HTTP_STATUS_UNAUTHORIZED</code> +status, prior to resubmitting your request. + +</p> +<h3 class="function"><a id="cupsEncodeOptions">cupsEncodeOptions</a></h3> + <p class="description">Encode printer options into IPP attributes.</p> +<p class="code"> +void cupsEncodeOptions(<a href="#ipp_t">ipp_t</a> *ipp, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">Request to add to</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Options</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function adds operation, job, and then subscription attributes, +in that order. Use the <a href="#cupsEncodeOptions2"><code>cupsEncodeOptions2</code></a> function to add attributes +for a single group.</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsEncodeOptions2">cupsEncodeOptions2</a></h3> + <p class="description">Encode printer options into IPP attributes for a group.</p> +<p class="code"> +void cupsEncodeOptions2(<a href="#ipp_t">ipp_t</a> *ipp, int num_options, <a href="#cups_option_t">cups_option_t</a> *options, ipp_tag_t group_tag);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">Request to add to</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Options</td></tr> +<tr><th>group_tag</th> + <td class="description">Group to encode</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function only adds attributes for a single group. Call this +function multiple times for each group, or use <a href="#cupsEncodeOptions"><code>cupsEncodeOptions</code></a> +to add the standard groups. + +</p> +<h3 class="function"><a id="cupsEncryption">cupsEncryption</a></h3> + <p class="description">Get the current encryption settings.</p> +<p class="code"> +<a href="#http_encryption_t">http_encryption_t</a> cupsEncryption(void);</p> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Encryption settings</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION +environment variable, then the ~/.cups/client.conf file, and finally the +/etc/cups/client.conf file. If not set, the default is +<code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> +<br> +Note: The current encryption setting is tracked separately for each thread +in a program. Multi-threaded programs that override the setting via the +<a href="#cupsSetEncryption"><code>cupsSetEncryption</code></a> function need to do so in each thread for the same +setting to be used.</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsEnumDests">cupsEnumDests</a></h3> + <p class="description">Enumerate available destinations with a callback function.</p> +<p class="code"> +int cupsEnumDests(unsigned flags, int msec, int *cancel, <a href="#cups_ptype_t">cups_ptype_t</a> type, <a href="#cups_ptype_t">cups_ptype_t</a> mask, <a href="#cups_dest_cb_t">cups_dest_cb_t</a> cb, void *user_data);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>flags</th> + <td class="description">Enumeration flags</td></tr> +<tr><th>msec</th> + <td class="description">Timeout in milliseconds, -1 for indefinite</td></tr> +<tr><th>cancel</th> + <td class="description">Pointer to "cancel" variable</td></tr> +<tr><th>type</th> + <td class="description">Printer type bits</td></tr> +<tr><th>mask</th> + <td class="description">Mask for printer type bits</td></tr> +<tr><th>cb</th> + <td class="description">Callback function</td></tr> +<tr><th>user_data</th> + <td class="description">User data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Destinations are enumerated from one or more sources. The callback function +receives the <code>user_data</code> pointer and the destination pointer which can +be used as input to the <a href="#cupsCopyDest"><code>cupsCopyDest</code></a> function. The function must +return 1 to continue enumeration or 0 to stop.<br> +<br> +The <code>type</code> and <code>mask</code> arguments allow the caller to filter the +destinations that are enumerated. Passing 0 for both will enumerate all +printers. The constant <code>CUPS_PRINTER_DISCOVERED</code> is used to filter on +destinations that are available but have not yet been added locally.<br> +<br> +Enumeration happens on the current thread and does not return until all +destinations have been enumerated or the callback function returns 0.<br> +<br> +Note: The callback function will likely receive multiple updates for the same +destinations - it is up to the caller to suppress any duplicate destinations. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestDefault">cupsFindDestDefault</a></h3> + <p class="description">Find the default value(s) for the given option.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsFindDestDefault(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>option</th> + <td class="description">Option/attribute name</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Default attribute or <code>NULL</code> for none</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, +<code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, +<code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, +<code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> +functions to inspect the default value(s) as needed. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestReady">cupsFindDestReady</a></h3> + <p class="description">Find the default value(s) for the given option.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsFindDestReady(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>option</th> + <td class="description">Option/attribute name</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Default attribute or <code>NULL</code> for none</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, +<code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, +<code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, +<code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> +functions to inspect the default value(s) as needed. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestSupported">cupsFindDestSupported</a></h3> + <p class="description">Find the default value(s) for the given option.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsFindDestSupported(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>option</th> + <td class="description">Option/attribute name</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Default attribute or <code>NULL</code> for none</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, +<code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, +<code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, +<code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> +functions to inspect the default value(s) as needed. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsFinishDestDocument">cupsFinishDestDocument</a></h3> + <p class="description">Finish the current document.</p> +<p class="code"> +ipp_status_t cupsFinishDestDocument(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>info</th> + <td class="description">Destination information</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of document submission</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsFreeDestInfo">cupsFreeDestInfo</a></h3> + <p class="description">Free destination information obtained using +<a href="#cupsCopyDestInfo"><code>cupsCopyDestInfo</code></a>.</p> +<p class="code"> +void cupsFreeDestInfo(<a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +</tbody></table> +<h3 class="function"><a id="cupsFreeDests">cupsFreeDests</a></h3> + <p class="description">Free the memory used by the list of destinations.</p> +<p class="code"> +void cupsFreeDests(int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>num_dests</th> + <td class="description">Number of destinations</td></tr> +<tr><th>dests</th> + <td class="description">Destinations</td></tr> +</tbody></table> +<h3 class="function"><a id="cupsFreeJobs">cupsFreeJobs</a></h3> + <p class="description">Free memory used by job data.</p> +<p class="code"> +void cupsFreeJobs(int num_jobs, <a href="#cups_job_t">cups_job_t</a> *jobs);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>num_jobs</th> + <td class="description">Number of jobs</td></tr> +<tr><th>jobs</th> + <td class="description">Jobs</td></tr> +</tbody></table> +<h3 class="function"><a id="cupsFreeOptions">cupsFreeOptions</a></h3> + <p class="description">Free all memory used by options.</p> +<p class="code"> +void cupsFreeOptions(int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Pointer to options</td></tr> +</tbody></table> +<h3 class="function"><a id="cupsGetDest">cupsGetDest</a></h3> + <p class="description">Get the named destination from the list.</p> +<p class="code"> +<a href="#cups_dest_t">cups_dest_t</a> *cupsGetDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr> +<tr><th>instance</th> + <td class="description">Instance name or <code>NULL</code></td></tr> +<tr><th>num_dests</th> + <td class="description">Number of destinations</td></tr> +<tr><th>dests</th> + <td class="description">Destinations</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Destination pointer or <code>NULL</code></p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Use the <a href="#cupsEnumDests"><code>cupsEnumDests</code></a> or <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> functions to get a +list of supported destinations for the current user.</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></h3> + <p class="description">Get a media name, dimension, and margins for a +specific size.</p> +<p class="code"> +int cupsGetDestMediaByIndex(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, int n, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>n</th> + <td class="description">Media size number (0-based)</td></tr> +<tr><th>flags</th> + <td class="description">Media flags</td></tr> +<tr><th>size</th> + <td class="description">Media size information</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>flags</code> parameter determines which set of media are indexed. For +example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will get the Nth +borderless size supported by the printer. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsGetDestMediaByName">cupsGetDestMediaByName</a></h3> + <p class="description">Get media names, dimensions, and margins.</p> +<p class="code"> +int cupsGetDestMediaByName(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *media, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>media</th> + <td class="description">Media name</td></tr> +<tr><th>flags</th> + <td class="description">Media matching flags</td></tr> +<tr><th>size</th> + <td class="description">Media size information</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on match, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The "media" string is a PWG media name. "Flags" provides some matching +guidance (multiple flags can be combined):<br> +<br> +CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, +CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, +CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, +CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and +CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the +size amongst the "ready" media.<br> +<br> +The matching result (if any) is returned in the "cups_size_t" structure.<br> +<br> +Returns 1 when there is a match and 0 if there is not a match. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></h3> + <p class="description">Get media names, dimensions, and margins.</p> +<p class="code"> +int cupsGetDestMediaBySize(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, int width, int length, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>width</th> + <td class="description">Media width in hundredths of +of millimeters</td></tr> +<tr><th>length</th> + <td class="description">Media length in hundredths of +of millimeters</td></tr> +<tr><th>flags</th> + <td class="description">Media matching flags</td></tr> +<tr><th>size</th> + <td class="description">Media size information</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on match, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">"Width" and "length" are the dimensions in hundredths of millimeters. +"Flags" provides some matching guidance (multiple flags can be combined):<br> +<br> +CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, +CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, +CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, +CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and +CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the +size amongst the "ready" media.<br> +<br> +The matching result (if any) is returned in the "cups_size_t" structure.<br> +<br> +Returns 1 when there is a match and 0 if there is not a match. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsGetDestMediaCount">cupsGetDestMediaCount</a></h3> + <p class="description">Get the number of sizes supported by a +destination.</p> +<p class="code"> +int cupsGetDestMediaCount(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>flags</th> + <td class="description">Media flags</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of sizes</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>flags</code> parameter determines the set of media sizes that are +counted. For example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return +the number of borderless sizes. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></h3> + <p class="description">Get the default size for a destination.</p> +<p class="code"> +int cupsGetDestMediaDefault(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>flags</th> + <td class="description">Media flags</td></tr> +<tr><th>size</th> + <td class="description">Media size information</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>flags</code> parameter determines which default size is returned. For +example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return the default +borderless size, typically US Letter or A4, but sometimes 4x6 photo media. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="cupsGetDestWithURI">cupsGetDestWithURI</a></h3> + <p class="description">Get a destination associated with a URI.</p> +<p class="code"> +<a href="#cups_dest_t">cups_dest_t</a> *cupsGetDestWithURI(const char *name, const char *uri);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Desired printer name or <code>NULL</code></td></tr> +<tr><th>uri</th> + <td class="description">URI for the printer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Destination or <code>NULL</code></p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">"name" is the desired name for the printer. If <code>NULL</code>, a name will be +created using the URI.<br> +<br> +"uri" is the "ipp" or "ipps" URI for the printer. + +</p> +<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsGetDests2">cupsGetDests2</a></h3> + <p class="description">Get the list of destinations from the specified server.</p> +<p class="code"> +int cupsGetDests2(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>dests</th> + <td class="description">Destinations</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of destinations</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Starting with CUPS 1.2, the returned list of destinations include the +"printer-info", "printer-is-accepting-jobs", "printer-is-shared", +"printer-make-and-model", "printer-state", "printer-state-change-time", +"printer-state-reasons", "printer-type", and "printer-uri-supported" +attributes as options.<br> +<br> +CUPS 1.4 adds the "marker-change-time", "marker-colors", +"marker-high-levels", "marker-levels", "marker-low-levels", "marker-message", +"marker-names", "marker-types", and "printer-commands" attributes as options.<br> +<br> +CUPS 2.2 adds accessible IPP printers to the list of destinations that can +be used. The "printer-uri-supported" option will be present for those IPP +printers that have been recently used.<br> +<br> +Use the <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> function to free the destination list and +the <a href="#cupsGetDest"><code>cupsGetDest</code></a> function to find a particular destination. + +</p> +<h3 class="function"><span class="info"> CUPS 2.2.4/macOS 10.13 </span><a id="cupsGetIntegerOption">cupsGetIntegerOption</a></h3> + <p class="description">Get an integer option value.</p> +<p class="code"> +int cupsGetIntegerOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Name of option</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Options</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Option value or <code>INT_MIN</code></p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">INT_MIN is returned when the option does not exist, is not an integer, or +exceeds the range of values for the "int" type. + +</p> +<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsGetJobs2">cupsGetJobs2</a></h3> + <p class="description">Get the jobs from the specified server.</p> +<p class="code"> +int cupsGetJobs2(<a href="#http_t">http_t</a> *http, <a href="#cups_job_t">cups_job_t</a> **jobs, const char *name, int myjobs, int whichjobs);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>jobs</th> + <td class="description">Job data</td></tr> +<tr><th>name</th> + <td class="description"><code>NULL</code> = all destinations, otherwise show jobs for named destination</td></tr> +<tr><th>myjobs</th> + <td class="description">0 = all users, 1 = mine</td></tr> +<tr><th>whichjobs</th> + <td class="description"><code>CUPS_WHICHJOBS_ALL</code>, <code>CUPS_WHICHJOBS_ACTIVE</code>, or <code>CUPS_WHICHJOBS_COMPLETED</code></td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of jobs</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">A "whichjobs" value of <code>CUPS_WHICHJOBS_ALL</code> returns all jobs regardless +of state, while <code>CUPS_WHICHJOBS_ACTIVE</code> returns jobs that are +pending, processing, or held and <code>CUPS_WHICHJOBS_COMPLETED</code> returns +jobs that are stopped, canceled, aborted, or completed. + +</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsGetNamedDest">cupsGetNamedDest</a></h3> + <p class="description">Get options for the named destination.</p> +<p class="code"> +<a href="#cups_dest_t">cups_dest_t</a> *cupsGetNamedDest(<a href="#http_t">http_t</a> *http, const char *name, const char *instance);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>name</th> + <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr> +<tr><th>instance</th> + <td class="description">Instance name or <code>NULL</code></td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Destination or <code>NULL</code></p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function is optimized for retrieving a single destination and should +be used instead of <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> and <a href="#cupsGetDest"><code>cupsGetDest</code></a> when you +either know the name of the destination or want to print to the default +destination. If <code>NULL</code> is returned, the destination does not exist or +there is no default destination.<br> +<br> +If "http" is <code>CUPS_HTTP_DEFAULT</code>, the connection to the default print +server will be used.<br> +<br> +If "name" is <code>NULL</code>, the default printer for the current user will be +returned.<br> +<br> +The returned destination must be freed using <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> with a +"num_dests" value of 1. + +</p> +<h3 class="function"><a id="cupsGetOption">cupsGetOption</a></h3> + <p class="description">Get an option value.</p> +<p class="code"> +const char *cupsGetOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Name of option</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Options</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Option value or <code>NULL</code></p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsGetPassword2">cupsGetPassword2</a></h3> + <p class="description">Get a password from the user using the current +password callback.</p> +<p class="code"> +const char *cupsGetPassword2(const char *prompt, <a href="#http_t">http_t</a> *http, const char *method, const char *resource);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>prompt</th> + <td class="description">Prompt string</td></tr> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>method</th> + <td class="description">Request method ("GET", "POST", "PUT")</td></tr> +<tr><th>resource</th> + <td class="description">Resource path</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Password</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Uses the current password callback function. Returns <code>NULL</code> if the +user does not provide a password.<br> +<br> +Note: The current password callback function is tracked separately for each +thread in a program. Multi-threaded programs that override the setting via +the <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> function need to do so in each thread for the +same function to be used. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></h3> + <p class="description">Get the localized string for a destination media +size.</p> +<p class="code"> +const char *cupsLocalizeDestMedia(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>flags</th> + <td class="description">Media flags</td></tr> +<tr><th>size</th> + <td class="description">Media size</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Localized string</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The returned string is stored in the destination information and will become +invalid if the destination information is deleted. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsLocalizeDestOption">cupsLocalizeDestOption</a></h3> + <p class="description">Get the localized string for a destination +option.</p> +<p class="code"> +const char *cupsLocalizeDestOption(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>option</th> + <td class="description">Option to localize</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Localized string</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The returned string is stored in the destination information and will become +invalid if the destination information is deleted. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsLocalizeDestValue">cupsLocalizeDestValue</a></h3> + <p class="description">Get the localized string for a destination +option+value pair.</p> +<p class="code"> +const char *cupsLocalizeDestValue(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option, const char *value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>dinfo</th> + <td class="description">Destination information</td></tr> +<tr><th>option</th> + <td class="description">Option to localize</td></tr> +<tr><th>value</th> + <td class="description">Value to localize</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Localized string</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The returned string is stored in the destination information and will become +invalid if the destination information is deleted. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="cupsMakeServerCredentials">cupsMakeServerCredentials</a></h3> + <p class="description">Make a self-signed certificate and private key pair.</p> +<p class="code"> +int cupsMakeServerCredentials(const char *path, const char *common_name, int num_alt_names, const char **alt_names, time_t expiration_date);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>path</th> + <td class="description">Keychain path or <code>NULL</code> for default</td></tr> +<tr><th>common_name</th> + <td class="description">Common name</td></tr> +<tr><th>num_alt_names</th> + <td class="description">Number of subject alternate names</td></tr> +<tr><th>alt_names</th> + <td class="description">Subject Alternate Names</td></tr> +<tr><th>expiration_date</th> + <td class="description">Expiration date</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h3 class="function"><a id="cupsParseOptions">cupsParseOptions</a></h3> + <p class="description">Parse options from a command-line argument.</p> +<p class="code"> +int cupsParseOptions(const char *arg, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>arg</th> + <td class="description">Argument to parse</td></tr> +<tr><th>num_options</th> + <td class="description">Number of options</td></tr> +<tr><th>options</th> + <td class="description">Options found</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of options found</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function converts space-delimited name/value pairs according +to the PAPI text option ABNF specification. Collection values +("name={a=... b=... c=...}") are stored with the curley brackets +intact - use <code>cupsParseOptions</code> on the value to extract the +collection attributes.</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsRemoveDest">cupsRemoveDest</a></h3> + <p class="description">Remove a destination from the destination list.</p> +<p class="code"> +int cupsRemoveDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Destination name</td></tr> +<tr><th>instance</th> + <td class="description">Instance name or <code>NULL</code></td></tr> +<tr><th>num_dests</th> + <td class="description">Number of destinations</td></tr> +<tr><th>dests</th> + <td class="description">Destinations</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New number of destinations</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Removing a destination/instance does not delete the class or printer +queue, merely the lpoptions for that destination/instance. Use the +<a href="#cupsSetDests"><code>cupsSetDests</code></a> or <a href="#cupsSetDests2"><code>cupsSetDests2</code></a> functions to save the new +options for the user. + +</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsRemoveOption">cupsRemoveOption</a></h3> + <p class="description">Remove an option from an option array.</p> +<p class="code"> +int cupsRemoveOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Option name</td></tr> +<tr><th>num_options</th> + <td class="description">Current number of options</td></tr> +<tr><th>options</th> + <td class="description">Options</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New number of options</p> +<h3 class="function"><a id="cupsServer">cupsServer</a></h3> + <p class="description">Return the hostname/address of the current server.</p> +<p class="code"> +const char *cupsServer(void);</p> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Server name</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The default server comes from the CUPS_SERVER environment variable, then the +~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not +set, the default is the local system - either "localhost" or a domain socket +path.<br> +<br> +The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6 +address, or a domain socket pathname.<br> +<br> +Note: The current server is tracked separately for each thread in a program. +Multi-threaded programs that override the server via the +<a href="#cupsSetServer"><code>cupsSetServer</code></a> function need to do so in each thread for the same +server to be used.</p> +<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="cupsSetClientCertCB">cupsSetClientCertCB</a></h3> + <p class="description">Set the client certificate callback.</p> +<p class="code"> +void cupsSetClientCertCB(<a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a> cb, void *user_data);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>cb</th> + <td class="description">Callback function</td></tr> +<tr><th>user_data</th> + <td class="description">User data pointer</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> +<br> +Note: The current certificate callback is tracked separately for each thread +in a program. Multi-threaded programs that override the callback need to do +so in each thread for the same callback to be used. + +</p> +<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="cupsSetCredentials">cupsSetCredentials</a></h3> + <p class="description">Set the default credentials to be used for SSL/TLS +connections.</p> +<p class="code"> +int cupsSetCredentials(cups_array_t *credentials);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>credentials</th> + <td class="description">Array of credentials</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of call (0 = success)</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Note: The default credentials are tracked separately for each thread in a +program. Multi-threaded programs that override the setting need to do so in +each thread for the same setting to be used. + +</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsSetDefaultDest">cupsSetDefaultDest</a></h3> + <p class="description">Set the default destination.</p> +<p class="code"> +void cupsSetDefaultDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Destination name</td></tr> +<tr><th>instance</th> + <td class="description">Instance name or <code>NULL</code></td></tr> +<tr><th>num_dests</th> + <td class="description">Number of destinations</td></tr> +<tr><th>dests</th> + <td class="description">Destinations</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsSetDests2">cupsSetDests2</a></h3> + <p class="description">Save the list of destinations for the specified server.</p> +<p class="code"> +int cupsSetDests2(<a href="#http_t">http_t</a> *http, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> +<tr><th>num_dests</th> + <td class="description">Number of destinations</td></tr> +<tr><th>dests</th> + <td class="description">Destinations</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">0 on success, -1 on error</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function saves the destinations to /etc/cups/lpoptions when run +as root and ~/.cups/lpoptions when run as a normal user. + +</p> +<h3 class="function"><a id="cupsSetEncryption">cupsSetEncryption</a></h3> + <p class="description">Set the encryption preference.</p> +<p class="code"> +void cupsSetEncryption(<a href="#http_encryption_t">http_encryption_t</a> e);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>e</th> + <td class="description">New encryption preference</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION +environment variable, then the ~/.cups/client.conf file, and finally the +/etc/cups/client.conf file. If not set, the default is +<code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> +<br> +Note: The current encryption setting is tracked separately for each thread +in a program. Multi-threaded programs that override the setting need to do +so in each thread for the same setting to be used.</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsSetPasswordCB2">cupsSetPasswordCB2</a></h3> + <p class="description">Set the advanced password callback for CUPS.</p> +<p class="code"> +void cupsSetPasswordCB2(<a href="#cups_password_cb2_t">cups_password_cb2_t</a> cb, void *user_data);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>cb</th> + <td class="description">Callback function</td></tr> +<tr><th>user_data</th> + <td class="description">User data pointer</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Pass <code>NULL</code> to restore the default (console) password callback, which +reads the password from the console. Programs should call either this +function or <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a>, as only one callback can be registered +by a program per thread.<br> +<br> +Note: The current password callback is tracked separately for each thread +in a program. Multi-threaded programs that override the callback need to do +so in each thread for the same callback to be used. + +</p> +<h3 class="function"><a id="cupsSetServer">cupsSetServer</a></h3> + <p class="description">Set the default server name and port.</p> +<p class="code"> +void cupsSetServer(const char *server);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>server</th> + <td class="description">Server name</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The "server" string can be a fully-qualified hostname, a numeric +IPv4 or IPv6 address, or a domain socket pathname. Hostnames and numeric IP +addresses can be optionally followed by a colon and port number to override +the default port 631, e.g. "hostname:8631". Pass <code>NULL</code> to restore the +default server name and port.<br> +<br> +Note: The current server is tracked separately for each thread in a program. +Multi-threaded programs that override the server need to do so in each +thread for the same server to be used.</p> +<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="cupsSetServerCertCB">cupsSetServerCertCB</a></h3> + <p class="description">Set the server certificate callback.</p> +<p class="code"> +void cupsSetServerCertCB(<a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a> cb, void *user_data);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>cb</th> + <td class="description">Callback function</td></tr> +<tr><th>user_data</th> + <td class="description">User data pointer</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> +<br> +Note: The current credentials callback is tracked separately for each thread +in a program. Multi-threaded programs that override the callback need to do +so in each thread for the same callback to be used. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="cupsSetServerCredentials">cupsSetServerCredentials</a></h3> + <p class="description">Set the default server credentials.</p> +<p class="code"> +int cupsSetServerCredentials(const char *path, const char *common_name, int auto_create);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>path</th> + <td class="description">Keychain path or <code>NULL</code> for default</td></tr> +<tr><th>common_name</th> + <td class="description">Default common name for server</td></tr> +<tr><th>auto_create</th> + <td class="description">1 = automatically create self-signed certificates</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Note: The server credentials are used by all threads in the running process. +This function is threadsafe. + +</p> +<h3 class="function"><a id="cupsSetUser">cupsSetUser</a></h3> + <p class="description">Set the default user name.</p> +<p class="code"> +void cupsSetUser(const char *user);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>user</th> + <td class="description">User name</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Pass <code>NULL</code> to restore the default user name.<br> +<br> +Note: The current user name is tracked separately for each thread in a +program. Multi-threaded programs that override the user name need to do so +in each thread for the same user name to be used.</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsSetUserAgent">cupsSetUserAgent</a></h3> + <p class="description">Set the default HTTP User-Agent string.</p> +<p class="code"> +void cupsSetUserAgent(const char *user_agent);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>user_agent</th> + <td class="description">User-Agent string or <code>NULL</code></td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Setting the string to NULL forces the default value containing the CUPS +version, IPP version, and operating system version and architecture. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsStartDestDocument">cupsStartDestDocument</a></h3> + <p class="description">Start a new document.</p> +<p class="code"> +http_status_t cupsStartDestDocument(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info, int job_id, const char *docname, const char *format, int num_options, <a href="#cups_option_t">cups_option_t</a> *options, int last_document);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to destination</td></tr> +<tr><th>dest</th> + <td class="description">Destination</td></tr> +<tr><th>info</th> + <td class="description">Destination information</td></tr> +<tr><th>job_id</th> + <td class="description">Job ID</td></tr> +<tr><th>docname</th> + <td class="description">Document name</td></tr> +<tr><th>format</th> + <td class="description">Document format</td></tr> +<tr><th>num_options</th> + <td class="description">Number of document options</td></tr> +<tr><th>options</th> + <td class="description">Document options</td></tr> +<tr><th>last_document</th> + <td class="description">1 if this is the last document</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of document creation</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">"job_id" is the job ID returned by cupsCreateDestJob. "docname" is the name +of the document/file being printed, "format" is the MIME media type for the +document (see CUPS_FORMAT_xxx constants), and "num_options" and "options" +are the options do be applied to the document. "last_document" should be 1 +if this is the last document to be submitted in the job. Returns +<code>HTTP_CONTINUE</code> on success. + +</p> +<h3 class="function"><a id="cupsUser">cupsUser</a></h3> + <p class="description">Return the current user's name.</p> +<p class="code"> +const char *cupsUser(void);</p> +<h4 class="returnvalue">Return Value</h4> + <p class="description">User name</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Note: The current user name is tracked separately for each thread in a +program. Multi-threaded programs that override the user name with the +<a href="#cupsSetUser"><code>cupsSetUser</code></a> function need to do so in each thread for the same user +name to be used.</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsUserAgent">cupsUserAgent</a></h3> + <p class="description">Return the default HTTP User-Agent string.</p> +<p class="code"> +const char *cupsUserAgent(void);</p> +<h4 class="returnvalue">Return Value</h4> + <p class="description">User-Agent string</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAcceptConnection">httpAcceptConnection</a></h3> + <p class="description">Accept a new HTTP client connection from the +specified listening socket.</p> +<p class="code"> +<a href="#http_t">http_t</a> *httpAcceptConnection(int fd, int blocking);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>fd</th> + <td class="description">Listen socket file descriptor</td></tr> +<tr><th>blocking</th> + <td class="description">1 if the connection should be +blocking, 0 otherwise</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">HTTP connection or <code>NULL</code></p> +<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpAddCredential">httpAddCredential</a></h3> + <p class="description">Allocates and adds a single credential to an array.</p> +<p class="code"> +int httpAddCredential(cups_array_t *credentials, const void *data, size_t datalen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>credentials</th> + <td class="description">Credentials array</td></tr> +<tr><th>data</th> + <td class="description">PEM-encoded X.509 data</td></tr> +<tr><th>datalen</th> + <td class="description">Length of data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">0 on success, -1 on error</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Use <code>cupsArrayNew(NULL, NULL)</code> to create a credentials array. + +</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrAny">httpAddrAny</a></h3> + <p class="description">Check for the "any" address.</p> +<p class="code"> +int httpAddrAny(const <a href="#http_addr_t">http_addr_t</a> *addr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr</th> + <td class="description">Address to check</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if "any", 0 otherwise</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpAddrClose">httpAddrClose</a></h3> + <p class="description">Close a socket created by <a href="#httpAddrConnect"><code>httpAddrConnect</code></a> or +<a href="#httpAddrListen"><code>httpAddrListen</code></a>.</p> +<p class="code"> +int httpAddrClose(<a href="#http_addr_t">http_addr_t</a> *addr, int fd);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr</th> + <td class="description">Listen address or <code>NULL</code></td></tr> +<tr><th>fd</th> + <td class="description">Socket file descriptor</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">0 on success, -1 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Pass <code>NULL</code> for sockets created with <a href="#httpAddrConnect2"><code>httpAddrConnect2</code></a> and the +listen address for sockets created with <a href="#httpAddrListen"><code>httpAddrListen</code></a>. This function +ensures that domain sockets are removed when closed. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrConnect2">httpAddrConnect2</a></h3> + <p class="description">Connect to any of the addresses in the list with a +timeout and optional cancel.</p> +<p class="code"> +<a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrConnect2(<a href="#http_addrlist_t">http_addrlist_t</a> *addrlist, int *sock, int msec, int *cancel);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addrlist</th> + <td class="description">List of potential addresses</td></tr> +<tr><th>sock</th> + <td class="description">Socket</td></tr> +<tr><th>msec</th> + <td class="description">Timeout in milliseconds</td></tr> +<tr><th>cancel</th> + <td class="description">Pointer to "cancel" variable</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Connected address or NULL on failure</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrCopyList">httpAddrCopyList</a></h3> + <p class="description">Copy an address list.</p> +<p class="code"> +<a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrCopyList(<a href="#http_addrlist_t">http_addrlist_t</a> *src);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>src</th> + <td class="description">Source address list</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New address list or <code>NULL</code> on error</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrEqual">httpAddrEqual</a></h3> + <p class="description">Compare two addresses.</p> +<p class="code"> +int httpAddrEqual(const <a href="#http_addr_t">http_addr_t</a> *addr1, const <a href="#http_addr_t">http_addr_t</a> *addr2);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr1</th> + <td class="description">First address</td></tr> +<tr><th>addr2</th> + <td class="description">Second address</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if equal, 0 if not</p> +<h3 class="function"><a id="httpAddrFamily">httpAddrFamily</a></h3> + <p class="description">Get the address family of an address.</p> +<p class="code"> +int httpAddrFamily(<a href="#http_addr_t">http_addr_t</a> *addr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr</th> + <td class="description">Address</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Address family</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrFreeList">httpAddrFreeList</a></h3> + <p class="description">Free an address list.</p> +<p class="code"> +void httpAddrFreeList(<a href="#http_addrlist_t">http_addrlist_t</a> *addrlist);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addrlist</th> + <td class="description">Address list to free</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrGetList">httpAddrGetList</a></h3> + <p class="description">Get a list of addresses for a hostname.</p> +<p class="code"> +<a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrGetList(const char *hostname, int family, const char *service);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>hostname</th> + <td class="description">Hostname, IP address, or NULL for passive listen address</td></tr> +<tr><th>family</th> + <td class="description">Address family or AF_UNSPEC</td></tr> +<tr><th>service</th> + <td class="description">Service name or port number</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">List of addresses or NULL</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrLength">httpAddrLength</a></h3> + <p class="description">Return the length of the address in bytes.</p> +<p class="code"> +int httpAddrLength(const <a href="#http_addr_t">http_addr_t</a> *addr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr</th> + <td class="description">Address</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Length in bytes</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrListen">httpAddrListen</a></h3> + <p class="description">Create a listening socket bound to the specified +address and port.</p> +<p class="code"> +int httpAddrListen(<a href="#http_addr_t">http_addr_t</a> *addr, int port);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr</th> + <td class="description">Address to bind to</td></tr> +<tr><th>port</th> + <td class="description">Port number to bind to</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Socket or -1 on error</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrLocalhost">httpAddrLocalhost</a></h3> + <p class="description">Check for the local loopback address.</p> +<p class="code"> +int httpAddrLocalhost(const <a href="#http_addr_t">http_addr_t</a> *addr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr</th> + <td class="description">Address to check</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if local host, 0 otherwise</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrLookup">httpAddrLookup</a></h3> + <p class="description">Lookup the hostname associated with the address.</p> +<p class="code"> +char *httpAddrLookup(const <a href="#http_addr_t">http_addr_t</a> *addr, char *name, int namelen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr</th> + <td class="description">Address to lookup</td></tr> +<tr><th>name</th> + <td class="description">Host name buffer</td></tr> +<tr><th>namelen</th> + <td class="description">Size of name buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Host name</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrPort">httpAddrPort</a></h3> + <p class="description">Get the port number associated with an address.</p> +<p class="code"> +int httpAddrPort(<a href="#http_addr_t">http_addr_t</a> *addr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr</th> + <td class="description">Address</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Port number</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrString">httpAddrString</a></h3> + <p class="description">Convert an address to a numeric string.</p> +<p class="code"> +char *httpAddrString(const <a href="#http_addr_t">http_addr_t</a> *addr, char *s, int slen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>addr</th> + <td class="description">Address to convert</td></tr> +<tr><th>s</th> + <td class="description">String buffer</td></tr> +<tr><th>slen</th> + <td class="description">Length of string</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Numeric address string</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAssembleURI">httpAssembleURI</a></h3> + <p class="description">Assemble a uniform resource identifier from its +components.</p> +<p class="code"> +<a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURI(<a href="#http_uri_coding_t">http_uri_coding_t</a> encoding, char *uri, int urilen, const char *scheme, const char *username, const char *host, int port, const char *resource);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>encoding</th> + <td class="description">Encoding flags</td></tr> +<tr><th>uri</th> + <td class="description">URI buffer</td></tr> +<tr><th>urilen</th> + <td class="description">Size of URI buffer</td></tr> +<tr><th>scheme</th> + <td class="description">Scheme name</td></tr> +<tr><th>username</th> + <td class="description">Username</td></tr> +<tr><th>host</th> + <td class="description">Hostname or address</td></tr> +<tr><th>port</th> + <td class="description">Port number</td></tr> +<tr><th>resource</th> + <td class="description">Resource</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">URI status</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function escapes reserved characters in the URI depending on the +value of the "encoding" argument. You should use this function in +place of traditional string functions whenever you need to create a +URI string. + +</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAssembleURIf">httpAssembleURIf</a></h3> + <p class="description">Assemble a uniform resource identifier from its +components with a formatted resource.</p> +<p class="code"> +<a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURIf(<a href="#http_uri_coding_t">http_uri_coding_t</a> encoding, char *uri, int urilen, const char *scheme, const char *username, const char *host, int port, const char *resourcef, ...);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>encoding</th> + <td class="description">Encoding flags</td></tr> +<tr><th>uri</th> + <td class="description">URI buffer</td></tr> +<tr><th>urilen</th> + <td class="description">Size of URI buffer</td></tr> +<tr><th>scheme</th> + <td class="description">Scheme name</td></tr> +<tr><th>username</th> + <td class="description">Username</td></tr> +<tr><th>host</th> + <td class="description">Hostname or address</td></tr> +<tr><th>port</th> + <td class="description">Port number</td></tr> +<tr><th>resourcef</th> + <td class="description">Printf-style resource</td></tr> +<tr><th>...</th> + <td class="description">Additional arguments as needed</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">URI status</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function creates a formatted version of the resource string +argument "resourcef" and escapes reserved characters in the URI +depending on the value of the "encoding" argument. You should use +this function in place of traditional string functions whenever +you need to create a URI string. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAssembleUUID">httpAssembleUUID</a></h3> + <p class="description">Assemble a name-based UUID URN conforming to RFC 4122.</p> +<p class="code"> +char *httpAssembleUUID(const char *server, int port, const char *name, int number, char *buffer, size_t bufsize);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>server</th> + <td class="description">Server name</td></tr> +<tr><th>port</th> + <td class="description">Port number</td></tr> +<tr><th>name</th> + <td class="description">Object name or NULL</td></tr> +<tr><th>number</th> + <td class="description">Object number or 0</td></tr> +<tr><th>buffer</th> + <td class="description">String buffer</td></tr> +<tr><th>bufsize</th> + <td class="description">Size of buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">UUID string</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function creates a unique 128-bit identifying number using the server +name, port number, random data, and optionally an object name and/or object +number. The result is formatted as a UUID URN as defined in RFC 4122.<br> +<br> +The buffer needs to be at least 46 bytes in size. + +</p> +<h3 class="function"><a id="httpBlocking">httpBlocking</a></h3> + <p class="description">Set blocking/non-blocking behavior on a connection.</p> +<p class="code"> +void httpBlocking(<a href="#http_t">http_t</a> *http, int b);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>b</th> + <td class="description">1 = blocking, 0 = non-blocking</td></tr> +</tbody></table> +<h3 class="function"><a id="httpCheck">httpCheck</a></h3> + <p class="description">Check to see if there is a pending response from the server.</p> +<p class="code"> +int httpCheck(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">0 = no data, 1 = data available</p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpClearCookie">httpClearCookie</a></h3> + <p class="description">Clear the cookie value(s).</p> +<p class="code"> +void httpClearCookie(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h3 class="function"><a id="httpClearFields">httpClearFields</a></h3> + <p class="description">Clear HTTP request fields.</p> +<p class="code"> +void httpClearFields(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h3 class="function"><a id="httpClose">httpClose</a></h3> + <p class="description">Close an HTTP connection.</p> +<p class="code"> +void httpClose(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpCompareCredentials">httpCompareCredentials</a></h3> + <p class="description">Compare two sets of X.509 credentials.</p> +<p class="code"> +int httpCompareCredentials(cups_array_t *cred1, cups_array_t *cred2);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>cred1</th> + <td class="description">First set of X.509 credentials</td></tr> +<tr><th>cred2</th> + <td class="description">Second set of X.509 credentials</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if they match, 0 if they do not</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpConnect2">httpConnect2</a></h3> + <p class="description">Connect to a HTTP server.</p> +<p class="code"> +<a href="#http_t">http_t</a> *httpConnect2(const char *host, int port, <a href="#http_addrlist_t">http_addrlist_t</a> *addrlist, int family, <a href="#http_encryption_t">http_encryption_t</a> encryption, int blocking, int msec, int *cancel);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>host</th> + <td class="description">Host to connect to</td></tr> +<tr><th>port</th> + <td class="description">Port number</td></tr> +<tr><th>addrlist</th> + <td class="description">List of addresses or <code>NULL</code> to lookup</td></tr> +<tr><th>family</th> + <td class="description">Address family to use or <code>AF_UNSPEC</code> for any</td></tr> +<tr><th>encryption</th> + <td class="description">Type of encryption to use</td></tr> +<tr><th>blocking</th> + <td class="description">1 for blocking connection, 0 for non-blocking</td></tr> +<tr><th>msec</th> + <td class="description">Connection timeout in milliseconds, 0 means don't connect</td></tr> +<tr><th>cancel</th> + <td class="description">Pointer to "cancel" variable</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New HTTP connection</p> +<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpCopyCredentials">httpCopyCredentials</a></h3> + <p class="description">Copy the credentials associated with the peer in +an encrypted connection.</p> +<p class="code"> +int httpCopyCredentials(<a href="#http_t">http_t</a> *http, cups_array_t **credentials);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection to server</td></tr> +<tr><th>credentials</th> + <td class="description">Array of credentials</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of call (0 = success)</p> +<h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsAreValidForName">httpCredentialsAreValidForName</a></h3> + <p class="description">Return whether the credentials are valid for the given name.</p> +<p class="code"> +int httpCredentialsAreValidForName(cups_array_t *credentials, const char *common_name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>credentials</th> + <td class="description">Credentials</td></tr> +<tr><th>common_name</th> + <td class="description">Name to check</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if valid, 0 otherwise</p> +<h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsGetExpiration">httpCredentialsGetExpiration</a></h3> + <p class="description">Return the expiration date of the credentials.</p> +<p class="code"> +time_t httpCredentialsGetExpiration(cups_array_t *credentials);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>credentials</th> + <td class="description">Credentials</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Expiration date of credentials</p> +<h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsGetTrust">httpCredentialsGetTrust</a></h3> + <p class="description">Return the trust of credentials.</p> +<p class="code"> +<a href="#http_trust_t">http_trust_t</a> httpCredentialsGetTrust(cups_array_t *credentials, const char *common_name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>credentials</th> + <td class="description">Credentials</td></tr> +<tr><th>common_name</th> + <td class="description">Common name for trust lookup</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Level of trust</p> +<h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsString">httpCredentialsString</a></h3> + <p class="description">Return a string representing the credentials.</p> +<p class="code"> +size_t httpCredentialsString(cups_array_t *credentials, char *buffer, size_t bufsize);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>credentials</th> + <td class="description">Credentials</td></tr> +<tr><th>buffer</th> + <td class="description">Buffer or <code>NULL</code></td></tr> +<tr><th>bufsize</th> + <td class="description">Size of buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Total size of credentials string</p> +<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="httpDecode64_2">httpDecode64_2</a></h3> + <p class="description">Base64-decode a string.</p> +<p class="code"> +char *httpDecode64_2(char *out, int *outlen, const char *in);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>out</th> + <td class="description">String to write to</td></tr> +<tr><th>outlen</th> + <td class="description">Size of output string</td></tr> +<tr><th>in</th> + <td class="description">String to read from</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Decoded string</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The caller must initialize "outlen" to the maximum size of the decoded +string before calling <code>httpDecode64_2</code>. On return "outlen" contains the +decoded length of the string. + +</p> +<h3 class="function"><a id="httpDelete">httpDelete</a></h3> + <p class="description">Send a DELETE request to the server.</p> +<p class="code"> +int httpDelete(<a href="#http_t">http_t</a> *http, const char *uri);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>uri</th> + <td class="description">URI to delete</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of call (0 = success)</p> +<h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="httpEncode64_2">httpEncode64_2</a></h3> + <p class="description">Base64-encode a string.</p> +<p class="code"> +char *httpEncode64_2(char *out, int outlen, const char *in, int inlen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>out</th> + <td class="description">String to write to</td></tr> +<tr><th>outlen</th> + <td class="description">Maximum size of output string</td></tr> +<tr><th>in</th> + <td class="description">String to read from</td></tr> +<tr><th>inlen</th> + <td class="description">Size of input string</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Encoded string</p> +<h3 class="function"><a id="httpEncryption">httpEncryption</a></h3> + <p class="description">Set the required encryption on the link.</p> +<p class="code"> +int httpEncryption(<a href="#http_t">http_t</a> *http, <a href="#http_encryption_t">http_encryption_t</a> e);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>e</th> + <td class="description">New encryption preference</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">-1 on error, 0 on success</p> +<h3 class="function"><a id="httpError">httpError</a></h3> + <p class="description">Get the last error on a connection.</p> +<p class="code"> +int httpError(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Error code (errno) value</p> +<h3 class="function"><a id="httpFieldValue">httpFieldValue</a></h3> + <p class="description">Return the HTTP field enumeration value for a field +name.</p> +<p class="code"> +<a href="#http_field_t">http_field_t</a> httpFieldValue(const char *name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">String name</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Field index</p> +<h3 class="function"><a id="httpFlush">httpFlush</a></h3> + <p class="description">Flush data read from a HTTP connection.</p> +<p class="code"> +void httpFlush(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpFlushWrite">httpFlushWrite</a></h3> + <p class="description">Flush data written to a HTTP connection.</p> +<p class="code"> +int httpFlushWrite(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Bytes written or -1 on error</p> +<h3 class="function"><a id="httpFreeCredentials">httpFreeCredentials</a></h3> + <p class="description">Free an array of credentials.</p> +<p class="code"> +void httpFreeCredentials(cups_array_t *credentials);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>credentials</th> + <td class="description">Array of credentials</td></tr> +</tbody></table> +<h3 class="function"><a id="httpGet">httpGet</a></h3> + <p class="description">Send a GET request to the server.</p> +<p class="code"> +int httpGet(<a href="#http_t">http_t</a> *http, const char *uri);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>uri</th> + <td class="description">URI to get</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of call (0 = success)</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetActivity">httpGetActivity</a></h3> + <p class="description">Get the most recent activity for a connection.</p> +<p class="code"> +time_t httpGetActivity(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Time of last read or write</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The return value is the time in seconds of the last read or write. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetAddress">httpGetAddress</a></h3> + <p class="description">Get the address of the connected peer of a connection.</p> +<p class="code"> +<a href="#http_addr_t">http_addr_t</a> *httpGetAddress(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Connected address or <code>NULL</code></p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">For connections created with <a href="#httpConnect2"><code>httpConnect2</code></a>, the address is for the +server. For connections created with <a href="#httpAccept"><code>httpAccept</code></a>, the address is for +the client.<br> +<br> +Returns <code>NULL</code> if the socket is currently unconnected. + +</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="httpGetAuthString">httpGetAuthString</a></h3> + <p class="description">Get the current authorization string.</p> +<p class="code"> +char *httpGetAuthString(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Authorization string</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The authorization string is set by <a href="#cupsDoAuthentication"><code>cupsDoAuthentication</code></a> and +<a href="#httpSetAuthString"><code>httpSetAuthString</code></a>. Use <a href="#httpGetAuthString"><code>httpGetAuthString</code></a> to retrieve the +string to use with <a href="#httpSetField"><code>httpSetField</code></a> for the +<code>HTTP_FIELD_AUTHORIZATION</code> value. + +</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetBlocking">httpGetBlocking</a></h3> + <p class="description">Get the blocking/non-block state of a connection.</p> +<p class="code"> +int httpGetBlocking(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if blocking, 0 if non-blocking</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpGetContentEncoding">httpGetContentEncoding</a></h3> + <p class="description">Get a common content encoding, if any, between +the client and server.</p> +<p class="code"> +const char *httpGetContentEncoding(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Content-Coding value or +<code>NULL</code> for the identity +coding.</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function uses the value of the Accepts-Encoding HTTP header and must be +called after receiving a response from the server or a request from the +client. The value returned can be use in subsequent requests (for clients) +or in the response (for servers) in order to compress the content stream. + +</p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpGetCookie">httpGetCookie</a></h3> + <p class="description">Get any cookie data from the response.</p> +<p class="code"> +const char *httpGetCookie(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Cookie data or <code>NULL</code></p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetDateString2">httpGetDateString2</a></h3> + <p class="description">Get a formatted date/time string from a time value.</p> +<p class="code"> +const char *httpGetDateString2(time_t t, char *s, int slen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>t</th> + <td class="description">Time in seconds</td></tr> +<tr><th>s</th> + <td class="description">String buffer</td></tr> +<tr><th>slen</th> + <td class="description">Size of string buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Date/time string</p> +<h3 class="function"><a id="httpGetDateTime">httpGetDateTime</a></h3> + <p class="description">Get a time value from a formatted date/time string.</p> +<p class="code"> +time_t httpGetDateTime(const char *s);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>s</th> + <td class="description">Date/time string</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Time in seconds</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetEncryption">httpGetEncryption</a></h3> + <p class="description">Get the current encryption mode of a connection.</p> +<p class="code"> +<a href="#http_encryption_t">http_encryption_t</a> httpGetEncryption(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Current encryption mode</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function returns the encryption mode for the connection. Use the +<a href="#httpIsEncrypted"><code>httpIsEncrypted</code></a> function to determine whether a TLS session has +been established. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpGetExpect">httpGetExpect</a></h3> + <p class="description">Get the value of the Expect header, if any.</p> +<p class="code"> +http_status_t httpGetExpect(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Expect: status, if any</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Returns <code>HTTP_STATUS_NONE</code> if there is no Expect header, otherwise +returns the expected HTTP status code, typically <code>HTTP_STATUS_CONTINUE</code>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetFd">httpGetFd</a></h3> + <p class="description">Get the file descriptor associated with a connection.</p> +<p class="code"> +int httpGetFd(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">File descriptor or -1 if none</p> +<h3 class="function"><a id="httpGetField">httpGetField</a></h3> + <p class="description">Get a field value from a request/response.</p> +<p class="code"> +const char *httpGetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>field</th> + <td class="description">Field to get</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Field value</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetHostname">httpGetHostname</a></h3> + <p class="description">Get the FQDN for the connection or local system.</p> +<p class="code"> +const char *httpGetHostname(<a href="#http_t">http_t</a> *http, char *s, int slen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection or NULL</td></tr> +<tr><th>s</th> + <td class="description">String buffer for name</td></tr> +<tr><th>slen</th> + <td class="description">Size of buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">FQDN for connection or system</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">When "http" points to a connected socket, return the hostname or +address that was used in the call to httpConnect() or httpConnectEncrypt(), +or the address of the client for the connection from httpAcceptConnection(). +Otherwise, return the FQDN for the local system using both gethostname() +and gethostbyname() to get the local hostname with domain. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetKeepAlive">httpGetKeepAlive</a></h3> + <p class="description">Get the current Keep-Alive state of the connection.</p> +<p class="code"> +<a href="#http_keepalive_t">http_keepalive_t</a> httpGetKeepAlive(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Keep-Alive state</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetLength2">httpGetLength2</a></h3> + <p class="description">Get the amount of data remaining from the +content-length or transfer-encoding fields.</p> +<p class="code"> +off_t httpGetLength2(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Content length</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function returns the complete content length, even for +content larger than 2^31 - 1. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetPending">httpGetPending</a></h3> + <p class="description">Get the number of bytes that are buffered for writing.</p> +<p class="code"> +size_t httpGetPending(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of bytes buffered</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetReady">httpGetReady</a></h3> + <p class="description">Get the number of bytes that can be read without blocking.</p> +<p class="code"> +size_t httpGetReady(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of bytes available</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetRemaining">httpGetRemaining</a></h3> + <p class="description">Get the number of remaining bytes in the message +body or current chunk.</p> +<p class="code"> +size_t httpGetRemaining(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Remaining bytes</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <a href="#httpIsChunked"><code>httpIsChunked</code></a> function can be used to determine whether the +message body is chunked or fixed-length. + +</p> +<h3 class="function"><a id="httpGetState">httpGetState</a></h3> + <p class="description">Get the current state of the HTTP request.</p> +<p class="code"> +<a href="#http_state_t">http_state_t</a> httpGetState(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">HTTP state</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetStatus">httpGetStatus</a></h3> + <p class="description">Get the status of the last HTTP request.</p> +<p class="code"> +http_status_t httpGetStatus(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">HTTP status</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetSubField2">httpGetSubField2</a></h3> + <p class="description">Get a sub-field value.</p> +<p class="code"> +char *httpGetSubField2(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *name, char *value, int valuelen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>field</th> + <td class="description">Field index</td></tr> +<tr><th>name</th> + <td class="description">Name of sub-field</td></tr> +<tr><th>value</th> + <td class="description">Value string</td></tr> +<tr><th>valuelen</th> + <td class="description">Size of value buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Value or <code>NULL</code></p> +<h3 class="function"><a id="httpGetVersion">httpGetVersion</a></h3> + <p class="description">Get the HTTP version at the other end.</p> +<p class="code"> +<a href="#http_version_t">http_version_t</a> httpGetVersion(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Version number</p> +<h3 class="function"><a id="httpGets">httpGets</a></h3> + <p class="description">Get a line of text from a HTTP connection.</p> +<p class="code"> +char *httpGets(char *line, int length, <a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>line</th> + <td class="description">Line to read into</td></tr> +<tr><th>length</th> + <td class="description">Max length of buffer</td></tr> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Line or <code>NULL</code></p> +<h3 class="function"><a id="httpHead">httpHead</a></h3> + <p class="description">Send a HEAD request to the server.</p> +<p class="code"> +int httpHead(<a href="#http_t">http_t</a> *http, const char *uri);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>uri</th> + <td class="description">URI for head</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of call (0 = success)</p> +<h3 class="function"><a id="httpInitialize">httpInitialize</a></h3> + <p class="description">Initialize the HTTP interface library and set the +default HTTP proxy (if any).</p> +<p class="code"> +void httpInitialize(void);</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpIsChunked">httpIsChunked</a></h3> + <p class="description">Report whether a message body is chunked.</p> +<p class="code"> +int httpIsChunked(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if chunked, 0 if not</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function returns non-zero if the message body is composed of +variable-length chunks. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpIsEncrypted">httpIsEncrypted</a></h3> + <p class="description">Report whether a connection is encrypted.</p> +<p class="code"> +int httpIsEncrypted(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if encrypted, 0 if not</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function returns non-zero if the connection is currently encrypted. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpLoadCredentials">httpLoadCredentials</a></h3> + <p class="description">Load X.509 credentials from a keychain file.</p> +<p class="code"> +int httpLoadCredentials(const char *path, cups_array_t **credentials, const char *common_name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>path</th> + <td class="description">Keychain path or <code>NULL</code> for default</td></tr> +<tr><th>credentials</th> + <td class="description">Credentials</td></tr> +<tr><th>common_name</th> + <td class="description">Common name for credentials</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">0 on success, -1 on error</p> +<h3 class="function"><a id="httpOptions">httpOptions</a></h3> + <p class="description">Send an OPTIONS request to the server.</p> +<p class="code"> +int httpOptions(<a href="#http_t">http_t</a> *http, const char *uri);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>uri</th> + <td class="description">URI for options</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of call (0 = success)</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpPeek">httpPeek</a></h3> + <p class="description">Peek at data from a HTTP connection.</p> +<p class="code"> +ssize_t httpPeek(<a href="#http_t">http_t</a> *http, char *buffer, size_t length);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>buffer</th> + <td class="description">Buffer for data</td></tr> +<tr><th>length</th> + <td class="description">Maximum number of bytes</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of bytes copied</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function copies available data from the given HTTP connection, reading +a buffer as needed. The data is still available for reading using +<a href="#httpRead2"><code>httpRead2</code></a>.<br> +<br> +For non-blocking connections the usual timeouts apply. + +</p> +<h3 class="function"><a id="httpPost">httpPost</a></h3> + <p class="description">Send a POST request to the server.</p> +<p class="code"> +int httpPost(<a href="#http_t">http_t</a> *http, const char *uri);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>uri</th> + <td class="description">URI for post</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of call (0 = success)</p> +<h3 class="function"><a id="httpPut">httpPut</a></h3> + <p class="description">Send a PUT request to the server.</p> +<p class="code"> +int httpPut(<a href="#http_t">http_t</a> *http, const char *uri);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>uri</th> + <td class="description">URI to put</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of call (0 = success)</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpRead2">httpRead2</a></h3> + <p class="description">Read data from a HTTP connection.</p> +<p class="code"> +ssize_t httpRead2(<a href="#http_t">http_t</a> *http, char *buffer, size_t length);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>buffer</th> + <td class="description">Buffer for data</td></tr> +<tr><th>length</th> + <td class="description">Maximum number of bytes</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of bytes read</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpReadRequest">httpReadRequest</a></h3> + <p class="description">Read a HTTP request from a connection.</p> +<p class="code"> +<a href="#http_state_t">http_state_t</a> httpReadRequest(<a href="#http_t">http_t</a> *http, char *uri, size_t urilen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>uri</th> + <td class="description">URI buffer</td></tr> +<tr><th>urilen</th> + <td class="description">Size of URI buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New state of connection</p> +<h3 class="function"><a id="httpReconnect2">httpReconnect2</a></h3> + <p class="description">Reconnect to a HTTP server with timeout and optional +cancel.</p> +<p class="code"> +int httpReconnect2(<a href="#http_t">http_t</a> *http, int msec, int *cancel);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>msec</th> + <td class="description">Timeout in milliseconds</td></tr> +<tr><th>cancel</th> + <td class="description">Pointer to "cancel" variable</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">0 on success, non-zero on failure</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpResolveHostname">httpResolveHostname</a></h3> + <p class="description">Resolve the hostname of the HTTP connection +address.</p> +<p class="code"> +const char *httpResolveHostname(<a href="#http_t">http_t</a> *http, char *buffer, size_t bufsize);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>buffer</th> + <td class="description">Hostname buffer</td></tr> +<tr><th>bufsize</th> + <td class="description">Size of buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Resolved hostname or <code>NULL</code></p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpSaveCredentials">httpSaveCredentials</a></h3> + <p class="description">Save X.509 credentials to a keychain file.</p> +<p class="code"> +int httpSaveCredentials(const char *path, cups_array_t *credentials, const char *common_name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>path</th> + <td class="description">Keychain path or <code>NULL</code> for default</td></tr> +<tr><th>credentials</th> + <td class="description">Credentials</td></tr> +<tr><th>common_name</th> + <td class="description">Common name for credentials</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">-1 on error, 0 on success</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpSeparateURI">httpSeparateURI</a></h3> + <p class="description">Separate a Universal Resource Identifier into its +components.</p> +<p class="code"> +<a href="#http_uri_status_t">http_uri_status_t</a> httpSeparateURI(<a href="#http_uri_coding_t">http_uri_coding_t</a> decoding, const char *uri, char *scheme, int schemelen, char *username, int usernamelen, char *host, int hostlen, int *port, char *resource, int resourcelen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>decoding</th> + <td class="description">Decoding flags</td></tr> +<tr><th>uri</th> + <td class="description">Universal Resource Identifier</td></tr> +<tr><th>scheme</th> + <td class="description">Scheme (http, https, etc.)</td></tr> +<tr><th>schemelen</th> + <td class="description">Size of scheme buffer</td></tr> +<tr><th>username</th> + <td class="description">Username</td></tr> +<tr><th>usernamelen</th> + <td class="description">Size of username buffer</td></tr> +<tr><th>host</th> + <td class="description">Hostname</td></tr> +<tr><th>hostlen</th> + <td class="description">Size of hostname buffer</td></tr> +<tr><th>port</th> + <td class="description">Port number to use</td></tr> +<tr><th>resource</th> + <td class="description">Resource/filename</td></tr> +<tr><th>resourcelen</th> + <td class="description">Size of resource buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Result of separation</p> +<h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="httpSetAuthString">httpSetAuthString</a></h3> + <p class="description">Set the current authorization string.</p> +<p class="code"> +void httpSetAuthString(<a href="#http_t">http_t</a> *http, const char *scheme, const char *data);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>scheme</th> + <td class="description">Auth scheme (NULL to clear it)</td></tr> +<tr><th>data</th> + <td class="description">Auth data (NULL for none)</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function just stores a copy of the current authorization string in +the HTTP connection object. You must still call <a href="#httpSetField"><code>httpSetField</code></a> to set +<code>HTTP_FIELD_AUTHORIZATION</code> prior to issuing a HTTP request using +<a href="#httpGet"><code>httpGet</code></a>, <a href="#httpHead"><code>httpHead</code></a>, <a href="#httpOptions"><code>httpOptions</code></a>, <a href="#httpPost"><code>httpPost</code></a>, or +<a href="#httpPut"><code>httpPut</code></a>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpSetCookie">httpSetCookie</a></h3> + <p class="description">Set the cookie value(s).</p> +<p class="code"> +void httpSetCookie(<a href="#http_t">http_t</a> *http, const char *cookie);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">Connection</td></tr> +<tr><th>cookie</th> + <td class="description">Cookie string</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpSetCredentials">httpSetCredentials</a></h3> + <p class="description">Set the credentials associated with an encrypted +connection.</p> +<p class="code"> +int httpSetCredentials(<a href="#http_t">http_t</a> *http, cups_array_t *credentials);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>credentials</th> + <td class="description">Array of credentials</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status of call (0 = success)</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpSetDefaultField">httpSetDefaultField</a></h3> + <p class="description">Set the default value of an HTTP header.</p> +<p class="code"> +void httpSetDefaultField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>field</th> + <td class="description">Field index</td></tr> +<tr><th>value</th> + <td class="description">Value</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Currently only <code>HTTP_FIELD_ACCEPT_ENCODING</code>, <code>HTTP_FIELD_SERVER</code>, +and <code>HTTP_FIELD_USER_AGENT</code> can be set. + +</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpSetExpect">httpSetExpect</a></h3> + <p class="description">Set the Expect: header in a request.</p> +<p class="code"> +void httpSetExpect(<a href="#http_t">http_t</a> *http, http_status_t expect);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>expect</th> + <td class="description">HTTP status to expect +(<code>HTTP_STATUS_CONTINUE</code>)</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Currently only <code>HTTP_STATUS_CONTINUE</code> is supported for the "expect" +argument. + +</p> +<h3 class="function"><a id="httpSetField">httpSetField</a></h3> + <p class="description">Set the value of an HTTP header.</p> +<p class="code"> +void httpSetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>field</th> + <td class="description">Field index</td></tr> +<tr><th>value</th> + <td class="description">Value</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpSetKeepAlive">httpSetKeepAlive</a></h3> + <p class="description">Set the current Keep-Alive state of a connection.</p> +<p class="code"> +void httpSetKeepAlive(<a href="#http_t">http_t</a> *http, <a href="#http_keepalive_t">http_keepalive_t</a> keep_alive);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>keep_alive</th> + <td class="description">New Keep-Alive value</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpSetLength">httpSetLength</a></h3> + <p class="description">Set the content-length and content-encoding.</p> +<p class="code"> +void httpSetLength(<a href="#http_t">http_t</a> *http, size_t length);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>length</th> + <td class="description">Length (0 for chunked)</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpSetTimeout">httpSetTimeout</a></h3> + <p class="description">Set read/write timeouts and an optional callback.</p> +<p class="code"> +void httpSetTimeout(<a href="#http_t">http_t</a> *http, double timeout, <a href="#http_timeout_cb_t">http_timeout_cb_t</a> cb, void *user_data);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>timeout</th> + <td class="description">Number of seconds for timeout, +must be greater than 0</td></tr> +<tr><th>cb</th> + <td class="description">Callback function or <code>NULL</code></td></tr> +<tr><th>user_data</th> + <td class="description">User data pointer</td></tr> +</tbody></table> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The optional timeout callback receives both the HTTP connection and a user +data pointer and must return 1 to continue or 0 to error (time) out. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpShutdown">httpShutdown</a></h3> + <p class="description">Shutdown one side of an HTTP connection.</p> +<p class="code"> +void httpShutdown(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpStateString">httpStateString</a></h3> + <p class="description">Return the string describing a HTTP state value.</p> +<p class="code"> +const char *httpStateString(<a href="#http_state_t">http_state_t</a> state);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>state</th> + <td class="description">HTTP state value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">State string</p> +<h3 class="function"><a id="httpStatus">httpStatus</a></h3> + <p class="description">Return a short string describing a HTTP status code.</p> +<p class="code"> +const char *httpStatus(http_status_t status);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>status</th> + <td class="description">HTTP status code</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Localized status string</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The returned string is localized to the current POSIX locale and is based +on the status strings defined in RFC 7231.</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpURIStatusString">httpURIStatusString</a></h3> + <p class="description">Return a string describing a URI status code.</p> +<p class="code"> +const char *httpURIStatusString(<a href="#http_uri_status_t">http_uri_status_t</a> status);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>status</th> + <td class="description">URI status code</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Localized status string</p> +<h3 class="function"><a id="httpUpdate">httpUpdate</a></h3> + <p class="description">Update the current HTTP state for incoming data.</p> +<p class="code"> +http_status_t httpUpdate(<a href="#http_t">http_t</a> *http);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">HTTP status</p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpWait">httpWait</a></h3> + <p class="description">Wait for data available on a connection.</p> +<p class="code"> +int httpWait(<a href="#http_t">http_t</a> *http, int msec);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>msec</th> + <td class="description">Milliseconds to wait</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if data is available, 0 otherwise</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpWrite2">httpWrite2</a></h3> + <p class="description">Write data to a HTTP connection.</p> +<p class="code"> +ssize_t httpWrite2(<a href="#http_t">http_t</a> *http, const char *buffer, size_t length);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>buffer</th> + <td class="description">Buffer for data</td></tr> +<tr><th>length</th> + <td class="description">Number of bytes to write</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of bytes written</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpWriteResponse">httpWriteResponse</a></h3> + <p class="description">Write a HTTP response to a client connection.</p> +<p class="code"> +int httpWriteResponse(<a href="#http_t">http_t</a> *http, http_status_t status);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>status</th> + <td class="description">Status code</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">0 on success, -1 on error</p> +<h3 class="function"><a id="ippAddBoolean">ippAddBoolean</a></h3> + <p class="description">Add a boolean attribute to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBoolean(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, char value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>value</th> + <td class="description">Value of attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> +<h3 class="function"><a id="ippAddBooleans">ippAddBooleans</a></h3> + <p class="description">Add an array of boolean values.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBooleans(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, const char *values);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>num_values</th> + <td class="description">Number of values</td></tr> +<tr><th>values</th> + <td class="description">Values</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippAddCollection">ippAddCollection</a></h3> + <p class="description">Add a collection value.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollection(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, <a href="#ipp_t">ipp_t</a> *value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>value</th> + <td class="description">Value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). + +</p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippAddCollections">ippAddCollections</a></h3> + <p class="description">Add an array of collection values.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollections(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, const <a href="#ipp_t">ipp_t</a> **values);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>num_values</th> + <td class="description">Number of values</td></tr> +<tr><th>values</th> + <td class="description">Values</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). + +</p> +<h3 class="function"><a id="ippAddDate">ippAddDate</a></h3> + <p class="description">Add a dateTime attribute to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddDate(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, const <a href="#ipp_uchar_t">ipp_uchar_t</a> *value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>value</th> + <td class="description">Value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> +<h3 class="function"><a id="ippAddInteger">ippAddInteger</a></h3> + <p class="description">Add a integer attribute to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddInteger(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, int value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>value_tag</th> + <td class="description">Type of attribute</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>value</th> + <td class="description">Value of attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> +<br> +Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer +(<code>IPP_TAG_INTEGER</code>).</p> +<h3 class="function"><a id="ippAddIntegers">ippAddIntegers</a></h3> + <p class="description">Add an array of integer values.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddIntegers(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, int num_values, const int *values);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>value_tag</th> + <td class="description">Type of attribute</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>num_values</th> + <td class="description">Number of values</td></tr> +<tr><th>values</th> + <td class="description">Values</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> +<br> +Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer +(<code>IPP_TAG_INTEGER</code>).</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippAddOctetString">ippAddOctetString</a></h3> + <p class="description">Add an octetString value to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddOctetString(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, const void *data, int datalen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>data</th> + <td class="description">octetString data</td></tr> +<tr><th>datalen</th> + <td class="description">Length of data in bytes</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippAddOutOfBand">ippAddOutOfBand</a></h3> + <p class="description">Add an out-of-band value to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddOutOfBand(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>value_tag</th> + <td class="description">Type of attribute</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> +<br> +Supported out-of-band values include unsupported-value +(<code>IPP_TAG_UNSUPPORTED_VALUE</code>), default (<code>IPP_TAG_DEFAULT</code>), unknown +(<code>IPP_TAG_UNKNOWN</code>), no-value (<code>IPP_TAG_NOVALUE</code>), not-settable +(<code>IPP_TAG_NOTSETTABLE</code>), delete-attribute (<code>IPP_TAG_DELETEATTR</code>), and +admin-define (<code>IPP_TAG_ADMINDEFINE</code>). + +</p> +<h3 class="function"><a id="ippAddRange">ippAddRange</a></h3> + <p class="description">Add a range of values to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRange(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int lower, int upper);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>lower</th> + <td class="description">Lower value</td></tr> +<tr><th>upper</th> + <td class="description">Upper value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> +<br> +The <code>lower</code> parameter must be less than or equal to the <code>upper</code> parameter.</p> +<h3 class="function"><a id="ippAddRanges">ippAddRanges</a></h3> + <p class="description">Add ranges of values to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRanges(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, const int *lower, const int *upper);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>num_values</th> + <td class="description">Number of values</td></tr> +<tr><th>lower</th> + <td class="description">Lower values</td></tr> +<tr><th>upper</th> + <td class="description">Upper values</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> +<h3 class="function"><a id="ippAddResolution">ippAddResolution</a></h3> + <p class="description">Add a resolution value to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolution(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, <a href="#ipp_res_t">ipp_res_t</a> units, int xres, int yres);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>units</th> + <td class="description">Units for resolution</td></tr> +<tr><th>xres</th> + <td class="description">X resolution</td></tr> +<tr><th>yres</th> + <td class="description">Y resolution</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> +<h3 class="function"><a id="ippAddResolutions">ippAddResolutions</a></h3> + <p class="description">Add resolution values to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolutions(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, <a href="#ipp_res_t">ipp_res_t</a> units, const int *xres, const int *yres);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>num_values</th> + <td class="description">Number of values</td></tr> +<tr><th>units</th> + <td class="description">Units for resolution</td></tr> +<tr><th>xres</th> + <td class="description">X resolutions</td></tr> +<tr><th>yres</th> + <td class="description">Y resolutions</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> +<h3 class="function"><a id="ippAddSeparator">ippAddSeparator</a></h3> + <p class="description">Add a group separator to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddSeparator(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.</p> +<h3 class="function"><a id="ippAddString">ippAddString</a></h3> + <p class="description">Add a language-encoded string to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddString(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, const char *language, const char *value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>value_tag</th> + <td class="description">Type of attribute</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>language</th> + <td class="description">Language code</td></tr> +<tr><th>value</th> + <td class="description">Value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> +<br> +Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword +(<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType +(<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage +(<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage +(<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme +(<code>IPP_TAG_URISCHEME</code>).<br> +<br> +The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and +textWithLanguage string values and must be <code>NULL</code> for all other string values.</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippAddStringf">ippAddStringf</a></h3> + <p class="description">Add a formatted string to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStringf(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, const char *language, const char *format, ...);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>value_tag</th> + <td class="description">Type of attribute</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>language</th> + <td class="description">Language code (<code>NULL</code> for default)</td></tr> +<tr><th>format</th> + <td class="description">Printf-style format string</td></tr> +<tr><th>...</th> + <td class="description">Additional arguments as needed</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document +(<code>IPP_TAG_DOCUMENT</code>), event notification +(<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), +printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), +or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> +<br> +Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword +(<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType +(<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage +(<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage +(<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme +(<code>IPP_TAG_URISCHEME</code>).<br> +<br> +The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage +and textWithLanguage string values and must be <code>NULL</code> for all other +string values.<br> +<br> +The <code>format</code> parameter uses formatting characters compatible with the +printf family of standard functions. Additional arguments follow it as +needed. The formatted string is truncated as needed to the maximum length of +the corresponding value type. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippAddStringfv">ippAddStringfv</a></h3> + <p class="description">Add a formatted string to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStringfv(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, const char *language, const char *format, va_list ap);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>value_tag</th> + <td class="description">Type of attribute</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>language</th> + <td class="description">Language code (<code>NULL</code> for default)</td></tr> +<tr><th>format</th> + <td class="description">Printf-style format string</td></tr> +<tr><th>ap</th> + <td class="description">Additional arguments</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document +(<code>IPP_TAG_DOCUMENT</code>), event notification +(<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), +printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), +or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> +<br> +Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword +(<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType +(<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage +(<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage +(<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme +(<code>IPP_TAG_URISCHEME</code>).<br> +<br> +The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage +and textWithLanguage string values and must be <code>NULL</code> for all other +string values.<br> +<br> +The <code>format</code> parameter uses formatting characters compatible with the +printf family of standard functions. Additional arguments are passed in the +stdarg pointer <code>ap</code>. The formatted string is truncated as needed to the +maximum length of the corresponding value type. + +</p> +<h3 class="function"><a id="ippAddStrings">ippAddStrings</a></h3> + <p class="description">Add language-encoded strings to an IPP message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStrings(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, int num_values, const char *language, const char *const *values);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>group</th> + <td class="description">IPP group</td></tr> +<tr><th>value_tag</th> + <td class="description">Type of attribute</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>num_values</th> + <td class="description">Number of values</td></tr> +<tr><th>language</th> + <td class="description">Language code (<code>NULL</code> for default)</td></tr> +<tr><th>values</th> + <td class="description">Values</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> +<br> +Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword +(<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType +(<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage +(<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage +(<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme +(<code>IPP_TAG_URISCHEME</code>).<br> +<br> +The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and +textWithLanguage string values and must be <code>NULL</code> for all other string values.</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippAttributeString">ippAttributeString</a></h3> + <p class="description">Convert the attribute's value to a string.</p> +<p class="code"> +size_t ippAttributeString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, char *buffer, size_t bufsize);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">Attribute</td></tr> +<tr><th>buffer</th> + <td class="description">String buffer or NULL</td></tr> +<tr><th>bufsize</th> + <td class="description">Size of string buffer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of bytes less nul</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Returns the number of bytes that would be written, not including the +trailing nul. The buffer pointer can be NULL to get the required length, +just like (v)snprintf. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippContainsInteger">ippContainsInteger</a></h3> + <p class="description">Determine whether an attribute contains the +specified value or is within the list of ranges.</p> +<p class="code"> +int ippContainsInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">Attribute</td></tr> +<tr><th>value</th> + <td class="description">Integer/enum value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on a match, 0 on no match</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Returns non-zero when the attribute contains either a matching integer or +enum value, or the value falls within one of the rangeOfInteger values for +the attribute. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippContainsString">ippContainsString</a></h3> + <p class="description">Determine whether an attribute contains the +specified string value.</p> +<p class="code"> +int ippContainsString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, const char *value);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">Attribute</td></tr> +<tr><th>value</th> + <td class="description">String value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on a match, 0 on no match</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Returns non-zero when the attribute contains a matching charset, keyword, +naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippCopyAttribute">ippCopyAttribute</a></h3> + <p class="description">Copy an attribute.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippCopyAttribute(<a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_attribute_t">ipp_attribute_t</a> *srcattr, int quickcopy);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>dst</th> + <td class="description">Destination IPP message</td></tr> +<tr><th>srcattr</th> + <td class="description">Attribute to copy</td></tr> +<tr><th>quickcopy</th> + <td class="description">1 for a referenced copy, 0 for normal</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The specified attribute, <code>attr</code>, is copied to the destination IPP message. +When <code>quickcopy</code> is non-zero, a "shallow" reference copy of the attribute is +created - this should only be done as long as the original source IPP message will +not be freed for the life of the destination. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippCopyAttributes">ippCopyAttributes</a></h3> + <p class="description">Copy attributes from one IPP message to another.</p> +<p class="code"> +int ippCopyAttributes(<a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_t">ipp_t</a> *src, int quickcopy, <a href="#ipp_copycb_t">ipp_copycb_t</a> cb, void *context);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>dst</th> + <td class="description">Destination IPP message</td></tr> +<tr><th>src</th> + <td class="description">Source IPP message</td></tr> +<tr><th>quickcopy</th> + <td class="description">1 for a referenced copy, 0 for normal</td></tr> +<tr><th>cb</th> + <td class="description">Copy callback or <code>NULL</code> for none</td></tr> +<tr><th>context</th> + <td class="description">Context pointer</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on error</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Zero or more attributes are copied from the source IPP message, <code>src</code>, to the +destination IPP message, <code>dst</code>. When <code>quickcopy</code> is non-zero, a "shallow" +reference copy of the attribute is created - this should only be done as long as the +original source IPP message will not be freed for the life of the destination.<br> +<br> +The <code>cb</code> and <code>context</code> parameters provide a generic way to "filter" the +attributes that are copied - the function must return 1 to copy the attribute or +0 to skip it. The function may also choose to do a partial copy of the source attribute +itself. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippCreateRequestedArray">ippCreateRequestedArray</a></h3> + <p class="description">Create a CUPS array of attribute names from the +given requested-attributes attribute.</p> +<p class="code"> +cups_array_t *ippCreateRequestedArray(<a href="#ipp_t">ipp_t</a> *request);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>request</th> + <td class="description">IPP request</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">CUPS array or <code>NULL</code> if all</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function creates a (sorted) CUPS array of attribute names matching the +list of "requested-attribute" values supplied in an IPP request. All IANA- +registered values are supported in addition to the CUPS IPP extension +attributes.<br> +<br> +The <code>request</code> parameter specifies the request message that was read from +the client. + +<code>NULL</code> is returned if all attributes should be returned. Otherwise, the +result is a sorted array of attribute names, where <code>cupsArrayFind(array, +"attribute-name")</code> will return a non-NULL pointer. The array must be freed +using the <code>cupsArrayDelete</code> function. + +</p> +<h3 class="function"><a id="ippDateToTime">ippDateToTime</a></h3> + <p class="description">Convert from RFC 2579 Date/Time format to time in +seconds.</p> +<p class="code"> +time_t ippDateToTime(const <a href="#ipp_uchar_t">ipp_uchar_t</a> *date);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>date</th> + <td class="description">RFC 2579 date info</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">UNIX time value</p> +<h3 class="function"><a id="ippDelete">ippDelete</a></h3> + <p class="description">Delete an IPP message.</p> +<p class="code"> +void ippDelete(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippDeleteAttribute">ippDeleteAttribute</a></h3> + <p class="description">Delete a single attribute in an IPP message.</p> +<p class="code"> +void ippDeleteAttribute(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">Attribute to delete</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippDeleteValues">ippDeleteValues</a></h3> + <p class="description">Delete values in an attribute.</p> +<p class="code"> +int ippDeleteValues(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int count);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">Attribute</td></tr> +<tr><th>element</th> + <td class="description">Index of first value to delete (0-based)</td></tr> +<tr><th>count</th> + <td class="description">Number of values to delete</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>element</code> parameter specifies the first value to delete, starting at +0. It must be less than the number of values returned by <a href="#ippGetCount"><code>ippGetCount</code></a>.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +Deleting all values in an attribute deletes the attribute. + +</p> +<h3 class="function"><a id="ippEnumString">ippEnumString</a></h3> + <p class="description">Return a string corresponding to the enum value.</p> +<p class="code"> +const char *ippEnumString(const char *attrname, int enumvalue);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attrname</th> + <td class="description">Attribute name</td></tr> +<tr><th>enumvalue</th> + <td class="description">Enum value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Enum string</p> +<h3 class="function"><a id="ippEnumValue">ippEnumValue</a></h3> + <p class="description">Return the value associated with a given enum string.</p> +<p class="code"> +int ippEnumValue(const char *attrname, const char *enumstring);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attrname</th> + <td class="description">Attribute name</td></tr> +<tr><th>enumstring</th> + <td class="description">Enum string</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Enum value or -1 if unknown</p> +<h3 class="function"><a id="ippErrorString">ippErrorString</a></h3> + <p class="description">Return a name for the given status code.</p> +<p class="code"> +const char *ippErrorString(ipp_status_t error);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>error</th> + <td class="description">Error status</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Text string</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippErrorValue">ippErrorValue</a></h3> + <p class="description">Return a status code for the given name.</p> +<p class="code"> +ipp_status_t ippErrorValue(const char *name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Name</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">IPP status code</p> +<h3 class="function"><a id="ippFindAttribute">ippFindAttribute</a></h3> + <p class="description">Find a named attribute in a request.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindAttribute(<a href="#ipp_t">ipp_t</a> *ipp, const char *name, ipp_tag_t type);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>type</th> + <td class="description">Type of attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Matching attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list +of attribute and member names separated by slashes, for example +"media-col/media-size".</p> +<h3 class="function"><a id="ippFindNextAttribute">ippFindNextAttribute</a></h3> + <p class="description">Find the next named attribute in a request.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindNextAttribute(<a href="#ipp_t">ipp_t</a> *ipp, const char *name, ipp_tag_t type);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>name</th> + <td class="description">Name of attribute</td></tr> +<tr><th>type</th> + <td class="description">Type of attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Matching attribute</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list +of attribute and member names separated by slashes, for example +"media-col/media-size".</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippFirstAttribute">ippFirstAttribute</a></h3> + <p class="description">Return the first attribute in the message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFirstAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">First attribute or <code>NULL</code> if none</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetBoolean">ippGetBoolean</a></h3> + <p class="description">Get a boolean value for an attribute.</p> +<p class="code"> +int ippGetBoolean(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Boolean value or 0 on error</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to +<code>ippGetCount(attr)</code> - 1. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetCollection">ippGetCollection</a></h3> + <p class="description">Get a collection value for an attribute.</p> +<p class="code"> +<a href="#ipp_t">ipp_t</a> *ippGetCollection(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Collection value or <code>NULL</code> on error</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to +<code>ippGetCount(attr)</code> - 1. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetCount">ippGetCount</a></h3> + <p class="description">Get the number of values in an attribute.</p> +<p class="code"> +int ippGetCount(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Number of values or 0 on error</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetDate">ippGetDate</a></h3> + <p class="description">Get a dateTime value for an attribute.</p> +<p class="code"> +const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippGetDate(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">dateTime value or <code>NULL</code></p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to +<code>ippGetCount(attr)</code> - 1. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetGroupTag">ippGetGroupTag</a></h3> + <p class="description">Get the group associated with an attribute.</p> +<p class="code"> +ipp_tag_t ippGetGroupTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Group tag or <code>IPP_TAG_ZERO</code> on error</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetInteger">ippGetInteger</a></h3> + <p class="description">Get the integer/enum value for an attribute.</p> +<p class="code"> +int ippGetInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Value or 0 on error</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to +<code>ippGetCount(attr)</code> - 1. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetName">ippGetName</a></h3> + <p class="description">Get the attribute name.</p> +<p class="code"> +const char *ippGetName(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Attribute name or <code>NULL</code> for separators</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippGetOctetString">ippGetOctetString</a></h3> + <p class="description">Get an octetString value from an IPP attribute.</p> +<p class="code"> +void *ippGetOctetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *datalen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>datalen</th> + <td class="description">Length of octetString data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Pointer to octetString data</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to +<code>ippGetCount(attr)</code> - 1. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetOperation">ippGetOperation</a></h3> + <p class="description">Get the operation ID in an IPP message.</p> +<p class="code"> +ipp_op_t ippGetOperation(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP request message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Operation ID or 0 on error</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetRange">ippGetRange</a></h3> + <p class="description">Get a rangeOfInteger value from an attribute.</p> +<p class="code"> +int ippGetRange(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *uppervalue);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>uppervalue</th> + <td class="description">Upper value of range</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Lower value of range or 0</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to +<code>ippGetCount(attr)</code> - 1. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetRequestId">ippGetRequestId</a></h3> + <p class="description">Get the request ID from an IPP message.</p> +<p class="code"> +int ippGetRequestId(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Request ID or 0 on error</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetResolution">ippGetResolution</a></h3> + <p class="description">Get a resolution value for an attribute.</p> +<p class="code"> +int ippGetResolution(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *yres, <a href="#ipp_res_t">ipp_res_t</a> *units);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>yres</th> + <td class="description">Vertical/feed resolution</td></tr> +<tr><th>units</th> + <td class="description">Units for resolution</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Horizontal/cross feed resolution or 0</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to +<code>ippGetCount(attr)</code> - 1. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetState">ippGetState</a></h3> + <p class="description">Get the IPP message state.</p> +<p class="code"> +<a href="#ipp_state_t">ipp_state_t</a> ippGetState(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">IPP message state value</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetStatusCode">ippGetStatusCode</a></h3> + <p class="description">Get the status code from an IPP response or event message.</p> +<p class="code"> +ipp_status_t ippGetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP response or event message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Status code in IPP message</p> +<h3 class="function"><a id="ippGetString">ippGetString</a></h3> + <p class="description"></p> +<p class="code"> +const char *ippGetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, const char **language);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>language</th> + <td class="description">Language code (<code>NULL</code> for don't care)</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Get the string and optionally the language code for an attribute.</p> + <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to +<code>ippGetCount(attr)</code> - 1. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetValueTag">ippGetValueTag</a></h3> + <p class="description">Get the value tag for an attribute.</p> +<p class="code"> +ipp_tag_t ippGetValueTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Value tag or <code>IPP_TAG_ZERO</code> on error</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetVersion">ippGetVersion</a></h3> + <p class="description">Get the major and minor version number from an IPP message.</p> +<p class="code"> +int ippGetVersion(<a href="#ipp_t">ipp_t</a> *ipp, int *minor);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>minor</th> + <td class="description">Minor version number or <code>NULL</code> for don't care</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Major version number or 0 on error</p> +<h3 class="function"><a id="ippLength">ippLength</a></h3> + <p class="description">Compute the length of an IPP message.</p> +<p class="code"> +size_t ippLength(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Size of IPP message</p> +<h3 class="function"><a id="ippNew">ippNew</a></h3> + <p class="description">Allocate a new IPP message.</p> +<p class="code"> +<a href="#ipp_t">ipp_t</a> *ippNew(void);</p> +<h4 class="returnvalue">Return Value</h4> + <p class="description">New IPP message</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippNewRequest">ippNewRequest</a></h3> + <p class="description">Allocate a new IPP request message.</p> +<p class="code"> +<a href="#ipp_t">ipp_t</a> *ippNewRequest(ipp_op_t op);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>op</th> + <td class="description">Operation code</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">IPP request message</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The new request message is initialized with the "attributes-charset" and +"attributes-natural-language" attributes added. The +"attributes-natural-language" value is derived from the current locale. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippNewResponse">ippNewResponse</a></h3> + <p class="description">Allocate a new IPP response message.</p> +<p class="code"> +<a href="#ipp_t">ipp_t</a> *ippNewResponse(<a href="#ipp_t">ipp_t</a> *request);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>request</th> + <td class="description">IPP request message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">IPP response message</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The new response message is initialized with the same "version-number", +"request-id", "attributes-charset", and "attributes-natural-language" as the +provided request message. If the "attributes-charset" or +"attributes-natural-language" attributes are missing from the request, +'utf-8' and a value derived from the current locale are substituted, +respectively. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippNextAttribute">ippNextAttribute</a></h3> + <p class="description">Return the next attribute in the message.</p> +<p class="code"> +<a href="#ipp_attribute_t">ipp_attribute_t</a> *ippNextAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Next attribute or <code>NULL</code> if none</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippOpString">ippOpString</a></h3> + <p class="description">Return a name for the given operation id.</p> +<p class="code"> +const char *ippOpString(ipp_op_t op);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>op</th> + <td class="description">Operation ID</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Name</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippOpValue">ippOpValue</a></h3> + <p class="description">Return an operation id for the given name.</p> +<p class="code"> +ipp_op_t ippOpValue(const char *name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Textual name</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Operation ID</p> +<h3 class="function"><a id="ippPort">ippPort</a></h3> + <p class="description">Return the default IPP port number.</p> +<p class="code"> +int ippPort(void);</p> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Port number</p> +<h3 class="function"><a id="ippRead">ippRead</a></h3> + <p class="description">Read data for an IPP message from a HTTP connection.</p> +<p class="code"> +<a href="#ipp_state_t">ipp_state_t</a> ippRead(<a href="#http_t">http_t</a> *http, <a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>ipp</th> + <td class="description">IPP data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Current state</p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippReadFile">ippReadFile</a></h3> + <p class="description">Read data for an IPP message from a file.</p> +<p class="code"> +<a href="#ipp_state_t">ipp_state_t</a> ippReadFile(int fd, <a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>fd</th> + <td class="description">HTTP data</td></tr> +<tr><th>ipp</th> + <td class="description">IPP data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Current state</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippReadIO">ippReadIO</a></h3> + <p class="description">Read data for an IPP message.</p> +<p class="code"> +<a href="#ipp_state_t">ipp_state_t</a> ippReadIO(void *src, <a href="#ipp_iocb_t">ipp_iocb_t</a> cb, int blocking, <a href="#ipp_t">ipp_t</a> *parent, <a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>src</th> + <td class="description">Data source</td></tr> +<tr><th>cb</th> + <td class="description">Read callback function</td></tr> +<tr><th>blocking</th> + <td class="description">Use blocking IO?</td></tr> +<tr><th>parent</th> + <td class="description">Parent request, if any</td></tr> +<tr><th>ipp</th> + <td class="description">IPP data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Current state</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetBoolean">ippSetBoolean</a></h3> + <p class="description">Set a boolean value in an attribute.</p> +<p class="code"> +int ippSetBoolean(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int boolvalue);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>boolvalue</th> + <td class="description">Boolean value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetCollection">ippSetCollection</a></h3> + <p class="description">Set a collection value in an attribute.</p> +<p class="code"> +int ippSetCollection(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, <a href="#ipp_t">ipp_t</a> *colvalue);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>colvalue</th> + <td class="description">Collection value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetDate">ippSetDate</a></h3> + <p class="description">Set a dateTime value in an attribute.</p> +<p class="code"> +int ippSetDate(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const <a href="#ipp_uchar_t">ipp_uchar_t</a> *datevalue);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>datevalue</th> + <td class="description">dateTime value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetGroupTag">ippSetGroupTag</a></h3> + <p class="description">Set the group tag of an attribute.</p> +<p class="code"> +int ippSetGroupTag(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, ipp_tag_t group_tag);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">Attribute</td></tr> +<tr><th>group_tag</th> + <td class="description">Group tag</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>group</code> parameter specifies the IPP attribute group tag: none +(<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), +event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation +(<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription +(<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetInteger">ippSetInteger</a></h3> + <p class="description">Set an integer or enum value in an attribute.</p> +<p class="code"> +int ippSetInteger(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int intvalue);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>intvalue</th> + <td class="description">Integer/enum value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetName">ippSetName</a></h3> + <p class="description">Set the name of an attribute.</p> +<p class="code"> +int ippSetName(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, const char *name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>name</th> + <td class="description">Attribute name</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippSetOctetString">ippSetOctetString</a></h3> + <p class="description">Set an octetString value in an IPP attribute.</p> +<p class="code"> +int ippSetOctetString(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const void *data, int datalen);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>data</th> + <td class="description">Pointer to octetString data</td></tr> +<tr><th>datalen</th> + <td class="description">Length of octetString data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetOperation">ippSetOperation</a></h3> + <p class="description">Set the operation ID in an IPP request message.</p> +<p class="code"> +int ippSetOperation(<a href="#ipp_t">ipp_t</a> *ipp, ipp_op_t op);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP request message</td></tr> +<tr><th>op</th> + <td class="description">Operation ID</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. + +</p> +<h3 class="function"><a id="ippSetPort">ippSetPort</a></h3> + <p class="description">Set the default port number.</p> +<p class="code"> +void ippSetPort(int p);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>p</th> + <td class="description">Port number to use</td></tr> +</tbody></table> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetRange">ippSetRange</a></h3> + <p class="description">Set a rangeOfInteger value in an attribute.</p> +<p class="code"> +int ippSetRange(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int lowervalue, int uppervalue);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>lowervalue</th> + <td class="description">Lower bound for range</td></tr> +<tr><th>uppervalue</th> + <td class="description">Upper bound for range</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetRequestId">ippSetRequestId</a></h3> + <p class="description">Set the request ID in an IPP message.</p> +<p class="code"> +int ippSetRequestId(<a href="#ipp_t">ipp_t</a> *ipp, int request_id);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>request_id</th> + <td class="description">Request ID</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>request_id</code> parameter must be greater than 0. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetResolution">ippSetResolution</a></h3> + <p class="description">Set a resolution value in an attribute.</p> +<p class="code"> +int ippSetResolution(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, <a href="#ipp_res_t">ipp_res_t</a> unitsvalue, int xresvalue, int yresvalue);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>unitsvalue</th> + <td class="description">Resolution units</td></tr> +<tr><th>xresvalue</th> + <td class="description">Horizontal/cross feed resolution</td></tr> +<tr><th>yresvalue</th> + <td class="description">Vertical/feed resolution</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetState">ippSetState</a></h3> + <p class="description">Set the current state of the IPP message.</p> +<p class="code"> +int ippSetState(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_state_t">ipp_state_t</a> state);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>state</th> + <td class="description">IPP state value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetStatusCode">ippSetStatusCode</a></h3> + <p class="description">Set the status code in an IPP response or event message.</p> +<p class="code"> +int ippSetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp, ipp_status_t status);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP response or event message</td></tr> +<tr><th>status</th> + <td class="description">Status code</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetString">ippSetString</a></h3> + <p class="description">Set a string value in an attribute.</p> +<p class="code"> +int ippSetString(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const char *strvalue);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>strvalue</th> + <td class="description">String value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippSetStringf">ippSetStringf</a></h3> + <p class="description">Set a formatted string value of an attribute.</p> +<p class="code"> +int ippSetStringf(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const char *format, ...);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>format</th> + <td class="description">Printf-style format string</td></tr> +<tr><th>...</th> + <td class="description">Additional arguments as needed</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>.<br> +<br> +The <code>format</code> parameter uses formatting characters compatible with the +printf family of standard functions. Additional arguments follow it as +needed. The formatted string is truncated as needed to the maximum length of +the corresponding value type. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippSetStringfv">ippSetStringfv</a></h3> + <p class="description">Set a formatted string value of an attribute.</p> +<p class="code"> +int ippSetStringfv(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const char *format, va_list ap);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>element</th> + <td class="description">Value number (0-based)</td></tr> +<tr><th>format</th> + <td class="description">Printf-style format string</td></tr> +<tr><th>ap</th> + <td class="description">Pointer to additional arguments</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +The <code>element</code> parameter specifies which value to set from 0 to +<code>ippGetCount(attr)</code>.<br> +<br> +The <code>format</code> parameter uses formatting characters compatible with the +printf family of standard functions. Additional arguments follow it as +needed. The formatted string is truncated as needed to the maximum length of +the corresponding value type. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetValueTag">ippSetValueTag</a></h3> + <p class="description">Set the value tag of an attribute.</p> +<p class="code"> +int ippSetValueTag(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, ipp_tag_t value_tag);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>attr</th> + <td class="description">IPP attribute</td></tr> +<tr><th>value_tag</th> + <td class="description">Value tag</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The <code>attr</code> parameter may be modified as a result of setting the value.<br> +<br> +Integer (<code>IPP_TAG_INTEGER</code>) values can be promoted to rangeOfInteger +(<code>IPP_TAG_RANGE</code>) values, the various string tags can be promoted to name +(<code>IPP_TAG_NAME</code>) or nameWithLanguage (<code>IPP_TAG_NAMELANG</code>) values, text +(<code>IPP_TAG_TEXT</code>) values can be promoted to textWithLanguage +(<code>IPP_TAG_TEXTLANG</code>) values, and all values can be demoted to the various +out-of-band value tags such as no-value (<code>IPP_TAG_NOVALUE</code>). All other changes +will be rejected.<br> +<br> +Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language +code in the "attributes-natural-language" attribute or, if not present, the language +code for the current locale. + +</p> +<h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetVersion">ippSetVersion</a></h3> + <p class="description">Set the version number in an IPP message.</p> +<p class="code"> +int ippSetVersion(<a href="#ipp_t">ipp_t</a> *ipp, int major, int minor);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +<tr><th>major</th> + <td class="description">Major version number (major.minor)</td></tr> +<tr><th>minor</th> + <td class="description">Minor version number (major.minor)</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 on success, 0 on failure</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using +the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> +<br> +The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2. + +</p> +<h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="ippStateString">ippStateString</a></h3> + <p class="description">Return the name corresponding to a state value.</p> +<p class="code"> +const char *ippStateString(<a href="#ipp_state_t">ipp_state_t</a> state);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>state</th> + <td class="description">State value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">State name</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="ippTagString">ippTagString</a></h3> + <p class="description">Return the tag name corresponding to a tag value.</p> +<p class="code"> +const char *ippTagString(ipp_tag_t tag);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>tag</th> + <td class="description">Tag value</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Tag name</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The returned names are defined in RFC 8011 and the IANA IPP Registry. + +</p> +<h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="ippTagValue">ippTagValue</a></h3> + <p class="description">Return the tag value corresponding to a tag name.</p> +<p class="code"> +ipp_tag_t ippTagValue(const char *name);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>name</th> + <td class="description">Tag name</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Tag value</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">The tag names are defined in RFC 8011 and the IANA IPP Registry. + +</p> +<h3 class="function"><a id="ippTimeToDate">ippTimeToDate</a></h3> + <p class="description">Convert from time in seconds to RFC 2579 format.</p> +<p class="code"> +const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippTimeToDate(time_t t);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>t</th> + <td class="description">Time in seconds</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">RFC-2579 date/time data</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippValidateAttribute">ippValidateAttribute</a></h3> + <p class="description">Validate the contents of an attribute.</p> +<p class="code"> +int ippValidateAttribute(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>attr</th> + <td class="description">Attribute</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if valid, 0 otherwise</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function validates the contents of an attribute based on the name and +value tag. 1 is returned if the attribute is valid, 0 otherwise. On +failure, <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> is set to a human-readable message. + +</p> +<h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippValidateAttributes">ippValidateAttributes</a></h3> + <p class="description">Validate all attributes in an IPP message.</p> +<p class="code"> +int ippValidateAttributes(<a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>ipp</th> + <td class="description">IPP message</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">1 if valid, 0 otherwise</p> +<h4 class="discussion">Discussion</h4> + <p class="discussion">This function validates the contents of the IPP message, including each +attribute. Like <a href="#ippValidateAttribute"><code>ippValidateAttribute</code></a>, <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> is +set to a human-readable message on failure. + +</p> +<h3 class="function"><a id="ippWrite">ippWrite</a></h3> + <p class="description">Write data for an IPP message to a HTTP connection.</p> +<p class="code"> +<a href="#ipp_state_t">ipp_state_t</a> ippWrite(<a href="#http_t">http_t</a> *http, <a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>http</th> + <td class="description">HTTP connection</td></tr> +<tr><th>ipp</th> + <td class="description">IPP data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Current state</p> +<h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippWriteFile">ippWriteFile</a></h3> + <p class="description">Write data for an IPP message to a file.</p> +<p class="code"> +<a href="#ipp_state_t">ipp_state_t</a> ippWriteFile(int fd, <a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>fd</th> + <td class="description">HTTP data</td></tr> +<tr><th>ipp</th> + <td class="description">IPP data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Current state</p> +<h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippWriteIO">ippWriteIO</a></h3> + <p class="description">Write data for an IPP message.</p> +<p class="code"> +<a href="#ipp_state_t">ipp_state_t</a> ippWriteIO(void *dst, <a href="#ipp_iocb_t">ipp_iocb_t</a> cb, int blocking, <a href="#ipp_t">ipp_t</a> *parent, <a href="#ipp_t">ipp_t</a> *ipp);</p> +<h4 class="parameters">Parameters</h4> +<table class="list"><tbody> +<tr><th>dst</th> + <td class="description">Destination</td></tr> +<tr><th>cb</th> + <td class="description">Write callback function</td></tr> +<tr><th>blocking</th> + <td class="description">Use blocking IO?</td></tr> +<tr><th>parent</th> + <td class="description">Parent IPP message</td></tr> +<tr><th>ipp</th> + <td class="description">IPP data</td></tr> +</tbody></table> +<h4 class="returnvalue">Return Value</h4> + <p class="description">Current state</p> + <h2 class="title"><a id="TYPES">Data Types</a></h2> + <h3 class="typedef"><a id="cups_client_cert_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>cups_client_cert_cb_t</a></h3> + <p class="description">Client credentials callback +</p> + <p class="code"> +typedef int(*)(http_t *http, void *tls, cups_array_t *distinguished_names, void *user_data)cups_client_cert_cb_t; +</p> + <h3 class="typedef"><a id="cups_dest_cb_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>cups_dest_cb_t</a></h3> + <p class="description">Destination enumeration callback +</p> + <p class="code"> +typedef int(*)(void *user_data, unsigned flags, <a href="#cups_dest_t">cups_dest_t</a> *dest)cups_dest_cb_t; +</p> + <h3 class="typedef"><a id="cups_dest_t">cups_dest_t</a></h3> + <p class="description">Destination</p> + <p class="code"> +typedef struct <a href="#cups_dest_s">cups_dest_s</a> cups_dest_t; +</p> + <h3 class="typedef"><a id="cups_dinfo_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>cups_dinfo_t</a></h3> + <p class="description">Destination capability and status +information </p> + <p class="code"> +typedef struct _cups_dinfo_s cups_dinfo_t; +</p> + <h3 class="typedef"><a id="cups_job_t">cups_job_t</a></h3> + <p class="description">Job</p> + <p class="code"> +typedef struct <a href="#cups_job_s">cups_job_s</a> cups_job_t; +</p> + <h3 class="typedef"><a id="cups_option_t">cups_option_t</a></h3> + <p class="description">Printer Options</p> + <p class="code"> +typedef struct <a href="#cups_option_s">cups_option_s</a> cups_option_t; +</p> + <h3 class="typedef"><a id="cups_password_cb2_t"><span class="info"> CUPS 1.4/macOS 10.6 </span>cups_password_cb2_t</a></h3> + <p class="description">New password callback +</p> + <p class="code"> +typedef const char *(*)(const char *prompt, <a href="#http_t">http_t</a> *http, const char *method, const char *resource, void *user_data)cups_password_cb2_t; +</p> + <h3 class="typedef"><a id="cups_ptype_t">cups_ptype_t</a></h3> + <p class="description">Printer type/capability bits</p> + <p class="code"> +typedef unsigned cups_ptype_t; +</p> + <h3 class="typedef"><a id="cups_server_cert_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>cups_server_cert_cb_t</a></h3> + <p class="description">Server credentials callback +</p> + <p class="code"> +typedef int(*)(http_t *http, void *tls, cups_array_t *certs, void *user_data)cups_server_cert_cb_t; +</p> + <h3 class="typedef"><a id="cups_size_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>cups_size_t</a></h3> + <p class="description">Media Size </p> + <p class="code"> +typedef struct <a href="#cups_size_s">cups_size_s</a> cups_size_t; +</p> + <h3 class="typedef"><a id="http_addr_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>http_addr_t</a></h3> + <p class="description">Socket address union, which +makes using IPv6 and other +address types easier and +more portable. </p> + <p class="code"> +typedef union _http_addr_u / http_addr_t; +</p> + <h3 class="typedef"><a id="http_encoding_t">http_encoding_t</a></h3> + <p class="description">HTTP transfer encoding values</p> + <p class="code"> +typedef enum <a href="#http_encoding_e">http_encoding_e</a> http_encoding_t; +</p> + <h3 class="typedef"><a id="http_encryption_t">http_encryption_t</a></h3> + <p class="description">HTTP encryption values</p> + <p class="code"> +typedef enum <a href="#http_encryption_e">http_encryption_e</a> http_encryption_t; +</p> + <h3 class="typedef"><a id="http_field_t">http_field_t</a></h3> + <p class="description">HTTP field names</p> + <p class="code"> +typedef enum <a href="#http_field_e">http_field_e</a> http_field_t; +</p> + <h3 class="typedef"><a id="http_keepalive_t">http_keepalive_t</a></h3> + <p class="description">HTTP keep-alive values</p> + <p class="code"> +typedef enum <a href="#http_keepalive_e">http_keepalive_e</a> http_keepalive_t; +</p> + <h3 class="typedef"><a id="http_state_t">http_state_t</a></h3> + <p class="description">HTTP state values; states +are server-oriented...</p> + <p class="code"> +typedef enum <a href="#http_state_e">http_state_e</a> http_state_t; +</p> + <h3 class="typedef"><a id="http_t">http_t</a></h3> + <p class="description">HTTP connection type</p> + <p class="code"> +typedef struct _http_s http_t; +</p> + <h3 class="typedef"><a id="http_timeout_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>http_timeout_cb_t</a></h3> + <p class="description">HTTP timeout callback </p> + <p class="code"> +typedef int(*)(http_t *http, void *user_data)http_timeout_cb_t; +</p> + <h3 class="typedef"><a id="http_trust_t"><span class="info"> CUPS 2.0/OS 10.10 </span>http_trust_t</a></h3> + <p class="description">Level of trust for credentials </p> + <p class="code"> +typedef enum <a href="#http_trust_e">http_trust_e</a> http_trust_t; +</p> + <h3 class="typedef"><a id="http_uri_coding_t">http_uri_coding_t</a></h3> + <p class="description">URI en/decode flags</p> + <p class="code"> +typedef enum <a href="#http_uri_coding_e">http_uri_coding_e</a> http_uri_coding_t; +</p> + <h3 class="typedef"><a id="http_uri_status_t"><span class="info"> CUPS 1.2 </span>http_uri_status_t</a></h3> + <p class="description">URI separation status </p> + <p class="code"> +typedef enum <a href="#http_uri_status_e">http_uri_status_e</a> http_uri_status_t; +</p> + <h3 class="typedef"><a id="ipp_attribute_t">ipp_attribute_t</a></h3> + <p class="description">IPP attribute</p> + <p class="code"> +typedef struct _ipp_attribute_s ipp_attribute_t; +</p> + <h3 class="typedef"><a id="ipp_copycb_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>ipp_copycb_t</a></h3> + <p class="description">ippCopyAttributes callback function </p> + <p class="code"> +typedef int(*)(void *context, <a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr)ipp_copycb_t; +</p> + <h3 class="typedef"><a id="ipp_iocb_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ipp_iocb_t</a></h3> + <p class="description">ippReadIO/ippWriteIO callback function </p> + <p class="code"> +typedef ssize_t(*)(void *context, ipp_uchar_t *buffer, size_t bytes) ipp_iocb_t; +</p> + <h3 class="typedef"><a id="ipp_orient_t">ipp_orient_t</a></h3> + <p class="description">Orientation values</p> + <p class="code"> +typedef enum <a href="#ipp_orient_e">ipp_orient_e</a> ipp_orient_t; +</p> + <h3 class="typedef"><a id="ipp_pstate_t">ipp_pstate_t</a></h3> + <p class="description">Printer state values</p> + <p class="code"> +typedef enum <a href="#ipp_pstate_e">ipp_pstate_e</a> ipp_pstate_t; +</p> + <h3 class="typedef"><a id="ipp_quality_t">ipp_quality_t</a></h3> + <p class="description">Print quality values</p> + <p class="code"> +typedef enum <a href="#ipp_quality_e">ipp_quality_e</a> ipp_quality_t; +</p> + <h3 class="typedef"><a id="ipp_res_t">ipp_res_t</a></h3> + <p class="description">Resolution units</p> + <p class="code"> +typedef enum <a href="#ipp_res_e">ipp_res_e</a> ipp_res_t; +</p> + <h3 class="typedef"><a id="ipp_state_t">ipp_state_t</a></h3> + <p class="description">ipp_t state values</p> + <p class="code"> +typedef enum <a href="#ipp_state_e">ipp_state_e</a> ipp_state_t; +</p> + <h3 class="typedef"><a id="ipp_t">ipp_t</a></h3> + <p class="description">IPP request/response data</p> + <p class="code"> +typedef struct _ipp_s ipp_t; +</p> + <h2 class="title"><a id="STRUCTURES">Structures</a></h2> +<h3 class="struct"><a id="cups_dest_s">cups_dest_s</a></h3> + <p class="description">Destination</p> +<p class="code">struct cups_dest_s {<br> +    char *name, *instance;<br> +    int is_default;<br> +    int num_options;<br> +    <a href="#cups_option_t">cups_option_t</a> *options;<br> +};</p> +<h4 class="members">Members</h4> +<table class="list"><tbody> +<tr><th>instance </th> + <td class="description">Local instance name or NULL</td></tr> +<tr><th>is_default </th> + <td class="description">Is this printer the default?</td></tr> +<tr><th>num_options </th> + <td class="description">Number of options</td></tr> +<tr><th>options </th> + <td class="description">Options</td></tr> +</tbody></table> +<h3 class="struct"><a id="cups_job_s">cups_job_s</a></h3> + <p class="description">Job</p> +<p class="code">struct cups_job_s {<br> +    time_t completed_time;<br> +    time_t creation_time;<br> +    char *dest;<br> +    char *format;<br> +    int id;<br> +    int priority;<br> +    time_t processing_time;<br> +    int size;<br> +    ipp_jstate_t state;<br> +    char *title;<br> +    char *user;<br> +};</p> +<h4 class="members">Members</h4> +<table class="list"><tbody> +<tr><th>completed_time </th> + <td class="description">Time the job was completed</td></tr> +<tr><th>creation_time </th> + <td class="description">Time the job was created</td></tr> +<tr><th>dest </th> + <td class="description">Printer or class name</td></tr> +<tr><th>format </th> + <td class="description">Document format</td></tr> +<tr><th>id </th> + <td class="description">The job ID</td></tr> +<tr><th>priority </th> + <td class="description">Priority (1-100)</td></tr> +<tr><th>processing_time </th> + <td class="description">Time the job was processed</td></tr> +<tr><th>size </th> + <td class="description">Size in kilobytes</td></tr> +<tr><th>state </th> + <td class="description">Job state</td></tr> +<tr><th>title </th> + <td class="description">Title/job name</td></tr> +<tr><th>user </th> + <td class="description">User that submitted the job</td></tr> +</tbody></table> +<h3 class="struct"><a id="cups_option_s">cups_option_s</a></h3> + <p class="description">Printer Options</p> +<p class="code">struct cups_option_s {<br> +    char *name;<br> +    char *value;<br> +};</p> +<h4 class="members">Members</h4> +<table class="list"><tbody> +<tr><th>name </th> + <td class="description">Name of option</td></tr> +<tr><th>value </th> + <td class="description">Value of option</td></tr> +</tbody></table> +<h3 class="struct"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cups_size_s">cups_size_s</a></h3> + <p class="description">Media Size </p> +<p class="code">struct cups_size_s {<br> +    char media[128];<br> +    int width, length, bottom, left, right, top;<br> +};</p> +<h4 class="members">Members</h4> +<table class="list"><tbody> +<tr><th>media[128] </th> + <td class="description">Media name to use</td></tr> +<tr><th>top </th> + <td class="description">Top margin in hundredths of +millimeters</td></tr> +</tbody></table> + <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> + <h3 class="enumeration"><a id="cups_ptype_e">cups_ptype_e</a></h3> + <p class="description">Printer type/capability bit +constants</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>CUPS_PRINTER_AUTHENTICATED <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer requires authentication +</td></tr> + <tr><th>CUPS_PRINTER_BIND </th> <td class="description">Can bind output</td></tr> + <tr><th>CUPS_PRINTER_BW </th> <td class="description">Can do B&W printing</td></tr> + <tr><th>CUPS_PRINTER_CLASS </th> <td class="description">Printer class</td></tr> + <tr><th>CUPS_PRINTER_COLLATE </th> <td class="description">Can quickly collate copies</td></tr> + <tr><th>CUPS_PRINTER_COLOR </th> <td class="description">Can do color printing</td></tr> + <tr><th>CUPS_PRINTER_COMMANDS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer supports maintenance commands +</td></tr> + <tr><th>CUPS_PRINTER_COPIES </th> <td class="description">Can do copies in hardware</td></tr> + <tr><th>CUPS_PRINTER_COVER </th> <td class="description">Can cover output</td></tr> + <tr><th>CUPS_PRINTER_DEFAULT </th> <td class="description">Default printer on network</td></tr> + <tr><th>CUPS_PRINTER_DISCOVERED <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer was discovered </td></tr> + <tr><th>CUPS_PRINTER_DUPLEX </th> <td class="description">Can do two-sided printing</td></tr> + <tr><th>CUPS_PRINTER_FAX </th> <td class="description">Fax queue</td></tr> + <tr><th>CUPS_PRINTER_LARGE </th> <td class="description">Can print on D/E/A1/A0-size media</td></tr> + <tr><th>CUPS_PRINTER_LOCAL </th> <td class="description">Local printer or class</td></tr> + <tr><th>CUPS_PRINTER_MEDIUM </th> <td class="description">Can print on Tabloid/B/C/A3/A2-size media</td></tr> + <tr><th>CUPS_PRINTER_NOT_SHARED <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer is not shared +</td></tr> + <tr><th>CUPS_PRINTER_PUNCH </th> <td class="description">Can punch output</td></tr> + <tr><th>CUPS_PRINTER_REJECTING </th> <td class="description">Printer is rejecting jobs</td></tr> + <tr><th>CUPS_PRINTER_REMOTE </th> <td class="description">Remote printer or class</td></tr> + <tr><th>CUPS_PRINTER_SMALL </th> <td class="description">Can print on Letter/Legal/A4-size media</td></tr> + <tr><th>CUPS_PRINTER_SORT </th> <td class="description">Can sort output</td></tr> + <tr><th>CUPS_PRINTER_STAPLE </th> <td class="description">Can staple output</td></tr> + <tr><th>CUPS_PRINTER_VARIABLE </th> <td class="description">Can print on rolls and custom-size media</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="http_encoding_e">http_encoding_e</a></h3> + <p class="description">HTTP transfer encoding values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>HTTP_ENCODING_CHUNKED </th> <td class="description">Data is chunked</td></tr> + <tr><th>HTTP_ENCODING_FIELDS </th> <td class="description">Sending HTTP fields</td></tr> + <tr><th>HTTP_ENCODING_LENGTH </th> <td class="description">Data is sent with Content-Length</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="http_encryption_e">http_encryption_e</a></h3> + <p class="description">HTTP encryption values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>HTTP_ENCRYPTION_ALWAYS </th> <td class="description">Always encrypt (SSL)</td></tr> + <tr><th>HTTP_ENCRYPTION_IF_REQUESTED </th> <td class="description">Encrypt if requested (TLS upgrade)</td></tr> + <tr><th>HTTP_ENCRYPTION_NEVER </th> <td class="description">Never encrypt</td></tr> + <tr><th>HTTP_ENCRYPTION_REQUIRED </th> <td class="description">Encryption is required (TLS upgrade)</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="http_field_e">http_field_e</a></h3> + <p class="description">HTTP field names</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>HTTP_FIELD_ACCEPT_ENCODING <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Accepting-Encoding field </td></tr> + <tr><th>HTTP_FIELD_ACCEPT_LANGUAGE </th> <td class="description">Accept-Language field</td></tr> + <tr><th>HTTP_FIELD_ACCEPT_RANGES </th> <td class="description">Accept-Ranges field</td></tr> + <tr><th>HTTP_FIELD_ALLOW <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Allow field </td></tr> + <tr><th>HTTP_FIELD_AUTHORIZATION </th> <td class="description">Authorization field</td></tr> + <tr><th>HTTP_FIELD_CONNECTION </th> <td class="description">Connection field</td></tr> + <tr><th>HTTP_FIELD_CONTENT_ENCODING </th> <td class="description">Content-Encoding field</td></tr> + <tr><th>HTTP_FIELD_CONTENT_LANGUAGE </th> <td class="description">Content-Language field</td></tr> + <tr><th>HTTP_FIELD_CONTENT_LENGTH </th> <td class="description">Content-Length field</td></tr> + <tr><th>HTTP_FIELD_CONTENT_LOCATION </th> <td class="description">Content-Location field</td></tr> + <tr><th>HTTP_FIELD_CONTENT_MD5 </th> <td class="description">Content-MD5 field</td></tr> + <tr><th>HTTP_FIELD_CONTENT_RANGE </th> <td class="description">Content-Range field</td></tr> + <tr><th>HTTP_FIELD_CONTENT_TYPE </th> <td class="description">Content-Type field</td></tr> + <tr><th>HTTP_FIELD_CONTENT_VERSION </th> <td class="description">Content-Version field</td></tr> + <tr><th>HTTP_FIELD_DATE </th> <td class="description">Date field</td></tr> + <tr><th>HTTP_FIELD_HOST </th> <td class="description">Host field</td></tr> + <tr><th>HTTP_FIELD_IF_MODIFIED_SINCE </th> <td class="description">If-Modified-Since field</td></tr> + <tr><th>HTTP_FIELD_IF_UNMODIFIED_SINCE </th> <td class="description">If-Unmodified-Since field</td></tr> + <tr><th>HTTP_FIELD_KEEP_ALIVE </th> <td class="description">Keep-Alive field</td></tr> + <tr><th>HTTP_FIELD_LAST_MODIFIED </th> <td class="description">Last-Modified field</td></tr> + <tr><th>HTTP_FIELD_LINK </th> <td class="description">Link field</td></tr> + <tr><th>HTTP_FIELD_LOCATION </th> <td class="description">Location field</td></tr> + <tr><th>HTTP_FIELD_MAX </th> <td class="description">Maximum field index</td></tr> + <tr><th>HTTP_FIELD_RANGE </th> <td class="description">Range field</td></tr> + <tr><th>HTTP_FIELD_REFERER </th> <td class="description">Referer field</td></tr> + <tr><th>HTTP_FIELD_RETRY_AFTER </th> <td class="description">Retry-After field</td></tr> + <tr><th>HTTP_FIELD_SERVER <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Server field </td></tr> + <tr><th>HTTP_FIELD_TRANSFER_ENCODING </th> <td class="description">Transfer-Encoding field</td></tr> + <tr><th>HTTP_FIELD_UNKNOWN </th> <td class="description">Unknown field</td></tr> + <tr><th>HTTP_FIELD_UPGRADE </th> <td class="description">Upgrade field</td></tr> + <tr><th>HTTP_FIELD_USER_AGENT </th> <td class="description">User-Agent field</td></tr> + <tr><th>HTTP_FIELD_WWW_AUTHENTICATE </th> <td class="description">WWW-Authenticate field</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="http_keepalive_e">http_keepalive_e</a></h3> + <p class="description">HTTP keep-alive values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>HTTP_KEEPALIVE_OFF </th> <td class="description">No keep alive support</td></tr> + <tr><th>HTTP_KEEPALIVE_ON </th> <td class="description">Use keep alive</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="http_state_e">http_state_e</a></h3> + <p class="description">HTTP state values; states +are server-oriented...</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>HTTP_STATE_CONNECT </th> <td class="description">CONNECT command, waiting for blank line</td></tr> + <tr><th>HTTP_STATE_DELETE </th> <td class="description">DELETE command, waiting for blank line</td></tr> + <tr><th>HTTP_STATE_ERROR </th> <td class="description">Error on socket</td></tr> + <tr><th>HTTP_STATE_GET </th> <td class="description">GET command, waiting for blank line</td></tr> + <tr><th>HTTP_STATE_GET_SEND </th> <td class="description">GET command, sending data</td></tr> + <tr><th>HTTP_STATE_HEAD </th> <td class="description">HEAD command, waiting for blank line</td></tr> + <tr><th>HTTP_STATE_OPTIONS </th> <td class="description">OPTIONS command, waiting for blank line</td></tr> + <tr><th>HTTP_STATE_POST </th> <td class="description">POST command, waiting for blank line</td></tr> + <tr><th>HTTP_STATE_POST_RECV </th> <td class="description">POST command, receiving data</td></tr> + <tr><th>HTTP_STATE_POST_SEND </th> <td class="description">POST command, sending data</td></tr> + <tr><th>HTTP_STATE_PUT </th> <td class="description">PUT command, waiting for blank line</td></tr> + <tr><th>HTTP_STATE_PUT_RECV </th> <td class="description">PUT command, receiving data</td></tr> + <tr><th>HTTP_STATE_STATUS </th> <td class="description">Command complete, sending status</td></tr> + <tr><th>HTTP_STATE_TRACE </th> <td class="description">TRACE command, waiting for blank line</td></tr> + <tr><th>HTTP_STATE_UNKNOWN_METHOD <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Unknown request method, waiting for blank line </td></tr> + <tr><th>HTTP_STATE_UNKNOWN_VERSION <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Unknown request method, waiting for blank line </td></tr> + <tr><th>HTTP_STATE_WAITING </th> <td class="description">Waiting for command</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="http_status_e">http_status_e</a></h3> + <p class="description">HTTP status codes</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>HTTP_STATUS_ACCEPTED </th> <td class="description">DELETE command was successful</td></tr> + <tr><th>HTTP_STATUS_BAD_GATEWAY </th> <td class="description">Bad gateway</td></tr> + <tr><th>HTTP_STATUS_BAD_REQUEST </th> <td class="description">Bad request</td></tr> + <tr><th>HTTP_STATUS_CONFLICT </th> <td class="description">Request is self-conflicting</td></tr> + <tr><th>HTTP_STATUS_CONTINUE </th> <td class="description">Everything OK, keep going...</td></tr> + <tr><th>HTTP_STATUS_CREATED </th> <td class="description">PUT command was successful</td></tr> + <tr><th>HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED <span class="info"> CUPS 1.4 </span></th> <td class="description">User canceled authorization </td></tr> + <tr><th>HTTP_STATUS_CUPS_PKI_ERROR <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">Error negotiating a secure connection </td></tr> + <tr><th>HTTP_STATUS_ERROR </th> <td class="description">An error response from httpXxxx()</td></tr> + <tr><th>HTTP_STATUS_EXPECTATION_FAILED </th> <td class="description">The expectation given in an Expect header field was not met</td></tr> + <tr><th>HTTP_STATUS_FORBIDDEN </th> <td class="description">Forbidden to access this URI</td></tr> + <tr><th>HTTP_STATUS_GATEWAY_TIMEOUT </th> <td class="description">Gateway connection timed out</td></tr> + <tr><th>HTTP_STATUS_GONE </th> <td class="description">Server has gone away</td></tr> + <tr><th>HTTP_STATUS_LENGTH_REQUIRED </th> <td class="description">A content length or encoding is required</td></tr> + <tr><th>HTTP_STATUS_METHOD_NOT_ALLOWED </th> <td class="description">Method is not allowed</td></tr> + <tr><th>HTTP_STATUS_MOVED_PERMANENTLY </th> <td class="description">Document has moved permanently</td></tr> + <tr><th>HTTP_STATUS_MOVED_TEMPORARILY </th> <td class="description">Document has moved temporarily</td></tr> + <tr><th>HTTP_STATUS_MULTIPLE_CHOICES </th> <td class="description">Multiple files match request</td></tr> + <tr><th>HTTP_STATUS_NONE <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">No Expect value </td></tr> + <tr><th>HTTP_STATUS_NOT_ACCEPTABLE </th> <td class="description">Not Acceptable</td></tr> + <tr><th>HTTP_STATUS_NOT_AUTHORITATIVE </th> <td class="description">Information isn't authoritative</td></tr> + <tr><th>HTTP_STATUS_NOT_FOUND </th> <td class="description">URI was not found</td></tr> + <tr><th>HTTP_STATUS_NOT_IMPLEMENTED </th> <td class="description">Feature not implemented</td></tr> + <tr><th>HTTP_STATUS_NOT_MODIFIED </th> <td class="description">File not modified</td></tr> + <tr><th>HTTP_STATUS_NOT_SUPPORTED </th> <td class="description">HTTP version not supported</td></tr> + <tr><th>HTTP_STATUS_NO_CONTENT </th> <td class="description">Successful command, no new data</td></tr> + <tr><th>HTTP_STATUS_OK </th> <td class="description">OPTIONS/GET/HEAD/POST/TRACE command was successful</td></tr> + <tr><th>HTTP_STATUS_PARTIAL_CONTENT </th> <td class="description">Only a partial file was received/sent</td></tr> + <tr><th>HTTP_STATUS_PAYMENT_REQUIRED </th> <td class="description">Payment required</td></tr> + <tr><th>HTTP_STATUS_PRECONDITION </th> <td class="description">Precondition failed</td></tr> + <tr><th>HTTP_STATUS_PROXY_AUTHENTICATION </th> <td class="description">Proxy Authentication is Required</td></tr> + <tr><th>HTTP_STATUS_REQUESTED_RANGE </th> <td class="description">The requested range is not satisfiable</td></tr> + <tr><th>HTTP_STATUS_REQUEST_TIMEOUT </th> <td class="description">Request timed out</td></tr> + <tr><th>HTTP_STATUS_REQUEST_TOO_LARGE </th> <td class="description">Request entity too large</td></tr> + <tr><th>HTTP_STATUS_RESET_CONTENT </th> <td class="description">Content was reset/recreated</td></tr> + <tr><th>HTTP_STATUS_SEE_OTHER </th> <td class="description">See this other link...</td></tr> + <tr><th>HTTP_STATUS_SERVER_ERROR </th> <td class="description">Internal server error</td></tr> + <tr><th>HTTP_STATUS_SERVICE_UNAVAILABLE </th> <td class="description">Service is unavailable</td></tr> + <tr><th>HTTP_STATUS_SWITCHING_PROTOCOLS </th> <td class="description">HTTP upgrade to TLS/SSL</td></tr> + <tr><th>HTTP_STATUS_UNAUTHORIZED </th> <td class="description">Unauthorized to access host</td></tr> + <tr><th>HTTP_STATUS_UNSUPPORTED_MEDIATYPE </th> <td class="description">The requested media type is unsupported</td></tr> + <tr><th>HTTP_STATUS_UPGRADE_REQUIRED </th> <td class="description">Upgrade to SSL/TLS required</td></tr> + <tr><th>HTTP_STATUS_URI_TOO_LONG </th> <td class="description">URI too long</td></tr> + <tr><th>HTTP_STATUS_USE_PROXY </th> <td class="description">Must use a proxy to access this URI</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="http_trust_e"><span class="info"> CUPS 2.0/OS 10.10 </span>http_trust_e</a></h3> + <p class="description">Level of trust for credentials </p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>HTTP_TRUST_CHANGED </th> <td class="description">Credentials have changed</td></tr> + <tr><th>HTTP_TRUST_EXPIRED </th> <td class="description">Credentials are expired</td></tr> + <tr><th>HTTP_TRUST_INVALID </th> <td class="description">Credentials are invalid</td></tr> + <tr><th>HTTP_TRUST_OK </th> <td class="description">Credentials are OK/trusted</td></tr> + <tr><th>HTTP_TRUST_RENEWED </th> <td class="description">Credentials have been renewed</td></tr> + <tr><th>HTTP_TRUST_UNKNOWN </th> <td class="description">Credentials are unknown/new</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="http_uri_coding_e">http_uri_coding_e</a></h3> + <p class="description">URI en/decode flags</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>HTTP_URI_CODING_ALL </th> <td class="description">En/decode everything</td></tr> + <tr><th>HTTP_URI_CODING_HOSTNAME </th> <td class="description">En/decode the hostname portion</td></tr> + <tr><th>HTTP_URI_CODING_MOST </th> <td class="description">En/decode all but the query</td></tr> + <tr><th>HTTP_URI_CODING_NONE </th> <td class="description">Don't en/decode anything</td></tr> + <tr><th>HTTP_URI_CODING_QUERY </th> <td class="description">En/decode the query portion</td></tr> + <tr><th>HTTP_URI_CODING_RESOURCE </th> <td class="description">En/decode the resource portion</td></tr> + <tr><th>HTTP_URI_CODING_RFC6874 </th> <td class="description">Use RFC 6874 address format</td></tr> + <tr><th>HTTP_URI_CODING_USERNAME </th> <td class="description">En/decode the username portion</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="http_uri_status_e"><span class="info"> CUPS 1.2 </span>http_uri_status_e</a></h3> + <p class="description">URI separation status </p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>HTTP_URI_STATUS_BAD_ARGUMENTS </th> <td class="description">Bad arguments to function (error)</td></tr> + <tr><th>HTTP_URI_STATUS_BAD_HOSTNAME </th> <td class="description">Bad hostname in URI (error)</td></tr> + <tr><th>HTTP_URI_STATUS_BAD_PORT </th> <td class="description">Bad port number in URI (error)</td></tr> + <tr><th>HTTP_URI_STATUS_BAD_RESOURCE </th> <td class="description">Bad resource in URI (error)</td></tr> + <tr><th>HTTP_URI_STATUS_BAD_SCHEME </th> <td class="description">Bad scheme in URI (error)</td></tr> + <tr><th>HTTP_URI_STATUS_BAD_URI </th> <td class="description">Bad/empty URI (error)</td></tr> + <tr><th>HTTP_URI_STATUS_BAD_USERNAME </th> <td class="description">Bad username in URI (error)</td></tr> + <tr><th>HTTP_URI_STATUS_MISSING_RESOURCE </th> <td class="description">Missing resource in URI (warning)</td></tr> + <tr><th>HTTP_URI_STATUS_MISSING_SCHEME </th> <td class="description">Missing scheme in URI (warning)</td></tr> + <tr><th>HTTP_URI_STATUS_OK </th> <td class="description">URI decoded OK</td></tr> + <tr><th>HTTP_URI_STATUS_OVERFLOW </th> <td class="description">URI buffer for httpAssembleURI is too small</td></tr> + <tr><th>HTTP_URI_STATUS_UNKNOWN_SCHEME </th> <td class="description">Unknown scheme in URI (warning)</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_finishings_e">ipp_finishings_e</a></h3> + <p class="description">Finishings values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_FINISHINGS_BALE </th> <td class="description">Bale (any type)</td></tr> + <tr><th>IPP_FINISHINGS_BIND </th> <td class="description">Bind</td></tr> + <tr><th>IPP_FINISHINGS_BIND_BOTTOM </th> <td class="description">Bind on bottom</td></tr> + <tr><th>IPP_FINISHINGS_BIND_LEFT </th> <td class="description">Bind on left</td></tr> + <tr><th>IPP_FINISHINGS_BIND_RIGHT </th> <td class="description">Bind on right</td></tr> + <tr><th>IPP_FINISHINGS_BIND_TOP </th> <td class="description">Bind on top</td></tr> + <tr><th>IPP_FINISHINGS_BOOKLET_MAKER </th> <td class="description">Fold to make booklet</td></tr> + <tr><th>IPP_FINISHINGS_COAT </th> <td class="description">Apply protective liquid or powder coating</td></tr> + <tr><th>IPP_FINISHINGS_COVER </th> <td class="description">Add cover</td></tr> + <tr><th>IPP_FINISHINGS_EDGE_STITCH </th> <td class="description">Stitch along any side</td></tr> + <tr><th>IPP_FINISHINGS_EDGE_STITCH_BOTTOM </th> <td class="description">Stitch along bottom edge</td></tr> + <tr><th>IPP_FINISHINGS_EDGE_STITCH_LEFT </th> <td class="description">Stitch along left side</td></tr> + <tr><th>IPP_FINISHINGS_EDGE_STITCH_RIGHT </th> <td class="description">Stitch along right side</td></tr> + <tr><th>IPP_FINISHINGS_EDGE_STITCH_TOP </th> <td class="description">Stitch along top edge</td></tr> + <tr><th>IPP_FINISHINGS_FOLD </th> <td class="description">Fold (any type)</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_ACCORDIAN </th> <td class="description">Accordian-fold the paper vertically into four sections</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_DOUBLE_GATE </th> <td class="description">Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_ENGINEERING_Z </th> <td class="description">Fold the paper vertically into two small sections and one larger, forming an elongated Z</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_GATE </th> <td class="description">Fold the top and bottom quarters of the paper towards the midline</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_HALF </th> <td class="description">Fold the paper in half vertically</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_HALF_Z </th> <td class="description">Fold the paper in half horizontally, then Z-fold the paper vertically</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_LEFT_GATE </th> <td class="description">Fold the top quarter of the paper towards the midline</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_LETTER </th> <td class="description">Fold the paper into three sections vertically; sometimes also known as a C fold</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_PARALLEL </th> <td class="description">Fold the paper in half vertically two times, yielding four sections</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_POSTER </th> <td class="description">Fold the paper in half horizontally and vertically; sometimes also called a cross fold</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_RIGHT_GATE </th> <td class="description">Fold the bottom quarter of the paper towards the midline</td></tr> + <tr><th>IPP_FINISHINGS_FOLD_Z </th> <td class="description">Fold the paper vertically into three sections, forming a Z</td></tr> + <tr><th>IPP_FINISHINGS_JOG_OFFSET </th> <td class="description">Offset for binding (any type)</td></tr> + <tr><th>IPP_FINISHINGS_LAMINATE </th> <td class="description">Apply protective (solid) material</td></tr> + <tr><th>IPP_FINISHINGS_NONE </th> <td class="description">No finishing</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH </th> <td class="description">Punch (any location/count)</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_LEFT </th> <td class="description">Punch 1 hole bottom left</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_RIGHT </th> <td class="description">Punch 1 hole bottom right</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_DUAL_BOTTOM </th> <td class="description">Punch 2 holes bottom edge</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_DUAL_LEFT </th> <td class="description">Punch 2 holes left side</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_DUAL_RIGHT </th> <td class="description">Punch 2 holes right side</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_DUAL_TOP </th> <td class="description">Punch 2 holes top edge</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_BOTTOM </th> <td class="description">Pucnh multiple holes bottom edge</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_LEFT </th> <td class="description">Pucnh multiple holes left side</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_RIGHT </th> <td class="description">Pucnh multiple holes right side</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_TOP </th> <td class="description">Pucnh multiple holes top edge</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_QUAD_BOTTOM </th> <td class="description">Punch 4 holes bottom edge</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_QUAD_LEFT </th> <td class="description">Punch 4 holes left side</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_QUAD_RIGHT </th> <td class="description">Punch 4 holes right side</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_QUAD_TOP </th> <td class="description">Punch 4 holes top edge</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_TOP_LEFT </th> <td class="description">Punch 1 hole top left</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_TOP_RIGHT </th> <td class="description">Punch 1 hole top right</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_BOTTOM </th> <td class="description">Punch 3 holes bottom edge</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_LEFT </th> <td class="description">Punch 3 holes left side</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_RIGHT </th> <td class="description">Punch 3 holes right side</td></tr> + <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_TOP </th> <td class="description">Punch 3 holes top edge</td></tr> + <tr><th>IPP_FINISHINGS_SADDLE_STITCH </th> <td class="description">Staple interior</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE </th> <td class="description">Staple (any location/method)</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_LEFT </th> <td class="description">Staple bottom left corner</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT </th> <td class="description">Staple bottom right corner</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_DUAL_BOTTOM </th> <td class="description">Two staples on bottom</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_DUAL_LEFT </th> <td class="description">Two staples on left</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_DUAL_RIGHT </th> <td class="description">Two staples on right</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_DUAL_TOP </th> <td class="description">Two staples on top</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_TOP_LEFT </th> <td class="description">Staple top left corner</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_TOP_RIGHT </th> <td class="description">Staple top right corner</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_BOTTOM </th> <td class="description">Three staples on bottom</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_LEFT </th> <td class="description">Three staples on left</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_RIGHT </th> <td class="description">Three staples on right</td></tr> + <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_TOP </th> <td class="description">Three staples on top</td></tr> + <tr><th>IPP_FINISHINGS_TRIM </th> <td class="description">Trim (any type)</td></tr> + <tr><th>IPP_FINISHINGS_TRIM_AFTER_COPIES </th> <td class="description">Trim output after each copy</td></tr> + <tr><th>IPP_FINISHINGS_TRIM_AFTER_DOCUMENTS </th> <td class="description">Trim output after each document</td></tr> + <tr><th>IPP_FINISHINGS_TRIM_AFTER_JOB </th> <td class="description">Trim output after job</td></tr> + <tr><th>IPP_FINISHINGS_TRIM_AFTER_PAGES </th> <td class="description">Trim output after each page</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_jstate_e">ipp_jstate_e</a></h3> + <p class="description">Job states</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_JSTATE_ABORTED </th> <td class="description">Job has aborted due to error</td></tr> + <tr><th>IPP_JSTATE_CANCELED </th> <td class="description">Job has been canceled</td></tr> + <tr><th>IPP_JSTATE_COMPLETED </th> <td class="description">Job has completed successfully</td></tr> + <tr><th>IPP_JSTATE_HELD </th> <td class="description">Job is held for printing</td></tr> + <tr><th>IPP_JSTATE_PENDING </th> <td class="description">Job is waiting to be printed</td></tr> + <tr><th>IPP_JSTATE_PROCESSING </th> <td class="description">Job is currently printing</td></tr> + <tr><th>IPP_JSTATE_STOPPED </th> <td class="description">Job has been stopped</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_op_e">ipp_op_e</a></h3> + <p class="description">IPP operations</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_OP_CANCEL_CURRENT_JOB </th> <td class="description">Cancel-Current-Job: Cancel the current job</td></tr> + <tr><th>IPP_OP_CANCEL_JOB </th> <td class="description">Cancel-Job: Cancel a job</td></tr> + <tr><th>IPP_OP_CANCEL_JOBS </th> <td class="description">Cancel-Jobs: Cancel all jobs (administrative)</td></tr> + <tr><th>IPP_OP_CANCEL_MY_JOBS </th> <td class="description">Cancel-My-Jobs: Cancel a user's jobs</td></tr> + <tr><th>IPP_OP_CANCEL_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Cancel-Subscription: Cancel a subscription </td></tr> + <tr><th>IPP_OP_CLOSE_JOB </th> <td class="description">Close-Job: Close a job and start printing</td></tr> + <tr><th>IPP_OP_CREATE_JOB </th> <td class="description">Create-Job: Create an empty print job</td></tr> + <tr><th>IPP_OP_CREATE_JOB_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Create-Job-Subscriptions: Create one of more job subscriptions </td></tr> + <tr><th>IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Create-Printer-Subscriptions: Create one or more printer subscriptions </td></tr> + <tr><th>IPP_OP_CUPS_ADD_MODIFY_CLASS </th> <td class="description">CUPS-Add-Modify-Class: Add or modify a class</td></tr> + <tr><th>IPP_OP_CUPS_ADD_MODIFY_PRINTER </th> <td class="description">CUPS-Add-Modify-Printer: Add or modify a printer</td></tr> + <tr><th>IPP_OP_CUPS_AUTHENTICATE_JOB <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">CUPS-Authenticate-Job: Authenticate a job </td></tr> + <tr><th>IPP_OP_CUPS_CREATE_LOCAL_PRINTER <span class="info"> CUPS 2.2 </span></th> <td class="description">CUPS-Create-Local-Printer: Create a local (temporary) printer </td></tr> + <tr><th>IPP_OP_CUPS_DELETE_CLASS </th> <td class="description">CUPS-Delete-Class: Delete a class</td></tr> + <tr><th>IPP_OP_CUPS_DELETE_PRINTER </th> <td class="description">CUPS-Delete-Printer: Delete a printer</td></tr> + <tr><th>IPP_OP_CUPS_GET_DEFAULT </th> <td class="description">CUPS-Get-Default: Get the default printer</td></tr> + <tr><th>IPP_OP_CUPS_GET_DEVICES <span class="info"> DEPRECATED </span></th> <td class="description">CUPS-Get-Devices: Get a list of supported devices </td></tr> + <tr><th>IPP_OP_CUPS_GET_DOCUMENT <span class="info"> CUPS 1.4/macOS 10.6 </span></th> <td class="description">CUPS-Get-Document: Get a document file </td></tr> + <tr><th>IPP_OP_CUPS_GET_PPD <span class="info"> DEPRECATED </span></th> <td class="description">CUPS-Get-PPD: Get a PPD file </td></tr> + <tr><th>IPP_OP_CUPS_GET_PPDS <span class="info"> DEPRECATED </span></th> <td class="description">CUPS-Get-PPDs: Get a list of supported drivers </td></tr> + <tr><th>IPP_OP_CUPS_GET_PRINTERS </th> <td class="description">CUPS-Get-Printers: Get a list of printers and/or classes</td></tr> + <tr><th>IPP_OP_CUPS_INVALID </th> <td class="description">Invalid operation name for <a href="#ippOpValue"><code>ippOpValue</code></a></td></tr> + <tr><th>IPP_OP_CUPS_MOVE_JOB </th> <td class="description">CUPS-Move-Job: Move a job to a different printer</td></tr> + <tr><th>IPP_OP_CUPS_SET_DEFAULT </th> <td class="description">CUPS-Set-Default: Set the default printer</td></tr> + <tr><th>IPP_OP_DISABLE_PRINTER </th> <td class="description">Disable-Printer: Reject new jobs for a printer</td></tr> + <tr><th>IPP_OP_ENABLE_PRINTER </th> <td class="description">Enable-Printer: Accept new jobs for a printer</td></tr> + <tr><th>IPP_OP_GET_JOBS </th> <td class="description">Get-Jobs: Get a list of jobs</td></tr> + <tr><th>IPP_OP_GET_JOB_ATTRIBUTES </th> <td class="description">Get-Job-Attribute: Get information about a job</td></tr> + <tr><th>IPP_OP_GET_NOTIFICATIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Get-Notifications: Get notification events </td></tr> + <tr><th>IPP_OP_GET_PRINTER_ATTRIBUTES </th> <td class="description">Get-Printer-Attributes: Get information about a printer</td></tr> + <tr><th>IPP_OP_GET_PRINTER_SUPPORTED_VALUES </th> <td class="description">Get-Printer-Supported-Values: Get supported values</td></tr> + <tr><th>IPP_OP_GET_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Get-Subscriptions: Get list of subscriptions </td></tr> + <tr><th>IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Get-Subscription-Attributes: Get subscription information </td></tr> + <tr><th>IPP_OP_HOLD_JOB </th> <td class="description">Hold-Job: Hold a job for printing</td></tr> + <tr><th>IPP_OP_HOLD_NEW_JOBS </th> <td class="description">Hold-New-Jobs: Hold new jobs</td></tr> + <tr><th>IPP_OP_IDENTIFY_PRINTER </th> <td class="description">Identify-Printer: Make the printer beep, flash, or display a message for identification</td></tr> + <tr><th>IPP_OP_PAUSE_PRINTER </th> <td class="description">Pause-Printer: Stop a printer</td></tr> + <tr><th>IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB </th> <td class="description">Pause-Printer-After-Current-Job: Stop printer after the current job</td></tr> + <tr><th>IPP_OP_PRINT_JOB </th> <td class="description">Print-Job: Print a single file</td></tr> + <tr><th>IPP_OP_PROMOTE_JOB </th> <td class="description">Promote-Job: Promote a job to print sooner</td></tr> + <tr><th>IPP_OP_RELEASE_HELD_NEW_JOBS </th> <td class="description">Release-Held-New-Jobs: Release new jobs that were previously held</td></tr> + <tr><th>IPP_OP_RELEASE_JOB </th> <td class="description">Release-Job: Release a job for printing</td></tr> + <tr><th>IPP_OP_RENEW_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Renew-Subscription: Renew a printer subscription </td></tr> + <tr><th>IPP_OP_RESTART_JOB <span class="info"> DEPRECATED </span></th> <td class="description">Restart-Job: Reprint a job </td></tr> + <tr><th>IPP_OP_RESUME_JOB </th> <td class="description">Resume-Job: Resume the current job</td></tr> + <tr><th>IPP_OP_RESUME_PRINTER </th> <td class="description">Resume-Printer: Start a printer</td></tr> + <tr><th>IPP_OP_SCHEDULE_JOB_AFTER </th> <td class="description">Schedule-Job-After: Schedule a job to print after another</td></tr> + <tr><th>IPP_OP_SEND_DOCUMENT </th> <td class="description">Send-Document: Add a file to a job</td></tr> + <tr><th>IPP_OP_SET_JOB_ATTRIBUTES </th> <td class="description">Set-Job-Attributes: Set job values</td></tr> + <tr><th>IPP_OP_SET_PRINTER_ATTRIBUTES </th> <td class="description">Set-Printer-Attributes: Set printer values</td></tr> + <tr><th>IPP_OP_SUSPEND_CURRENT_JOB </th> <td class="description">Suspend-Current-Job: Suspend the current job</td></tr> + <tr><th>IPP_OP_VALIDATE_JOB </th> <td class="description">Validate-Job: Validate job values prior to submission</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_orient_e">ipp_orient_e</a></h3> + <p class="description">Orientation values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_ORIENT_LANDSCAPE </th> <td class="description">90 degrees counter-clockwise</td></tr> + <tr><th>IPP_ORIENT_NONE </th> <td class="description">No rotation</td></tr> + <tr><th>IPP_ORIENT_PORTRAIT </th> <td class="description">No rotation</td></tr> + <tr><th>IPP_ORIENT_REVERSE_LANDSCAPE </th> <td class="description">90 degrees clockwise</td></tr> + <tr><th>IPP_ORIENT_REVERSE_PORTRAIT </th> <td class="description">180 degrees</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_pstate_e">ipp_pstate_e</a></h3> + <p class="description">Printer state values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_PSTATE_IDLE </th> <td class="description">Printer is idle</td></tr> + <tr><th>IPP_PSTATE_PROCESSING </th> <td class="description">Printer is working</td></tr> + <tr><th>IPP_PSTATE_STOPPED </th> <td class="description">Printer is stopped</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_quality_e">ipp_quality_e</a></h3> + <p class="description">Print quality values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_QUALITY_DRAFT </th> <td class="description">Draft quality</td></tr> + <tr><th>IPP_QUALITY_HIGH </th> <td class="description">High quality</td></tr> + <tr><th>IPP_QUALITY_NORMAL </th> <td class="description">Normal quality</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_res_e">ipp_res_e</a></h3> + <p class="description">Resolution units</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_RES_PER_CM </th> <td class="description">Pixels per centimeter</td></tr> + <tr><th>IPP_RES_PER_INCH </th> <td class="description">Pixels per inch</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_state_e">ipp_state_e</a></h3> + <p class="description">ipp_t state values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_STATE_ATTRIBUTE </th> <td class="description">One or more attributes need to be sent/received</td></tr> + <tr><th>IPP_STATE_DATA </th> <td class="description">IPP request data needs to be sent/received</td></tr> + <tr><th>IPP_STATE_ERROR </th> <td class="description">An error occurred</td></tr> + <tr><th>IPP_STATE_HEADER </th> <td class="description">The request header needs to be sent/received</td></tr> + <tr><th>IPP_STATE_IDLE </th> <td class="description">Nothing is happening/request completed</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_status_e">ipp_status_e</a></h3> + <p class="description">IPP status code values</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_STATUS_CUPS_INVALID </th> <td class="description">Invalid status name for <a href="#ippErrorValue"><code>ippErrorValue</code></a></td></tr> + <tr><th>IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED </th> <td class="description">client-error-account-authorization-failed</td></tr> + <tr><th>IPP_STATUS_ERROR_ACCOUNT_CLOSED </th> <td class="description">client-error-account-closed</td></tr> + <tr><th>IPP_STATUS_ERROR_ACCOUNT_INFO_NEEDED </th> <td class="description">client-error-account-info-needed</td></tr> + <tr><th>IPP_STATUS_ERROR_ACCOUNT_LIMIT_REACHED </th> <td class="description">client-error-account-limit-reached</td></tr> + <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE </th> <td class="description">client-error-attributes-not-settable</td></tr> + <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES </th> <td class="description">client-error-attributes-or-values-not-supported</td></tr> + <tr><th>IPP_STATUS_ERROR_BAD_REQUEST </th> <td class="description">client-error-bad-request</td></tr> + <tr><th>IPP_STATUS_ERROR_BUSY </th> <td class="description">server-error-busy</td></tr> + <tr><th>IPP_STATUS_ERROR_CHARSET </th> <td class="description">client-error-charset-not-supported</td></tr> + <tr><th>IPP_STATUS_ERROR_COMPRESSION_ERROR </th> <td class="description">client-error-compression-error</td></tr> + <tr><th>IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED </th> <td class="description">client-error-compression-not-supported</td></tr> + <tr><th>IPP_STATUS_ERROR_CONFLICTING </th> <td class="description">client-error-conflicting-attributes</td></tr> + <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED <span class="info"> DEPRECATED </span></th> <td class="description">cups-error-account-authorization-failed </td></tr> + <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED </th> <td class="description">cups-error-account-closed @deprecate@</td></tr> + <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED <span class="info"> DEPRECATED </span></th> <td class="description">cups-error-account-info-needed </td></tr> + <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED <span class="info"> DEPRECATED </span></th> <td class="description">cups-error-account-limit-reached </td></tr> + <tr><th>IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">cups-authentication-canceled - Authentication canceled by user </td></tr> + <tr><th>IPP_STATUS_ERROR_CUPS_PKI <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">cups-pki-error - Error negotiating a secure connection </td></tr> + <tr><th>IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">cups-upgrade-required - TLS upgrade required </td></tr> + <tr><th>IPP_STATUS_ERROR_DEVICE </th> <td class="description">server-error-device-error</td></tr> + <tr><th>IPP_STATUS_ERROR_DOCUMENT_ACCESS </th> <td class="description">client-error-document-access-error</td></tr> + <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR </th> <td class="description">client-error-document-format-error</td></tr> + <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED </th> <td class="description">client-error-document-format-not-supported</td></tr> + <tr><th>IPP_STATUS_ERROR_DOCUMENT_PASSWORD </th> <td class="description">client-error-document-password-error</td></tr> + <tr><th>IPP_STATUS_ERROR_DOCUMENT_PERMISSION </th> <td class="description">client-error-document-permission-error</td></tr> + <tr><th>IPP_STATUS_ERROR_DOCUMENT_SECURITY </th> <td class="description">client-error-document-security-error</td></tr> + <tr><th>IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE </th> <td class="description">client-error-document-unprintable-error</td></tr> + <tr><th>IPP_STATUS_ERROR_FORBIDDEN </th> <td class="description">client-error-forbidden</td></tr> + <tr><th>IPP_STATUS_ERROR_GONE </th> <td class="description">client-error-gone</td></tr> + <tr><th>IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS </th> <td class="description">client-error-ignored-all-subscriptions</td></tr> + <tr><th>IPP_STATUS_ERROR_INTERNAL </th> <td class="description">server-error-internal-error</td></tr> + <tr><th>IPP_STATUS_ERROR_JOB_CANCELED </th> <td class="description">server-error-job-canceled</td></tr> + <tr><th>IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED </th> <td class="description">server-error-multiple-document-jobs-not-supported</td></tr> + <tr><th>IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS </th> <td class="description">server-error-not-accepting-jobs</td></tr> + <tr><th>IPP_STATUS_ERROR_NOT_AUTHENTICATED </th> <td class="description">client-error-not-authenticated</td></tr> + <tr><th>IPP_STATUS_ERROR_NOT_AUTHORIZED </th> <td class="description">client-error-not-authorized</td></tr> + <tr><th>IPP_STATUS_ERROR_NOT_FETCHABLE </th> <td class="description">client-error-not-fetchable</td></tr> + <tr><th>IPP_STATUS_ERROR_NOT_FOUND </th> <td class="description">client-error-not-found</td></tr> + <tr><th>IPP_STATUS_ERROR_NOT_POSSIBLE </th> <td class="description">client-error-not-possible</td></tr> + <tr><th>IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED </th> <td class="description">server-error-operation-not-supported</td></tr> + <tr><th>IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED </th> <td class="description">server-error-printer-is-deactivated</td></tr> + <tr><th>IPP_STATUS_ERROR_REQUEST_ENTITY </th> <td class="description">client-error-request-entity-too-large</td></tr> + <tr><th>IPP_STATUS_ERROR_REQUEST_VALUE </th> <td class="description">client-error-request-value-too-long</td></tr> + <tr><th>IPP_STATUS_ERROR_SERVICE_UNAVAILABLE </th> <td class="description">server-error-service-unavailable</td></tr> + <tr><th>IPP_STATUS_ERROR_TEMPORARY </th> <td class="description">server-error-temporary-error</td></tr> + <tr><th>IPP_STATUS_ERROR_TIMEOUT </th> <td class="description">client-error-timeout</td></tr> + <tr><th>IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS </th> <td class="description">server-error-too-many-documents</td></tr> + <tr><th>IPP_STATUS_ERROR_TOO_MANY_JOBS </th> <td class="description">server-error-too-many-jobs</td></tr> + <tr><th>IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS </th> <td class="description">client-error-too-many-subscriptions</td></tr> + <tr><th>IPP_STATUS_ERROR_URI_SCHEME </th> <td class="description">client-error-uri-scheme-not-supported</td></tr> + <tr><th>IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED </th> <td class="description">server-error-version-not-supported</td></tr> + <tr><th>IPP_STATUS_OK </th> <td class="description">successful-ok</td></tr> + <tr><th>IPP_STATUS_OK_CONFLICTING </th> <td class="description">successful-ok-conflicting-attributes</td></tr> + <tr><th>IPP_STATUS_OK_EVENTS_COMPLETE </th> <td class="description">successful-ok-events-complete</td></tr> + <tr><th>IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED </th> <td class="description">successful-ok-ignored-or-substituted-attributes</td></tr> + <tr><th>IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS </th> <td class="description">successful-ok-ignored-subscriptions</td></tr> + <tr><th>IPP_STATUS_OK_TOO_MANY_EVENTS </th> <td class="description">successful-ok-too-many-events</td></tr> +</tbody></table> + <h3 class="enumeration"><a id="ipp_tag_e">ipp_tag_e</a></h3> + <p class="description">Value and group tag values for attributes</p> + <h4 class="constants">Constants</h4> + <table class="list"><tbody> + <tr><th>IPP_TAG_ADMINDEFINE </th> <td class="description">Admin-defined value</td></tr> + <tr><th>IPP_TAG_BOOLEAN </th> <td class="description">Boolean value</td></tr> + <tr><th>IPP_TAG_CHARSET </th> <td class="description">Character set value</td></tr> + <tr><th>IPP_TAG_CUPS_INVALID </th> <td class="description">Invalid tag name for <a href="#ippTagValue"><code>ippTagValue</code></a></td></tr> + <tr><th>IPP_TAG_DATE </th> <td class="description">Date/time value</td></tr> + <tr><th>IPP_TAG_DEFAULT </th> <td class="description">Default value</td></tr> + <tr><th>IPP_TAG_DELETEATTR </th> <td class="description">Delete-attribute value</td></tr> + <tr><th>IPP_TAG_END </th> <td class="description">End-of-attributes</td></tr> + <tr><th>IPP_TAG_ENUM </th> <td class="description">Enumeration value</td></tr> + <tr><th>IPP_TAG_EVENT_NOTIFICATION </th> <td class="description">Event group</td></tr> + <tr><th>IPP_TAG_INTEGER </th> <td class="description">Integer value</td></tr> + <tr><th>IPP_TAG_JOB </th> <td class="description">Job group</td></tr> + <tr><th>IPP_TAG_KEYWORD </th> <td class="description">Keyword value</td></tr> + <tr><th>IPP_TAG_LANGUAGE </th> <td class="description">Language value</td></tr> + <tr><th>IPP_TAG_MIMETYPE </th> <td class="description">MIME media type value</td></tr> + <tr><th>IPP_TAG_NAME </th> <td class="description">Name value</td></tr> + <tr><th>IPP_TAG_NAMELANG </th> <td class="description">Name-with-language value</td></tr> + <tr><th>IPP_TAG_NOTSETTABLE </th> <td class="description">Not-settable value</td></tr> + <tr><th>IPP_TAG_NOVALUE </th> <td class="description">No-value value</td></tr> + <tr><th>IPP_TAG_OPERATION </th> <td class="description">Operation group</td></tr> + <tr><th>IPP_TAG_PRINTER </th> <td class="description">Printer group</td></tr> + <tr><th>IPP_TAG_RANGE </th> <td class="description">Range value</td></tr> + <tr><th>IPP_TAG_RESOLUTION </th> <td class="description">Resolution value</td></tr> + <tr><th>IPP_TAG_STRING </th> <td class="description">Octet string value</td></tr> + <tr><th>IPP_TAG_SUBSCRIPTION </th> <td class="description">Subscription group</td></tr> + <tr><th>IPP_TAG_TEXT </th> <td class="description">Text value</td></tr> + <tr><th>IPP_TAG_TEXTLANG </th> <td class="description">Text-with-language value</td></tr> + <tr><th>IPP_TAG_UNKNOWN </th> <td class="description">Unknown value</td></tr> + <tr><th>IPP_TAG_UNSUPPORTED_GROUP </th> <td class="description">Unsupported attributes group</td></tr> + <tr><th>IPP_TAG_UNSUPPORTED_VALUE </th> <td class="description">Unsupported value</td></tr> + <tr><th>IPP_TAG_URI </th> <td class="description">URI value</td></tr> + <tr><th>IPP_TAG_URISCHEME </th> <td class="description">URI scheme value</td></tr> + <tr><th>IPP_TAG_ZERO </th> <td class="description">Zero tag - used for separators</td></tr> +</tbody></table> + </div> + </body> +</html> diff --git a/doc/help/man-ipptool.html b/doc/help/man-ipptool.html index c1034f3..ef95bfe 100644 --- a/doc/help/man-ipptool.html +++ b/doc/help/man-ipptool.html @@ -210,10 +210,9 @@ Get a list of completed jobs for "myprinter": </pre> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> <a href="man-ipptoolfile.html?TOPIC=Man+Pages"><b>ipptoolfile</b>(5),</a> -CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>, IANA IPP Registry (<a href="http://www.iana.org/assignments/ipp\-registrations)">http://www.iana.org/assignments/ipp\-registrations)</a>, PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>) -RFC 2911 (<a href="http://tools.ietf.org/html/rfc2911)">http://tools.ietf.org/html/rfc2911)</a>, +RFC 8011 (<a href="http://tools.ietf.org/html/rfc8011)">http://tools.ietf.org/html/rfc8011)</a>, <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> Copyright © 2007-2017 by Apple Inc. diff --git a/doc/help/man-ipptoolfile.html b/doc/help/man-ipptoolfile.html index 2ddd22e..2921bea 100644 --- a/doc/help/man-ipptoolfile.html +++ b/doc/help/man-ipptoolfile.html @@ -12,22 +12,42 @@ ipptoolfile - ipptool file format <h2 class="title"><a name="DESCRIPTION">Description</a></h2> The <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1)</a> -program accepts free-form plain text files that describe one or more IPP requests. Comments start with the "#" character and continue to the end of the line. Each request is enclosed by curly braces, for example: +program accepts free-form plain text files that describe one or more IPP requests. +Comments start with the "#" character and continue to the end of the line. +Each request is enclosed by curly braces, for example: <pre class="man"> # This is a comment { # The name of the test - NAME "Print PostScript File" + NAME "Print PDF File" # The request to send OPERATION Print-Job + GROUP operation-attributes-tag ATTR charset attributes-charset utf-8 ATTR language attributes-natural-language en ATTR uri printer-uri $uri ATTR name requesting-user-name $user - FILE testfile.ps + ATTR mimeMediaType document-format application/pdf + + GROUP job-attributes-tag + ATTR collection media-col { + # US Letter plain paper from the "main" tray + MEMBER collection media-size { + MEMBER integer x-dimension 21590 + MEMBER integer y-dimension 27940 + } + MEMBER integer media-top-margin 423 + MEMBER integer media-bottom-margin 423 + MEMBER integer media-left-margin 423 + MEMBER integer media-right-margin 423 + MEMBER keyword media-source "main" + MEMBER keyword media-type "stationery" + } + + FILE testfile.pdf # The response to expect STATUS successful-ok @@ -36,10 +56,11 @@ program accepts free-form plain text files that describe one or more IPP request } { # The name of the test - NAME "Get Attributes of PostScript Job" + NAME "Wait for Job to Complete" # The request to send OPERATION Get-Job-Attributes + GROUP operation-attributes-tag ATTR charset attributes-charset utf-8 ATTR language attributes-natural-language en @@ -51,8 +72,12 @@ program accepts free-form plain text files that describe one or more IPP request STATUS successful-ok EXPECT job-id OF-TYPE integer WITH-VALUE $job-id EXPECT job-uri OF-TYPE uri - EXPECT job-state OF-TYPE enum WITH-VALUE 3,4,5,6,7,8,9 + EXPECT job-state OF-TYPE enum WITH-VALUE >5 REPEAT-NO-MATCH EXPECT job-originating-user-name OF-TYPE name WITH-VALUE "$user" + + # Show the job state until completed... + DISPLAY job-state + DISPLAY job-state-reasons } </pre> <h3><a name="TOP_LEVEL_DIRECTIVES">Top-level Directives</a></h3> @@ -115,15 +140,20 @@ command-line. Support for content length requests is required for conformance wi The following directives are understood within a <i>test</i>: <dl class="man"> <dt><b>ATTR </b><i>tag attribute-name value(s)</i> -<dd style="margin-left: 5.0em">Adds an attribute to the test request. Values are separated by the comma (",") character - escape commas using the "" character. Common attributes and values are listed in the IANA IPP registry - see references below. +<dd style="margin-left: 5.0em">Adds an attribute to the test request. +Values are separated by the comma (",") character - escape commas using the "" character. +Common attributes and values are listed in the IANA IPP registry - see references below. <dt><b>ATTR collection </b><i>attribute-name </i><b>{ MEMBER </b><i>tag member-name value(s) ... </i><b>}</b> [ <i>... </i><b>,{ </b><i>... </i><b>} </b>] -<dd style="margin-left: 5.0em">Adds a collection attribute to the test request. Member attributes follow the same syntax as regular attributes and can themselves be nested collections. Multiple collection values can be supplied as needed, separated by commas. +<dd style="margin-left: 5.0em">Adds a collection attribute to the test request. +Member attributes follow the same syntax as regular attributes and can themselves be nested collections. +Multiple collection values can be supplied as needed, separated by commas. <dt><b>COMPRESSION deflate</b> <dd style="margin-left: 5.0em"><dt><b>COMPRESSION gzip</b> <dd style="margin-left: 5.0em"><dt><b>COMPRESSION none</b> <dd style="margin-left: 5.0em">Uses the specified compression on the document data following the attributes in a Print-Job or Send-Document request. -<dt><b>DELAY </b><i>seconds</i> -<dd style="margin-left: 5.0em">Specifies a delay before this test will be run. +<dt><b>DELAY </b><i>seconds</i>[<i>,repeat-seconds</i>] +<dd style="margin-left: 5.0em">Specifies a delay in seconds before this test will be run. +If two values are specified, the second value is used as the delay between repeated tests. <dt><b>DISPLAY </b><i>attribute-name</i> <dd style="margin-left: 5.0em">Specifies that value of the named attribute should be output as part of the test report. @@ -496,10 +526,9 @@ if any. </dl> <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> <a href="man-ipptool.html?TOPIC=Man+Pages"><b>ipptool</b>(1),</a> -CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>, IANA IPP Registry (<a href="http://www.iana.org/assignments/ipp-registrations)">http://www.iana.org/assignments/ipp-registrations)</a>, PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp)">http://www.pwg.org/ipp)</a>, -RFC 2911 (<a href="http://tools.ietf.org/html/rfc3911">http://tools.ietf.org/html/rfc3911</a>) +RFC 8011 (<a href="http://tools.ietf.org/html/rfc8011">http://tools.ietf.org/html/rfc8011</a>) <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2> Copyright © 2007-2017 by Apple Inc. diff --git a/doc/help/man-lpstat.html b/doc/help/man-lpstat.html index 391ce44..106b9f5 100644 --- a/doc/help/man-lpstat.html +++ b/doc/help/man-lpstat.html @@ -36,6 +36,8 @@ lpstat - print cups status information ] ] [ <b>-d</b> ] [ +<b>-e</b> +] [ <b>-o</b> [ <i>destination(s)</i> @@ -85,6 +87,8 @@ If no printers are specified then all printers are listed. If no classes are specified then all classes are listed. <dt><b>-d</b> <dd style="margin-left: 5.0em">Shows the current default destination. +<dt><b>-e</b> +<dd style="margin-left: 5.0em">Shows all available destinations on the local network. <dt><b>-h </b><i>server</i>[<b>:</b><i>port</i>] <dd style="margin-left: 5.0em">Specifies an alternate server. <dt><b>-l</b> @@ -113,7 +117,7 @@ If no printers are specified then all printers are listed. <h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2> Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#". Also, printer and class names are <i>not</i> case-sensitive. -<p>The <i>-h</i>, <i>-E</i>, <i>-U</i>, and <i>-W</i> options are unique to CUPS. +<p>The <i>-h</i>, <i>-e</i>, <i>-E</i>, <i>-U</i>, and <i>-W</i> options are unique to CUPS. <p>The Solaris <i>-f</i>, <i>-P</i>, and <i>-S</i> options are silently ignored. <h2 class="title"><a name="SEE_ALSO">See Also</a></h2> <a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> diff --git a/doc/help/postscript-driver.html b/doc/help/postscript-driver.html index a996bac..5d0239c 100644 --- a/doc/help/postscript-driver.html +++ b/doc/help/postscript-driver.html @@ -1,12 +1,15 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!doctype html> <html> <!-- SECTION: Programming --> -<head> - <title>Developing PostScript Printer Drivers </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<style type="text/css"><!-- + <head> + <title>Developing PostScript Printer Drivers</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="Mini-XML v2.11"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- BODY { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } @@ -349,9 +352,8 @@ div.contents ul.subcontents li { text-indent: -1em; } --></style> -</head> -<body> -<div class='body'> + </head> + <body> <!-- PostScript printer driver documentation for CUPS. @@ -382,16 +384,19 @@ div.contents ul.subcontents li { </tr> </tbody> </table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#BASICS">Printer Driver Basics</a></li> -<li><a href="#CREATING">Creating New PPD Files</a><ul class="subcontents"> - <li><a href="#IMPORT">Importing Existing PPD Files</a></li> -</ul></li> -<li><a href="#FILTERS">Using Custom Filters</a></li> -<li><a href="#COLOR">Implementing Color Management</a></li> -<li><a href="#MACOSX">Adding macOS Features</a></li> -</ul> + <div class="contents"> + <h2 class="title">Contents</h2> + <ul class="contents"> + <li><a href="#BASICS">Printer Driver Basics</a></li> + <li><a href="#CREATING">Creating New PPD Files</a><ul class="subcontents"> + <li><a href="#IMPORT">Importing Existing PPD Files</a></li> + </ul></li> + <li><a href="#FILTERS">Using Custom Filters</a></li> + <li><a href="#COLOR">Implementing Color Management</a></li> + <li><a href="#MACOSX">Adding macOS Features</a></li> + </ul> + </div> + <div class="body"> <h2 class='title'><a name='BASICS'>Printer Driver Basics</a></h2> <p>A CUPS PostScript printer driver consists of a PostScript Printer Description (PPD) file that describes the features and capabilities of the device, zero or more <em>filter</em> programs that prepare print data for the device, and zero or more support files for color management, online help, and so forth. The PPD file includes references to all of the filters and support files used by the driver.</p> @@ -668,6 +673,6 @@ information file.</P> <a href='ref-ppdcfile.html#Attribute'>Attribute</a> APPrinterIconPath "" /Library/Printers/Vendor/filename.icns <a href='ref-ppdcfile.html#Attribute'>Attribute</a> APPrinterPreset "name/text" "*option choice ..." </pre> -</div> -</body> + </div> + </body> </html> diff --git a/doc/help/ppd-compiler.html b/doc/help/ppd-compiler.html index d6a457f..2807e85 100644 --- a/doc/help/ppd-compiler.html +++ b/doc/help/ppd-compiler.html @@ -1,12 +1,15 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!doctype html> <html> <!-- SECTION: Programming --> -<head> - <title>Introduction to the PPD Compiler </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<style type="text/css"><!-- + <head> + <title>Introduction to the PPD Compiler</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="Mini-XML v2.11"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- BODY { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } @@ -349,9 +352,8 @@ div.contents ul.subcontents li { text-indent: -1em; } --></style> -</head> -<body> -<div class='body'> + </head> + <body> <!-- PPD compiler documentation for CUPS. @@ -390,23 +392,26 @@ that describe the features and capabilities of one or more printers.</P> </tr> </tbody> </table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#BASICS">The Basics</a></li> -<li><a href="#DRV">Driver Information Files</a><ul class="subcontents"> - <li><a href="#SIMPLE">A Simple Example</a></li> - <li><a href="#GROUPING">Grouping and Inheritance</a></li> - <li><a href="#COLOR">Color Support</a></li> - <li><a href="#OPTIONS">Defining Custom Options and Option Groups</a></li> - <li><a href="#DEFINE">Defining Constants</a></li> - <li><a href="#CONDITIONAL">Conditional Statements</a></li> - <li><a href="#CONSTRAINTS">Defining Constraints</a></li> -</ul></li> -<li><a href="#LOCALIZATION">Localization</a><ul class="subcontents"> - <li><a href="#PPDPO">The ppdpo Utility</a></li> - <li><a href="#PPDC_CATALOG">Using Message Catalogs with the PPD Compiler</a></li> -</ul></li> -</ul> + <div class="contents"> + <h2 class="title">Contents</h2> + <ul class="contents"> + <li><a href="#BASICS">The Basics</a></li> + <li><a href="#DRV">Driver Information Files</a><ul class="subcontents"> + <li><a href="#SIMPLE">A Simple Example</a></li> + <li><a href="#GROUPING">Grouping and Inheritance</a></li> + <li><a href="#COLOR">Color Support</a></li> + <li><a href="#OPTIONS">Defining Custom Options and Option Groups</a></li> + <li><a href="#DEFINE">Defining Constants</a></li> + <li><a href="#CONDITIONAL">Conditional Statements</a></li> + <li><a href="#CONSTRAINTS">Defining Constraints</a></li> + </ul></li> + <li><a href="#LOCALIZATION">Localization</a><ul class="subcontents"> + <li><a href="#PPDPO">The ppdpo Utility</a></li> + <li><a href="#PPDC_CATALOG">Using Message Catalogs with the PPD Compiler</a></li> + </ul></li> + </ul> + </div> + <div class="body"> <h2 class='title'><a name='BASICS'>The Basics</a></h2> <P>The PPD compiler, <a href='man-ppdc.html'><code>ppdc(1)</code></a>, is a @@ -1290,6 +1295,6 @@ ppdc -l de -d ppd/de mydrivers.drv </pre> <p>to generate German PPD files.</p> -</div> -</body> + </div> + </body> </html> diff --git a/doc/help/raster-driver.html b/doc/help/raster-driver.html index d44e45c..3a6f5d8 100644 --- a/doc/help/raster-driver.html +++ b/doc/help/raster-driver.html @@ -1,12 +1,15 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!doctype html> <html> <!-- SECTION: Programming --> -<head> - <title>Developing Raster Printer Drivers </title> - <meta name="keywords" content="Programming"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<style type="text/css"><!-- + <head> + <title>Developing Raster Printer Drivers</title> + <meta name="keywords" content="Programming"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="Mini-XML v2.11"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- BODY { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } @@ -349,9 +352,8 @@ div.contents ul.subcontents li { text-indent: -1em; } --></style> -</head> -<body> -<div class='body'> + </head> + <body> <!-- Raster printer driver documentation for CUPS. @@ -382,14 +384,17 @@ div.contents ul.subcontents li { </tr> </tbody> </table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#BASICS">Printer Driver Basics</a></li> -<li><a href="#CREATING">Creating New PPD Files</a></li> -<li><a href="#FILTERS">Using Filters</a></li> -<li><a href="#COLOR">Implementing Color Management</a></li> -<li><a href="#MACOSX">Adding macOS Features</a></li> -</ul> + <div class="contents"> + <h2 class="title">Contents</h2> + <ul class="contents"> + <li><a href="#BASICS">Printer Driver Basics</a></li> + <li><a href="#CREATING">Creating New PPD Files</a></li> + <li><a href="#FILTERS">Using Filters</a></li> + <li><a href="#COLOR">Implementing Color Management</a></li> + <li><a href="#MACOSX">Adding macOS Features</a></li> + </ul> + </div> + <div class="body"> <h2 class='title'><a name='BASICS'>Printer Driver Basics</a></h2> <p>A CUPS raster printer driver consists of a PostScript Printer Description (PPD) file that describes the features and capabilities of the device, one or more <em>filter</em> programs that prepare print data for the device, and zero or more support files for color management, online help, and so forth. The PPD file includes references to all of the filters and support files used by the driver.</p> @@ -584,6 +589,6 @@ div.contents ul.subcontents li { <a href='ref-ppdcfile.html#Attribute'>Attribute</a> APPrinterIconPath "" /Library/Printers/Vendor/filename.icns <a href='ref-ppdcfile.html#Attribute'>Attribute</a> APPrinterPreset "name/text" "*option choice ..." </pre> -</div> -</body> + </div> + </body> </html> diff --git a/doc/help/spec-ppd.html b/doc/help/spec-ppd.html index 16f4cf3..06f5769 100644 --- a/doc/help/spec-ppd.html +++ b/doc/help/spec-ppd.html @@ -1,12 +1,15 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!doctype html> <html> <!-- SECTION: Specifications --> -<head> - <title>CUPS PPD Extensions </title> - <meta name="keywords" content="Specifications"> - <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> - <meta name="creator" content="Mini-XML v2.7"> -<style type="text/css"><!-- + <head> + <title>CUPS PPD Extensions</title> + <meta name="keywords" content="Specifications"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="creator" content="Mini-XML v2.11"> + <meta name="author" content="Unknown"> + <meta name="copyright" content="Unknown"> + <meta name="version" content="0.0"> + <style type="text/css"><!-- BODY { font-family: lucida grande, geneva, helvetica, arial, sans-serif; } @@ -349,9 +352,8 @@ div.contents ul.subcontents li { text-indent: -1em; } --></style> -</head> -<body> -<div class='body'> + </head> + <body> <!-- PPD extension documentation for CUPS. @@ -382,78 +384,81 @@ div.contents ul.subcontents li { </tr> </tbody> </table></div> -<h2 class="title">Contents</h2> -<ul class="contents"> -<li><a href="#SYNTAX">PPD File Syntax</a></li> -<li><a href="#AUTOCONFIG">Auto-Configuration</a><ul class="subcontents"> - <li><a href="#APAutoSetupTool">APAutoSetupTool</a></li> - <li><a href="#QUERYKEYWORD">?MainKeyword</a></li> - <li><a href="#OID">OIDMainKeyword</a></li> -</ul></li> -<li><a href="#PROFILES">Color Profiles</a><ul class="subcontents"> - <li><a href="#cupsColorProfile">cupsColorProfile</a></li> - <li><a href="#cupsICCProfile">cupsICCProfile</a></li> - <li><a href="#APCustom">Custom Color Matching Support</a></li> -</ul></li> -<li><a href="#CONSTRAINTS">Constraints</a><ul class="subcontents"> - <li><a href="#cupsUIConstraints">cupsUIConstraints</a></li> - <li><a href="#cupsUIResolver">cupsUIResolver</a></li> -</ul></li> -<li><a href="#I18N">Globalized PPD Support</a></li> -<li><a href="#OPTIONS">CUPS 1.3/macOS 10.6Custom Options</a></li> -<li><a href="#RASTERPS">Writing PostScript Option Commands for Raster Drivers</a></li> -<li><a href="#MEDIA">Media Keywords</a><ul class="subcontents"> - <li><a href="#cupsMediaQualifier2">cupsMediaQualifier2</a></li> - <li><a href="#cupsMediaQualifier3">cupsMediaQualifier3</a></li> - <li><a href="#cupsMinSize">cupsMinSize</a></li> - <li><a href="#cupsMaxSize">cupsMaxSize</a></li> - <li><a href="#cupsPageSizeCategory">cupsPageSizeCategory</a></li> -</ul></li> -<li><a href="#ATTRIBUTES">General Attributes</a><ul class="subcontents"> - <li><a href="#cupsBackSide">cupsBackSide</a></li> - <li><a href="#cupsCommands">cupsCommands</a></li> - <li><a href="#cupsEvenDuplex">cupsEvenDuplex</a></li> - <li><a href="#cupsFax">cupsFax</a></li> - <li><a href="#cupsFilter">cupsFilter</a></li> - <li><a href="#cupsFilter2">cupsFilter2</a></li> - <li><a href="#cupsFlipDuplex">cupsFlipDuplex</a></li> - <li><a href="#cupsIPPFinishings">cupsIPPFinishings</a></li> - <li><a href="#cupsIPPReason">cupsIPPReason</a></li> - <li><a href="#cupsIPPSupplies">cupsIPPSupplies</a></li> - <li><a href="#cupsJobAccountId">cupsJobAccountId</a></li> - <li><a href="#cupsJobAccountingUserId">cupsJobAccountingUserId</a></li> - <li><a href="#cupsJobPassword">cupsJobPassword</a></li> - <li><a href="#cupsLanguages">cupsLanguages</a></li> - <li><a href="#cupsMandatory">cupsMandatory</a></li> - <li><a href="#cupsManualCopies">cupsManualCopies</a></li> - <li><a href="#cupsMarkerName">cupsMarkerName</a></li> - <li><a href="#cupsMarkerNotice">cupsMarkerNotice</a></li> - <li><a href="#cupsMaxCopies">cupsMaxCopies</a></li> - <li><a href="#cupsModelNumber">cupsModelNumber</a></li> - <li><a href="#cupsPJLCharset">cupsPJLCharset</a></li> - <li><a href="#cupsPJLDisplay">cupsPJLDisplay</a></li> - <li><a href="#cupsPortMonitor">cupsPortMonitor</a></li> - <li><a href="#cupsPreFilter">cupsPreFilter</a></li> - <li><a href="#cupsPrintQuality">cupsPrintQuality</a></li> - <li><a href="#cupsSingleFile">cupsSingleFile</a></li> - <li><a href="#cupsSNMPSupplies">cupsSNMPSupplies</a></li> - <li><a href="#cupsVersion">cupsVersion</a></li> - <li><a href="#JCLToPDFInterpreter">JCLToPDFInterpreter</a></li> -</ul></li> -<li><a href="#MACOSX">macOS Attributes</a><ul class="subcontents"> - <li><a href="#APDialogExtension">APDialogExtension</a></li> - <li><a href="#APDuplexRequiresFlippedMargin">APDuplexRequiresFlippedMargin</a></li> - <li><a href="#APHelpBook">APHelpBook</a></li> - <li><a href="#APICADriver">APICADriver</a></li> - <li><a href="#APPrinterIconPath">APPrinterIconPath</a></li> - <li><a href="#APPrinterLowInkTool">APPrinterLowInkTool</a></li> - <li><a href="#APPrinterPreset">APPrinterPreset</a></li> - <li><a href="#APPrinterUtilityPath">APPrinterUtilityPath</a></li> - <li><a href="#APScannerOnly">APScannerOnly</a></li> - <li><a href="#APScanAppBundleID">APScanAppBundleID</a></li> -</ul></li> -<li><a href="#HISTORY">Change History</a></li> -</ul> + <div class="contents"> + <h2 class="title">Contents</h2> + <ul class="contents"> + <li><a href="#SYNTAX">PPD File Syntax</a></li> + <li><a href="#AUTOCONFIG">Auto-Configuration</a><ul class="subcontents"> + <li><a href="#APAutoSetupTool">APAutoSetupTool</a></li> + <li><a href="#QUERYKEYWORD">?MainKeyword</a></li> + <li><a href="#OID">OIDMainKeyword</a></li> + </ul></li> + <li><a href="#PROFILES">Color Profiles</a><ul class="subcontents"> + <li><a href="#cupsColorProfile">cupsColorProfile</a></li> + <li><a href="#cupsICCProfile">cupsICCProfile</a></li> + <li><a href="#APCustom">Custom Color Matching Support</a></li> + </ul></li> + <li><a href="#CONSTRAINTS">Constraints</a><ul class="subcontents"> + <li><a href="#cupsUIConstraints">cupsUIConstraints</a></li> + <li><a href="#cupsUIResolver">cupsUIResolver</a></li> + </ul></li> + <li><a href="#I18N">Globalized PPD Support</a></li> + <li><a href="#OPTIONS"><span class="info">CUPS 1.3/macOS 10.6</span>Custom Options</a></li> + <li><a href="#RASTERPS">Writing PostScript Option Commands for Raster Drivers</a></li> + <li><a href="#MEDIA">Media Keywords</a><ul class="subcontents"> + <li><a href="#cupsMediaQualifier2">cupsMediaQualifier2</a></li> + <li><a href="#cupsMediaQualifier3">cupsMediaQualifier3</a></li> + <li><a href="#cupsMinSize">cupsMinSize</a></li> + <li><a href="#cupsMaxSize">cupsMaxSize</a></li> + <li><a href="#cupsPageSizeCategory">cupsPageSizeCategory</a></li> + </ul></li> + <li><a href="#ATTRIBUTES">General Attributes</a><ul class="subcontents"> + <li><a href="#cupsBackSide">cupsBackSide</a></li> + <li><a href="#cupsCommands">cupsCommands</a></li> + <li><a href="#cupsEvenDuplex">cupsEvenDuplex</a></li> + <li><a href="#cupsFax">cupsFax</a></li> + <li><a href="#cupsFilter">cupsFilter</a></li> + <li><a href="#cupsFilter2">cupsFilter2</a></li> + <li><a href="#cupsFlipDuplex">cupsFlipDuplex</a></li> + <li><a href="#cupsIPPFinishings">cupsIPPFinishings</a></li> + <li><a href="#cupsIPPReason">cupsIPPReason</a></li> + <li><a href="#cupsIPPSupplies">cupsIPPSupplies</a></li> + <li><a href="#cupsJobAccountId">cupsJobAccountId</a></li> + <li><a href="#cupsJobAccountingUserId">cupsJobAccountingUserId</a></li> + <li><a href="#cupsJobPassword">cupsJobPassword</a></li> + <li><a href="#cupsLanguages">cupsLanguages</a></li> + <li><a href="#cupsMandatory">cupsMandatory</a></li> + <li><a href="#cupsManualCopies">cupsManualCopies</a></li> + <li><a href="#cupsMarkerName">cupsMarkerName</a></li> + <li><a href="#cupsMarkerNotice">cupsMarkerNotice</a></li> + <li><a href="#cupsMaxCopies">cupsMaxCopies</a></li> + <li><a href="#cupsModelNumber">cupsModelNumber</a></li> + <li><a href="#cupsPJLCharset">cupsPJLCharset</a></li> + <li><a href="#cupsPJLDisplay">cupsPJLDisplay</a></li> + <li><a href="#cupsPortMonitor">cupsPortMonitor</a></li> + <li><a href="#cupsPreFilter">cupsPreFilter</a></li> + <li><a href="#cupsPrintQuality">cupsPrintQuality</a></li> + <li><a href="#cupsSingleFile">cupsSingleFile</a></li> + <li><a href="#cupsSNMPSupplies">cupsSNMPSupplies</a></li> + <li><a href="#cupsVersion">cupsVersion</a></li> + <li><a href="#JCLToPDFInterpreter">JCLToPDFInterpreter</a></li> + </ul></li> + <li><a href="#MACOSX">macOS Attributes</a><ul class="subcontents"> + <li><a href="#APDialogExtension">APDialogExtension</a></li> + <li><a href="#APDuplexRequiresFlippedMargin">APDuplexRequiresFlippedMargin</a></li> + <li><a href="#APHelpBook">APHelpBook</a></li> + <li><a href="#APICADriver">APICADriver</a></li> + <li><a href="#APPrinterIconPath">APPrinterIconPath</a></li> + <li><a href="#APPrinterLowInkTool">APPrinterLowInkTool</a></li> + <li><a href="#APPrinterPreset">APPrinterPreset</a></li> + <li><a href="#APPrinterUtilityPath">APPrinterUtilityPath</a></li> + <li><a href="#APScannerOnly">APScannerOnly</a></li> + <li><a href="#APScanAppBundleID">APScanAppBundleID</a></li> + </ul></li> + <li><a href="#HISTORY">Change History</a></li> + </ul> + </div> + <div class="body"> <h2 class='title'><a name='SYNTAX'>PPD File Syntax</a></h2> <p>The PPD format is text-based and uses lines of up to 255 characters terminated by a carriage return, linefeed, or combination of carriage return and line feed. The following ABNF definition [<a href="http://tools.ietf.org/html/rfc5234" target="_blank">RFC5234</a>] defines the general format of lines in a PPD file:</p> @@ -2480,6 +2485,6 @@ the device.</p> <li>Added <tt>cupsProtocol</tt> keyword</li> </ul> -</div> -</body> + </div> + </body> </html> |