doc/help/cupspm.html

   1 <!doctype html>
   2 <html>
   3 <!-- SECTION: Programming -->
   4   <head>
   5     <title>CUPS Programming Manual</title>
   6     <meta name="keywords" content="Programming">
   7     <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
   8     <meta name="creator" content="Mini-XML v2.11">
   9     <meta name="author" content="Michael R Sweet">
  10     <meta name="copyright" content="Copyright &#xa9; 2007-2018 by Apple Inc. All Rights Reserved.">
  11     <meta name="version" content="2.3.0">
  12     <style type="text/css"><!--
  13 body, p, h1, h2, h3, h4 {
  14   font-family: sans-serif;
  15 }
  16 div.body h1 {
  17   font-size: 250%;
  18   font-weight: bold;
  19   margin: 0;
  20 }
  21 div.body h2 {
  22   font-size: 250%;
  23   margin-top: 1.5em;
  24 }
  25 div.body h3 {
  26   font-size: 150%;
  27   margin-bottom: 0.5em;
  28   margin-top: 1.5em;
  29 }
  30 div.body h4 {
  31   font-size: 110%;
  32   margin-bottom: 0.5em;
  33   margin-top: 1.5em;
  34 }
  35 div.body h5 {
  36   font-size: 100%;
  37   margin-bottom: 0.5em;
  38   margin-top: 1.5em;
  39 }
  40 div.contents {
  41   background: #e8e8e8;
  42   border: solid thin black;
  43   padding: 10px;
  44 }
  45 div.contents h1 {
  46   font-size: 110%;
  47 }
  48 div.contents h2 {
  49   font-size: 100%;
  50 }
  51 div.contents ul.contents {
  52   font-size: 80%;
  53 }
  54 .class {
  55   border-bottom: solid 2px gray;
  56 }
  57 .constants {
  58 }
  59 .description {
  60   margin-top: 0.5em;
  61 }
  62 .discussion {
  63 }
  64 .enumeration {
  65   border-bottom: solid 2px gray;
  66 }
  67 .function {
  68   border-bottom: solid 2px gray;
  69   margin-bottom: 0;
  70 }
  71 .members {
  72 }
  73 .method {
  74 }
  75 .parameters {
  76 }
  77 .returnvalue {
  78 }
  79 .struct {
  80   border-bottom: solid 2px gray;
  81 }
  82 .typedef {
  83   border-bottom: solid 2px gray;
  84 }
  85 .union {
  86   border-bottom: solid 2px gray;
  87 }
  88 .variable {
  89 }
  90 h1, h2, h3, h4, h5, h6 {
  91   page-break-inside: avoid;
  92 }
  93 blockquote {
  94   border: solid thin gray;
  95   box-shadow: 3px 3px 5px rgba(0,0,0,0.5);
  96   padding: 0px 10px;
  97   page-break-inside: avoid;
  98 }
  99 p code, li code, p.code, pre, ul.code li {
 100   background: rgba(127,127,127,0.1);
 101   border: thin dotted gray;
 102   font-family: monospace;
 103   font-size: 90%;
 104   hyphens: manual;
 105   -webkit-hyphens: manual;
 106   page-break-inside: avoid;
 107 }
 108 p.code, pre, ul.code li {
 109   padding: 10px;
 110 }
 111 p code, li code {
 112   padding: 2px 5px;
 113 }
 114 a:link, a:visited {
 115   text-decoration: none;
 116 }
 117 span.info {
 118   background: black;
 119   border: solid thin black;
 120   color: white;
 121   font-size: 80%;
 122   font-style: italic;
 123   font-weight: bold;
 124   white-space: nowrap;
 125 }
 126 h3 span.info, h4 span.info {
 127   border-top-left-radius: 10px;
 128   border-top-right-radius: 10px;
 129   float: right;
 130   padding: 3px 6px;
 131 }
 132 ul.code, ul.contents, ul.subcontents {
 133   list-style-type: none;
 134   margin: 0;
 135   padding-left: 0;
 136 }
 137 ul.code li {
 138   margin: 0;
 139 }
 140 ul.contents > li {
 141   margin-top: 1em;
 142 }
 143 ul.contents li ul.code, ul.contents li ul.subcontents {
 144   padding-left: 2em;
 145 }
 146 table.list {
 147   border-collapse: collapse;
 148   width: 100%;
 149 }
 150 table.list tr:nth-child(even) {
 151   background: rgba(127,127,127,0.1);]n}
 152 table.list th {
 153   border-right: 2px solid gray;
 154   font-family: monospace;
 155   padding: 5px 10px 5px 2px;
 156   text-align: right;
 157   vertical-align: top;
 158 }
 159 table.list td {
 160   padding: 5px 2px 5px 10px;
 161   text-align: left;
 162   vertical-align: top;
 163 }
 164 h1.title {
 165 }
 166 h2.title {
 167   border-bottom: solid 2px black;
 168 }
 169 h3.title {
 170   border-bottom: solid 2px black;
 171 }
 172 --></style>
 173   </head>
 174   <body>
 175     <h1 class="title">CUPS Programming Manual</h1>
 176     <p>Michael R Sweet</p>
 177     <p>Copyright &#xa9; 2007-2018 by Apple Inc. All Rights Reserved.</p>
 178     <div class="contents">
 179       <h2 class="title">Contents</h2>
 180       <ul class="contents">
 181         <li><a href="#introduction">Introduction</a><ul class="subcontents">
 182           <li><a href="#guidelines">Guidelines</a></li>
 183           <li><a href="#terms-used-in-this-document">Terms Used in This Document</a></li>
 184           <li><a href="#compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></li>
 185         </ul></li>
 186         <li><a href="#working-with-destinations">Working with Destinations</a><ul class="subcontents">
 187           <li><a href="#finding-available-destinations">Finding Available Destinations</a></li>
 188           <li><a href="#basic-destination-information">Basic Destination Information</a></li>
 189           <li><a href="#detailed-destination-information">Detailed Destination Information</a></li>
 190           <li><a href="#submitting-a-print-job">Submitting a Print Job</a></li>
 191         </ul></li>
 192         <li><a href="#sending-ipp-requests">Sending IPP Requests</a><ul class="subcontents">
 193           <li><a href="#connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</a></li>
 194           <li><a href="#creating-an-ipp-request">Creating an IPP Request</a></li>
 195           <li><a href="#sending-the-ipp-request">Sending the IPP Request</a></li>
 196           <li><a href="#processing-the-ipp-response">Processing the IPP Response</a></li>
 197           <li><a href="#authentication">Authentication</a></li>
 198         </ul></li>
 199         <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents">
 200           <li><a href="#cupsAddDest">cupsAddDest</a></li>
 201           <li><a href="#cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></li>
 202           <li><a href="#cupsAddIntegerOption">cupsAddIntegerOption</a></li>
 203           <li><a href="#cupsAddOption">cupsAddOption</a></li>
 204           <li><a href="#cupsCancelDestJob">cupsCancelDestJob</a></li>
 205           <li><a href="#cupsCheckDestSupported">cupsCheckDestSupported</a></li>
 206           <li><a href="#cupsCloseDestJob">cupsCloseDestJob</a></li>
 207           <li><a href="#cupsConnectDest">cupsConnectDest</a></li>
 208           <li><a href="#cupsCopyDest">cupsCopyDest</a></li>
 209           <li><a href="#cupsCopyDestConflicts">cupsCopyDestConflicts</a></li>
 210           <li><a href="#cupsCopyDestInfo">cupsCopyDestInfo</a></li>
 211           <li><a href="#cupsCreateDestJob">cupsCreateDestJob</a></li>
 212           <li><a href="#cupsDoAuthentication">cupsDoAuthentication</a></li>
 213           <li><a href="#cupsEncodeOption">cupsEncodeOption</a></li>
 214           <li><a href="#cupsEncodeOptions">cupsEncodeOptions</a></li>
 215           <li><a href="#cupsEncodeOptions2">cupsEncodeOptions2</a></li>
 216           <li><a href="#cupsEncryption">cupsEncryption</a></li>
 217           <li><a href="#cupsEnumDests">cupsEnumDests</a></li>
 218           <li><a href="#cupsFindDestDefault">cupsFindDestDefault</a></li>
 219           <li><a href="#cupsFindDestReady">cupsFindDestReady</a></li>
 220           <li><a href="#cupsFindDestSupported">cupsFindDestSupported</a></li>
 221           <li><a href="#cupsFinishDestDocument">cupsFinishDestDocument</a></li>
 222           <li><a href="#cupsFreeDestInfo">cupsFreeDestInfo</a></li>
 223           <li><a href="#cupsFreeDests">cupsFreeDests</a></li>
 224           <li><a href="#cupsFreeJobs">cupsFreeJobs</a></li>
 225           <li><a href="#cupsFreeOptions">cupsFreeOptions</a></li>
 226           <li><a href="#cupsGetDest">cupsGetDest</a></li>
 227           <li><a href="#cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></li>
 228           <li><a href="#cupsGetDestMediaByName">cupsGetDestMediaByName</a></li>
 229           <li><a href="#cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></li>
 230           <li><a href="#cupsGetDestMediaCount">cupsGetDestMediaCount</a></li>
 231           <li><a href="#cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></li>
 232           <li><a href="#cupsGetDestWithURI">cupsGetDestWithURI</a></li>
 233           <li><a href="#cupsGetDests2">cupsGetDests2</a></li>
 234           <li><a href="#cupsGetIntegerOption">cupsGetIntegerOption</a></li>
 235           <li><a href="#cupsGetJobs2">cupsGetJobs2</a></li>
 236           <li><a href="#cupsGetNamedDest">cupsGetNamedDest</a></li>
 237           <li><a href="#cupsGetOption">cupsGetOption</a></li>
 238           <li><a href="#cupsGetPassword2">cupsGetPassword2</a></li>
 239           <li><a href="#cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></li>
 240           <li><a href="#cupsLocalizeDestOption">cupsLocalizeDestOption</a></li>
 241           <li><a href="#cupsLocalizeDestValue">cupsLocalizeDestValue</a></li>
 242           <li><a href="#cupsMakeServerCredentials">cupsMakeServerCredentials</a></li>
 243           <li><a href="#cupsParseOptions">cupsParseOptions</a></li>
 244           <li><a href="#cupsRemoveDest">cupsRemoveDest</a></li>
 245           <li><a href="#cupsRemoveOption">cupsRemoveOption</a></li>
 246           <li><a href="#cupsServer">cupsServer</a></li>
 247           <li><a href="#cupsSetClientCertCB">cupsSetClientCertCB</a></li>
 248           <li><a href="#cupsSetCredentials">cupsSetCredentials</a></li>
 249           <li><a href="#cupsSetDefaultDest">cupsSetDefaultDest</a></li>
 250           <li><a href="#cupsSetDests2">cupsSetDests2</a></li>
 251           <li><a href="#cupsSetEncryption">cupsSetEncryption</a></li>
 252           <li><a href="#cupsSetPasswordCB2">cupsSetPasswordCB2</a></li>
 253           <li><a href="#cupsSetServer">cupsSetServer</a></li>
 254           <li><a href="#cupsSetServerCertCB">cupsSetServerCertCB</a></li>
 255           <li><a href="#cupsSetServerCredentials">cupsSetServerCredentials</a></li>
 256           <li><a href="#cupsSetUser">cupsSetUser</a></li>
 257           <li><a href="#cupsSetUserAgent">cupsSetUserAgent</a></li>
 258           <li><a href="#cupsStartDestDocument">cupsStartDestDocument</a></li>
 259           <li><a href="#cupsUser">cupsUser</a></li>
 260           <li><a href="#cupsUserAgent">cupsUserAgent</a></li>
 261           <li><a href="#httpAcceptConnection">httpAcceptConnection</a></li>
 262           <li><a href="#httpAddCredential">httpAddCredential</a></li>
 263           <li><a href="#httpAddrAny">httpAddrAny</a></li>
 264           <li><a href="#httpAddrClose">httpAddrClose</a></li>
 265           <li><a href="#httpAddrConnect2">httpAddrConnect2</a></li>
 266           <li><a href="#httpAddrCopyList">httpAddrCopyList</a></li>
 267           <li><a href="#httpAddrEqual">httpAddrEqual</a></li>
 268           <li><a href="#httpAddrFamily">httpAddrFamily</a></li>
 269           <li><a href="#httpAddrFreeList">httpAddrFreeList</a></li>
 270           <li><a href="#httpAddrGetList">httpAddrGetList</a></li>
 271           <li><a href="#httpAddrLength">httpAddrLength</a></li>
 272           <li><a href="#httpAddrListen">httpAddrListen</a></li>
 273           <li><a href="#httpAddrLocalhost">httpAddrLocalhost</a></li>
 274           <li><a href="#httpAddrLookup">httpAddrLookup</a></li>
 275           <li><a href="#httpAddrPort">httpAddrPort</a></li>
 276           <li><a href="#httpAddrString">httpAddrString</a></li>
 277           <li><a href="#httpAssembleURI">httpAssembleURI</a></li>
 278           <li><a href="#httpAssembleURIf">httpAssembleURIf</a></li>
 279           <li><a href="#httpAssembleUUID">httpAssembleUUID</a></li>
 280           <li><a href="#httpBlocking">httpBlocking</a></li>
 281           <li><a href="#httpCheck">httpCheck</a></li>
 282           <li><a href="#httpClearCookie">httpClearCookie</a></li>
 283           <li><a href="#httpClearFields">httpClearFields</a></li>
 284           <li><a href="#httpClose">httpClose</a></li>
 285           <li><a href="#httpCompareCredentials">httpCompareCredentials</a></li>
 286           <li><a href="#httpConnect2">httpConnect2</a></li>
 287           <li><a href="#httpCopyCredentials">httpCopyCredentials</a></li>
 288           <li><a href="#httpCredentialsAreValidForName">httpCredentialsAreValidForName</a></li>
 289           <li><a href="#httpCredentialsGetExpiration">httpCredentialsGetExpiration</a></li>
 290           <li><a href="#httpCredentialsGetTrust">httpCredentialsGetTrust</a></li>
 291           <li><a href="#httpCredentialsString">httpCredentialsString</a></li>
 292           <li><a href="#httpDecode64_2">httpDecode64_2</a></li>
 293           <li><a href="#httpDelete">httpDelete</a></li>
 294           <li><a href="#httpEncode64_2">httpEncode64_2</a></li>
 295           <li><a href="#httpEncryption">httpEncryption</a></li>
 296           <li><a href="#httpError">httpError</a></li>
 297           <li><a href="#httpFieldValue">httpFieldValue</a></li>
 298           <li><a href="#httpFlush">httpFlush</a></li>
 299           <li><a href="#httpFlushWrite">httpFlushWrite</a></li>
 300           <li><a href="#httpFreeCredentials">httpFreeCredentials</a></li>
 301           <li><a href="#httpGet">httpGet</a></li>
 302           <li><a href="#httpGetActivity">httpGetActivity</a></li>
 303           <li><a href="#httpGetAddress">httpGetAddress</a></li>
 304           <li><a href="#httpGetAuthString">httpGetAuthString</a></li>
 305           <li><a href="#httpGetBlocking">httpGetBlocking</a></li>
 306           <li><a href="#httpGetContentEncoding">httpGetContentEncoding</a></li>
 307           <li><a href="#httpGetCookie">httpGetCookie</a></li>
 308           <li><a href="#httpGetDateString2">httpGetDateString2</a></li>
 309           <li><a href="#httpGetDateTime">httpGetDateTime</a></li>
 310           <li><a href="#httpGetEncryption">httpGetEncryption</a></li>
 311           <li><a href="#httpGetExpect">httpGetExpect</a></li>
 312           <li><a href="#httpGetFd">httpGetFd</a></li>
 313           <li><a href="#httpGetField">httpGetField</a></li>
 314           <li><a href="#httpGetHostname">httpGetHostname</a></li>
 315           <li><a href="#httpGetKeepAlive">httpGetKeepAlive</a></li>
 316           <li><a href="#httpGetLength2">httpGetLength2</a></li>
 317           <li><a href="#httpGetPending">httpGetPending</a></li>
 318           <li><a href="#httpGetReady">httpGetReady</a></li>
 319           <li><a href="#httpGetRemaining">httpGetRemaining</a></li>
 320           <li><a href="#httpGetState">httpGetState</a></li>
 321           <li><a href="#httpGetStatus">httpGetStatus</a></li>
 322           <li><a href="#httpGetSubField2">httpGetSubField2</a></li>
 323           <li><a href="#httpGetVersion">httpGetVersion</a></li>
 324           <li><a href="#httpGets">httpGets</a></li>
 325           <li><a href="#httpHead">httpHead</a></li>
 326           <li><a href="#httpInitialize">httpInitialize</a></li>
 327           <li><a href="#httpIsChunked">httpIsChunked</a></li>
 328           <li><a href="#httpIsEncrypted">httpIsEncrypted</a></li>
 329           <li><a href="#httpLoadCredentials">httpLoadCredentials</a></li>
 330           <li><a href="#httpOptions">httpOptions</a></li>
 331           <li><a href="#httpPeek">httpPeek</a></li>
 332           <li><a href="#httpPost">httpPost</a></li>
 333           <li><a href="#httpPut">httpPut</a></li>
 334           <li><a href="#httpRead2">httpRead2</a></li>
 335           <li><a href="#httpReadRequest">httpReadRequest</a></li>
 336           <li><a href="#httpReconnect2">httpReconnect2</a></li>
 337           <li><a href="#httpResolveHostname">httpResolveHostname</a></li>
 338           <li><a href="#httpSaveCredentials">httpSaveCredentials</a></li>
 339           <li><a href="#httpSeparateURI">httpSeparateURI</a></li>
 340           <li><a href="#httpSetAuthString">httpSetAuthString</a></li>
 341           <li><a href="#httpSetCookie">httpSetCookie</a></li>
 342           <li><a href="#httpSetCredentials">httpSetCredentials</a></li>
 343           <li><a href="#httpSetDefaultField">httpSetDefaultField</a></li>
 344           <li><a href="#httpSetExpect">httpSetExpect</a></li>
 345           <li><a href="#httpSetField">httpSetField</a></li>
 346           <li><a href="#httpSetKeepAlive">httpSetKeepAlive</a></li>
 347           <li><a href="#httpSetLength">httpSetLength</a></li>
 348           <li><a href="#httpSetTimeout">httpSetTimeout</a></li>
 349           <li><a href="#httpShutdown">httpShutdown</a></li>
 350           <li><a href="#httpStateString">httpStateString</a></li>
 351           <li><a href="#httpStatus">httpStatus</a></li>
 352           <li><a href="#httpURIStatusString">httpURIStatusString</a></li>
 353           <li><a href="#httpUpdate">httpUpdate</a></li>
 354           <li><a href="#httpWait">httpWait</a></li>
 355           <li><a href="#httpWrite2">httpWrite2</a></li>
 356           <li><a href="#httpWriteResponse">httpWriteResponse</a></li>
 357           <li><a href="#ippAddBoolean">ippAddBoolean</a></li>
 358           <li><a href="#ippAddBooleans">ippAddBooleans</a></li>
 359           <li><a href="#ippAddCollection">ippAddCollection</a></li>
 360           <li><a href="#ippAddCollections">ippAddCollections</a></li>
 361           <li><a href="#ippAddDate">ippAddDate</a></li>
 362           <li><a href="#ippAddInteger">ippAddInteger</a></li>
 363           <li><a href="#ippAddIntegers">ippAddIntegers</a></li>
 364           <li><a href="#ippAddOctetString">ippAddOctetString</a></li>
 365           <li><a href="#ippAddOutOfBand">ippAddOutOfBand</a></li>
 366           <li><a href="#ippAddRange">ippAddRange</a></li>
 367           <li><a href="#ippAddRanges">ippAddRanges</a></li>
 368           <li><a href="#ippAddResolution">ippAddResolution</a></li>
 369           <li><a href="#ippAddResolutions">ippAddResolutions</a></li>
 370           <li><a href="#ippAddSeparator">ippAddSeparator</a></li>
 371           <li><a href="#ippAddString">ippAddString</a></li>
 372           <li><a href="#ippAddStringf">ippAddStringf</a></li>
 373           <li><a href="#ippAddStringfv">ippAddStringfv</a></li>
 374           <li><a href="#ippAddStrings">ippAddStrings</a></li>
 375           <li><a href="#ippAttributeString">ippAttributeString</a></li>
 376           <li><a href="#ippContainsInteger">ippContainsInteger</a></li>
 377           <li><a href="#ippContainsString">ippContainsString</a></li>
 378           <li><a href="#ippCopyAttribute">ippCopyAttribute</a></li>
 379           <li><a href="#ippCopyAttributes">ippCopyAttributes</a></li>
 380           <li><a href="#ippCreateRequestedArray">ippCreateRequestedArray</a></li>
 381           <li><a href="#ippDateToTime">ippDateToTime</a></li>
 382           <li><a href="#ippDelete">ippDelete</a></li>
 383           <li><a href="#ippDeleteAttribute">ippDeleteAttribute</a></li>
 384           <li><a href="#ippDeleteValues">ippDeleteValues</a></li>
 385           <li><a href="#ippEnumString">ippEnumString</a></li>
 386           <li><a href="#ippEnumValue">ippEnumValue</a></li>
 387           <li><a href="#ippErrorString">ippErrorString</a></li>
 388           <li><a href="#ippErrorValue">ippErrorValue</a></li>
 389           <li><a href="#ippFindAttribute">ippFindAttribute</a></li>
 390           <li><a href="#ippFindNextAttribute">ippFindNextAttribute</a></li>
 391           <li><a href="#ippFirstAttribute">ippFirstAttribute</a></li>
 392           <li><a href="#ippGetBoolean">ippGetBoolean</a></li>
 393           <li><a href="#ippGetCollection">ippGetCollection</a></li>
 394           <li><a href="#ippGetCount">ippGetCount</a></li>
 395           <li><a href="#ippGetDate">ippGetDate</a></li>
 396           <li><a href="#ippGetGroupTag">ippGetGroupTag</a></li>
 397           <li><a href="#ippGetInteger">ippGetInteger</a></li>
 398           <li><a href="#ippGetName">ippGetName</a></li>
 399           <li><a href="#ippGetOctetString">ippGetOctetString</a></li>
 400           <li><a href="#ippGetOperation">ippGetOperation</a></li>
 401           <li><a href="#ippGetRange">ippGetRange</a></li>
 402           <li><a href="#ippGetRequestId">ippGetRequestId</a></li>
 403           <li><a href="#ippGetResolution">ippGetResolution</a></li>
 404           <li><a href="#ippGetState">ippGetState</a></li>
 405           <li><a href="#ippGetStatusCode">ippGetStatusCode</a></li>
 406           <li><a href="#ippGetString">ippGetString</a></li>
 407           <li><a href="#ippGetValueTag">ippGetValueTag</a></li>
 408           <li><a href="#ippGetVersion">ippGetVersion</a></li>
 409           <li><a href="#ippLength">ippLength</a></li>
 410           <li><a href="#ippNew">ippNew</a></li>
 411           <li><a href="#ippNewRequest">ippNewRequest</a></li>
 412           <li><a href="#ippNewResponse">ippNewResponse</a></li>
 413           <li><a href="#ippNextAttribute">ippNextAttribute</a></li>
 414           <li><a href="#ippOpString">ippOpString</a></li>
 415           <li><a href="#ippOpValue">ippOpValue</a></li>
 416           <li><a href="#ippPort">ippPort</a></li>
 417           <li><a href="#ippRead">ippRead</a></li>
 418           <li><a href="#ippReadFile">ippReadFile</a></li>
 419           <li><a href="#ippReadIO">ippReadIO</a></li>
 420           <li><a href="#ippSetBoolean">ippSetBoolean</a></li>
 421           <li><a href="#ippSetCollection">ippSetCollection</a></li>
 422           <li><a href="#ippSetDate">ippSetDate</a></li>
 423           <li><a href="#ippSetGroupTag">ippSetGroupTag</a></li>
 424           <li><a href="#ippSetInteger">ippSetInteger</a></li>
 425           <li><a href="#ippSetName">ippSetName</a></li>
 426           <li><a href="#ippSetOctetString">ippSetOctetString</a></li>
 427           <li><a href="#ippSetOperation">ippSetOperation</a></li>
 428           <li><a href="#ippSetPort">ippSetPort</a></li>
 429           <li><a href="#ippSetRange">ippSetRange</a></li>
 430           <li><a href="#ippSetRequestId">ippSetRequestId</a></li>
 431           <li><a href="#ippSetResolution">ippSetResolution</a></li>
 432           <li><a href="#ippSetState">ippSetState</a></li>
 433           <li><a href="#ippSetStatusCode">ippSetStatusCode</a></li>
 434           <li><a href="#ippSetString">ippSetString</a></li>
 435           <li><a href="#ippSetStringf">ippSetStringf</a></li>
 436           <li><a href="#ippSetStringfv">ippSetStringfv</a></li>
 437           <li><a href="#ippSetValueTag">ippSetValueTag</a></li>
 438           <li><a href="#ippSetVersion">ippSetVersion</a></li>
 439           <li><a href="#ippStateString">ippStateString</a></li>
 440           <li><a href="#ippTagString">ippTagString</a></li>
 441           <li><a href="#ippTagValue">ippTagValue</a></li>
 442           <li><a href="#ippTimeToDate">ippTimeToDate</a></li>
 443           <li><a href="#ippValidateAttribute">ippValidateAttribute</a></li>
 444           <li><a href="#ippValidateAttributes">ippValidateAttributes</a></li>
 445           <li><a href="#ippWrite">ippWrite</a></li>
 446           <li><a href="#ippWriteFile">ippWriteFile</a></li>
 447           <li><a href="#ippWriteIO">ippWriteIO</a></li>
 448         </ul></li>
 449         <li><a href="#TYPES">Data Types</a><ul class="subcontents">
 450           <li><a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a></li>
 451           <li><a href="#cups_dest_cb_t">cups_dest_cb_t</a></li>
 452           <li><a href="#cups_dest_t">cups_dest_t</a></li>
 453           <li><a href="#cups_dinfo_t">cups_dinfo_t</a></li>
 454           <li><a href="#cups_job_t">cups_job_t</a></li>
 455           <li><a href="#cups_option_t">cups_option_t</a></li>
 456           <li><a href="#cups_password_cb2_t">cups_password_cb2_t</a></li>
 457           <li><a href="#cups_ptype_t">cups_ptype_t</a></li>
 458           <li><a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a></li>
 459           <li><a href="#cups_size_t">cups_size_t</a></li>
 460           <li><a href="#http_addr_t">http_addr_t</a></li>
 461           <li><a href="#http_encoding_t">http_encoding_t</a></li>
 462           <li><a href="#http_encryption_t">http_encryption_t</a></li>
 463           <li><a href="#http_field_t">http_field_t</a></li>
 464           <li><a href="#http_keepalive_t">http_keepalive_t</a></li>
 465           <li><a href="#http_state_t">http_state_t</a></li>
 466           <li><a href="#http_t">http_t</a></li>
 467           <li><a href="#http_timeout_cb_t">http_timeout_cb_t</a></li>
 468           <li><a href="#http_trust_t">http_trust_t</a></li>
 469           <li><a href="#http_uri_coding_t">http_uri_coding_t</a></li>
 470           <li><a href="#http_uri_status_t">http_uri_status_t</a></li>
 471           <li><a href="#ipp_attribute_t">ipp_attribute_t</a></li>
 472           <li><a href="#ipp_copycb_t">ipp_copycb_t</a></li>
 473           <li><a href="#ipp_iocb_t">ipp_iocb_t</a></li>
 474           <li><a href="#ipp_orient_t">ipp_orient_t</a></li>
 475           <li><a href="#ipp_pstate_t">ipp_pstate_t</a></li>
 476           <li><a href="#ipp_quality_t">ipp_quality_t</a></li>
 477           <li><a href="#ipp_res_t">ipp_res_t</a></li>
 478           <li><a href="#ipp_rstate_t">ipp_rstate_t</a></li>
 479           <li><a href="#ipp_sstate_t">ipp_sstate_t</a></li>
 480           <li><a href="#ipp_state_t">ipp_state_t</a></li>
 481           <li><a href="#ipp_t">ipp_t</a></li>
 482         </ul></li>
 483         <li><a href="#STRUCTURES">Structures</a><ul class="subcontents">
 484           <li><a href="#cups_dest_s">cups_dest_s</a></li>
 485           <li><a href="#cups_job_s">cups_job_s</a></li>
 486           <li><a href="#cups_option_s">cups_option_s</a></li>
 487           <li><a href="#cups_size_s">cups_size_s</a></li>
 488         </ul></li>
 489         <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents">
 490           <li><a href="#cups_ptype_e">cups_ptype_e</a></li>
 491           <li><a href="#http_encoding_e">http_encoding_e</a></li>
 492           <li><a href="#http_encryption_e">http_encryption_e</a></li>
 493           <li><a href="#http_field_e">http_field_e</a></li>
 494           <li><a href="#http_keepalive_e">http_keepalive_e</a></li>
 495           <li><a href="#http_state_e">http_state_e</a></li>
 496           <li><a href="#http_status_e">http_status_e</a></li>
 497           <li><a href="#http_trust_e">http_trust_e</a></li>
 498           <li><a href="#http_uri_coding_e">http_uri_coding_e</a></li>
 499           <li><a href="#http_uri_status_e">http_uri_status_e</a></li>
 500           <li><a href="#ipp_finishings_e">ipp_finishings_e</a></li>
 501           <li><a href="#ipp_jstate_e">ipp_jstate_e</a></li>
 502           <li><a href="#ipp_op_e">ipp_op_e</a></li>
 503           <li><a href="#ipp_orient_e">ipp_orient_e</a></li>
 504           <li><a href="#ipp_pstate_e">ipp_pstate_e</a></li>
 505           <li><a href="#ipp_quality_e">ipp_quality_e</a></li>
 506           <li><a href="#ipp_res_e">ipp_res_e</a></li>
 507           <li><a href="#ipp_rstate_e">ipp_rstate_e</a></li>
 508           <li><a href="#ipp_sstate_e">ipp_sstate_e</a></li>
 509           <li><a href="#ipp_state_e">ipp_state_e</a></li>
 510           <li><a href="#ipp_status_e">ipp_status_e</a></li>
 511           <li><a href="#ipp_tag_e">ipp_tag_e</a></li>
 512         </ul></li>
 513       </ul>
 514     </div>
 515     <div class="body">
 516     <blockquote>
 517     <p>Please <a href="https://github.com/apple/cups/issues">file issues on Github</a> to provide feedback on this document.</p>
 518 </blockquote>
 519     <h2><a id="introduction">Introduction</a></h2>
 520     <p>CUPS provides the &quot;cups&quot; library to talk to the different parts of CUPS and with Internet Printing Protocol (IPP) printers. The &quot;cups&quot; library functions are accessed by including the <code>&lt;cups/cups.h&gt;</code> header.</p>
 521     <p>CUPS is based on the Internet Printing Protocol (&quot;IPP&quot;), 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>
 522     <h3><a id="guidelines">Guidelines</a></h3>
 523     <p>When writing software that uses the &quot;cups&quot; library:</p>
 524     <ul>
 525     <li>Do not use undocumented or deprecated APIs,</li>
 526     <li>Do not rely on pre-configured printers,</li>
 527     <li>Do not assume that printers support specific features or formats, and</li>
 528     <li>Do not rely on implementation details (PPDs, etc.)</li>
 529 </ul>
 530     <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 (&quot;print four copies, two-sided on A4 media, and staple each copy&quot;) and have the printing system manage the printer communication and format conversion needed.</p>
 531     <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>
 532     <h3><a id="terms-used-in-this-document">Terms Used in This Document</a></h3>
 533     <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>
 534     <h3><a id="compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></h3>
 535     <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>
 536     <p>The following simple program lists the available destinations:</p>
 537     <pre><code>#include &lt;stdio.h&gt;
 538 #include &lt;cups/cups.h&gt;
 539
 540 int print_dest(void *user_data, unsigned flags, cups_dest_t *dest)
 541 {
 542   if (dest-&gt;instance)
 543     printf(&quot;%s/%s\n&quot;, dest-&gt;name, dest-&gt;instance);
 544   else
 545     puts(dest-&gt;name);
 546
 547   return (1);
 548 }
 549
 550 int main(void)
 551 {
 552   cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, 0, 0, print_dest, NULL);
 553
 554   return (0);
 555 }
 556 </code></pre>
 557     <h4><a id="compiling-with-xcode">Compiling with Xcode</a></h4>
 558     <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 &quot;firstcups&quot;. Click <em>Next</em> and choose a project directory. The click <em>Next</em> to create the project.</p>
 559     <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 &quot;libcups&quot; to show the library, and then double-click on <code>libcups.tbd</code>.</p>
 560     <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>
 561     <h4><a id="compiling-with-gcc">Compiling with GCC</a></h4>
 562     <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>
 563     <pre><code>gcc -o simple `cups-config --cflags` simple.c `cups-config --libs`
 564 ./simple
 565 </code></pre>
 566     <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>
 567     <h2><a id="working-with-destinations">Working with Destinations</a></h2>
 568     <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>
 569     <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>
 570     <h3><a id="finding-available-destinations">Finding Available Destinations</a></h3>
 571     <p>The <code>cupsEnumDests</code> function finds all of the available destinations:</p>
 572     <pre><code> int
 573  cupsEnumDests(unsigned flags, int msec, int *cancel,
 574                cups_ptype_t type, cups_ptype_t mask,
 575                cups_dest_cb_t cb, void *user_data)
 576 </code></pre>
 577     <p>The <code>flags</code> argument specifies enumeration options, which at present must be <code>CUPS_DEST_FLAGS_NONE</code>.</p>
 578     <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>
 579     <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>
 580     <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 &quot;printer-type&quot; 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>
 581     <ul>
 582     <li><code>CUPS_PRINTER_CLASS</code>: A collection of destinations.</li>
 583     <li><code>CUPS_PRINTER_FAX</code>: A facsimile device.</li>
 584     <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>
 585     <li><code>CUPS_PRINTER_REMOTE</code>: A remote (shared) printer or class.</li>
 586     <li><code>CUPS_PRINTER_DISCOVERED</code>: An available network printer or class.</li>
 587     <li><code>CUPS_PRINTER_BW</code>: Can do B&amp;W printing.</li>
 588     <li><code>CUPS_PRINTER_COLOR</code>: Can do color printing.</li>
 589     <li><code>CUPS_PRINTER_DUPLEX</code>: Can do two-sided printing.</li>
 590     <li><code>CUPS_PRINTER_STAPLE</code>: Can staple output.</li>
 591     <li><code>CUPS_PRINTER_COLLATE</code>: Can quickly collate copies.</li>
 592     <li><code>CUPS_PRINTER_PUNCH</code>: Can punch output.</li>
 593     <li><code>CUPS_PRINTER_COVER</code>: Can cover output.</li>
 594     <li><code>CUPS_PRINTER_BIND</code>: Can bind output.</li>
 595     <li><code>CUPS_PRINTER_SORT</code>: Can sort output (mailboxes, etc.)</li>
 596     <li><code>CUPS_PRINTER_SMALL</code>: Can print on Letter/Legal/A4-size media.</li>
 597     <li><code>CUPS_PRINTER_MEDIUM</code>: Can print on Tabloid/B/C/A3/A2-size media.</li>
 598     <li><code>CUPS_PRINTER_LARGE</code>: Can print on D/E/A1/A0-size media.</li>
 599     <li><code>CUPS_PRINTER_VARIABLE</code>: Can print on rolls and custom-size media.</li>
 600 </ul>
 601     <p>The <code>cb</code> argument specifies a function to call for every destination that is found:</p>
 602     <pre><code>typedef int (*cups_dest_cb_t)(void *user_data,
 603                               unsigned flags,
 604                               cups_dest_t *dest);
 605 </code></pre>
 606     <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>
 607     <ul>
 608     <li><code>CUPS_DEST_FLAGS_MORE</code>: There are more destinations coming.</li>
 609     <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>
 610     <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>
 611 </ul>
 612     <p>The callback function returns 0 to stop enumeration or 1 to continue.</p>
 613     <blockquote>
 614     <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>
 615 </blockquote>
 616     <p>The following example shows how to use <code>cupsEnumDests</code> to get a filtered array of destinations:</p>
 617     <pre><code>typedef struct
 618 {
 619   int num_dests;
 620   cups_dest_t *dests;
 621 } my_user_data_t;
 622
 623 int
 624 my_dest_cb(my_user_data_t *user_data, unsigned flags,
 625            cups_dest_t *dest)
 626 {
 627   if (flags &amp; CUPS_DEST_FLAGS_REMOVED)
 628   {
 629    /*
 630     * Remove destination from array...
 631     */
 632
 633     user_data-&gt;num_dests =
 634         cupsRemoveDest(dest-&gt;name, dest-&gt;instance,
 635                        user_data-&gt;num_dests,
 636                        &amp;(user_data-&gt;dests));
 637   }
 638   else
 639   {
 640    /*
 641     * Add destination to array...
 642     */
 643
 644     user_data-&gt;num_dests =
 645         cupsCopyDest(dest, user_data-&gt;num_dests,
 646                      &amp;(user_data-&gt;dests));
 647   }
 648
 649   return (1);
 650 }
 651
 652 int
 653 my_get_dests(cups_ptype_t type, cups_ptype_t mask,
 654              cups_dest_t **dests)
 655 {
 656   my_user_data_t user_data = { 0, NULL };
 657
 658   if (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, type,
 659                      mask, (cups_dest_cb_t)my_dest_cb,
 660                      &amp;user_data))
 661   {
 662    /*
 663     * An error occurred, free all of the destinations and
 664     * return...
 665     */
 666
 667     cupsFreeDests(user_data.num_dests, user_dasta.dests);
 668
 669     *dests = NULL;
 670
 671     return (0);
 672   }
 673
 674  /*
 675   * Return the destination array...
 676   */
 677
 678   *dests = user_data.dests;
 679
 680   return (user_data.num_dests);
 681 }
 682 </code></pre>
 683     <h3><a id="basic-destination-information">Basic Destination Information</a></h3>
 684     <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>
 685     <ul>
 686     <li>&quot;auth-info-required&quot;: The type of authentication required for printing to this destination: &quot;none&quot;, &quot;username,password&quot;, &quot;domain,username,password&quot;, or &quot;negotiate&quot; (Kerberos).</li>
 687     <li>&quot;printer-info&quot;: The human-readable description of the destination such as &quot;My Laser Printer&quot;.</li>
 688     <li>&quot;printer-is-accepting-jobs&quot;: &quot;true&quot; if the destination is accepting new jobs, &quot;false&quot; otherwise.</li>
 689     <li>&quot;printer-is-shared&quot;: &quot;true&quot; if the destination is being shared with other computers, &quot;false&quot; otherwise.</li>
 690     <li>&quot;printer-location&quot;: The human-readable location of the destination such as &quot;Lab 4&quot;.</li>
 691     <li>&quot;printer-make-and-model&quot;: The human-readable make and model of the destination such as &quot;ExampleCorp LaserPrinter 4000 Series&quot;.</li>
 692     <li>&quot;printer-state&quot;: &quot;3&quot; if the destination is idle, &quot;4&quot; if the destination is printing a job, and &quot;5&quot; if the destination is stopped.</li>
 693     <li>&quot;printer-state-change-time&quot;: The UNIX time when the destination entered the current state.</li>
 694     <li>&quot;printer-state-reasons&quot;: Additional comma-delimited state keywords for the destination such as &quot;media-tray-empty-error&quot; and &quot;toner-low-warning&quot;.</li>
 695     <li>&quot;printer-type&quot;: The <code>cups_ptype_t</code> value associated with the destination.</li>
 696     <li>&quot;printer-uri-supported&quot;: The URI associated with the destination; if not set, this destination was discovered but is not yet setup as a local printer.</li>
 697 </ul>
 698     <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>
 699     <pre><code>const char *model = cupsGetOption(&quot;printer-make-and-model&quot;,
 700                                   dest-&gt;num_options,
 701                                   dest-&gt;options);
 702 </code></pre>
 703     <h3><a id="detailed-destination-information">Detailed Destination Information</a></h3>
 704     <p>Once a destination has been chosen, the <code>cupsCopyDestInfo</code> function can be used to gather detailed information about the destination:</p>
 705     <pre><code>cups_dinfo_t *
 706 cupsCopyDestInfo(http_t *http, cups_dest_t *dest);
 707 </code></pre>
 708     <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>
 709     <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>
 710     <h4><a id="getting-supported-options-and-values">Getting Supported Options and Values</a></h4>
 711     <p>The <code>cupsCheckDestSupported</code> function can be used to test whether a particular option or option and value is supported:</p>
 712     <pre><code>int
 713 cupsCheckDestSupported(http_t *http, cups_dest_t *dest,
 714                        cups_dinfo_t *info,
 715                        const char *option,
 716                        const char *value);
 717 </code></pre>
 718     <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>
 719     <ul>
 720     <li><code>CUPS_COPIES</code>: Controls the number of copies that are produced.</li>
 721     <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>
 722     <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>
 723     <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>
 724     <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>
 725     <li><code>CUPS_NUMBER_UP</code>: Controls the number of document pages that are placed on each media side.</li>
 726     <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>
 727     <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>
 728     <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>
 729     <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>
 730 </ul>
 731     <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>
 732     <p>The <code>cupsFindDestSupported</code> function returns the IPP attribute containing the supported values for a given option:</p>
 733     <pre><code> ipp_attribute_t *
 734  cupsFindDestSupported(http_t *http, cups_dest_t *dest,
 735                        cups_dinfo_t *dinfo,
 736                        const char *option);
 737 </code></pre>
 738     <p>For example, the following code prints the supported finishing processes for a destination, if any, to the standard output:</p>
 739     <pre><code>cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT,
 740                                       dest);
 741
 742 if (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info,
 743                            CUPS_FINISHINGS, NULL))
 744 {
 745   ipp_attribute_t *finishings =
 746       cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info,
 747                             CUPS_FINISHINGS);
 748   int i, count = ippGetCount(finishings);
 749
 750   puts(&quot;finishings supported:&quot;);
 751   for (i = 0; i &lt; count; i ++)
 752     printf(&quot;  %d\n&quot;, ippGetInteger(finishings, i));
 753 }
 754 else
 755   puts(&quot;finishings not supported.&quot;);
 756 </code></pre>
 757     <p>The &quot;job-creation-attributes&quot; 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>
 758     <pre><code>ipp_attribute_t *attrs =
 759     cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info,
 760                           &quot;job-creation-attributes&quot;);
 761 int i, count = ippGetCount(attrs);
 762
 763 for (i = 0; i &lt; count; i ++)
 764   puts(ippGetString(attrs, i, NULL));
 765 </code></pre>
 766     <h4><a id="getting-default-values">Getting Default Values</a></h4>
 767     <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>
 768     <pre><code>ipp_attribute_t *
 769 cupsFindDestDefault(http_t *http, cups_dest_t *dest,
 770                     cups_dinfo_t *dinfo,
 771                     const char *option);
 772 </code></pre>
 773     <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>
 774     <pre><code>const char *def_value =
 775     cupsGetOption(CUPS_FINISHINGS, dest-&gt;num_options,
 776                   dest-&gt;options);
 777 ipp_attribute_t *def_attr =
 778     cupsFindDestDefault(CUPS_HTTP_DEFAULT, dest, info,
 779                         CUPS_FINISHINGS);
 780
 781 if (def_value != NULL)
 782 {
 783   printf(&quot;Default finishings: %s\n&quot;, def_value);
 784 }
 785 else
 786 {
 787   int i, count = ippGetCount(def_attr);
 788
 789   printf(&quot;Default finishings: %d&quot;,
 790          ippGetInteger(def_attr, 0));
 791   for (i = 1; i &lt; count; i ++)
 792     printf(&quot;,%d&quot;, ippGetInteger(def_attr, i));
 793   putchar('\n');
 794 }
 795 </code></pre>
 796     <h4><a id="getting-ready-loaded-values">Getting Ready (Loaded) Values</a></h4>
 797     <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>
 798     <p>The <code>cupsFindDestReady</code> function finds the IPP attribute containing the ready values for a given option:</p>
 799     <pre><code>ipp_attribute_t *
 800 cupsFindDestReady(http_t *http, cups_dest_t *dest,
 801                   cups_dinfo_t *dinfo, const char *option);
 802 </code></pre>
 803     <p>For example, the following code lists the ready finishing processes:</p>
 804     <pre><code>ipp_attribute_t *ready_finishings =
 805     cupsFindDestReady(CUPS_HTTP_DEFAULT, dest, info,
 806                       CUPS_FINISHINGS);
 807
 808 if (ready_finishings != NULL)
 809 {
 810   int i, count = ippGetCount(ready_finishings);
 811
 812   puts(&quot;finishings ready:&quot;);
 813   for (i = 0; i &lt; count; i ++)
 814     printf(&quot;  %d\n&quot;, ippGetInteger(ready_finishings, i));
 815 }
 816 else
 817   puts(&quot;no finishings are ready.&quot;);
 818 </code></pre>
 819     <h4><a id="media-size-options">Media Size Options</a></h4>
 820     <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>
 821     <pre><code>typedef struct cups_size_s
 822 {
 823   char media[128];
 824   int width, length;
 825   int bottom, left, right, top;
 826 } cups_size_t;
 827 </code></pre>
 828     <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>
 829     <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>
 830     <pre><code>int
 831 cupsGetDestMediaByName(http_t *http, cups_dest_t *dest,
 832                        cups_dinfo_t *dinfo,
 833                        const char *media,
 834                        unsigned flags, cups_size_t *size);
 835
 836 int
 837 cupsGetDestMediaBySize(http_t *http, cups_dest_t *dest,
 838                        cups_dinfo_t *dinfo,
 839                        int width, int length,
 840                        unsigned flags, cups_size_t *size);
 841 </code></pre>
 842     <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>
 843     <ul>
 844     <li><code>CUPS_MEDIA_FLAGS_DEFAULT</code>: Find the closest size supported by the printer.</li>
 845     <li><code>CUPS_MEDIA_FLAGS_BORDERLESS</code>: Find a borderless size.</li>
 846     <li><code>CUPS_MEDIA_FLAGS_DUPLEX</code>: Find a size compatible with two-sided printing.</li>
 847     <li><code>CUPS_MEDIA_FLAGS_EXACT</code>: Find an exact match for the size.</li>
 848     <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 &quot;ready&quot; media.</li>
 849 </ul>
 850     <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>
 851     <p>For example, the following code prints the margins for two-sided printing on US Letter media:</p>
 852     <pre><code>cups_size_t size;
 853
 854 if (cupsGetDestMediaByName(CUPS_HTTP_DEFAULT, dest, info,
 855                            CUPS_MEDIA_LETTER,
 856                            CUPS_MEDIA_FLAGS_DUPLEX, &amp;size))
 857 {
 858   puts(&quot;Margins for duplex US Letter:&quot;);
 859   printf(&quot;  Bottom: %.2fin\n&quot;, size.bottom / 2540.0);
 860   printf(&quot;    Left: %.2fin\n&quot;, size.left / 2540.0);
 861   printf(&quot;   Right: %.2fin\n&quot;, size.right / 2540.0);
 862   printf(&quot;     Top: %.2fin\n&quot;, size.top / 2540.0);
 863 }
 864 else
 865   puts(&quot;Margins for duplex US Letter are not available.&quot;);
 866 </code></pre>
 867     <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>
 868     <pre><code>int
 869 cupsGetDestMediaByIndex(http_t *http, cups_dest_t *dest,
 870                         cups_dinfo_t *dinfo, int n,
 871                         unsigned flags, cups_size_t *size);
 872
 873 int
 874 cupsGetDestMediaCount(http_t *http, cups_dest_t *dest,
 875                       cups_dinfo_t *dinfo, unsigned flags);
 876 </code></pre>
 877     <p>For example, the following code prints the list of ready media and corresponding margins:</p>
 878     <pre><code>cups_size_t size;
 879 int i;
 880 int count = cupsGetDestMediaCount(CUPS_HTTP_DEFAULT,
 881                                   dest, info,
 882                                   CUPS_MEDIA_FLAGS_READY);
 883
 884 for (i = 0; i &lt; count; i ++)
 885 {
 886   if (cupsGetDestMediaByIndex(CUPS_HTTP_DEFAULT, dest, info,
 887                               i, CUPS_MEDIA_FLAGS_READY,
 888                               &amp;size))
 889   {
 890     printf(&quot;%s:\n&quot;, size.name);
 891     printf(&quot;   Width: %.2fin\n&quot;, size.width / 2540.0);
 892     printf(&quot;  Length: %.2fin\n&quot;, size.length / 2540.0);
 893     printf(&quot;  Bottom: %.2fin\n&quot;, size.bottom / 2540.0);
 894     printf(&quot;    Left: %.2fin\n&quot;, size.left / 2540.0);
 895     printf(&quot;   Right: %.2fin\n&quot;, size.right / 2540.0);
 896     printf(&quot;     Top: %.2fin\n&quot;, size.top / 2540.0);
 897   }
 898 }
 899 </code></pre>
 900     <p>Finally, the <code>cupsGetDestMediaDefault</code> function returns the default media size:</p>
 901     <pre><code>int
 902 cupsGetDestMediaDefault(http_t *http, cups_dest_t *dest,
 903                         cups_dinfo_t *dinfo, unsigned flags,
 904                         cups_size_t *size);
 905 </code></pre>
 906     <h4><a id="localizing-options-and-values">Localizing Options and Values</a></h4>
 907     <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>
 908     <pre><code>const char *
 909 cupsLocalizeDestMedia(http_t *http, cups_dest_t *dest,
 910                       cups_dinfo_t *info, unsigned flags,
 911                       cups_size_t *size);
 912
 913 const char *
 914 cupsLocalizeDestOption(http_t *http, cups_dest_t *dest,
 915                        cups_dinfo_t *info,
 916                        const char *option);
 917
 918 const char *
 919 cupsLocalizeDestValue(http_t *http, cups_dest_t *dest,
 920                       cups_dinfo_t *info,
 921                       const char *option, const char *value);
 922 </code></pre>
 923     <h3><a id="submitting-a-print-job">Submitting a Print Job</a></h3>
 924     <p>Once you are ready to submit a print job, you create a job using the <code>cupsCreateDestJob</code> function:</p>
 925     <pre><code>ipp_status_t
 926 cupsCreateDestJob(http_t *http, cups_dest_t *dest,
 927                   cups_dinfo_t *info, int *job_id,
 928                   const char *title, int num_options,
 929                   cups_option_t *options);
 930 </code></pre>
 931     <p>The <code>title</code> argument specifies a name for the print job such as &quot;My Document&quot;. 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>
 932     <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>
 933     <p>For example, the following code creates a new job that will print 42 copies of a two-sided US Letter document:</p>
 934     <pre><code>int job_id = 0;
 935 int num_options = 0;
 936 cups_option_t *options = NULL;
 937
 938 num_options = cupsAddOption(CUPS_COPIES, &quot;42&quot;,
 939                             num_options, &amp;options);
 940 num_options = cupsAddOption(CUPS_MEDIA, CUPS_MEDIA_LETTER,
 941                             num_options, &amp;options);
 942 num_options = cupsAddOption(CUPS_SIDES,
 943                             CUPS_SIDES_TWO_SIDED_PORTRAIT,
 944                             num_options, &amp;options);
 945
 946 if (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info,
 947                       &amp;job_id, &quot;My Document&quot;, num_options,
 948                       options) == IPP_STATUS_OK)
 949   printf(&quot;Created job: %d\n&quot;, job_id);
 950 else
 951   printf(&quot;Unable to create job: %s\n&quot;,
 952          cupsLastErrorString());
 953 </code></pre>
 954     <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>
 955     <pre><code>http_status_t
 956 cupsStartDestDocument(http_t *http, cups_dest_t *dest,
 957                       cups_dinfo_t *info, int job_id,
 958                       const char *docname,
 959                       const char *format,
 960                       int num_options,
 961                       cups_option_t *options,
 962                       int last_document);
 963
 964 http_status_t
 965 cupsWriteRequestData(http_t *http, const char *buffer,
 966                      size_t length);
 967
 968 ipp_status_t
 969 cupsFinishDestDocument(http_t *http, cups_dest_t *dest,
 970                        cups_dinfo_t *info);
 971 </code></pre>
 972     <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>
 973     <ul>
 974     <li><code>CUPS_FORMAT_JPEG</code>: &quot;image/jpeg&quot;</li>
 975     <li><code>CUPS_FORMAT_PDF</code>: &quot;application/pdf&quot;</li>
 976     <li><code>CUPS_FORMAT_POSTSCRIPT</code>: &quot;application/postscript&quot;</li>
 977     <li><code>CUPS_FORMAT_TEXT</code>: &quot;text/plain&quot;</li>
 978 </ul>
 979     <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>
 980     <p>For example, the following code submits a PDF file to the job that was just created:</p>
 981     <pre><code>FILE *fp = fopen(&quot;filename.pdf&quot;, &quot;rb&quot;);
 982 size_t bytes;
 983 char buffer[65536];
 984
 985 if (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info,
 986                           job_id, &quot;filename.pdf&quot;, 0, NULL,
 987                           1) == HTTP_STATUS_CONTINUE)
 988 {
 989   while ((bytes = fread(buffer, 1, sizeof(buffer), fp)) &gt; 0)
 990     if (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer,
 991                              bytes) != HTTP_STATUS_CONTINUE)
 992       break;
 993
 994   if (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest,
 995                              info) == IPP_STATUS_OK)
 996     puts(&quot;Document send succeeded.&quot;);
 997   else
 998     printf(&quot;Document send failed: %s\n&quot;,
 999            cupsLastErrorString());
1000 }
1001
1002 fclose(fp);
1003 </code></pre>
1004     <h2><a id="sending-ipp-requests">Sending IPP Requests</a></h2>
1005     <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>
1006     <h3><a id="connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</a></h3>
1007     <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>
1008     <pre><code>http_t *
1009 cupsConnectDest(cups_dest_t *dest, unsigned flags, int msec,
1010                 int *cancel, char *resource,
1011                 size_t resourcesize, cups_dest_cb_t cb,
1012                 void *user_data);
1013 </code></pre>
1014     <p>The <code>dest</code> argument specifies the destination to connect to.</p>
1015     <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>
1016     <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>
1017     <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>
1018     <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>
1019     <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>
1020     <p>On success, a HTTP connection is returned that can be used to send IPP requests and get IPP responses.</p>
1021     <p>For example, the following code connects to the printer associated with a destination with a 30 second timeout:</p>
1022     <pre><code>char resource[256];
1023 http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_DEVICE,
1024                                30000, NULL, resource,
1025                                sizeof(resource), NULL, NULL);
1026 </code></pre>
1027     <h3><a id="creating-an-ipp-request">Creating an IPP Request</a></h3>
1028     <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>
1029     <p>The <code>ippNewRequest</code> function creates a new IPP request:</p>
1030     <pre><code>ipp_t *
1031 ippNewRequest(ipp_op_t op);
1032 </code></pre>
1033     <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>
1034     <pre><code>ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES);
1035 </code></pre>
1036     <p>The request identifier is automatically set to a unique value for the current process.</p>
1037     <p>Each IPP request starts with two IPP attributes, &quot;attributes-charset&quot; and &quot;attributes-natural-language&quot;, followed by IPP attribute(s) that specify the target of the operation. The <code>ippNewRequest</code> automatically adds the correct &quot;attributes-charset&quot; and &quot;attributes-natural-language&quot; attributes, but you must add the target attribute(s). For example, the following code adds the &quot;printer-uri&quot; attribute to the IPP Get-Printer-Attributes request to specify which printer is being queried:</p>
1038     <pre><code>const char *printer_uri = cupsGetOption(&quot;device-uri&quot;,
1039                                         dest-&gt;num_options,
1040                                         dest-&gt;options);
1041
1042 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI,
1043              &quot;printer-uri&quot;, NULL, printer_uri);
1044 </code></pre>
1045     <blockquote>
1046     <p>Note: If we wanted to query the scheduler instead of the device, we would look up the &quot;printer-uri-supported&quot; option instead of the &quot;device-uri&quot; value.</p>
1047 </blockquote>
1048     <p>The <code>ippAddString</code> function adds the &quot;printer-uri&quot; 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>
1049     <p>The IPP Get-Printer-Attributes request also supports an IPP attribute called &quot;requested-attributes&quot; that lists the attributes and values you are interested in. For example, the following code requests the printer state attributes:</p>
1050     <pre><code>static const char * const requested_attributes[] =
1051 {
1052   &quot;printer-state&quot;,
1053   &quot;printer-state-message&quot;,
1054   &quot;printer-state-reasons&quot;
1055 };
1056
1057 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1058               &quot;requested-attributes&quot;, 3, NULL,
1059               requested_attributes);
1060 </code></pre>
1061     <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>
1062     <p>CUPS provides many functions to adding attributes of different types:</p>
1063     <ul>
1064     <li><code>ippAddBoolean</code> adds a boolean (<code>IPP_TAG_BOOLEAN</code>) attribute with one value.</li>
1065     <li><code>ippAddInteger</code> adds an enum (<code>IPP_TAG_ENUM</code>) or integer (<code>IPP_TAG_INTEGER</code>) attribute with one value.</li>
1066     <li><code>ippAddIntegers</code> adds an enum or integer attribute with one or more values.</li>
1067     <li><code>ippAddOctetString</code> adds an octetString attribute with one value.</li>
1068     <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>
1069     <li><code>ippAddRange</code> adds a rangeOfInteger attribute with one range.</li>
1070     <li><code>ippAddRanges</code> adds a rangeOfInteger attribute with one or more ranges.</li>
1071     <li><code>ippAddResolution</code> adds a resolution attribute with one resolution.</li>
1072     <li><code>ippAddResolutions</code> adds a resolution attribute with one or more resolutions.</li>
1073     <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>
1074     <li><code>ippAddStrings</code> adds a charset, keyword, mimeMediaType, name, naturalLanguage, text, uri, or uriScheme attribute with one or more values.</li>
1075 </ul>
1076     <h3><a id="sending-the-ipp-request">Sending the IPP Request</a></h3>
1077     <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>
1078     <pre><code>ipp_t *response = cupsDoRequest(http, request, resource);
1079 </code></pre>
1080     <p>For requests like Send-Document that include a file, the <code>cupsDoFileRequest</code> function should be used:</p>
1081     <pre><code>ipp_t *response = cupsDoFileRequest(http, request, resource,
1082                                     filename);
1083 </code></pre>
1084     <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>
1085     <p>The status from the most recent request can be queried using the <code>cupsLastError</code> function, for example:</p>
1086     <pre><code>if (cupsLastError() &gt;= IPP_STATUS_ERROR_BAD_REQUEST)
1087 {
1088   /* request failed */
1089 }
1090 </code></pre>
1091     <p>A human-readable error message is also available using the <code>cupsLastErrorString</code> function:</p>
1092     <pre><code>if (cupsLastError() &gt;= IPP_STATUS_ERROR_BAD_REQUEST)
1093 {
1094   /* request failed */
1095   printf(&quot;Request failed: %s\n&quot;, cupsLastErrorString());
1096 }
1097 </code></pre>
1098     <h3><a id="processing-the-ipp-response">Processing the IPP Response</a></h3>
1099     <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>
1100     <p>For example, the following code finds the printer state attributes and prints their values:</p>
1101     <pre><code>ipp_attribute_t *attr;
1102
1103 if ((attr = ippFindAttribute(response, &quot;printer-state&quot;,
1104                              IPP_TAG_ENUM)) != NULL)
1105 {
1106   printf(&quot;printer-state=%s\n&quot;,
1107          ippEnumString(&quot;printer-state&quot;, ippGetInteger(attr, 0)));
1108 }
1109 else
1110   puts(&quot;printer-state=unknown&quot;);
1111
1112 if ((attr = ippFindAttribute(response, &quot;printer-state-message&quot;,
1113                              IPP_TAG_TEXT)) != NULL)
1114 {
1115   printf(&quot;printer-state-message=\&quot;%s\&quot;\n&quot;,
1116          ippGetString(attr, 0, NULL)));
1117 }
1118
1119 if ((attr = ippFindAttribute(response, &quot;printer-state-reasons&quot;,
1120                              IPP_TAG_KEYWORD)) != NULL)
1121 {
1122   int i, count = ippGetCount(attr);
1123
1124   puts(&quot;printer-state-reasons=&quot;);
1125   for (i = 0; i &lt; count; i ++)
1126     printf(&quot;    %s\n&quot;, ippGetString(attr, i, NULL)));
1127 }
1128 </code></pre>
1129     <p>The <code>ippGetCount</code> function returns the number of values in an attribute.</p>
1130     <p>The <code>ippGetInteger</code> and <code>ippGetString</code> functions return a single integer or string value from an attribute.</p>
1131     <p>The <code>ippEnumString</code> function converts a enum value to its keyword (string) equivalent.</p>
1132     <p>Once you are done using the IPP response message, free it using the <code>ippDelete</code> function:</p>
1133     <pre><code>ippDelete(response);
1134 </code></pre>
1135     <h3><a id="authentication">Authentication</a></h3>
1136     <p>CUPS normally handles authentication through the console. GUI applications should set a password callback using the <code>cupsSetPasswordCB2</code> function:</p>
1137     <pre><code>void
1138 cupsSetPasswordCB2(cups_password_cb2_t cb, void *user_data);
1139 </code></pre>
1140     <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>
1141     <pre><code>const char *
1142 cups_password_cb2(const char *prompt, http_t *http,
1143                   const char *method, const char *resource,
1144                   void *user_data);
1145 </code></pre>
1146     <p>The <code>prompt</code> argument is a string from CUPS that should be displayed to the user.</p>
1147     <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>
1148     <p>The <code>method</code> argument specifies the HTTP method used for the request and is typically &quot;POST&quot;.</p>
1149     <p>The <code>resource</code> argument specifies the path used for the request.</p>
1150     <p>The <code>user_data</code> argument provides the user data pointer from the <code>cupsSetPasswordCB2</code> call.</p>
1151       <h2 class="title"><a id="FUNCTIONS">Functions</a></h2>
1152 <h3 class="function"><a id="cupsAddDest">cupsAddDest</a></h3>
1153         <p class="description">Add a destination to the list of destinations.</p>
1154 <p class="code">
1155 int cupsAddDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p>
1156 <h4 class="parameters">Parameters</h4>
1157 <table class="list"><tbody>
1158 <tr><th>name</th>
1159         <td class="description">Destination name</td></tr>
1160 <tr><th>instance</th>
1161         <td class="description">Instance name or <code>NULL</code> for none/primary</td></tr>
1162 <tr><th>num_dests</th>
1163         <td class="description">Number of destinations</td></tr>
1164 <tr><th>dests</th>
1165         <td class="description">Destinations</td></tr>
1166 </tbody></table>
1167 <h4 class="returnvalue">Return Value</h4>
1168         <p class="description">New number of destinations</p>
1169 <h4 class="discussion">Discussion</h4>
1170         <p class="discussion">This function cannot be used to add a new class or printer queue,
1171 it only adds a new container of saved options for the named
1172 destination or instance.<br>
1173 <br>
1174 If the named destination already exists, the destination list is
1175 returned unchanged.  Adding a new instance of a destination creates
1176 a copy of that destination's options.<br>
1177 <br>
1178 Use the <a href="#cupsSaveDests"><code>cupsSaveDests</code></a> function to save the updated list of
1179 destinations to the user's lpoptions file.</p>
1180 <h3 class="function"><span class="info">&#160;CUPS 2.3&#160;</span><a id="cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></h3>
1181         <p class="description">Add the option corresponding to the specified media size.</p>
1182 <p class="code">
1183 int cupsAddDestMediaOptions(<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, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p>
1184 <h4 class="parameters">Parameters</h4>
1185 <table class="list"><tbody>
1186 <tr><th>http</th>
1187         <td class="description">Connection to destination</td></tr>
1188 <tr><th>dest</th>
1189         <td class="description">Destination</td></tr>
1190 <tr><th>dinfo</th>
1191         <td class="description">Destination information</td></tr>
1192 <tr><th>flags</th>
1193         <td class="description">Media matching flags</td></tr>
1194 <tr><th>size</th>
1195         <td class="description">Media size</td></tr>
1196 <tr><th>num_options</th>
1197         <td class="description">Current number of options</td></tr>
1198 <tr><th>options</th>
1199         <td class="description">Options</td></tr>
1200 </tbody></table>
1201 <h4 class="returnvalue">Return Value</h4>
1202         <p class="description">New number of options</p>
1203 <h3 class="function"><span class="info">&#160;CUPS 2.2.4/macOS 10.13&#160;</span><a id="cupsAddIntegerOption">cupsAddIntegerOption</a></h3>
1204         <p class="description">Add an integer option to an option array.</p>
1205 <p class="code">
1206 int cupsAddIntegerOption(const char *name, int value, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p>
1207 <h4 class="parameters">Parameters</h4>
1208 <table class="list"><tbody>
1209 <tr><th>name</th>
1210         <td class="description">Name of option</td></tr>
1211 <tr><th>value</th>
1212         <td class="description">Value of option</td></tr>
1213 <tr><th>num_options</th>
1214         <td class="description">Number of options</td></tr>
1215 <tr><th>options</th>
1216         <td class="description">Pointer to options</td></tr>
1217 </tbody></table>
1218 <h4 class="returnvalue">Return Value</h4>
1219         <p class="description">Number of options</p>
1220 <h4 class="discussion">Discussion</h4>
1221         <p class="discussion">New option arrays can be initialized simply by passing 0 for the
1222 &quot;num_options&quot; parameter.
1223
1224 </p>
1225 <h3 class="function"><a id="cupsAddOption">cupsAddOption</a></h3>
1226         <p class="description">Add an option to an option array.</p>
1227 <p class="code">
1228 int cupsAddOption(const char *name, const char *value, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p>
1229 <h4 class="parameters">Parameters</h4>
1230 <table class="list"><tbody>
1231 <tr><th>name</th>
1232         <td class="description">Name of option</td></tr>
1233 <tr><th>value</th>
1234         <td class="description">Value of option</td></tr>
1235 <tr><th>num_options</th>
1236         <td class="description">Number of options</td></tr>
1237 <tr><th>options</th>
1238         <td class="description">Pointer to options</td></tr>
1239 </tbody></table>
1240 <h4 class="returnvalue">Return Value</h4>
1241         <p class="description">Number of options</p>
1242 <h4 class="discussion">Discussion</h4>
1243         <p class="discussion">New option arrays can be initialized simply by passing 0 for the
1244 &quot;num_options&quot; parameter.</p>
1245 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsCancelDestJob">cupsCancelDestJob</a></h3>
1246         <p class="description">Cancel a job on a destination.</p>
1247 <p class="code">
1248 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>
1249 <h4 class="parameters">Parameters</h4>
1250 <table class="list"><tbody>
1251 <tr><th>http</th>
1252         <td class="description">Connection to destination</td></tr>
1253 <tr><th>dest</th>
1254         <td class="description">Destination</td></tr>
1255 <tr><th>job_id</th>
1256         <td class="description">Job ID</td></tr>
1257 </tbody></table>
1258 <h4 class="returnvalue">Return Value</h4>
1259         <p class="description">Status of cancel operation</p>
1260 <h4 class="discussion">Discussion</h4>
1261         <p class="discussion">The &quot;job_id&quot; is the number returned by cupsCreateDestJob.<br>
1262 <br>
1263 Returns <code>IPP_STATUS_OK</code> on success and
1264 <code>IPP_STATUS_ERROR_NOT_AUTHORIZED</code> or
1265 <code>IPP_STATUS_ERROR_FORBIDDEN</code> on failure.
1266
1267 </p>
1268 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsCheckDestSupported">cupsCheckDestSupported</a></h3>
1269         <p class="description">Check that the option and value are supported
1270 by the destination.</p>
1271 <p class="code">
1272 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>
1273 <h4 class="parameters">Parameters</h4>
1274 <table class="list"><tbody>
1275 <tr><th>http</th>
1276         <td class="description">Connection to destination</td></tr>
1277 <tr><th>dest</th>
1278         <td class="description">Destination</td></tr>
1279 <tr><th>dinfo</th>
1280         <td class="description">Destination information</td></tr>
1281 <tr><th>option</th>
1282         <td class="description">Option</td></tr>
1283 <tr><th>value</th>
1284         <td class="description">Value or <code>NULL</code></td></tr>
1285 </tbody></table>
1286 <h4 class="returnvalue">Return Value</h4>
1287         <p class="description">1 if supported, 0 otherwise</p>
1288 <h4 class="discussion">Discussion</h4>
1289         <p class="discussion">Returns 1 if supported, 0 otherwise.
1290
1291 </p>
1292 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsCloseDestJob">cupsCloseDestJob</a></h3>
1293         <p class="description">Close a job and start printing.</p>
1294 <p class="code">
1295 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>
1296 <h4 class="parameters">Parameters</h4>
1297 <table class="list"><tbody>
1298 <tr><th>http</th>
1299         <td class="description">Connection to destination</td></tr>
1300 <tr><th>dest</th>
1301         <td class="description">Destination</td></tr>
1302 <tr><th>info</th>
1303         <td class="description">Destination information</td></tr>
1304 <tr><th>job_id</th>
1305         <td class="description">Job ID</td></tr>
1306 </tbody></table>
1307 <h4 class="returnvalue">Return Value</h4>
1308         <p class="description">IPP status code</p>
1309 <h4 class="discussion">Discussion</h4>
1310         <p class="discussion">Use when the last call to cupsStartDocument passed 0 for &quot;last_document&quot;.
1311 &quot;job_id&quot; is the job ID returned by cupsCreateDestJob. Returns <code>IPP_STATUS_OK</code>
1312 on success.
1313
1314 </p>
1315 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsConnectDest">cupsConnectDest</a></h3>
1316         <p class="description">Open a connection to the destination.</p>
1317 <p class="code">
1318 <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>
1319 <h4 class="parameters">Parameters</h4>
1320 <table class="list"><tbody>
1321 <tr><th>dest</th>
1322         <td class="description">Destination</td></tr>
1323 <tr><th>flags</th>
1324         <td class="description">Connection flags</td></tr>
1325 <tr><th>msec</th>
1326         <td class="description">Timeout in milliseconds</td></tr>
1327 <tr><th>cancel</th>
1328         <td class="description">Pointer to &quot;cancel&quot; variable</td></tr>
1329 <tr><th>resource</th>
1330         <td class="description">Resource buffer</td></tr>
1331 <tr><th>resourcesize</th>
1332         <td class="description">Size of resource buffer</td></tr>
1333 <tr><th>cb</th>
1334         <td class="description">Callback function</td></tr>
1335 <tr><th>user_data</th>
1336         <td class="description">User data pointer</td></tr>
1337 </tbody></table>
1338 <h4 class="returnvalue">Return Value</h4>
1339         <p class="description">Connection to destination or <code>NULL</code></p>
1340 <h4 class="discussion">Discussion</h4>
1341         <p class="discussion">Connect to the destination, returning a new <code>http_t</code> connection object
1342 and optionally the resource path to use for the destination.  These calls
1343 will block until a connection is made, the timeout expires, the integer
1344 pointed to by &quot;cancel&quot; is non-zero, or the callback function (or block)
1345 returns 0.  The caller is responsible for calling <a href="#httpClose"><code>httpClose</code></a> on the
1346 returned connection.<br>
1347 <br>
1348 Starting with CUPS 2.2.4, the caller can pass <code>CUPS_DEST_FLAGS_DEVICE</code>
1349 for the &quot;flags&quot; argument to connect directly to the device associated with
1350 the destination.  Otherwise, the connection is made to the CUPS scheduler
1351 associated with the destination.
1352
1353 </p>
1354 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsCopyDest">cupsCopyDest</a></h3>
1355         <p class="description">Copy a destination.</p>
1356 <p class="code">
1357 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>
1358 <h4 class="parameters">Parameters</h4>
1359 <table class="list"><tbody>
1360 <tr><th>dest</th>
1361         <td class="description">Destination to copy</td></tr>
1362 <tr><th>num_dests</th>
1363         <td class="description">Number of destinations</td></tr>
1364 <tr><th>dests</th>
1365         <td class="description">Destination array</td></tr>
1366 </tbody></table>
1367 <h4 class="returnvalue">Return Value</h4>
1368         <p class="description">New number of destinations</p>
1369 <h4 class="discussion">Discussion</h4>
1370         <p class="discussion">Make a copy of the destination to an array of destinations (or just a single
1371 copy) - for use with the cupsEnumDests* functions. The caller is responsible
1372 for calling cupsFreeDests() on the returned object(s).
1373
1374 </p>
1375 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsCopyDestConflicts">cupsCopyDestConflicts</a></h3>
1376         <p class="description">Get conflicts and resolutions for a new
1377 option/value pair.</p>
1378 <p class="code">
1379 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>
1380 <h4 class="parameters">Parameters</h4>
1381 <table class="list"><tbody>
1382 <tr><th>http</th>
1383         <td class="description">Connection to destination</td></tr>
1384 <tr><th>dest</th>
1385         <td class="description">Destination</td></tr>
1386 <tr><th>dinfo</th>
1387         <td class="description">Destination information</td></tr>
1388 <tr><th>num_options</th>
1389         <td class="description">Number of current options</td></tr>
1390 <tr><th>options</th>
1391         <td class="description">Current options</td></tr>
1392 <tr><th>new_option</th>
1393         <td class="description">New option</td></tr>
1394 <tr><th>new_value</th>
1395         <td class="description">New value</td></tr>
1396 <tr><th>num_conflicts</th>
1397         <td class="description">Number of conflicting options</td></tr>
1398 <tr><th>conflicts</th>
1399         <td class="description">Conflicting options</td></tr>
1400 <tr><th>num_resolved</th>
1401         <td class="description">Number of options to resolve</td></tr>
1402 <tr><th>resolved</th>
1403         <td class="description">Resolved options</td></tr>
1404 </tbody></table>
1405 <h4 class="returnvalue">Return Value</h4>
1406         <p class="description">1 if there is a conflict, 0 if none, -1 on error</p>
1407 <h4 class="discussion">Discussion</h4>
1408         <p class="discussion">&quot;num_options&quot; and &quot;options&quot; represent the currently selected options by the
1409 user.  &quot;new_option&quot; and &quot;new_value&quot; are the setting the user has just
1410 changed.<br>
1411 <br>
1412 Returns 1 if there is a conflict, 0 if there are no conflicts, and -1 if
1413 there was an unrecoverable error such as a resolver loop.<br>
1414 <br>
1415 If &quot;num_conflicts&quot; and &quot;conflicts&quot; are not <code>NULL</code>, they are set to
1416 contain the list of conflicting option/value pairs.  Similarly, if
1417 &quot;num_resolved&quot; and &quot;resolved&quot; are not <code>NULL</code> they will be set to the
1418 list of changes needed to resolve the conflict.<br>
1419 <br>
1420 If cupsCopyDestConflicts returns 1 but &quot;num_resolved&quot; and &quot;resolved&quot; are set
1421 to 0 and <code>NULL</code>, respectively, then the conflict cannot be resolved.
1422
1423 </p>
1424 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsCopyDestInfo">cupsCopyDestInfo</a></h3>
1425         <p class="description">Get the supported values/capabilities for the
1426 destination.</p>
1427 <p class="code">
1428 <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>
1429 <h4 class="parameters">Parameters</h4>
1430 <table class="list"><tbody>
1431 <tr><th>http</th>
1432         <td class="description">Connection to destination</td></tr>
1433 <tr><th>dest</th>
1434         <td class="description">Destination</td></tr>
1435 </tbody></table>
1436 <h4 class="returnvalue">Return Value</h4>
1437         <p class="description">Destination information</p>
1438 <h4 class="discussion">Discussion</h4>
1439         <p class="discussion">The caller is responsible for calling <a href="#cupsFreeDestInfo"><code>cupsFreeDestInfo</code></a> on the return
1440 value. <code>NULL</code> is returned on error.
1441
1442 </p>
1443 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsCreateDestJob">cupsCreateDestJob</a></h3>
1444         <p class="description">Create a job on a destination.</p>
1445 <p class="code">
1446 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>
1447 <h4 class="parameters">Parameters</h4>
1448 <table class="list"><tbody>
1449 <tr><th>http</th>
1450         <td class="description">Connection to destination</td></tr>
1451 <tr><th>dest</th>
1452         <td class="description">Destination</td></tr>
1453 <tr><th>info</th>
1454         <td class="description">Destination information</td></tr>
1455 <tr><th>job_id</th>
1456         <td class="description">Job ID or 0 on error</td></tr>
1457 <tr><th>title</th>
1458         <td class="description">Job name</td></tr>
1459 <tr><th>num_options</th>
1460         <td class="description">Number of job options</td></tr>
1461 <tr><th>options</th>
1462         <td class="description">Job options</td></tr>
1463 </tbody></table>
1464 <h4 class="returnvalue">Return Value</h4>
1465         <p class="description">IPP status code</p>
1466 <h4 class="discussion">Discussion</h4>
1467         <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success, saving the job ID
1468 in the variable pointed to by &quot;job_id&quot;.
1469
1470 </p>
1471 <h3 class="function"><span class="info">&#160;CUPS 1.1.20/macOS 10.4&#160;</span><a id="cupsDoAuthentication">cupsDoAuthentication</a></h3>
1472         <p class="description">Authenticate a request.</p>
1473 <p class="code">
1474 int cupsDoAuthentication(<a href="#http_t">http_t</a> *http, const char *method, const char *resource);</p>
1475 <h4 class="parameters">Parameters</h4>
1476 <table class="list"><tbody>
1477 <tr><th>http</th>
1478         <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr>
1479 <tr><th>method</th>
1480         <td class="description">Request method (&quot;GET&quot;, &quot;POST&quot;, &quot;PUT&quot;)</td></tr>
1481 <tr><th>resource</th>
1482         <td class="description">Resource path</td></tr>
1483 </tbody></table>
1484 <h4 class="returnvalue">Return Value</h4>
1485         <p class="description">0 on success, -1 on error</p>
1486 <h4 class="discussion">Discussion</h4>
1487         <p class="discussion">This function should be called in response to a <code>HTTP_STATUS_UNAUTHORIZED</code>
1488 status, prior to resubmitting your request.
1489
1490 </p>
1491 <h3 class="function"><span class="info">&#160;CUPS 2.3&#160;</span><a id="cupsEncodeOption">cupsEncodeOption</a></h3>
1492         <p class="description">Encode a single option into an IPP attribute.</p>
1493 <p class="code">
1494 <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsEncodeOption(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group_tag, const char *name, const char *value);</p>
1495 <h4 class="parameters">Parameters</h4>
1496 <table class="list"><tbody>
1497 <tr><th>ipp</th>
1498         <td class="description">IPP request/response</td></tr>
1499 <tr><th>group_tag</th>
1500         <td class="description">Attribute group</td></tr>
1501 <tr><th>name</th>
1502         <td class="description">Option name</td></tr>
1503 <tr><th>value</th>
1504         <td class="description">Option string value</td></tr>
1505 </tbody></table>
1506 <h4 class="returnvalue">Return Value</h4>
1507         <p class="description">New attribute or <code>NULL</code> on error</p>
1508 <h3 class="function"><a id="cupsEncodeOptions">cupsEncodeOptions</a></h3>
1509         <p class="description">Encode printer options into IPP attributes.</p>
1510 <p class="code">
1511 void cupsEncodeOptions(<a href="#ipp_t">ipp_t</a> *ipp, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p>
1512 <h4 class="parameters">Parameters</h4>
1513 <table class="list"><tbody>
1514 <tr><th>ipp</th>
1515         <td class="description">IPP request/response</td></tr>
1516 <tr><th>num_options</th>
1517         <td class="description">Number of options</td></tr>
1518 <tr><th>options</th>
1519         <td class="description">Options</td></tr>
1520 </tbody></table>
1521 <h4 class="discussion">Discussion</h4>
1522         <p class="discussion">This function adds operation, job, and then subscription attributes,
1523 in that order. Use the <a href="#cupsEncodeOptions2"><code>cupsEncodeOptions2</code></a> function to add attributes
1524 for a single group.</p>
1525 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="cupsEncodeOptions2">cupsEncodeOptions2</a></h3>
1526         <p class="description">Encode printer options into IPP attributes for a group.</p>
1527 <p class="code">
1528 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>
1529 <h4 class="parameters">Parameters</h4>
1530 <table class="list"><tbody>
1531 <tr><th>ipp</th>
1532         <td class="description">IPP request/response</td></tr>
1533 <tr><th>num_options</th>
1534         <td class="description">Number of options</td></tr>
1535 <tr><th>options</th>
1536         <td class="description">Options</td></tr>
1537 <tr><th>group_tag</th>
1538         <td class="description">Group to encode</td></tr>
1539 </tbody></table>
1540 <h4 class="discussion">Discussion</h4>
1541         <p class="discussion">This function only adds attributes for a single group. Call this
1542 function multiple times for each group, or use <a href="#cupsEncodeOptions"><code>cupsEncodeOptions</code></a>
1543 to add the standard groups.
1544
1545 </p>
1546 <h3 class="function"><a id="cupsEncryption">cupsEncryption</a></h3>
1547         <p class="description">Get the current encryption settings.</p>
1548 <p class="code">
1549 <a href="#http_encryption_t">http_encryption_t</a> cupsEncryption(void);</p>
1550 <h4 class="returnvalue">Return Value</h4>
1551         <p class="description">Encryption settings</p>
1552 <h4 class="discussion">Discussion</h4>
1553         <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION
1554 environment variable, then the ~/.cups/client.conf file, and finally the
1555 /etc/cups/client.conf file. If not set, the default is
1556 <code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br>
1557 <br>
1558 Note: The current encryption setting is tracked separately for each thread
1559 in a program. Multi-threaded programs that override the setting via the
1560 <a href="#cupsSetEncryption"><code>cupsSetEncryption</code></a> function need to do so in each thread for the same
1561 setting to be used.</p>
1562 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsEnumDests">cupsEnumDests</a></h3>
1563         <p class="description">Enumerate available destinations with a callback function.</p>
1564 <p class="code">
1565 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>
1566 <h4 class="parameters">Parameters</h4>
1567 <table class="list"><tbody>
1568 <tr><th>flags</th>
1569         <td class="description">Enumeration flags</td></tr>
1570 <tr><th>msec</th>
1571         <td class="description">Timeout in milliseconds, -1 for indefinite</td></tr>
1572 <tr><th>cancel</th>
1573         <td class="description">Pointer to &quot;cancel&quot; variable</td></tr>
1574 <tr><th>type</th>
1575         <td class="description">Printer type bits</td></tr>
1576 <tr><th>mask</th>
1577         <td class="description">Mask for printer type bits</td></tr>
1578 <tr><th>cb</th>
1579         <td class="description">Callback function</td></tr>
1580 <tr><th>user_data</th>
1581         <td class="description">User data</td></tr>
1582 </tbody></table>
1583 <h4 class="returnvalue">Return Value</h4>
1584         <p class="description">1 on success, 0 on failure</p>
1585 <h4 class="discussion">Discussion</h4>
1586         <p class="discussion">Destinations are enumerated from one or more sources.  The callback function
1587 receives the <code>user_data</code> pointer and the destination pointer which can
1588 be used as input to the <a href="#cupsCopyDest"><code>cupsCopyDest</code></a> function.  The function must
1589 return 1 to continue enumeration or 0 to stop.<br>
1590 <br>
1591 The <code>type</code> and <code>mask</code> arguments allow the caller to filter the
1592 destinations that are enumerated.  Passing 0 for both will enumerate all
1593 printers.  The constant <code>CUPS_PRINTER_DISCOVERED</code> is used to filter on
1594 destinations that are available but have not yet been added locally.<br>
1595 <br>
1596 Enumeration happens on the current thread and does not return until all
1597 destinations have been enumerated or the callback function returns 0.<br>
1598 <br>
1599 Note: The callback function will likely receive multiple updates for the same
1600 destinations - it is up to the caller to suppress any duplicate destinations.
1601
1602 </p>
1603 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="cupsFindDestDefault">cupsFindDestDefault</a></h3>
1604         <p class="description">Find the default value(s) for the given option.</p>
1605 <p class="code">
1606 <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>
1607 <h4 class="parameters">Parameters</h4>
1608 <table class="list"><tbody>
1609 <tr><th>http</th>
1610         <td class="description">Connection to destination</td></tr>
1611 <tr><th>dest</th>
1612         <td class="description">Destination</td></tr>
1613 <tr><th>dinfo</th>
1614         <td class="description">Destination information</td></tr>
1615 <tr><th>option</th>
1616         <td class="description">Option/attribute name</td></tr>
1617 </tbody></table>
1618 <h4 class="returnvalue">Return Value</h4>
1619         <p class="description">Default attribute or <code>NULL</code> for none</p>
1620 <h4 class="discussion">Discussion</h4>
1621         <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>,
1622 <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>,
1623 <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>,
1624 <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code>
1625 functions to inspect the default value(s) as needed.
1626
1627 </p>
1628 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="cupsFindDestReady">cupsFindDestReady</a></h3>
1629         <p class="description">Find the default value(s) for the given option.</p>
1630 <p class="code">
1631 <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>
1632 <h4 class="parameters">Parameters</h4>
1633 <table class="list"><tbody>
1634 <tr><th>http</th>
1635         <td class="description">Connection to destination</td></tr>
1636 <tr><th>dest</th>
1637         <td class="description">Destination</td></tr>
1638 <tr><th>dinfo</th>
1639         <td class="description">Destination information</td></tr>
1640 <tr><th>option</th>
1641         <td class="description">Option/attribute name</td></tr>
1642 </tbody></table>
1643 <h4 class="returnvalue">Return Value</h4>
1644         <p class="description">Default attribute or <code>NULL</code> for none</p>
1645 <h4 class="discussion">Discussion</h4>
1646         <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>,
1647 <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>,
1648 <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>,
1649 <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code>
1650 functions to inspect the default value(s) as needed.
1651
1652 </p>
1653 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="cupsFindDestSupported">cupsFindDestSupported</a></h3>
1654         <p class="description">Find the default value(s) for the given option.</p>
1655 <p class="code">
1656 <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>
1657 <h4 class="parameters">Parameters</h4>
1658 <table class="list"><tbody>
1659 <tr><th>http</th>
1660         <td class="description">Connection to destination</td></tr>
1661 <tr><th>dest</th>
1662         <td class="description">Destination</td></tr>
1663 <tr><th>dinfo</th>
1664         <td class="description">Destination information</td></tr>
1665 <tr><th>option</th>
1666         <td class="description">Option/attribute name</td></tr>
1667 </tbody></table>
1668 <h4 class="returnvalue">Return Value</h4>
1669         <p class="description">Default attribute or <code>NULL</code> for none</p>
1670 <h4 class="discussion">Discussion</h4>
1671         <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>,
1672 <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>,
1673 <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>,
1674 <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code>
1675 functions to inspect the default value(s) as needed.
1676
1677 </p>
1678 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsFinishDestDocument">cupsFinishDestDocument</a></h3>
1679         <p class="description">Finish the current document.</p>
1680 <p class="code">
1681 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>
1682 <h4 class="parameters">Parameters</h4>
1683 <table class="list"><tbody>
1684 <tr><th>http</th>
1685         <td class="description">Connection to destination</td></tr>
1686 <tr><th>dest</th>
1687         <td class="description">Destination</td></tr>
1688 <tr><th>info</th>
1689         <td class="description">Destination information</td></tr>
1690 </tbody></table>
1691 <h4 class="returnvalue">Return Value</h4>
1692         <p class="description">Status of document submission</p>
1693 <h4 class="discussion">Discussion</h4>
1694         <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success.
1695
1696 </p>
1697 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsFreeDestInfo">cupsFreeDestInfo</a></h3>
1698         <p class="description">Free destination information obtained using
1699 <a href="#cupsCopyDestInfo"><code>cupsCopyDestInfo</code></a>.</p>
1700 <p class="code">
1701 void cupsFreeDestInfo(<a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo);</p>
1702 <h4 class="parameters">Parameters</h4>
1703 <table class="list"><tbody>
1704 <tr><th>dinfo</th>
1705         <td class="description">Destination information</td></tr>
1706 </tbody></table>
1707 <h3 class="function"><a id="cupsFreeDests">cupsFreeDests</a></h3>
1708         <p class="description">Free the memory used by the list of destinations.</p>
1709 <p class="code">
1710 void cupsFreeDests(int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p>
1711 <h4 class="parameters">Parameters</h4>
1712 <table class="list"><tbody>
1713 <tr><th>num_dests</th>
1714         <td class="description">Number of destinations</td></tr>
1715 <tr><th>dests</th>
1716         <td class="description">Destinations</td></tr>
1717 </tbody></table>
1718 <h3 class="function"><a id="cupsFreeJobs">cupsFreeJobs</a></h3>
1719         <p class="description">Free memory used by job data.</p>
1720 <p class="code">
1721 void cupsFreeJobs(int num_jobs, <a href="#cups_job_t">cups_job_t</a> *jobs);</p>
1722 <h4 class="parameters">Parameters</h4>
1723 <table class="list"><tbody>
1724 <tr><th>num_jobs</th>
1725         <td class="description">Number of jobs</td></tr>
1726 <tr><th>jobs</th>
1727         <td class="description">Jobs</td></tr>
1728 </tbody></table>
1729 <h3 class="function"><a id="cupsFreeOptions">cupsFreeOptions</a></h3>
1730         <p class="description">Free all memory used by options.</p>
1731 <p class="code">
1732 void cupsFreeOptions(int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p>
1733 <h4 class="parameters">Parameters</h4>
1734 <table class="list"><tbody>
1735 <tr><th>num_options</th>
1736         <td class="description">Number of options</td></tr>
1737 <tr><th>options</th>
1738         <td class="description">Pointer to options</td></tr>
1739 </tbody></table>
1740 <h3 class="function"><a id="cupsGetDest">cupsGetDest</a></h3>
1741         <p class="description">Get the named destination from the list.</p>
1742 <p class="code">
1743 <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>
1744 <h4 class="parameters">Parameters</h4>
1745 <table class="list"><tbody>
1746 <tr><th>name</th>
1747         <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr>
1748 <tr><th>instance</th>
1749         <td class="description">Instance name or <code>NULL</code></td></tr>
1750 <tr><th>num_dests</th>
1751         <td class="description">Number of destinations</td></tr>
1752 <tr><th>dests</th>
1753         <td class="description">Destinations</td></tr>
1754 </tbody></table>
1755 <h4 class="returnvalue">Return Value</h4>
1756         <p class="description">Destination pointer or <code>NULL</code></p>
1757 <h4 class="discussion">Discussion</h4>
1758         <p class="discussion">Use the <a href="#cupsEnumDests"><code>cupsEnumDests</code></a> or <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> functions to get a
1759 list of supported destinations for the current user.</p>
1760 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></h3>
1761         <p class="description">Get a media name, dimension, and margins for a
1762 specific size.</p>
1763 <p class="code">
1764 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>
1765 <h4 class="parameters">Parameters</h4>
1766 <table class="list"><tbody>
1767 <tr><th>http</th>
1768         <td class="description">Connection to destination</td></tr>
1769 <tr><th>dest</th>
1770         <td class="description">Destination</td></tr>
1771 <tr><th>dinfo</th>
1772         <td class="description">Destination information</td></tr>
1773 <tr><th>n</th>
1774         <td class="description">Media size number (0-based)</td></tr>
1775 <tr><th>flags</th>
1776         <td class="description">Media flags</td></tr>
1777 <tr><th>size</th>
1778         <td class="description">Media size information</td></tr>
1779 </tbody></table>
1780 <h4 class="returnvalue">Return Value</h4>
1781         <p class="description">1 on success, 0 on failure</p>
1782 <h4 class="discussion">Discussion</h4>
1783         <p class="discussion">The <code>flags</code> parameter determines which set of media are indexed.  For
1784 example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will get the Nth
1785 borderless size supported by the printer.
1786
1787 </p>
1788 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsGetDestMediaByName">cupsGetDestMediaByName</a></h3>
1789         <p class="description">Get media names, dimensions, and margins.</p>
1790 <p class="code">
1791 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>
1792 <h4 class="parameters">Parameters</h4>
1793 <table class="list"><tbody>
1794 <tr><th>http</th>
1795         <td class="description">Connection to destination</td></tr>
1796 <tr><th>dest</th>
1797         <td class="description">Destination</td></tr>
1798 <tr><th>dinfo</th>
1799         <td class="description">Destination information</td></tr>
1800 <tr><th>media</th>
1801         <td class="description">Media name</td></tr>
1802 <tr><th>flags</th>
1803         <td class="description">Media matching flags</td></tr>
1804 <tr><th>size</th>
1805         <td class="description">Media size information</td></tr>
1806 </tbody></table>
1807 <h4 class="returnvalue">Return Value</h4>
1808         <p class="description">1 on match, 0 on failure</p>
1809 <h4 class="discussion">Discussion</h4>
1810         <p class="discussion">The &quot;media&quot; string is a PWG media name.  &quot;Flags&quot; provides some matching
1811 guidance (multiple flags can be combined):<br>
1812 <br>
1813 CUPS_MEDIA_FLAGS_DEFAULT    = find the closest size supported by the printer,
1814 CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size,
1815 CUPS_MEDIA_FLAGS_DUPLEX     = find a size compatible with 2-sided printing,
1816 CUPS_MEDIA_FLAGS_EXACT      = find an exact match for the size, and
1817 CUPS_MEDIA_FLAGS_READY      = if the printer supports media sensing, find the
1818 size amongst the &quot;ready&quot; media.<br>
1819 <br>
1820 The matching result (if any) is returned in the &quot;cups_size_t&quot; structure.<br>
1821 <br>
1822 Returns 1 when there is a match and 0 if there is not a match.
1823
1824 </p>
1825 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></h3>
1826         <p class="description">Get media names, dimensions, and margins.</p>
1827 <p class="code">
1828 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>
1829 <h4 class="parameters">Parameters</h4>
1830 <table class="list"><tbody>
1831 <tr><th>http</th>
1832         <td class="description">Connection to destination</td></tr>
1833 <tr><th>dest</th>
1834         <td class="description">Destination</td></tr>
1835 <tr><th>dinfo</th>
1836         <td class="description">Destination information</td></tr>
1837 <tr><th>width</th>
1838         <td class="description">Media width in hundredths of
1839 of millimeters</td></tr>
1840 <tr><th>length</th>
1841         <td class="description">Media length in hundredths of
1842 of millimeters</td></tr>
1843 <tr><th>flags</th>
1844         <td class="description">Media matching flags</td></tr>
1845 <tr><th>size</th>
1846         <td class="description">Media size information</td></tr>
1847 </tbody></table>
1848 <h4 class="returnvalue">Return Value</h4>
1849         <p class="description">1 on match, 0 on failure</p>
1850 <h4 class="discussion">Discussion</h4>
1851         <p class="discussion">&quot;Width&quot; and &quot;length&quot; are the dimensions in hundredths of millimeters.
1852 &quot;Flags&quot; provides some matching guidance (multiple flags can be combined):<br>
1853 <br>
1854 CUPS_MEDIA_FLAGS_DEFAULT    = find the closest size supported by the printer,
1855 CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size,
1856 CUPS_MEDIA_FLAGS_DUPLEX     = find a size compatible with 2-sided printing,
1857 CUPS_MEDIA_FLAGS_EXACT      = find an exact match for the size, and
1858 CUPS_MEDIA_FLAGS_READY      = if the printer supports media sensing, find the
1859 size amongst the &quot;ready&quot; media.<br>
1860 <br>
1861 The matching result (if any) is returned in the &quot;cups_size_t&quot; structure.<br>
1862 <br>
1863 Returns 1 when there is a match and 0 if there is not a match.
1864
1865 </p>
1866 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="cupsGetDestMediaCount">cupsGetDestMediaCount</a></h3>
1867         <p class="description">Get the number of sizes supported by a
1868 destination.</p>
1869 <p class="code">
1870 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>
1871 <h4 class="parameters">Parameters</h4>
1872 <table class="list"><tbody>
1873 <tr><th>http</th>
1874         <td class="description">Connection to destination</td></tr>
1875 <tr><th>dest</th>
1876         <td class="description">Destination</td></tr>
1877 <tr><th>dinfo</th>
1878         <td class="description">Destination information</td></tr>
1879 <tr><th>flags</th>
1880         <td class="description">Media flags</td></tr>
1881 </tbody></table>
1882 <h4 class="returnvalue">Return Value</h4>
1883         <p class="description">Number of sizes</p>
1884 <h4 class="discussion">Discussion</h4>
1885         <p class="discussion">The <code>flags</code> parameter determines the set of media sizes that are
1886 counted.  For example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return
1887 the number of borderless sizes.
1888
1889 </p>
1890 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></h3>
1891         <p class="description">Get the default size for a destination.</p>
1892 <p class="code">
1893 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>
1894 <h4 class="parameters">Parameters</h4>
1895 <table class="list"><tbody>
1896 <tr><th>http</th>
1897         <td class="description">Connection to destination</td></tr>
1898 <tr><th>dest</th>
1899         <td class="description">Destination</td></tr>
1900 <tr><th>dinfo</th>
1901         <td class="description">Destination information</td></tr>
1902 <tr><th>flags</th>
1903         <td class="description">Media flags</td></tr>
1904 <tr><th>size</th>
1905         <td class="description">Media size information</td></tr>
1906 </tbody></table>
1907 <h4 class="returnvalue">Return Value</h4>
1908         <p class="description">1 on success, 0 on failure</p>
1909 <h4 class="discussion">Discussion</h4>
1910         <p class="discussion">The <code>flags</code> parameter determines which default size is returned.  For
1911 example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return the default
1912 borderless size, typically US Letter or A4, but sometimes 4x6 photo media.
1913
1914 </p>
1915 <h3 class="function"><span class="info">&#160;CUPS 2.0/macOS 10.10&#160;</span><a id="cupsGetDestWithURI">cupsGetDestWithURI</a></h3>
1916         <p class="description">Get a destination associated with a URI.</p>
1917 <p class="code">
1918 <a href="#cups_dest_t">cups_dest_t</a> *cupsGetDestWithURI(const char *name, const char *uri);</p>
1919 <h4 class="parameters">Parameters</h4>
1920 <table class="list"><tbody>
1921 <tr><th>name</th>
1922         <td class="description">Desired printer name or <code>NULL</code></td></tr>
1923 <tr><th>uri</th>
1924         <td class="description">URI for the printer</td></tr>
1925 </tbody></table>
1926 <h4 class="returnvalue">Return Value</h4>
1927         <p class="description">Destination or <code>NULL</code></p>
1928 <h4 class="discussion">Discussion</h4>
1929         <p class="discussion">&quot;name&quot; is the desired name for the printer. If <code>NULL</code>, a name will be
1930 created using the URI.<br>
1931 <br>
1932 &quot;uri&quot; is the &quot;ipp&quot; or &quot;ipps&quot; URI for the printer.
1933
1934 </p>
1935 <h3 class="function"><span class="info">&#160;CUPS 1.1.21/macOS 10.4&#160;</span><a id="cupsGetDests2">cupsGetDests2</a></h3>
1936         <p class="description">Get the list of destinations from the specified server.</p>
1937 <p class="code">
1938 int cupsGetDests2(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p>
1939 <h4 class="parameters">Parameters</h4>
1940 <table class="list"><tbody>
1941 <tr><th>http</th>
1942         <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr>
1943 <tr><th>dests</th>
1944         <td class="description">Destinations</td></tr>
1945 </tbody></table>
1946 <h4 class="returnvalue">Return Value</h4>
1947         <p class="description">Number of destinations</p>
1948 <h4 class="discussion">Discussion</h4>
1949         <p class="discussion">Starting with CUPS 1.2, the returned list of destinations include the
1950 &quot;printer-info&quot;, &quot;printer-is-accepting-jobs&quot;, &quot;printer-is-shared&quot;,
1951 &quot;printer-make-and-model&quot;, &quot;printer-state&quot;, &quot;printer-state-change-time&quot;,
1952 &quot;printer-state-reasons&quot;, &quot;printer-type&quot;, and &quot;printer-uri-supported&quot;
1953 attributes as options.<br>
1954 <br>
1955 CUPS 1.4 adds the &quot;marker-change-time&quot;, &quot;marker-colors&quot;,
1956 &quot;marker-high-levels&quot;, &quot;marker-levels&quot;, &quot;marker-low-levels&quot;, &quot;marker-message&quot;,
1957 &quot;marker-names&quot;, &quot;marker-types&quot;, and &quot;printer-commands&quot; attributes as options.<br>
1958 <br>
1959 CUPS 2.2 adds accessible IPP printers to the list of destinations that can
1960 be used.  The &quot;printer-uri-supported&quot; option will be present for those IPP
1961 printers that have been recently used.<br>
1962 <br>
1963 Use the <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> function to free the destination list and
1964 the <a href="#cupsGetDest"><code>cupsGetDest</code></a> function to find a particular destination.
1965
1966 </p>
1967 <h3 class="function"><span class="info">&#160;CUPS 2.2.4/macOS 10.13&#160;</span><a id="cupsGetIntegerOption">cupsGetIntegerOption</a></h3>
1968         <p class="description">Get an integer option value.</p>
1969 <p class="code">
1970 int cupsGetIntegerOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p>
1971 <h4 class="parameters">Parameters</h4>
1972 <table class="list"><tbody>
1973 <tr><th>name</th>
1974         <td class="description">Name of option</td></tr>
1975 <tr><th>num_options</th>
1976         <td class="description">Number of options</td></tr>
1977 <tr><th>options</th>
1978         <td class="description">Options</td></tr>
1979 </tbody></table>
1980 <h4 class="returnvalue">Return Value</h4>
1981         <p class="description">Option value or <code>INT_MIN</code></p>
1982 <h4 class="discussion">Discussion</h4>
1983         <p class="discussion">INT_MIN is returned when the option does not exist, is not an integer, or
1984 exceeds the range of values for the &quot;int&quot; type.
1985
1986 </p>
1987 <h3 class="function"><span class="info">&#160;CUPS 1.1.21/macOS 10.4&#160;</span><a id="cupsGetJobs2">cupsGetJobs2</a></h3>
1988         <p class="description">Get the jobs from the specified server.</p>
1989 <p class="code">
1990 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>
1991 <h4 class="parameters">Parameters</h4>
1992 <table class="list"><tbody>
1993 <tr><th>http</th>
1994         <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr>
1995 <tr><th>jobs</th>
1996         <td class="description">Job data</td></tr>
1997 <tr><th>name</th>
1998         <td class="description"><code>NULL</code> = all destinations, otherwise show jobs for named destination</td></tr>
1999 <tr><th>myjobs</th>
2000         <td class="description">0 = all users, 1 = mine</td></tr>
2001 <tr><th>whichjobs</th>
2002         <td class="description"><code>CUPS_WHICHJOBS_ALL</code>, <code>CUPS_WHICHJOBS_ACTIVE</code>, or <code>CUPS_WHICHJOBS_COMPLETED</code></td></tr>
2003 </tbody></table>
2004 <h4 class="returnvalue">Return Value</h4>
2005         <p class="description">Number of jobs</p>
2006 <h4 class="discussion">Discussion</h4>
2007         <p class="discussion">A &quot;whichjobs&quot; value of <code>CUPS_WHICHJOBS_ALL</code> returns all jobs regardless
2008 of state, while <code>CUPS_WHICHJOBS_ACTIVE</code> returns jobs that are
2009 pending, processing, or held and <code>CUPS_WHICHJOBS_COMPLETED</code> returns
2010 jobs that are stopped, canceled, aborted, or completed.
2011
2012 </p>
2013 <h3 class="function"><span class="info">&#160;CUPS 1.4/macOS 10.6&#160;</span><a id="cupsGetNamedDest">cupsGetNamedDest</a></h3>
2014         <p class="description">Get options for the named destination.</p>
2015 <p class="code">
2016 <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>
2017 <h4 class="parameters">Parameters</h4>
2018 <table class="list"><tbody>
2019 <tr><th>http</th>
2020         <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr>
2021 <tr><th>name</th>
2022         <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr>
2023 <tr><th>instance</th>
2024         <td class="description">Instance name or <code>NULL</code></td></tr>
2025 </tbody></table>
2026 <h4 class="returnvalue">Return Value</h4>
2027         <p class="description">Destination or <code>NULL</code></p>
2028 <h4 class="discussion">Discussion</h4>
2029         <p class="discussion">This function is optimized for retrieving a single destination and should
2030 be used instead of <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> and <a href="#cupsGetDest"><code>cupsGetDest</code></a> when you
2031 either know the name of the destination or want to print to the default
2032 destination.  If <code>NULL</code> is returned, the destination does not exist or
2033 there is no default destination.<br>
2034 <br>
2035 If &quot;http&quot; is <code>CUPS_HTTP_DEFAULT</code>, the connection to the default print
2036 server will be used.<br>
2037 <br>
2038 If &quot;name&quot; is <code>NULL</code>, the default printer for the current user will be
2039 returned.<br>
2040 <br>
2041 The returned destination must be freed using <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> with a
2042 &quot;num_dests&quot; value of 1.
2043
2044 </p>
2045 <h3 class="function"><a id="cupsGetOption">cupsGetOption</a></h3>
2046         <p class="description">Get an option value.</p>
2047 <p class="code">
2048 const char *cupsGetOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p>
2049 <h4 class="parameters">Parameters</h4>
2050 <table class="list"><tbody>
2051 <tr><th>name</th>
2052         <td class="description">Name of option</td></tr>
2053 <tr><th>num_options</th>
2054         <td class="description">Number of options</td></tr>
2055 <tr><th>options</th>
2056         <td class="description">Options</td></tr>
2057 </tbody></table>
2058 <h4 class="returnvalue">Return Value</h4>
2059         <p class="description">Option value or <code>NULL</code></p>
2060 <h3 class="function"><span class="info">&#160;CUPS 1.4/macOS 10.6&#160;</span><a id="cupsGetPassword2">cupsGetPassword2</a></h3>
2061         <p class="description">Get a password from the user using the current
2062 password callback.</p>
2063 <p class="code">
2064 const char *cupsGetPassword2(const char *prompt, <a href="#http_t">http_t</a> *http, const char *method, const char *resource);</p>
2065 <h4 class="parameters">Parameters</h4>
2066 <table class="list"><tbody>
2067 <tr><th>prompt</th>
2068         <td class="description">Prompt string</td></tr>
2069 <tr><th>http</th>
2070         <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr>
2071 <tr><th>method</th>
2072         <td class="description">Request method (&quot;GET&quot;, &quot;POST&quot;, &quot;PUT&quot;)</td></tr>
2073 <tr><th>resource</th>
2074         <td class="description">Resource path</td></tr>
2075 </tbody></table>
2076 <h4 class="returnvalue">Return Value</h4>
2077         <p class="description">Password</p>
2078 <h4 class="discussion">Discussion</h4>
2079         <p class="discussion">Uses the current password callback function. Returns <code>NULL</code> if the
2080 user does not provide a password.<br>
2081 <br>
2082 Note: The current password callback function is tracked separately for each
2083 thread in a program. Multi-threaded programs that override the setting via
2084 the <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> function need to do so in each thread for the
2085 same function to be used.
2086
2087 </p>
2088 <h3 class="function"><span class="info">&#160;CUPS 2.0/macOS 10.10&#160;</span><a id="cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></h3>
2089         <p class="description">Get the localized string for a destination media
2090 size.</p>
2091 <p class="code">
2092 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>
2093 <h4 class="parameters">Parameters</h4>
2094 <table class="list"><tbody>
2095 <tr><th>http</th>
2096         <td class="description">Connection to destination</td></tr>
2097 <tr><th>dest</th>
2098         <td class="description">Destination</td></tr>
2099 <tr><th>dinfo</th>
2100         <td class="description">Destination information</td></tr>
2101 <tr><th>flags</th>
2102         <td class="description">Media flags</td></tr>
2103 <tr><th>size</th>
2104         <td class="description">Media size</td></tr>
2105 </tbody></table>
2106 <h4 class="returnvalue">Return Value</h4>
2107         <p class="description">Localized string</p>
2108 <h4 class="discussion">Discussion</h4>
2109         <p class="discussion">The returned string is stored in the destination information and will become
2110 invalid if the destination information is deleted.
2111
2112 </p>
2113 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsLocalizeDestOption">cupsLocalizeDestOption</a></h3>
2114         <p class="description">Get the localized string for a destination
2115 option.</p>
2116 <p class="code">
2117 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>
2118 <h4 class="parameters">Parameters</h4>
2119 <table class="list"><tbody>
2120 <tr><th>http</th>
2121         <td class="description">Connection to destination</td></tr>
2122 <tr><th>dest</th>
2123         <td class="description">Destination</td></tr>
2124 <tr><th>dinfo</th>
2125         <td class="description">Destination information</td></tr>
2126 <tr><th>option</th>
2127         <td class="description">Option to localize</td></tr>
2128 </tbody></table>
2129 <h4 class="returnvalue">Return Value</h4>
2130         <p class="description">Localized string</p>
2131 <h4 class="discussion">Discussion</h4>
2132         <p class="discussion">The returned string is stored in the destination information and will become
2133 invalid if the destination information is deleted.
2134
2135 </p>
2136 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsLocalizeDestValue">cupsLocalizeDestValue</a></h3>
2137         <p class="description">Get the localized string for a destination
2138 option+value pair.</p>
2139 <p class="code">
2140 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>
2141 <h4 class="parameters">Parameters</h4>
2142 <table class="list"><tbody>
2143 <tr><th>http</th>
2144         <td class="description">Connection to destination</td></tr>
2145 <tr><th>dest</th>
2146         <td class="description">Destination</td></tr>
2147 <tr><th>dinfo</th>
2148         <td class="description">Destination information</td></tr>
2149 <tr><th>option</th>
2150         <td class="description">Option to localize</td></tr>
2151 <tr><th>value</th>
2152         <td class="description">Value to localize</td></tr>
2153 </tbody></table>
2154 <h4 class="returnvalue">Return Value</h4>
2155         <p class="description">Localized string</p>
2156 <h4 class="discussion">Discussion</h4>
2157         <p class="discussion">The returned string is stored in the destination information and will become
2158 invalid if the destination information is deleted.
2159
2160 </p>
2161 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="cupsMakeServerCredentials">cupsMakeServerCredentials</a></h3>
2162         <p class="description">Make a self-signed certificate and private key pair.</p>
2163 <p class="code">
2164 int cupsMakeServerCredentials(const char *path, const char *common_name, int num_alt_names, const char **alt_names, time_t expiration_date);</p>
2165 <h4 class="parameters">Parameters</h4>
2166 <table class="list"><tbody>
2167 <tr><th>path</th>
2168         <td class="description">Keychain path or <code>NULL</code> for default</td></tr>
2169 <tr><th>common_name</th>
2170         <td class="description">Common name</td></tr>
2171 <tr><th>num_alt_names</th>
2172         <td class="description">Number of subject alternate names</td></tr>
2173 <tr><th>alt_names</th>
2174         <td class="description">Subject Alternate Names</td></tr>
2175 <tr><th>expiration_date</th>
2176         <td class="description">Expiration date</td></tr>
2177 </tbody></table>
2178 <h4 class="returnvalue">Return Value</h4>
2179         <p class="description">1 on success, 0 on failure</p>
2180 <h3 class="function"><a id="cupsParseOptions">cupsParseOptions</a></h3>
2181         <p class="description">Parse options from a command-line argument.</p>
2182 <p class="code">
2183 int cupsParseOptions(const char *arg, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p>
2184 <h4 class="parameters">Parameters</h4>
2185 <table class="list"><tbody>
2186 <tr><th>arg</th>
2187         <td class="description">Argument to parse</td></tr>
2188 <tr><th>num_options</th>
2189         <td class="description">Number of options</td></tr>
2190 <tr><th>options</th>
2191         <td class="description">Options found</td></tr>
2192 </tbody></table>
2193 <h4 class="returnvalue">Return Value</h4>
2194         <p class="description">Number of options found</p>
2195 <h4 class="discussion">Discussion</h4>
2196         <p class="discussion">This function converts space-delimited name/value pairs according
2197 to the PAPI text option ABNF specification. Collection values
2198 (&quot;name={a=... b=... c=...}&quot;) are stored with the curley brackets
2199 intact - use <code>cupsParseOptions</code> on the value to extract the
2200 collection attributes.</p>
2201 <h3 class="function"><span class="info">&#160;CUPS 1.3/macOS 10.5&#160;</span><a id="cupsRemoveDest">cupsRemoveDest</a></h3>
2202         <p class="description">Remove a destination from the destination list.</p>
2203 <p class="code">
2204 int cupsRemoveDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p>
2205 <h4 class="parameters">Parameters</h4>
2206 <table class="list"><tbody>
2207 <tr><th>name</th>
2208         <td class="description">Destination name</td></tr>
2209 <tr><th>instance</th>
2210         <td class="description">Instance name or <code>NULL</code></td></tr>
2211 <tr><th>num_dests</th>
2212         <td class="description">Number of destinations</td></tr>
2213 <tr><th>dests</th>
2214         <td class="description">Destinations</td></tr>
2215 </tbody></table>
2216 <h4 class="returnvalue">Return Value</h4>
2217         <p class="description">New number of destinations</p>
2218 <h4 class="discussion">Discussion</h4>
2219         <p class="discussion">Removing a destination/instance does not delete the class or printer
2220 queue, merely the lpoptions for that destination/instance.  Use the
2221 <a href="#cupsSetDests"><code>cupsSetDests</code></a> or <a href="#cupsSetDests2"><code>cupsSetDests2</code></a> functions to save the new
2222 options for the user.
2223
2224 </p>
2225 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="cupsRemoveOption">cupsRemoveOption</a></h3>
2226         <p class="description">Remove an option from an option array.</p>
2227 <p class="code">
2228 int cupsRemoveOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p>
2229 <h4 class="parameters">Parameters</h4>
2230 <table class="list"><tbody>
2231 <tr><th>name</th>
2232         <td class="description">Option name</td></tr>
2233 <tr><th>num_options</th>
2234         <td class="description">Current number of options</td></tr>
2235 <tr><th>options</th>
2236         <td class="description">Options</td></tr>
2237 </tbody></table>
2238 <h4 class="returnvalue">Return Value</h4>
2239         <p class="description">New number of options</p>
2240 <h3 class="function"><a id="cupsServer">cupsServer</a></h3>
2241         <p class="description">Return the hostname/address of the current server.</p>
2242 <p class="code">
2243 const char *cupsServer(void);</p>
2244 <h4 class="returnvalue">Return Value</h4>
2245         <p class="description">Server name</p>
2246 <h4 class="discussion">Discussion</h4>
2247         <p class="discussion">The default server comes from the CUPS_SERVER environment variable, then the
2248 ~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not
2249 set, the default is the local system - either &quot;localhost&quot; or a domain socket
2250 path.<br>
2251 <br>
2252 The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6
2253 address, or a domain socket pathname.<br>
2254 <br>
2255 Note: The current server is tracked separately for each thread in a program.
2256 Multi-threaded programs that override the server via the
2257 <a href="#cupsSetServer"><code>cupsSetServer</code></a> function need to do so in each thread for the same
2258 server to be used.</p>
2259 <h3 class="function"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span><a id="cupsSetClientCertCB">cupsSetClientCertCB</a></h3>
2260         <p class="description">Set the client certificate callback.</p>
2261 <p class="code">
2262 void cupsSetClientCertCB(<a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a> cb, void *user_data);</p>
2263 <h4 class="parameters">Parameters</h4>
2264 <table class="list"><tbody>
2265 <tr><th>cb</th>
2266         <td class="description">Callback function</td></tr>
2267 <tr><th>user_data</th>
2268         <td class="description">User data pointer</td></tr>
2269 </tbody></table>
2270 <h4 class="discussion">Discussion</h4>
2271         <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br>
2272 <br>
2273 Note: The current certificate callback is tracked separately for each thread
2274 in a program. Multi-threaded programs that override the callback need to do
2275 so in each thread for the same callback to be used.
2276
2277 </p>
2278 <h3 class="function"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span><a id="cupsSetCredentials">cupsSetCredentials</a></h3>
2279         <p class="description">Set the default credentials to be used for SSL/TLS
2280 connections.</p>
2281 <p class="code">
2282 int cupsSetCredentials(cups_array_t *credentials);</p>
2283 <h4 class="parameters">Parameters</h4>
2284 <table class="list"><tbody>
2285 <tr><th>credentials</th>
2286         <td class="description">Array of credentials</td></tr>
2287 </tbody></table>
2288 <h4 class="returnvalue">Return Value</h4>
2289         <p class="description">Status of call (0 = success)</p>
2290 <h4 class="discussion">Discussion</h4>
2291         <p class="discussion">Note: The default credentials are tracked separately for each thread in a
2292 program. Multi-threaded programs that override the setting need to do so in
2293 each thread for the same setting to be used.
2294
2295 </p>
2296 <h3 class="function"><span class="info">&#160;CUPS 1.3/macOS 10.5&#160;</span><a id="cupsSetDefaultDest">cupsSetDefaultDest</a></h3>
2297         <p class="description">Set the default destination.</p>
2298 <p class="code">
2299 void cupsSetDefaultDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p>
2300 <h4 class="parameters">Parameters</h4>
2301 <table class="list"><tbody>
2302 <tr><th>name</th>
2303         <td class="description">Destination name</td></tr>
2304 <tr><th>instance</th>
2305         <td class="description">Instance name or <code>NULL</code></td></tr>
2306 <tr><th>num_dests</th>
2307         <td class="description">Number of destinations</td></tr>
2308 <tr><th>dests</th>
2309         <td class="description">Destinations</td></tr>
2310 </tbody></table>
2311 <h3 class="function"><span class="info">&#160;CUPS 1.1.21/macOS 10.4&#160;</span><a id="cupsSetDests2">cupsSetDests2</a></h3>
2312         <p class="description">Save the list of destinations for the specified server.</p>
2313 <p class="code">
2314 int cupsSetDests2(<a href="#http_t">http_t</a> *http, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p>
2315 <h4 class="parameters">Parameters</h4>
2316 <table class="list"><tbody>
2317 <tr><th>http</th>
2318         <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr>
2319 <tr><th>num_dests</th>
2320         <td class="description">Number of destinations</td></tr>
2321 <tr><th>dests</th>
2322         <td class="description">Destinations</td></tr>
2323 </tbody></table>
2324 <h4 class="returnvalue">Return Value</h4>
2325         <p class="description">0 on success, -1 on error</p>
2326 <h4 class="discussion">Discussion</h4>
2327         <p class="discussion">This function saves the destinations to /etc/cups/lpoptions when run
2328 as root and ~/.cups/lpoptions when run as a normal user.
2329
2330 </p>
2331 <h3 class="function"><a id="cupsSetEncryption">cupsSetEncryption</a></h3>
2332         <p class="description">Set the encryption preference.</p>
2333 <p class="code">
2334 void cupsSetEncryption(<a href="#http_encryption_t">http_encryption_t</a> e);</p>
2335 <h4 class="parameters">Parameters</h4>
2336 <table class="list"><tbody>
2337 <tr><th>e</th>
2338         <td class="description">New encryption preference</td></tr>
2339 </tbody></table>
2340 <h4 class="discussion">Discussion</h4>
2341         <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION
2342 environment variable, then the ~/.cups/client.conf file, and finally the
2343 /etc/cups/client.conf file. If not set, the default is
2344 <code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br>
2345 <br>
2346 Note: The current encryption setting is tracked separately for each thread
2347 in a program. Multi-threaded programs that override the setting need to do
2348 so in each thread for the same setting to be used.</p>
2349 <h3 class="function"><span class="info">&#160;CUPS 1.4/macOS 10.6&#160;</span><a id="cupsSetPasswordCB2">cupsSetPasswordCB2</a></h3>
2350         <p class="description">Set the advanced password callback for CUPS.</p>
2351 <p class="code">
2352 void cupsSetPasswordCB2(<a href="#cups_password_cb2_t">cups_password_cb2_t</a> cb, void *user_data);</p>
2353 <h4 class="parameters">Parameters</h4>
2354 <table class="list"><tbody>
2355 <tr><th>cb</th>
2356         <td class="description">Callback function</td></tr>
2357 <tr><th>user_data</th>
2358         <td class="description">User data pointer</td></tr>
2359 </tbody></table>
2360 <h4 class="discussion">Discussion</h4>
2361         <p class="discussion">Pass <code>NULL</code> to restore the default (console) password callback, which
2362 reads the password from the console. Programs should call either this
2363 function or <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a>, as only one callback can be registered
2364 by a program per thread.<br>
2365 <br>
2366 Note: The current password callback is tracked separately for each thread
2367 in a program. Multi-threaded programs that override the callback need to do
2368 so in each thread for the same callback to be used.
2369
2370 </p>
2371 <h3 class="function"><a id="cupsSetServer">cupsSetServer</a></h3>
2372         <p class="description">Set the default server name and port.</p>
2373 <p class="code">
2374 void cupsSetServer(const char *server);</p>
2375 <h4 class="parameters">Parameters</h4>
2376 <table class="list"><tbody>
2377 <tr><th>server</th>
2378         <td class="description">Server name</td></tr>
2379 </tbody></table>
2380 <h4 class="discussion">Discussion</h4>
2381         <p class="discussion">The &quot;server&quot; string can be a fully-qualified hostname, a numeric
2382 IPv4 or IPv6 address, or a domain socket pathname. Hostnames and numeric IP
2383 addresses can be optionally followed by a colon and port number to override
2384 the default port 631, e.g. &quot;hostname:8631&quot;. Pass <code>NULL</code> to restore the
2385 default server name and port.<br>
2386 <br>
2387 Note: The current server is tracked separately for each thread in a program.
2388 Multi-threaded programs that override the server need to do so in each
2389 thread for the same server to be used.</p>
2390 <h3 class="function"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span><a id="cupsSetServerCertCB">cupsSetServerCertCB</a></h3>
2391         <p class="description">Set the server certificate callback.</p>
2392 <p class="code">
2393 void cupsSetServerCertCB(<a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a> cb, void *user_data);</p>
2394 <h4 class="parameters">Parameters</h4>
2395 <table class="list"><tbody>
2396 <tr><th>cb</th>
2397         <td class="description">Callback function</td></tr>
2398 <tr><th>user_data</th>
2399         <td class="description">User data pointer</td></tr>
2400 </tbody></table>
2401 <h4 class="discussion">Discussion</h4>
2402         <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br>
2403 <br>
2404 Note: The current credentials callback is tracked separately for each thread
2405 in a program. Multi-threaded programs that override the callback need to do
2406 so in each thread for the same callback to be used.
2407
2408 </p>
2409 <h3 class="function"><span class="info">&#160;CUPS 2.0/macOS 10.10&#160;</span><a id="cupsSetServerCredentials">cupsSetServerCredentials</a></h3>
2410         <p class="description">Set the default server credentials.</p>
2411 <p class="code">
2412 int cupsSetServerCredentials(const char *path, const char *common_name, int auto_create);</p>
2413 <h4 class="parameters">Parameters</h4>
2414 <table class="list"><tbody>
2415 <tr><th>path</th>
2416         <td class="description">Keychain path or <code>NULL</code> for default</td></tr>
2417 <tr><th>common_name</th>
2418         <td class="description">Default common name for server</td></tr>
2419 <tr><th>auto_create</th>
2420         <td class="description">1 = automatically create self-signed certificates</td></tr>
2421 </tbody></table>
2422 <h4 class="returnvalue">Return Value</h4>
2423         <p class="description">1 on success, 0 on failure</p>
2424 <h4 class="discussion">Discussion</h4>
2425         <p class="discussion">Note: The server credentials are used by all threads in the running process.
2426 This function is threadsafe.
2427
2428 </p>
2429 <h3 class="function"><a id="cupsSetUser">cupsSetUser</a></h3>
2430         <p class="description">Set the default user name.</p>
2431 <p class="code">
2432 void cupsSetUser(const char *user);</p>
2433 <h4 class="parameters">Parameters</h4>
2434 <table class="list"><tbody>
2435 <tr><th>user</th>
2436         <td class="description">User name</td></tr>
2437 </tbody></table>
2438 <h4 class="discussion">Discussion</h4>
2439         <p class="discussion">Pass <code>NULL</code> to restore the default user name.<br>
2440 <br>
2441 Note: The current user name is tracked separately for each thread in a
2442 program. Multi-threaded programs that override the user name need to do so
2443 in each thread for the same user name to be used.</p>
2444 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="cupsSetUserAgent">cupsSetUserAgent</a></h3>
2445         <p class="description">Set the default HTTP User-Agent string.</p>
2446 <p class="code">
2447 void cupsSetUserAgent(const char *user_agent);</p>
2448 <h4 class="parameters">Parameters</h4>
2449 <table class="list"><tbody>
2450 <tr><th>user_agent</th>
2451         <td class="description">User-Agent string or <code>NULL</code></td></tr>
2452 </tbody></table>
2453 <h4 class="discussion">Discussion</h4>
2454         <p class="discussion">Setting the string to NULL forces the default value containing the CUPS
2455 version, IPP version, and operating system version and architecture.
2456
2457 </p>
2458 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cupsStartDestDocument">cupsStartDestDocument</a></h3>
2459         <p class="description">Start a new document.</p>
2460 <p class="code">
2461 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>
2462 <h4 class="parameters">Parameters</h4>
2463 <table class="list"><tbody>
2464 <tr><th>http</th>
2465         <td class="description">Connection to destination</td></tr>
2466 <tr><th>dest</th>
2467         <td class="description">Destination</td></tr>
2468 <tr><th>info</th>
2469         <td class="description">Destination information</td></tr>
2470 <tr><th>job_id</th>
2471         <td class="description">Job ID</td></tr>
2472 <tr><th>docname</th>
2473         <td class="description">Document name</td></tr>
2474 <tr><th>format</th>
2475         <td class="description">Document format</td></tr>
2476 <tr><th>num_options</th>
2477         <td class="description">Number of document options</td></tr>
2478 <tr><th>options</th>
2479         <td class="description">Document options</td></tr>
2480 <tr><th>last_document</th>
2481         <td class="description">1 if this is the last document</td></tr>
2482 </tbody></table>
2483 <h4 class="returnvalue">Return Value</h4>
2484         <p class="description">Status of document creation</p>
2485 <h4 class="discussion">Discussion</h4>
2486         <p class="discussion">&quot;job_id&quot; is the job ID returned by cupsCreateDestJob.  &quot;docname&quot; is the name
2487 of the document/file being printed, &quot;format&quot; is the MIME media type for the
2488 document (see CUPS_FORMAT_xxx constants), and &quot;num_options&quot; and &quot;options&quot;
2489 are the options do be applied to the document. &quot;last_document&quot; should be 1
2490 if this is the last document to be submitted in the job.  Returns
2491 <code>HTTP_CONTINUE</code> on success.
2492
2493 </p>
2494 <h3 class="function"><a id="cupsUser">cupsUser</a></h3>
2495         <p class="description">Return the current user's name.</p>
2496 <p class="code">
2497 const char *cupsUser(void);</p>
2498 <h4 class="returnvalue">Return Value</h4>
2499         <p class="description">User name</p>
2500 <h4 class="discussion">Discussion</h4>
2501         <p class="discussion">Note: The current user name is tracked separately for each thread in a
2502 program. Multi-threaded programs that override the user name with the
2503 <a href="#cupsSetUser"><code>cupsSetUser</code></a> function need to do so in each thread for the same user
2504 name to be used.</p>
2505 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="cupsUserAgent">cupsUserAgent</a></h3>
2506         <p class="description">Return the default HTTP User-Agent string.</p>
2507 <p class="code">
2508 const char *cupsUserAgent(void);</p>
2509 <h4 class="returnvalue">Return Value</h4>
2510         <p class="description">User-Agent string</p>
2511 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpAcceptConnection">httpAcceptConnection</a></h3>
2512         <p class="description">Accept a new HTTP client connection from the
2513 specified listening socket.</p>
2514 <p class="code">
2515 <a href="#http_t">http_t</a> *httpAcceptConnection(int fd, int blocking);</p>
2516 <h4 class="parameters">Parameters</h4>
2517 <table class="list"><tbody>
2518 <tr><th>fd</th>
2519         <td class="description">Listen socket file descriptor</td></tr>
2520 <tr><th>blocking</th>
2521         <td class="description">1 if the connection should be
2522 blocking, 0 otherwise</td></tr>
2523 </tbody></table>
2524 <h4 class="returnvalue">Return Value</h4>
2525         <p class="description">HTTP connection or <code>NULL</code></p>
2526 <h3 class="function"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span><a id="httpAddCredential">httpAddCredential</a></h3>
2527         <p class="description">Allocates and adds a single credential to an array.</p>
2528 <p class="code">
2529 int httpAddCredential(cups_array_t *credentials, const void *data, size_t datalen);</p>
2530 <h4 class="parameters">Parameters</h4>
2531 <table class="list"><tbody>
2532 <tr><th>credentials</th>
2533         <td class="description">Credentials array</td></tr>
2534 <tr><th>data</th>
2535         <td class="description">PEM-encoded X.509 data</td></tr>
2536 <tr><th>datalen</th>
2537         <td class="description">Length of data</td></tr>
2538 </tbody></table>
2539 <h4 class="returnvalue">Return Value</h4>
2540         <p class="description">0 on success, -1 on error</p>
2541 <h4 class="discussion">Discussion</h4>
2542         <p class="discussion">Use <code>cupsArrayNew(NULL, NULL)</code> to create a credentials array.
2543
2544 </p>
2545 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAddrAny">httpAddrAny</a></h3>
2546         <p class="description">Check for the &quot;any&quot; address.</p>
2547 <p class="code">
2548 int httpAddrAny(const <a href="#http_addr_t">http_addr_t</a> *addr);</p>
2549 <h4 class="parameters">Parameters</h4>
2550 <table class="list"><tbody>
2551 <tr><th>addr</th>
2552         <td class="description">Address to check</td></tr>
2553 </tbody></table>
2554 <h4 class="returnvalue">Return Value</h4>
2555         <p class="description">1 if &quot;any&quot;, 0 otherwise</p>
2556 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpAddrClose">httpAddrClose</a></h3>
2557         <p class="description">Close a socket created by <a href="#httpAddrConnect"><code>httpAddrConnect</code></a> or
2558 <a href="#httpAddrListen"><code>httpAddrListen</code></a>.</p>
2559 <p class="code">
2560 int httpAddrClose(<a href="#http_addr_t">http_addr_t</a> *addr, int fd);</p>
2561 <h4 class="parameters">Parameters</h4>
2562 <table class="list"><tbody>
2563 <tr><th>addr</th>
2564         <td class="description">Listen address or <code>NULL</code></td></tr>
2565 <tr><th>fd</th>
2566         <td class="description">Socket file descriptor</td></tr>
2567 </tbody></table>
2568 <h4 class="returnvalue">Return Value</h4>
2569         <p class="description">0 on success, -1 on failure</p>
2570 <h4 class="discussion">Discussion</h4>
2571         <p class="discussion">Pass <code>NULL</code> for sockets created with <a href="#httpAddrConnect2"><code>httpAddrConnect2</code></a> and the
2572 listen address for sockets created with <a href="#httpAddrListen"><code>httpAddrListen</code></a>.  This function
2573 ensures that domain sockets are removed when closed.
2574
2575 </p>
2576 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpAddrConnect2">httpAddrConnect2</a></h3>
2577         <p class="description">Connect to any of the addresses in the list with a
2578 timeout and optional cancel.</p>
2579 <p class="code">
2580 <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>
2581 <h4 class="parameters">Parameters</h4>
2582 <table class="list"><tbody>
2583 <tr><th>addrlist</th>
2584         <td class="description">List of potential addresses</td></tr>
2585 <tr><th>sock</th>
2586         <td class="description">Socket</td></tr>
2587 <tr><th>msec</th>
2588         <td class="description">Timeout in milliseconds</td></tr>
2589 <tr><th>cancel</th>
2590         <td class="description">Pointer to &quot;cancel&quot; variable</td></tr>
2591 </tbody></table>
2592 <h4 class="returnvalue">Return Value</h4>
2593         <p class="description">Connected address or NULL on failure</p>
2594 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpAddrCopyList">httpAddrCopyList</a></h3>
2595         <p class="description">Copy an address list.</p>
2596 <p class="code">
2597 <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrCopyList(<a href="#http_addrlist_t">http_addrlist_t</a> *src);</p>
2598 <h4 class="parameters">Parameters</h4>
2599 <table class="list"><tbody>
2600 <tr><th>src</th>
2601         <td class="description">Source address list</td></tr>
2602 </tbody></table>
2603 <h4 class="returnvalue">Return Value</h4>
2604         <p class="description">New address list or <code>NULL</code> on error</p>
2605 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAddrEqual">httpAddrEqual</a></h3>
2606         <p class="description">Compare two addresses.</p>
2607 <p class="code">
2608 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>
2609 <h4 class="parameters">Parameters</h4>
2610 <table class="list"><tbody>
2611 <tr><th>addr1</th>
2612         <td class="description">First address</td></tr>
2613 <tr><th>addr2</th>
2614         <td class="description">Second address</td></tr>
2615 </tbody></table>
2616 <h4 class="returnvalue">Return Value</h4>
2617         <p class="description">1 if equal, 0 if not</p>
2618 <h3 class="function"><a id="httpAddrFamily">httpAddrFamily</a></h3>
2619         <p class="description">Get the address family of an address.</p>
2620 <p class="code">
2621 int httpAddrFamily(<a href="#http_addr_t">http_addr_t</a> *addr);</p>
2622 <h4 class="parameters">Parameters</h4>
2623 <table class="list"><tbody>
2624 <tr><th>addr</th>
2625         <td class="description">Address</td></tr>
2626 </tbody></table>
2627 <h4 class="returnvalue">Return Value</h4>
2628         <p class="description">Address family</p>
2629 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAddrFreeList">httpAddrFreeList</a></h3>
2630         <p class="description">Free an address list.</p>
2631 <p class="code">
2632 void httpAddrFreeList(<a href="#http_addrlist_t">http_addrlist_t</a> *addrlist);</p>
2633 <h4 class="parameters">Parameters</h4>
2634 <table class="list"><tbody>
2635 <tr><th>addrlist</th>
2636         <td class="description">Address list to free</td></tr>
2637 </tbody></table>
2638 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAddrGetList">httpAddrGetList</a></h3>
2639         <p class="description">Get a list of addresses for a hostname.</p>
2640 <p class="code">
2641 <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrGetList(const char *hostname, int family, const char *service);</p>
2642 <h4 class="parameters">Parameters</h4>
2643 <table class="list"><tbody>
2644 <tr><th>hostname</th>
2645         <td class="description">Hostname, IP address, or NULL for passive listen address</td></tr>
2646 <tr><th>family</th>
2647         <td class="description">Address family or AF_UNSPEC</td></tr>
2648 <tr><th>service</th>
2649         <td class="description">Service name or port number</td></tr>
2650 </tbody></table>
2651 <h4 class="returnvalue">Return Value</h4>
2652         <p class="description">List of addresses or NULL</p>
2653 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAddrLength">httpAddrLength</a></h3>
2654         <p class="description">Return the length of the address in bytes.</p>
2655 <p class="code">
2656 int httpAddrLength(const <a href="#http_addr_t">http_addr_t</a> *addr);</p>
2657 <h4 class="parameters">Parameters</h4>
2658 <table class="list"><tbody>
2659 <tr><th>addr</th>
2660         <td class="description">Address</td></tr>
2661 </tbody></table>
2662 <h4 class="returnvalue">Return Value</h4>
2663         <p class="description">Length in bytes</p>
2664 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpAddrListen">httpAddrListen</a></h3>
2665         <p class="description">Create a listening socket bound to the specified
2666 address and port.</p>
2667 <p class="code">
2668 int httpAddrListen(<a href="#http_addr_t">http_addr_t</a> *addr, int port);</p>
2669 <h4 class="parameters">Parameters</h4>
2670 <table class="list"><tbody>
2671 <tr><th>addr</th>
2672         <td class="description">Address to bind to</td></tr>
2673 <tr><th>port</th>
2674         <td class="description">Port number to bind to</td></tr>
2675 </tbody></table>
2676 <h4 class="returnvalue">Return Value</h4>
2677         <p class="description">Socket or -1 on error</p>
2678 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAddrLocalhost">httpAddrLocalhost</a></h3>
2679         <p class="description">Check for the local loopback address.</p>
2680 <p class="code">
2681 int httpAddrLocalhost(const <a href="#http_addr_t">http_addr_t</a> *addr);</p>
2682 <h4 class="parameters">Parameters</h4>
2683 <table class="list"><tbody>
2684 <tr><th>addr</th>
2685         <td class="description">Address to check</td></tr>
2686 </tbody></table>
2687 <h4 class="returnvalue">Return Value</h4>
2688         <p class="description">1 if local host, 0 otherwise</p>
2689 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAddrLookup">httpAddrLookup</a></h3>
2690         <p class="description">Lookup the hostname associated with the address.</p>
2691 <p class="code">
2692 char *httpAddrLookup(const <a href="#http_addr_t">http_addr_t</a> *addr, char *name, int namelen);</p>
2693 <h4 class="parameters">Parameters</h4>
2694 <table class="list"><tbody>
2695 <tr><th>addr</th>
2696         <td class="description">Address to lookup</td></tr>
2697 <tr><th>name</th>
2698         <td class="description">Host name buffer</td></tr>
2699 <tr><th>namelen</th>
2700         <td class="description">Size of name buffer</td></tr>
2701 </tbody></table>
2702 <h4 class="returnvalue">Return Value</h4>
2703         <p class="description">Host name</p>
2704 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpAddrPort">httpAddrPort</a></h3>
2705         <p class="description">Get the port number associated with an address.</p>
2706 <p class="code">
2707 int httpAddrPort(<a href="#http_addr_t">http_addr_t</a> *addr);</p>
2708 <h4 class="parameters">Parameters</h4>
2709 <table class="list"><tbody>
2710 <tr><th>addr</th>
2711         <td class="description">Address</td></tr>
2712 </tbody></table>
2713 <h4 class="returnvalue">Return Value</h4>
2714         <p class="description">Port number</p>
2715 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAddrString">httpAddrString</a></h3>
2716         <p class="description">Convert an address to a numeric string.</p>
2717 <p class="code">
2718 char *httpAddrString(const <a href="#http_addr_t">http_addr_t</a> *addr, char *s, int slen);</p>
2719 <h4 class="parameters">Parameters</h4>
2720 <table class="list"><tbody>
2721 <tr><th>addr</th>
2722         <td class="description">Address to convert</td></tr>
2723 <tr><th>s</th>
2724         <td class="description">String buffer</td></tr>
2725 <tr><th>slen</th>
2726         <td class="description">Length of string</td></tr>
2727 </tbody></table>
2728 <h4 class="returnvalue">Return Value</h4>
2729         <p class="description">Numeric address string</p>
2730 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAssembleURI">httpAssembleURI</a></h3>
2731         <p class="description">Assemble a uniform resource identifier from its
2732 components.</p>
2733 <p class="code">
2734 <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>
2735 <h4 class="parameters">Parameters</h4>
2736 <table class="list"><tbody>
2737 <tr><th>encoding</th>
2738         <td class="description">Encoding flags</td></tr>
2739 <tr><th>uri</th>
2740         <td class="description">URI buffer</td></tr>
2741 <tr><th>urilen</th>
2742         <td class="description">Size of URI buffer</td></tr>
2743 <tr><th>scheme</th>
2744         <td class="description">Scheme name</td></tr>
2745 <tr><th>username</th>
2746         <td class="description">Username</td></tr>
2747 <tr><th>host</th>
2748         <td class="description">Hostname or address</td></tr>
2749 <tr><th>port</th>
2750         <td class="description">Port number</td></tr>
2751 <tr><th>resource</th>
2752         <td class="description">Resource</td></tr>
2753 </tbody></table>
2754 <h4 class="returnvalue">Return Value</h4>
2755         <p class="description">URI status</p>
2756 <h4 class="discussion">Discussion</h4>
2757         <p class="discussion">This function escapes reserved characters in the URI depending on the
2758 value of the &quot;encoding&quot; argument.  You should use this function in
2759 place of traditional string functions whenever you need to create a
2760 URI string.
2761
2762 </p>
2763 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpAssembleURIf">httpAssembleURIf</a></h3>
2764         <p class="description">Assemble a uniform resource identifier from its
2765 components with a formatted resource.</p>
2766 <p class="code">
2767 <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>
2768 <h4 class="parameters">Parameters</h4>
2769 <table class="list"><tbody>
2770 <tr><th>encoding</th>
2771         <td class="description">Encoding flags</td></tr>
2772 <tr><th>uri</th>
2773         <td class="description">URI buffer</td></tr>
2774 <tr><th>urilen</th>
2775         <td class="description">Size of URI buffer</td></tr>
2776 <tr><th>scheme</th>
2777         <td class="description">Scheme name</td></tr>
2778 <tr><th>username</th>
2779         <td class="description">Username</td></tr>
2780 <tr><th>host</th>
2781         <td class="description">Hostname or address</td></tr>
2782 <tr><th>port</th>
2783         <td class="description">Port number</td></tr>
2784 <tr><th>resourcef</th>
2785         <td class="description">Printf-style resource</td></tr>
2786 <tr><th>...</th>
2787         <td class="description">Additional arguments as needed</td></tr>
2788 </tbody></table>
2789 <h4 class="returnvalue">Return Value</h4>
2790         <p class="description">URI status</p>
2791 <h4 class="discussion">Discussion</h4>
2792         <p class="discussion">This function creates a formatted version of the resource string
2793 argument &quot;resourcef&quot; and escapes reserved characters in the URI
2794 depending on the value of the &quot;encoding&quot; argument.  You should use
2795 this function in place of traditional string functions whenever
2796 you need to create a URI string.
2797
2798 </p>
2799 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpAssembleUUID">httpAssembleUUID</a></h3>
2800         <p class="description">Assemble a name-based UUID URN conforming to RFC 4122.</p>
2801 <p class="code">
2802 char *httpAssembleUUID(const char *server, int port, const char *name, int number, char *buffer, size_t bufsize);</p>
2803 <h4 class="parameters">Parameters</h4>
2804 <table class="list"><tbody>
2805 <tr><th>server</th>
2806         <td class="description">Server name</td></tr>
2807 <tr><th>port</th>
2808         <td class="description">Port number</td></tr>
2809 <tr><th>name</th>
2810         <td class="description">Object name or NULL</td></tr>
2811 <tr><th>number</th>
2812         <td class="description">Object number or 0</td></tr>
2813 <tr><th>buffer</th>
2814         <td class="description">String buffer</td></tr>
2815 <tr><th>bufsize</th>
2816         <td class="description">Size of buffer</td></tr>
2817 </tbody></table>
2818 <h4 class="returnvalue">Return Value</h4>
2819         <p class="description">UUID string</p>
2820 <h4 class="discussion">Discussion</h4>
2821         <p class="discussion">This function creates a unique 128-bit identifying number using the server
2822 name, port number, random data, and optionally an object name and/or object
2823 number.  The result is formatted as a UUID URN as defined in RFC 4122.<br>
2824 <br>
2825 The buffer needs to be at least 46 bytes in size.
2826
2827 </p>
2828 <h3 class="function"><a id="httpBlocking">httpBlocking</a></h3>
2829         <p class="description">Set blocking/non-blocking behavior on a connection.</p>
2830 <p class="code">
2831 void httpBlocking(<a href="#http_t">http_t</a> *http, int b);</p>
2832 <h4 class="parameters">Parameters</h4>
2833 <table class="list"><tbody>
2834 <tr><th>http</th>
2835         <td class="description">HTTP connection</td></tr>
2836 <tr><th>b</th>
2837         <td class="description">1 = blocking, 0 = non-blocking</td></tr>
2838 </tbody></table>
2839 <h3 class="function"><a id="httpCheck">httpCheck</a></h3>
2840         <p class="description">Check to see if there is a pending response from the server.</p>
2841 <p class="code">
2842 int httpCheck(<a href="#http_t">http_t</a> *http);</p>
2843 <h4 class="parameters">Parameters</h4>
2844 <table class="list"><tbody>
2845 <tr><th>http</th>
2846         <td class="description">HTTP connection</td></tr>
2847 </tbody></table>
2848 <h4 class="returnvalue">Return Value</h4>
2849         <p class="description">0 = no data, 1 = data available</p>
2850 <h3 class="function"><span class="info">&#160;CUPS 1.1.19/macOS 10.3&#160;</span><a id="httpClearCookie">httpClearCookie</a></h3>
2851         <p class="description">Clear the cookie value(s).</p>
2852 <p class="code">
2853 void httpClearCookie(<a href="#http_t">http_t</a> *http);</p>
2854 <h4 class="parameters">Parameters</h4>
2855 <table class="list"><tbody>
2856 <tr><th>http</th>
2857         <td class="description">HTTP connection</td></tr>
2858 </tbody></table>
2859 <h3 class="function"><a id="httpClearFields">httpClearFields</a></h3>
2860         <p class="description">Clear HTTP request fields.</p>
2861 <p class="code">
2862 void httpClearFields(<a href="#http_t">http_t</a> *http);</p>
2863 <h4 class="parameters">Parameters</h4>
2864 <table class="list"><tbody>
2865 <tr><th>http</th>
2866         <td class="description">HTTP connection</td></tr>
2867 </tbody></table>
2868 <h3 class="function"><a id="httpClose">httpClose</a></h3>
2869         <p class="description">Close an HTTP connection.</p>
2870 <p class="code">
2871 void httpClose(<a href="#http_t">http_t</a> *http);</p>
2872 <h4 class="parameters">Parameters</h4>
2873 <table class="list"><tbody>
2874 <tr><th>http</th>
2875         <td class="description">HTTP connection</td></tr>
2876 </tbody></table>
2877 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpCompareCredentials">httpCompareCredentials</a></h3>
2878         <p class="description">Compare two sets of X.509 credentials.</p>
2879 <p class="code">
2880 int httpCompareCredentials(cups_array_t *cred1, cups_array_t *cred2);</p>
2881 <h4 class="parameters">Parameters</h4>
2882 <table class="list"><tbody>
2883 <tr><th>cred1</th>
2884         <td class="description">First set of X.509 credentials</td></tr>
2885 <tr><th>cred2</th>
2886         <td class="description">Second set of X.509 credentials</td></tr>
2887 </tbody></table>
2888 <h4 class="returnvalue">Return Value</h4>
2889         <p class="description">1 if they match, 0 if they do not</p>
2890 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpConnect2">httpConnect2</a></h3>
2891         <p class="description">Connect to a HTTP server.</p>
2892 <p class="code">
2893 <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>
2894 <h4 class="parameters">Parameters</h4>
2895 <table class="list"><tbody>
2896 <tr><th>host</th>
2897         <td class="description">Host to connect to</td></tr>
2898 <tr><th>port</th>
2899         <td class="description">Port number</td></tr>
2900 <tr><th>addrlist</th>
2901         <td class="description">List of addresses or <code>NULL</code> to lookup</td></tr>
2902 <tr><th>family</th>
2903         <td class="description">Address family to use or <code>AF_UNSPEC</code> for any</td></tr>
2904 <tr><th>encryption</th>
2905         <td class="description">Type of encryption to use</td></tr>
2906 <tr><th>blocking</th>
2907         <td class="description">1 for blocking connection, 0 for non-blocking</td></tr>
2908 <tr><th>msec</th>
2909         <td class="description">Connection timeout in milliseconds, 0 means don't connect</td></tr>
2910 <tr><th>cancel</th>
2911         <td class="description">Pointer to &quot;cancel&quot; variable</td></tr>
2912 </tbody></table>
2913 <h4 class="returnvalue">Return Value</h4>
2914         <p class="description">New HTTP connection</p>
2915 <h3 class="function"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span><a id="httpCopyCredentials">httpCopyCredentials</a></h3>
2916         <p class="description">Copy the credentials associated with the peer in
2917 an encrypted connection.</p>
2918 <p class="code">
2919 int httpCopyCredentials(<a href="#http_t">http_t</a> *http, cups_array_t **credentials);</p>
2920 <h4 class="parameters">Parameters</h4>
2921 <table class="list"><tbody>
2922 <tr><th>http</th>
2923         <td class="description">Connection to server</td></tr>
2924 <tr><th>credentials</th>
2925         <td class="description">Array of credentials</td></tr>
2926 </tbody></table>
2927 <h4 class="returnvalue">Return Value</h4>
2928         <p class="description">Status of call (0 = success)</p>
2929 <h3 class="function"><span class="info">&#160;CUPS 2.0/macOS 10.10&#160;</span><a id="httpCredentialsAreValidForName">httpCredentialsAreValidForName</a></h3>
2930         <p class="description">Return whether the credentials are valid for the given name.</p>
2931 <p class="code">
2932 int httpCredentialsAreValidForName(cups_array_t *credentials, const char *common_name);</p>
2933 <h4 class="parameters">Parameters</h4>
2934 <table class="list"><tbody>
2935 <tr><th>credentials</th>
2936         <td class="description">Credentials</td></tr>
2937 <tr><th>common_name</th>
2938         <td class="description">Name to check</td></tr>
2939 </tbody></table>
2940 <h4 class="returnvalue">Return Value</h4>
2941         <p class="description">1 if valid, 0 otherwise</p>
2942 <h3 class="function"><span class="info">&#160;CUPS 2.0/macOS 10.10&#160;</span><a id="httpCredentialsGetExpiration">httpCredentialsGetExpiration</a></h3>
2943         <p class="description">Return the expiration date of the credentials.</p>
2944 <p class="code">
2945 time_t httpCredentialsGetExpiration(cups_array_t *credentials);</p>
2946 <h4 class="parameters">Parameters</h4>
2947 <table class="list"><tbody>
2948 <tr><th>credentials</th>
2949         <td class="description">Credentials</td></tr>
2950 </tbody></table>
2951 <h4 class="returnvalue">Return Value</h4>
2952         <p class="description">Expiration date of credentials</p>
2953 <h3 class="function"><span class="info">&#160;CUPS 2.0/macOS 10.10&#160;</span><a id="httpCredentialsGetTrust">httpCredentialsGetTrust</a></h3>
2954         <p class="description">Return the trust of credentials.</p>
2955 <p class="code">
2956 <a href="#http_trust_t">http_trust_t</a> httpCredentialsGetTrust(cups_array_t *credentials, const char *common_name);</p>
2957 <h4 class="parameters">Parameters</h4>
2958 <table class="list"><tbody>
2959 <tr><th>credentials</th>
2960         <td class="description">Credentials</td></tr>
2961 <tr><th>common_name</th>
2962         <td class="description">Common name for trust lookup</td></tr>
2963 </tbody></table>
2964 <h4 class="returnvalue">Return Value</h4>
2965         <p class="description">Level of trust</p>
2966 <h3 class="function"><span class="info">&#160;CUPS 2.0/macOS 10.10&#160;</span><a id="httpCredentialsString">httpCredentialsString</a></h3>
2967         <p class="description">Return a string representing the credentials.</p>
2968 <p class="code">
2969 size_t httpCredentialsString(cups_array_t *credentials, char *buffer, size_t bufsize);</p>
2970 <h4 class="parameters">Parameters</h4>
2971 <table class="list"><tbody>
2972 <tr><th>credentials</th>
2973         <td class="description">Credentials</td></tr>
2974 <tr><th>buffer</th>
2975         <td class="description">Buffer or <code>NULL</code></td></tr>
2976 <tr><th>bufsize</th>
2977         <td class="description">Size of buffer</td></tr>
2978 </tbody></table>
2979 <h4 class="returnvalue">Return Value</h4>
2980         <p class="description">Total size of credentials string</p>
2981 <h3 class="function"><span class="info">&#160;CUPS 1.1.21/macOS 10.4&#160;</span><a id="httpDecode64_2">httpDecode64_2</a></h3>
2982         <p class="description">Base64-decode a string.</p>
2983 <p class="code">
2984 char *httpDecode64_2(char *out, int *outlen, const char *in);</p>
2985 <h4 class="parameters">Parameters</h4>
2986 <table class="list"><tbody>
2987 <tr><th>out</th>
2988         <td class="description">String to write to</td></tr>
2989 <tr><th>outlen</th>
2990         <td class="description">Size of output string</td></tr>
2991 <tr><th>in</th>
2992         <td class="description">String to read from</td></tr>
2993 </tbody></table>
2994 <h4 class="returnvalue">Return Value</h4>
2995         <p class="description">Decoded string</p>
2996 <h4 class="discussion">Discussion</h4>
2997         <p class="discussion">The caller must initialize &quot;outlen&quot; to the maximum size of the decoded
2998 string before calling <code>httpDecode64_2</code>.  On return &quot;outlen&quot; contains the
2999 decoded length of the string.
3000
3001 </p>
3002 <h3 class="function"><a id="httpDelete">httpDelete</a></h3>
3003         <p class="description">Send a DELETE request to the server.</p>
3004 <p class="code">
3005 int httpDelete(<a href="#http_t">http_t</a> *http, const char *uri);</p>
3006 <h4 class="parameters">Parameters</h4>
3007 <table class="list"><tbody>
3008 <tr><th>http</th>
3009         <td class="description">HTTP connection</td></tr>
3010 <tr><th>uri</th>
3011         <td class="description">URI to delete</td></tr>
3012 </tbody></table>
3013 <h4 class="returnvalue">Return Value</h4>
3014         <p class="description">Status of call (0 = success)</p>
3015 <h3 class="function"><span class="info">&#160;CUPS 1.1.21/macOS 10.4&#160;</span><a id="httpEncode64_2">httpEncode64_2</a></h3>
3016         <p class="description">Base64-encode a string.</p>
3017 <p class="code">
3018 char *httpEncode64_2(char *out, int outlen, const char *in, int inlen);</p>
3019 <h4 class="parameters">Parameters</h4>
3020 <table class="list"><tbody>
3021 <tr><th>out</th>
3022         <td class="description">String to write to</td></tr>
3023 <tr><th>outlen</th>
3024         <td class="description">Maximum size of output string</td></tr>
3025 <tr><th>in</th>
3026         <td class="description">String to read from</td></tr>
3027 <tr><th>inlen</th>
3028         <td class="description">Size of input string</td></tr>
3029 </tbody></table>
3030 <h4 class="returnvalue">Return Value</h4>
3031         <p class="description">Encoded string</p>
3032 <h3 class="function"><a id="httpEncryption">httpEncryption</a></h3>
3033         <p class="description">Set the required encryption on the link.</p>
3034 <p class="code">
3035 int httpEncryption(<a href="#http_t">http_t</a> *http, <a href="#http_encryption_t">http_encryption_t</a> e);</p>
3036 <h4 class="parameters">Parameters</h4>
3037 <table class="list"><tbody>
3038 <tr><th>http</th>
3039         <td class="description">HTTP connection</td></tr>
3040 <tr><th>e</th>
3041         <td class="description">New encryption preference</td></tr>
3042 </tbody></table>
3043 <h4 class="returnvalue">Return Value</h4>
3044         <p class="description">-1 on error, 0 on success</p>
3045 <h3 class="function"><a id="httpError">httpError</a></h3>
3046         <p class="description">Get the last error on a connection.</p>
3047 <p class="code">
3048 int httpError(<a href="#http_t">http_t</a> *http);</p>
3049 <h4 class="parameters">Parameters</h4>
3050 <table class="list"><tbody>
3051 <tr><th>http</th>
3052         <td class="description">HTTP connection</td></tr>
3053 </tbody></table>
3054 <h4 class="returnvalue">Return Value</h4>
3055         <p class="description">Error code (errno) value</p>
3056 <h3 class="function"><a id="httpFieldValue">httpFieldValue</a></h3>
3057         <p class="description">Return the HTTP field enumeration value for a field
3058 name.</p>
3059 <p class="code">
3060 <a href="#http_field_t">http_field_t</a> httpFieldValue(const char *name);</p>
3061 <h4 class="parameters">Parameters</h4>
3062 <table class="list"><tbody>
3063 <tr><th>name</th>
3064         <td class="description">String name</td></tr>
3065 </tbody></table>
3066 <h4 class="returnvalue">Return Value</h4>
3067         <p class="description">Field index</p>
3068 <h3 class="function"><a id="httpFlush">httpFlush</a></h3>
3069         <p class="description">Flush data read from a HTTP connection.</p>
3070 <p class="code">
3071 void httpFlush(<a href="#http_t">http_t</a> *http);</p>
3072 <h4 class="parameters">Parameters</h4>
3073 <table class="list"><tbody>
3074 <tr><th>http</th>
3075         <td class="description">HTTP connection</td></tr>
3076 </tbody></table>
3077 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpFlushWrite">httpFlushWrite</a></h3>
3078         <p class="description">Flush data written to a HTTP connection.</p>
3079 <p class="code">
3080 int httpFlushWrite(<a href="#http_t">http_t</a> *http);</p>
3081 <h4 class="parameters">Parameters</h4>
3082 <table class="list"><tbody>
3083 <tr><th>http</th>
3084         <td class="description">HTTP connection</td></tr>
3085 </tbody></table>
3086 <h4 class="returnvalue">Return Value</h4>
3087         <p class="description">Bytes written or -1 on error</p>
3088 <h3 class="function"><a id="httpFreeCredentials">httpFreeCredentials</a></h3>
3089         <p class="description">Free an array of credentials.</p>
3090 <p class="code">
3091 void httpFreeCredentials(cups_array_t *credentials);</p>
3092 <h4 class="parameters">Parameters</h4>
3093 <table class="list"><tbody>
3094 <tr><th>credentials</th>
3095         <td class="description">Array of credentials</td></tr>
3096 </tbody></table>
3097 <h3 class="function"><a id="httpGet">httpGet</a></h3>
3098         <p class="description">Send a GET request to the server.</p>
3099 <p class="code">
3100 int httpGet(<a href="#http_t">http_t</a> *http, const char *uri);</p>
3101 <h4 class="parameters">Parameters</h4>
3102 <table class="list"><tbody>
3103 <tr><th>http</th>
3104         <td class="description">HTTP connection</td></tr>
3105 <tr><th>uri</th>
3106         <td class="description">URI to get</td></tr>
3107 </tbody></table>
3108 <h4 class="returnvalue">Return Value</h4>
3109         <p class="description">Status of call (0 = success)</p>
3110 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpGetActivity">httpGetActivity</a></h3>
3111         <p class="description">Get the most recent activity for a connection.</p>
3112 <p class="code">
3113 time_t httpGetActivity(<a href="#http_t">http_t</a> *http);</p>
3114 <h4 class="parameters">Parameters</h4>
3115 <table class="list"><tbody>
3116 <tr><th>http</th>
3117         <td class="description">HTTP connection</td></tr>
3118 </tbody></table>
3119 <h4 class="returnvalue">Return Value</h4>
3120         <p class="description">Time of last read or write</p>
3121 <h4 class="discussion">Discussion</h4>
3122         <p class="discussion">The return value is the time in seconds of the last read or write.
3123
3124 </p>
3125 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpGetAddress">httpGetAddress</a></h3>
3126         <p class="description">Get the address of the connected peer of a connection.</p>
3127 <p class="code">
3128 <a href="#http_addr_t">http_addr_t</a> *httpGetAddress(<a href="#http_t">http_t</a> *http);</p>
3129 <h4 class="parameters">Parameters</h4>
3130 <table class="list"><tbody>
3131 <tr><th>http</th>
3132         <td class="description">HTTP connection</td></tr>
3133 </tbody></table>
3134 <h4 class="returnvalue">Return Value</h4>
3135         <p class="description">Connected address or <code>NULL</code></p>
3136 <h4 class="discussion">Discussion</h4>
3137         <p class="discussion">For connections created with <a href="#httpConnect2"><code>httpConnect2</code></a>, the address is for the
3138 server.  For connections created with <a href="#httpAccept"><code>httpAccept</code></a>, the address is for
3139 the client.<br>
3140 <br>
3141 Returns <code>NULL</code> if the socket is currently unconnected.
3142
3143 </p>
3144 <h3 class="function"><span class="info">&#160;CUPS 1.3/macOS 10.5&#160;</span><a id="httpGetAuthString">httpGetAuthString</a></h3>
3145         <p class="description">Get the current authorization string.</p>
3146 <p class="code">
3147 char *httpGetAuthString(<a href="#http_t">http_t</a> *http);</p>
3148 <h4 class="parameters">Parameters</h4>
3149 <table class="list"><tbody>
3150 <tr><th>http</th>
3151         <td class="description">HTTP connection</td></tr>
3152 </tbody></table>
3153 <h4 class="returnvalue">Return Value</h4>
3154         <p class="description">Authorization string</p>
3155 <h4 class="discussion">Discussion</h4>
3156         <p class="discussion">The authorization string is set by <a href="#cupsDoAuthentication"><code>cupsDoAuthentication</code></a> and
3157 <a href="#httpSetAuthString"><code>httpSetAuthString</code></a>.  Use <a href="#httpGetAuthString"><code>httpGetAuthString</code></a> to retrieve the
3158 string to use with <a href="#httpSetField"><code>httpSetField</code></a> for the
3159 <code>HTTP_FIELD_AUTHORIZATION</code> value.
3160
3161 </p>
3162 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpGetBlocking">httpGetBlocking</a></h3>
3163         <p class="description">Get the blocking/non-block state of a connection.</p>
3164 <p class="code">
3165 int httpGetBlocking(<a href="#http_t">http_t</a> *http);</p>
3166 <h4 class="parameters">Parameters</h4>
3167 <table class="list"><tbody>
3168 <tr><th>http</th>
3169         <td class="description">HTTP connection</td></tr>
3170 </tbody></table>
3171 <h4 class="returnvalue">Return Value</h4>
3172         <p class="description">1 if blocking, 0 if non-blocking</p>
3173 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpGetContentEncoding">httpGetContentEncoding</a></h3>
3174         <p class="description">Get a common content encoding, if any, between
3175 the client and server.</p>
3176 <p class="code">
3177 const char *httpGetContentEncoding(<a href="#http_t">http_t</a> *http);</p>
3178 <h4 class="parameters">Parameters</h4>
3179 <table class="list"><tbody>
3180 <tr><th>http</th>
3181         <td class="description">HTTP connection</td></tr>
3182 </tbody></table>
3183 <h4 class="returnvalue">Return Value</h4>
3184         <p class="description">Content-Coding value or
3185 <code>NULL</code> for the identity
3186 coding.</p>
3187 <h4 class="discussion">Discussion</h4>
3188         <p class="discussion">This function uses the value of the Accepts-Encoding HTTP header and must be
3189 called after receiving a response from the server or a request from the
3190 client.  The value returned can be use in subsequent requests (for clients)
3191 or in the response (for servers) in order to compress the content stream.
3192
3193 </p>
3194 <h3 class="function"><span class="info">&#160;CUPS 1.1.19/macOS 10.3&#160;</span><a id="httpGetCookie">httpGetCookie</a></h3>
3195         <p class="description">Get any cookie data from the response.</p>
3196 <p class="code">
3197 const char *httpGetCookie(<a href="#http_t">http_t</a> *http);</p>
3198 <h4 class="parameters">Parameters</h4>
3199 <table class="list"><tbody>
3200 <tr><th>http</th>
3201         <td class="description">HTTP connection</td></tr>
3202 </tbody></table>
3203 <h4 class="returnvalue">Return Value</h4>
3204         <p class="description">Cookie data or <code>NULL</code></p>
3205 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpGetDateString2">httpGetDateString2</a></h3>
3206         <p class="description">Get a formatted date/time string from a time value.</p>
3207 <p class="code">
3208 const char *httpGetDateString2(time_t t, char *s, int slen);</p>
3209 <h4 class="parameters">Parameters</h4>
3210 <table class="list"><tbody>
3211 <tr><th>t</th>
3212         <td class="description">Time in seconds</td></tr>
3213 <tr><th>s</th>
3214         <td class="description">String buffer</td></tr>
3215 <tr><th>slen</th>
3216         <td class="description">Size of string buffer</td></tr>
3217 </tbody></table>
3218 <h4 class="returnvalue">Return Value</h4>
3219         <p class="description">Date/time string</p>
3220 <h3 class="function"><a id="httpGetDateTime">httpGetDateTime</a></h3>
3221         <p class="description">Get a time value from a formatted date/time string.</p>
3222 <p class="code">
3223 time_t httpGetDateTime(const char *s);</p>
3224 <h4 class="parameters">Parameters</h4>
3225 <table class="list"><tbody>
3226 <tr><th>s</th>
3227         <td class="description">Date/time string</td></tr>
3228 </tbody></table>
3229 <h4 class="returnvalue">Return Value</h4>
3230         <p class="description">Time in seconds</p>
3231 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpGetEncryption">httpGetEncryption</a></h3>
3232         <p class="description">Get the current encryption mode of a connection.</p>
3233 <p class="code">
3234 <a href="#http_encryption_t">http_encryption_t</a> httpGetEncryption(<a href="#http_t">http_t</a> *http);</p>
3235 <h4 class="parameters">Parameters</h4>
3236 <table class="list"><tbody>
3237 <tr><th>http</th>
3238         <td class="description">HTTP connection</td></tr>
3239 </tbody></table>
3240 <h4 class="returnvalue">Return Value</h4>
3241         <p class="description">Current encryption mode</p>
3242 <h4 class="discussion">Discussion</h4>
3243         <p class="discussion">This function returns the encryption mode for the connection. Use the
3244 <a href="#httpIsEncrypted"><code>httpIsEncrypted</code></a> function to determine whether a TLS session has
3245 been established.
3246
3247 </p>
3248 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpGetExpect">httpGetExpect</a></h3>
3249         <p class="description">Get the value of the Expect header, if any.</p>
3250 <p class="code">
3251 http_status_t httpGetExpect(<a href="#http_t">http_t</a> *http);</p>
3252 <h4 class="parameters">Parameters</h4>
3253 <table class="list"><tbody>
3254 <tr><th>http</th>
3255         <td class="description">HTTP connection</td></tr>
3256 </tbody></table>
3257 <h4 class="returnvalue">Return Value</h4>
3258         <p class="description">Expect: status, if any</p>
3259 <h4 class="discussion">Discussion</h4>
3260         <p class="discussion">Returns <code>HTTP_STATUS_NONE</code> if there is no Expect header, otherwise
3261 returns the expected HTTP status code, typically <code>HTTP_STATUS_CONTINUE</code>.
3262
3263 </p>
3264 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpGetFd">httpGetFd</a></h3>
3265         <p class="description">Get the file descriptor associated with a connection.</p>
3266 <p class="code">
3267 int httpGetFd(<a href="#http_t">http_t</a> *http);</p>
3268 <h4 class="parameters">Parameters</h4>
3269 <table class="list"><tbody>
3270 <tr><th>http</th>
3271         <td class="description">HTTP connection</td></tr>
3272 </tbody></table>
3273 <h4 class="returnvalue">Return Value</h4>
3274         <p class="description">File descriptor or -1 if none</p>
3275 <h3 class="function"><a id="httpGetField">httpGetField</a></h3>
3276         <p class="description">Get a field value from a request/response.</p>
3277 <p class="code">
3278 const char *httpGetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field);</p>
3279 <h4 class="parameters">Parameters</h4>
3280 <table class="list"><tbody>
3281 <tr><th>http</th>
3282         <td class="description">HTTP connection</td></tr>
3283 <tr><th>field</th>
3284         <td class="description">Field to get</td></tr>
3285 </tbody></table>
3286 <h4 class="returnvalue">Return Value</h4>
3287         <p class="description">Field value</p>
3288 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpGetHostname">httpGetHostname</a></h3>
3289         <p class="description">Get the FQDN for the connection or local system.</p>
3290 <p class="code">
3291 const char *httpGetHostname(<a href="#http_t">http_t</a> *http, char *s, int slen);</p>
3292 <h4 class="parameters">Parameters</h4>
3293 <table class="list"><tbody>
3294 <tr><th>http</th>
3295         <td class="description">HTTP connection or NULL</td></tr>
3296 <tr><th>s</th>
3297         <td class="description">String buffer for name</td></tr>
3298 <tr><th>slen</th>
3299         <td class="description">Size of buffer</td></tr>
3300 </tbody></table>
3301 <h4 class="returnvalue">Return Value</h4>
3302         <p class="description">FQDN for connection or system</p>
3303 <h4 class="discussion">Discussion</h4>
3304         <p class="discussion">When &quot;http&quot; points to a connected socket, return the hostname or
3305 address that was used in the call to httpConnect() or httpConnectEncrypt(),
3306 or the address of the client for the connection from httpAcceptConnection().
3307 Otherwise, return the FQDN for the local system using both gethostname()
3308 and gethostbyname() to get the local hostname with domain.
3309
3310 </p>
3311 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpGetKeepAlive">httpGetKeepAlive</a></h3>
3312         <p class="description">Get the current Keep-Alive state of the connection.</p>
3313 <p class="code">
3314 <a href="#http_keepalive_t">http_keepalive_t</a> httpGetKeepAlive(<a href="#http_t">http_t</a> *http);</p>
3315 <h4 class="parameters">Parameters</h4>
3316 <table class="list"><tbody>
3317 <tr><th>http</th>
3318         <td class="description">HTTP connection</td></tr>
3319 </tbody></table>
3320 <h4 class="returnvalue">Return Value</h4>
3321         <p class="description">Keep-Alive state</p>
3322 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpGetLength2">httpGetLength2</a></h3>
3323         <p class="description">Get the amount of data remaining from the
3324 content-length or transfer-encoding fields.</p>
3325 <p class="code">
3326 off_t httpGetLength2(<a href="#http_t">http_t</a> *http);</p>
3327 <h4 class="parameters">Parameters</h4>
3328 <table class="list"><tbody>
3329 <tr><th>http</th>
3330         <td class="description">HTTP connection</td></tr>
3331 </tbody></table>
3332 <h4 class="returnvalue">Return Value</h4>
3333         <p class="description">Content length</p>
3334 <h4 class="discussion">Discussion</h4>
3335         <p class="discussion">This function returns the complete content length, even for
3336 content larger than 2^31 - 1.
3337
3338 </p>
3339 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpGetPending">httpGetPending</a></h3>
3340         <p class="description">Get the number of bytes that are buffered for writing.</p>
3341 <p class="code">
3342 size_t httpGetPending(<a href="#http_t">http_t</a> *http);</p>
3343 <h4 class="parameters">Parameters</h4>
3344 <table class="list"><tbody>
3345 <tr><th>http</th>
3346         <td class="description">HTTP connection</td></tr>
3347 </tbody></table>
3348 <h4 class="returnvalue">Return Value</h4>
3349         <p class="description">Number of bytes buffered</p>
3350 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpGetReady">httpGetReady</a></h3>
3351         <p class="description">Get the number of bytes that can be read without blocking.</p>
3352 <p class="code">
3353 size_t httpGetReady(<a href="#http_t">http_t</a> *http);</p>
3354 <h4 class="parameters">Parameters</h4>
3355 <table class="list"><tbody>
3356 <tr><th>http</th>
3357         <td class="description">HTTP connection</td></tr>
3358 </tbody></table>
3359 <h4 class="returnvalue">Return Value</h4>
3360         <p class="description">Number of bytes available</p>
3361 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpGetRemaining">httpGetRemaining</a></h3>
3362         <p class="description">Get the number of remaining bytes in the message
3363 body or current chunk.</p>
3364 <p class="code">
3365 size_t httpGetRemaining(<a href="#http_t">http_t</a> *http);</p>
3366 <h4 class="parameters">Parameters</h4>
3367 <table class="list"><tbody>
3368 <tr><th>http</th>
3369         <td class="description">HTTP connection</td></tr>
3370 </tbody></table>
3371 <h4 class="returnvalue">Return Value</h4>
3372         <p class="description">Remaining bytes</p>
3373 <h4 class="discussion">Discussion</h4>
3374         <p class="discussion">The <a href="#httpIsChunked"><code>httpIsChunked</code></a> function can be used to determine whether the
3375 message body is chunked or fixed-length.
3376
3377 </p>
3378 <h3 class="function"><a id="httpGetState">httpGetState</a></h3>
3379         <p class="description">Get the current state of the HTTP request.</p>
3380 <p class="code">
3381 <a href="#http_state_t">http_state_t</a> httpGetState(<a href="#http_t">http_t</a> *http);</p>
3382 <h4 class="parameters">Parameters</h4>
3383 <table class="list"><tbody>
3384 <tr><th>http</th>
3385         <td class="description">HTTP connection</td></tr>
3386 </tbody></table>
3387 <h4 class="returnvalue">Return Value</h4>
3388         <p class="description">HTTP state</p>
3389 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpGetStatus">httpGetStatus</a></h3>
3390         <p class="description">Get the status of the last HTTP request.</p>
3391 <p class="code">
3392 http_status_t httpGetStatus(<a href="#http_t">http_t</a> *http);</p>
3393 <h4 class="parameters">Parameters</h4>
3394 <table class="list"><tbody>
3395 <tr><th>http</th>
3396         <td class="description">HTTP connection</td></tr>
3397 </tbody></table>
3398 <h4 class="returnvalue">Return Value</h4>
3399         <p class="description">HTTP status</p>
3400 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpGetSubField2">httpGetSubField2</a></h3>
3401         <p class="description">Get a sub-field value.</p>
3402 <p class="code">
3403 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>
3404 <h4 class="parameters">Parameters</h4>
3405 <table class="list"><tbody>
3406 <tr><th>http</th>
3407         <td class="description">HTTP connection</td></tr>
3408 <tr><th>field</th>
3409         <td class="description">Field index</td></tr>
3410 <tr><th>name</th>
3411         <td class="description">Name of sub-field</td></tr>
3412 <tr><th>value</th>
3413         <td class="description">Value string</td></tr>
3414 <tr><th>valuelen</th>
3415         <td class="description">Size of value buffer</td></tr>
3416 </tbody></table>
3417 <h4 class="returnvalue">Return Value</h4>
3418         <p class="description">Value or <code>NULL</code></p>
3419 <h3 class="function"><a id="httpGetVersion">httpGetVersion</a></h3>
3420         <p class="description">Get the HTTP version at the other end.</p>
3421 <p class="code">
3422 <a href="#http_version_t">http_version_t</a> httpGetVersion(<a href="#http_t">http_t</a> *http);</p>
3423 <h4 class="parameters">Parameters</h4>
3424 <table class="list"><tbody>
3425 <tr><th>http</th>
3426         <td class="description">HTTP connection</td></tr>
3427 </tbody></table>
3428 <h4 class="returnvalue">Return Value</h4>
3429         <p class="description">Version number</p>
3430 <h3 class="function"><a id="httpGets">httpGets</a></h3>
3431         <p class="description">Get a line of text from a HTTP connection.</p>
3432 <p class="code">
3433 char *httpGets(char *line, int length, <a href="#http_t">http_t</a> *http);</p>
3434 <h4 class="parameters">Parameters</h4>
3435 <table class="list"><tbody>
3436 <tr><th>line</th>
3437         <td class="description">Line to read into</td></tr>
3438 <tr><th>length</th>
3439         <td class="description">Max length of buffer</td></tr>
3440 <tr><th>http</th>
3441         <td class="description">HTTP connection</td></tr>
3442 </tbody></table>
3443 <h4 class="returnvalue">Return Value</h4>
3444         <p class="description">Line or <code>NULL</code></p>
3445 <h3 class="function"><a id="httpHead">httpHead</a></h3>
3446         <p class="description">Send a HEAD request to the server.</p>
3447 <p class="code">
3448 int httpHead(<a href="#http_t">http_t</a> *http, const char *uri);</p>
3449 <h4 class="parameters">Parameters</h4>
3450 <table class="list"><tbody>
3451 <tr><th>http</th>
3452         <td class="description">HTTP connection</td></tr>
3453 <tr><th>uri</th>
3454         <td class="description">URI for head</td></tr>
3455 </tbody></table>
3456 <h4 class="returnvalue">Return Value</h4>
3457         <p class="description">Status of call (0 = success)</p>
3458 <h3 class="function"><a id="httpInitialize">httpInitialize</a></h3>
3459         <p class="description">Initialize the HTTP interface library and set the
3460 default HTTP proxy (if any).</p>
3461 <p class="code">
3462 void httpInitialize(void);</p>
3463 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpIsChunked">httpIsChunked</a></h3>
3464         <p class="description">Report whether a message body is chunked.</p>
3465 <p class="code">
3466 int httpIsChunked(<a href="#http_t">http_t</a> *http);</p>
3467 <h4 class="parameters">Parameters</h4>
3468 <table class="list"><tbody>
3469 <tr><th>http</th>
3470         <td class="description">HTTP connection</td></tr>
3471 </tbody></table>
3472 <h4 class="returnvalue">Return Value</h4>
3473         <p class="description">1 if chunked, 0 if not</p>
3474 <h4 class="discussion">Discussion</h4>
3475         <p class="discussion">This function returns non-zero if the message body is composed of
3476 variable-length chunks.
3477
3478 </p>
3479 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpIsEncrypted">httpIsEncrypted</a></h3>
3480         <p class="description">Report whether a connection is encrypted.</p>
3481 <p class="code">
3482 int httpIsEncrypted(<a href="#http_t">http_t</a> *http);</p>
3483 <h4 class="parameters">Parameters</h4>
3484 <table class="list"><tbody>
3485 <tr><th>http</th>
3486         <td class="description">HTTP connection</td></tr>
3487 </tbody></table>
3488 <h4 class="returnvalue">Return Value</h4>
3489         <p class="description">1 if encrypted, 0 if not</p>
3490 <h4 class="discussion">Discussion</h4>
3491         <p class="discussion">This function returns non-zero if the connection is currently encrypted.
3492
3493 </p>
3494 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpLoadCredentials">httpLoadCredentials</a></h3>
3495         <p class="description">Load X.509 credentials from a keychain file.</p>
3496 <p class="code">
3497 int httpLoadCredentials(const char *path, cups_array_t **credentials, const char *common_name);</p>
3498 <h4 class="parameters">Parameters</h4>
3499 <table class="list"><tbody>
3500 <tr><th>path</th>
3501         <td class="description">Keychain path or <code>NULL</code> for default</td></tr>
3502 <tr><th>credentials</th>
3503         <td class="description">Credentials</td></tr>
3504 <tr><th>common_name</th>
3505         <td class="description">Common name for credentials</td></tr>
3506 </tbody></table>
3507 <h4 class="returnvalue">Return Value</h4>
3508         <p class="description">0 on success, -1 on error</p>
3509 <h3 class="function"><a id="httpOptions">httpOptions</a></h3>
3510         <p class="description">Send an OPTIONS request to the server.</p>
3511 <p class="code">
3512 int httpOptions(<a href="#http_t">http_t</a> *http, const char *uri);</p>
3513 <h4 class="parameters">Parameters</h4>
3514 <table class="list"><tbody>
3515 <tr><th>http</th>
3516         <td class="description">HTTP connection</td></tr>
3517 <tr><th>uri</th>
3518         <td class="description">URI for options</td></tr>
3519 </tbody></table>
3520 <h4 class="returnvalue">Return Value</h4>
3521         <p class="description">Status of call (0 = success)</p>
3522 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpPeek">httpPeek</a></h3>
3523         <p class="description">Peek at data from a HTTP connection.</p>
3524 <p class="code">
3525 ssize_t httpPeek(<a href="#http_t">http_t</a> *http, char *buffer, size_t length);</p>
3526 <h4 class="parameters">Parameters</h4>
3527 <table class="list"><tbody>
3528 <tr><th>http</th>
3529         <td class="description">HTTP connection</td></tr>
3530 <tr><th>buffer</th>
3531         <td class="description">Buffer for data</td></tr>
3532 <tr><th>length</th>
3533         <td class="description">Maximum number of bytes</td></tr>
3534 </tbody></table>
3535 <h4 class="returnvalue">Return Value</h4>
3536         <p class="description">Number of bytes copied</p>
3537 <h4 class="discussion">Discussion</h4>
3538         <p class="discussion">This function copies available data from the given HTTP connection, reading
3539 a buffer as needed.  The data is still available for reading using
3540 <a href="#httpRead2"><code>httpRead2</code></a>.<br>
3541 <br>
3542 For non-blocking connections the usual timeouts apply.
3543
3544 </p>
3545 <h3 class="function"><a id="httpPost">httpPost</a></h3>
3546         <p class="description">Send a POST request to the server.</p>
3547 <p class="code">
3548 int httpPost(<a href="#http_t">http_t</a> *http, const char *uri);</p>
3549 <h4 class="parameters">Parameters</h4>
3550 <table class="list"><tbody>
3551 <tr><th>http</th>
3552         <td class="description">HTTP connection</td></tr>
3553 <tr><th>uri</th>
3554         <td class="description">URI for post</td></tr>
3555 </tbody></table>
3556 <h4 class="returnvalue">Return Value</h4>
3557         <p class="description">Status of call (0 = success)</p>
3558 <h3 class="function"><a id="httpPut">httpPut</a></h3>
3559         <p class="description">Send a PUT request to the server.</p>
3560 <p class="code">
3561 int httpPut(<a href="#http_t">http_t</a> *http, const char *uri);</p>
3562 <h4 class="parameters">Parameters</h4>
3563 <table class="list"><tbody>
3564 <tr><th>http</th>
3565         <td class="description">HTTP connection</td></tr>
3566 <tr><th>uri</th>
3567         <td class="description">URI to put</td></tr>
3568 </tbody></table>
3569 <h4 class="returnvalue">Return Value</h4>
3570         <p class="description">Status of call (0 = success)</p>
3571 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpRead2">httpRead2</a></h3>
3572         <p class="description">Read data from a HTTP connection.</p>
3573 <p class="code">
3574 ssize_t httpRead2(<a href="#http_t">http_t</a> *http, char *buffer, size_t length);</p>
3575 <h4 class="parameters">Parameters</h4>
3576 <table class="list"><tbody>
3577 <tr><th>http</th>
3578         <td class="description">HTTP connection</td></tr>
3579 <tr><th>buffer</th>
3580         <td class="description">Buffer for data</td></tr>
3581 <tr><th>length</th>
3582         <td class="description">Maximum number of bytes</td></tr>
3583 </tbody></table>
3584 <h4 class="returnvalue">Return Value</h4>
3585         <p class="description">Number of bytes read</p>
3586 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpReadRequest">httpReadRequest</a></h3>
3587         <p class="description">Read a HTTP request from a connection.</p>
3588 <p class="code">
3589 <a href="#http_state_t">http_state_t</a> httpReadRequest(<a href="#http_t">http_t</a> *http, char *uri, size_t urilen);</p>
3590 <h4 class="parameters">Parameters</h4>
3591 <table class="list"><tbody>
3592 <tr><th>http</th>
3593         <td class="description">HTTP connection</td></tr>
3594 <tr><th>uri</th>
3595         <td class="description">URI buffer</td></tr>
3596 <tr><th>urilen</th>
3597         <td class="description">Size of URI buffer</td></tr>
3598 </tbody></table>
3599 <h4 class="returnvalue">Return Value</h4>
3600         <p class="description">New state of connection</p>
3601 <h3 class="function"><a id="httpReconnect2">httpReconnect2</a></h3>
3602         <p class="description">Reconnect to a HTTP server with timeout and optional
3603 cancel.</p>
3604 <p class="code">
3605 int httpReconnect2(<a href="#http_t">http_t</a> *http, int msec, int *cancel);</p>
3606 <h4 class="parameters">Parameters</h4>
3607 <table class="list"><tbody>
3608 <tr><th>http</th>
3609         <td class="description">HTTP connection</td></tr>
3610 <tr><th>msec</th>
3611         <td class="description">Timeout in milliseconds</td></tr>
3612 <tr><th>cancel</th>
3613         <td class="description">Pointer to &quot;cancel&quot; variable</td></tr>
3614 </tbody></table>
3615 <h4 class="returnvalue">Return Value</h4>
3616         <p class="description">0 on success, non-zero on failure</p>
3617 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpResolveHostname">httpResolveHostname</a></h3>
3618         <p class="description">Resolve the hostname of the HTTP connection
3619 address.</p>
3620 <p class="code">
3621 const char *httpResolveHostname(<a href="#http_t">http_t</a> *http, char *buffer, size_t bufsize);</p>
3622 <h4 class="parameters">Parameters</h4>
3623 <table class="list"><tbody>
3624 <tr><th>http</th>
3625         <td class="description">HTTP connection</td></tr>
3626 <tr><th>buffer</th>
3627         <td class="description">Hostname buffer</td></tr>
3628 <tr><th>bufsize</th>
3629         <td class="description">Size of buffer</td></tr>
3630 </tbody></table>
3631 <h4 class="returnvalue">Return Value</h4>
3632         <p class="description">Resolved hostname or <code>NULL</code></p>
3633 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpSaveCredentials">httpSaveCredentials</a></h3>
3634         <p class="description">Save X.509 credentials to a keychain file.</p>
3635 <p class="code">
3636 int httpSaveCredentials(const char *path, cups_array_t *credentials, const char *common_name);</p>
3637 <h4 class="parameters">Parameters</h4>
3638 <table class="list"><tbody>
3639 <tr><th>path</th>
3640         <td class="description">Keychain path or <code>NULL</code> for default</td></tr>
3641 <tr><th>credentials</th>
3642         <td class="description">Credentials</td></tr>
3643 <tr><th>common_name</th>
3644         <td class="description">Common name for credentials</td></tr>
3645 </tbody></table>
3646 <h4 class="returnvalue">Return Value</h4>
3647         <p class="description">-1 on error, 0 on success</p>
3648 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpSeparateURI">httpSeparateURI</a></h3>
3649         <p class="description">Separate a Universal Resource Identifier into its
3650 components.</p>
3651 <p class="code">
3652 <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>
3653 <h4 class="parameters">Parameters</h4>
3654 <table class="list"><tbody>
3655 <tr><th>decoding</th>
3656         <td class="description">Decoding flags</td></tr>
3657 <tr><th>uri</th>
3658         <td class="description">Universal Resource Identifier</td></tr>
3659 <tr><th>scheme</th>
3660         <td class="description">Scheme (http, https, etc.)</td></tr>
3661 <tr><th>schemelen</th>
3662         <td class="description">Size of scheme buffer</td></tr>
3663 <tr><th>username</th>
3664         <td class="description">Username</td></tr>
3665 <tr><th>usernamelen</th>
3666         <td class="description">Size of username buffer</td></tr>
3667 <tr><th>host</th>
3668         <td class="description">Hostname</td></tr>
3669 <tr><th>hostlen</th>
3670         <td class="description">Size of hostname buffer</td></tr>
3671 <tr><th>port</th>
3672         <td class="description">Port number to use</td></tr>
3673 <tr><th>resource</th>
3674         <td class="description">Resource/filename</td></tr>
3675 <tr><th>resourcelen</th>
3676         <td class="description">Size of resource buffer</td></tr>
3677 </tbody></table>
3678 <h4 class="returnvalue">Return Value</h4>
3679         <p class="description">Result of separation</p>
3680 <h3 class="function"><span class="info">&#160;CUPS 1.3/macOS 10.5&#160;</span><a id="httpSetAuthString">httpSetAuthString</a></h3>
3681         <p class="description">Set the current authorization string.</p>
3682 <p class="code">
3683 void httpSetAuthString(<a href="#http_t">http_t</a> *http, const char *scheme, const char *data);</p>
3684 <h4 class="parameters">Parameters</h4>
3685 <table class="list"><tbody>
3686 <tr><th>http</th>
3687         <td class="description">HTTP connection</td></tr>
3688 <tr><th>scheme</th>
3689         <td class="description">Auth scheme (NULL to clear it)</td></tr>
3690 <tr><th>data</th>
3691         <td class="description">Auth data (NULL for none)</td></tr>
3692 </tbody></table>
3693 <h4 class="discussion">Discussion</h4>
3694         <p class="discussion">This function just stores a copy of the current authorization string in
3695 the HTTP connection object.  You must still call <a href="#httpSetField"><code>httpSetField</code></a> to set
3696 <code>HTTP_FIELD_AUTHORIZATION</code> prior to issuing a HTTP request using
3697 <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
3698 <a href="#httpPut"><code>httpPut</code></a>.
3699
3700 </p>
3701 <h3 class="function"><span class="info">&#160;CUPS 1.1.19/macOS 10.3&#160;</span><a id="httpSetCookie">httpSetCookie</a></h3>
3702         <p class="description">Set the cookie value(s).</p>
3703 <p class="code">
3704 void httpSetCookie(<a href="#http_t">http_t</a> *http, const char *cookie);</p>
3705 <h4 class="parameters">Parameters</h4>
3706 <table class="list"><tbody>
3707 <tr><th>http</th>
3708         <td class="description">Connection</td></tr>
3709 <tr><th>cookie</th>
3710         <td class="description">Cookie string</td></tr>
3711 </tbody></table>
3712 <h3 class="function"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span><a id="httpSetCredentials">httpSetCredentials</a></h3>
3713         <p class="description">Set the credentials associated with an encrypted
3714 connection.</p>
3715 <p class="code">
3716 int httpSetCredentials(<a href="#http_t">http_t</a> *http, cups_array_t *credentials);</p>
3717 <h4 class="parameters">Parameters</h4>
3718 <table class="list"><tbody>
3719 <tr><th>http</th>
3720         <td class="description">HTTP connection</td></tr>
3721 <tr><th>credentials</th>
3722         <td class="description">Array of credentials</td></tr>
3723 </tbody></table>
3724 <h4 class="returnvalue">Return Value</h4>
3725         <p class="description">Status of call (0 = success)</p>
3726 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpSetDefaultField">httpSetDefaultField</a></h3>
3727         <p class="description">Set the default value of an HTTP header.</p>
3728 <p class="code">
3729 void httpSetDefaultField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *value);</p>
3730 <h4 class="parameters">Parameters</h4>
3731 <table class="list"><tbody>
3732 <tr><th>http</th>
3733         <td class="description">HTTP connection</td></tr>
3734 <tr><th>field</th>
3735         <td class="description">Field index</td></tr>
3736 <tr><th>value</th>
3737         <td class="description">Value</td></tr>
3738 </tbody></table>
3739 <h4 class="discussion">Discussion</h4>
3740         <p class="discussion">Currently only <code>HTTP_FIELD_ACCEPT_ENCODING</code>, <code>HTTP_FIELD_SERVER</code>,
3741 and <code>HTTP_FIELD_USER_AGENT</code> can be set.
3742
3743 </p>
3744 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpSetExpect">httpSetExpect</a></h3>
3745         <p class="description">Set the Expect: header in a request.</p>
3746 <p class="code">
3747 void httpSetExpect(<a href="#http_t">http_t</a> *http, http_status_t expect);</p>
3748 <h4 class="parameters">Parameters</h4>
3749 <table class="list"><tbody>
3750 <tr><th>http</th>
3751         <td class="description">HTTP connection</td></tr>
3752 <tr><th>expect</th>
3753         <td class="description">HTTP status to expect
3754 (<code>HTTP_STATUS_CONTINUE</code>)</td></tr>
3755 </tbody></table>
3756 <h4 class="discussion">Discussion</h4>
3757         <p class="discussion">Currently only <code>HTTP_STATUS_CONTINUE</code> is supported for the &quot;expect&quot;
3758 argument.
3759
3760 </p>
3761 <h3 class="function"><a id="httpSetField">httpSetField</a></h3>
3762         <p class="description">Set the value of an HTTP header.</p>
3763 <p class="code">
3764 void httpSetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *value);</p>
3765 <h4 class="parameters">Parameters</h4>
3766 <table class="list"><tbody>
3767 <tr><th>http</th>
3768         <td class="description">HTTP connection</td></tr>
3769 <tr><th>field</th>
3770         <td class="description">Field index</td></tr>
3771 <tr><th>value</th>
3772         <td class="description">Value</td></tr>
3773 </tbody></table>
3774 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpSetKeepAlive">httpSetKeepAlive</a></h3>
3775         <p class="description">Set the current Keep-Alive state of a connection.</p>
3776 <p class="code">
3777 void httpSetKeepAlive(<a href="#http_t">http_t</a> *http, <a href="#http_keepalive_t">http_keepalive_t</a> keep_alive);</p>
3778 <h4 class="parameters">Parameters</h4>
3779 <table class="list"><tbody>
3780 <tr><th>http</th>
3781         <td class="description">HTTP connection</td></tr>
3782 <tr><th>keep_alive</th>
3783         <td class="description">New Keep-Alive value</td></tr>
3784 </tbody></table>
3785 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpSetLength">httpSetLength</a></h3>
3786         <p class="description">Set the content-length and content-encoding.</p>
3787 <p class="code">
3788 void httpSetLength(<a href="#http_t">http_t</a> *http, size_t length);</p>
3789 <h4 class="parameters">Parameters</h4>
3790 <table class="list"><tbody>
3791 <tr><th>http</th>
3792         <td class="description">HTTP connection</td></tr>
3793 <tr><th>length</th>
3794         <td class="description">Length (0 for chunked)</td></tr>
3795 </tbody></table>
3796 <h3 class="function"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span><a id="httpSetTimeout">httpSetTimeout</a></h3>
3797         <p class="description">Set read/write timeouts and an optional callback.</p>
3798 <p class="code">
3799 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>
3800 <h4 class="parameters">Parameters</h4>
3801 <table class="list"><tbody>
3802 <tr><th>http</th>
3803         <td class="description">HTTP connection</td></tr>
3804 <tr><th>timeout</th>
3805         <td class="description">Number of seconds for timeout,
3806 must be greater than 0</td></tr>
3807 <tr><th>cb</th>
3808         <td class="description">Callback function or <code>NULL</code></td></tr>
3809 <tr><th>user_data</th>
3810         <td class="description">User data pointer</td></tr>
3811 </tbody></table>
3812 <h4 class="discussion">Discussion</h4>
3813         <p class="discussion">The optional timeout callback receives both the HTTP connection and a user
3814 data pointer and must return 1 to continue or 0 to error (time) out.
3815
3816 </p>
3817 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpShutdown">httpShutdown</a></h3>
3818         <p class="description">Shutdown one side of an HTTP connection.</p>
3819 <p class="code">
3820 void httpShutdown(<a href="#http_t">http_t</a> *http);</p>
3821 <h4 class="parameters">Parameters</h4>
3822 <table class="list"><tbody>
3823 <tr><th>http</th>
3824         <td class="description">HTTP connection</td></tr>
3825 </tbody></table>
3826 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpStateString">httpStateString</a></h3>
3827         <p class="description">Return the string describing a HTTP state value.</p>
3828 <p class="code">
3829 const char *httpStateString(<a href="#http_state_t">http_state_t</a> state);</p>
3830 <h4 class="parameters">Parameters</h4>
3831 <table class="list"><tbody>
3832 <tr><th>state</th>
3833         <td class="description">HTTP state value</td></tr>
3834 </tbody></table>
3835 <h4 class="returnvalue">Return Value</h4>
3836         <p class="description">State string</p>
3837 <h3 class="function"><a id="httpStatus">httpStatus</a></h3>
3838         <p class="description">Return a short string describing a HTTP status code.</p>
3839 <p class="code">
3840 const char *httpStatus(http_status_t status);</p>
3841 <h4 class="parameters">Parameters</h4>
3842 <table class="list"><tbody>
3843 <tr><th>status</th>
3844         <td class="description">HTTP status code</td></tr>
3845 </tbody></table>
3846 <h4 class="returnvalue">Return Value</h4>
3847         <p class="description">Localized status string</p>
3848 <h4 class="discussion">Discussion</h4>
3849         <p class="discussion">The returned string is localized to the current POSIX locale and is based
3850 on the status strings defined in RFC 7231.</p>
3851 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="httpURIStatusString">httpURIStatusString</a></h3>
3852         <p class="description">Return a string describing a URI status code.</p>
3853 <p class="code">
3854 const char *httpURIStatusString(<a href="#http_uri_status_t">http_uri_status_t</a> status);</p>
3855 <h4 class="parameters">Parameters</h4>
3856 <table class="list"><tbody>
3857 <tr><th>status</th>
3858         <td class="description">URI status code</td></tr>
3859 </tbody></table>
3860 <h4 class="returnvalue">Return Value</h4>
3861         <p class="description">Localized status string</p>
3862 <h3 class="function"><a id="httpUpdate">httpUpdate</a></h3>
3863         <p class="description">Update the current HTTP state for incoming data.</p>
3864 <p class="code">
3865 http_status_t httpUpdate(<a href="#http_t">http_t</a> *http);</p>
3866 <h4 class="parameters">Parameters</h4>
3867 <table class="list"><tbody>
3868 <tr><th>http</th>
3869         <td class="description">HTTP connection</td></tr>
3870 </tbody></table>
3871 <h4 class="returnvalue">Return Value</h4>
3872         <p class="description">HTTP status</p>
3873 <h3 class="function"><span class="info">&#160;CUPS 1.1.19/macOS 10.3&#160;</span><a id="httpWait">httpWait</a></h3>
3874         <p class="description">Wait for data available on a connection.</p>
3875 <p class="code">
3876 int httpWait(<a href="#http_t">http_t</a> *http, int msec);</p>
3877 <h4 class="parameters">Parameters</h4>
3878 <table class="list"><tbody>
3879 <tr><th>http</th>
3880         <td class="description">HTTP connection</td></tr>
3881 <tr><th>msec</th>
3882         <td class="description">Milliseconds to wait</td></tr>
3883 </tbody></table>
3884 <h4 class="returnvalue">Return Value</h4>
3885         <p class="description">1 if data is available, 0 otherwise</p>
3886 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="httpWrite2">httpWrite2</a></h3>
3887         <p class="description">Write data to a HTTP connection.</p>
3888 <p class="code">
3889 ssize_t httpWrite2(<a href="#http_t">http_t</a> *http, const char *buffer, size_t length);</p>
3890 <h4 class="parameters">Parameters</h4>
3891 <table class="list"><tbody>
3892 <tr><th>http</th>
3893         <td class="description">HTTP connection</td></tr>
3894 <tr><th>buffer</th>
3895         <td class="description">Buffer for data</td></tr>
3896 <tr><th>length</th>
3897         <td class="description">Number of bytes to write</td></tr>
3898 </tbody></table>
3899 <h4 class="returnvalue">Return Value</h4>
3900         <p class="description">Number of bytes written</p>
3901 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="httpWriteResponse">httpWriteResponse</a></h3>
3902         <p class="description">Write a HTTP response to a client connection.</p>
3903 <p class="code">
3904 int httpWriteResponse(<a href="#http_t">http_t</a> *http, http_status_t status);</p>
3905 <h4 class="parameters">Parameters</h4>
3906 <table class="list"><tbody>
3907 <tr><th>http</th>
3908         <td class="description">HTTP connection</td></tr>
3909 <tr><th>status</th>
3910         <td class="description">Status code</td></tr>
3911 </tbody></table>
3912 <h4 class="returnvalue">Return Value</h4>
3913         <p class="description">0 on success, -1 on error</p>
3914 <h3 class="function"><a id="ippAddBoolean">ippAddBoolean</a></h3>
3915         <p class="description">Add a boolean attribute to an IPP message.</p>
3916 <p class="code">
3917 <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>
3918 <h4 class="parameters">Parameters</h4>
3919 <table class="list"><tbody>
3920 <tr><th>ipp</th>
3921         <td class="description">IPP message</td></tr>
3922 <tr><th>group</th>
3923         <td class="description">IPP group</td></tr>
3924 <tr><th>name</th>
3925         <td class="description">Name of attribute</td></tr>
3926 <tr><th>value</th>
3927         <td class="description">Value of attribute</td></tr>
3928 </tbody></table>
3929 <h4 class="returnvalue">Return Value</h4>
3930         <p class="description">New attribute</p>
3931 <h4 class="discussion">Discussion</h4>
3932         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
3933 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>
3934 <br>
3935 The <code>group</code> parameter specifies the IPP attribute group tag: none
3936 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
3937 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
3938 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
3939 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p>
3940 <h3 class="function"><a id="ippAddBooleans">ippAddBooleans</a></h3>
3941         <p class="description">Add an array of boolean values.</p>
3942 <p class="code">
3943 <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>
3944 <h4 class="parameters">Parameters</h4>
3945 <table class="list"><tbody>
3946 <tr><th>ipp</th>
3947         <td class="description">IPP message</td></tr>
3948 <tr><th>group</th>
3949         <td class="description">IPP group</td></tr>
3950 <tr><th>name</th>
3951         <td class="description">Name of attribute</td></tr>
3952 <tr><th>num_values</th>
3953         <td class="description">Number of values</td></tr>
3954 <tr><th>values</th>
3955         <td class="description">Values</td></tr>
3956 </tbody></table>
3957 <h4 class="returnvalue">Return Value</h4>
3958         <p class="description">New attribute</p>
3959 <h4 class="discussion">Discussion</h4>
3960         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
3961 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>
3962 <br>
3963 The <code>group</code> parameter specifies the IPP attribute group tag: none
3964 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
3965 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
3966 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
3967 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p>
3968 <h3 class="function"><span class="info">&#160;CUPS 1.1.19/macOS 10.3&#160;</span><a id="ippAddCollection">ippAddCollection</a></h3>
3969         <p class="description">Add a collection value.</p>
3970 <p class="code">
3971 <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>
3972 <h4 class="parameters">Parameters</h4>
3973 <table class="list"><tbody>
3974 <tr><th>ipp</th>
3975         <td class="description">IPP message</td></tr>
3976 <tr><th>group</th>
3977         <td class="description">IPP group</td></tr>
3978 <tr><th>name</th>
3979         <td class="description">Name of attribute</td></tr>
3980 <tr><th>value</th>
3981         <td class="description">Value</td></tr>
3982 </tbody></table>
3983 <h4 class="returnvalue">Return Value</h4>
3984         <p class="description">New attribute</p>
3985 <h4 class="discussion">Discussion</h4>
3986         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
3987 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>
3988 <br>
3989 The <code>group</code> parameter specifies the IPP attribute group tag: none
3990 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
3991 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
3992 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
3993 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).
3994
3995 </p>
3996 <h3 class="function"><span class="info">&#160;CUPS 1.1.19/macOS 10.3&#160;</span><a id="ippAddCollections">ippAddCollections</a></h3>
3997         <p class="description">Add an array of collection values.</p>
3998 <p class="code">
3999 <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>
4000 <h4 class="parameters">Parameters</h4>
4001 <table class="list"><tbody>
4002 <tr><th>ipp</th>
4003         <td class="description">IPP message</td></tr>
4004 <tr><th>group</th>
4005         <td class="description">IPP group</td></tr>
4006 <tr><th>name</th>
4007         <td class="description">Name of attribute</td></tr>
4008 <tr><th>num_values</th>
4009         <td class="description">Number of values</td></tr>
4010 <tr><th>values</th>
4011         <td class="description">Values</td></tr>
4012 </tbody></table>
4013 <h4 class="returnvalue">Return Value</h4>
4014         <p class="description">New attribute</p>
4015 <h4 class="discussion">Discussion</h4>
4016         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4017 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>
4018 <br>
4019 The <code>group</code> parameter specifies the IPP attribute group tag: none
4020 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4021 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4022 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4023 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).
4024
4025 </p>
4026 <h3 class="function"><a id="ippAddDate">ippAddDate</a></h3>
4027         <p class="description">Add a dateTime attribute to an IPP message.</p>
4028 <p class="code">
4029 <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>
4030 <h4 class="parameters">Parameters</h4>
4031 <table class="list"><tbody>
4032 <tr><th>ipp</th>
4033         <td class="description">IPP message</td></tr>
4034 <tr><th>group</th>
4035         <td class="description">IPP group</td></tr>
4036 <tr><th>name</th>
4037         <td class="description">Name of attribute</td></tr>
4038 <tr><th>value</th>
4039         <td class="description">Value</td></tr>
4040 </tbody></table>
4041 <h4 class="returnvalue">Return Value</h4>
4042         <p class="description">New attribute</p>
4043 <h4 class="discussion">Discussion</h4>
4044         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4045 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>
4046 <br>
4047 The <code>group</code> parameter specifies the IPP attribute group tag: none
4048 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4049 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4050 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4051 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p>
4052 <h3 class="function"><a id="ippAddInteger">ippAddInteger</a></h3>
4053         <p class="description">Add a integer attribute to an IPP message.</p>
4054 <p class="code">
4055 <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>
4056 <h4 class="parameters">Parameters</h4>
4057 <table class="list"><tbody>
4058 <tr><th>ipp</th>
4059         <td class="description">IPP message</td></tr>
4060 <tr><th>group</th>
4061         <td class="description">IPP group</td></tr>
4062 <tr><th>value_tag</th>
4063         <td class="description">Type of attribute</td></tr>
4064 <tr><th>name</th>
4065         <td class="description">Name of attribute</td></tr>
4066 <tr><th>value</th>
4067         <td class="description">Value of attribute</td></tr>
4068 </tbody></table>
4069 <h4 class="returnvalue">Return Value</h4>
4070         <p class="description">New attribute</p>
4071 <h4 class="discussion">Discussion</h4>
4072         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4073 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>
4074 <br>
4075 The <code>group</code> parameter specifies the IPP attribute group tag: none
4076 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4077 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4078 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4079 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br>
4080 <br>
4081 Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer
4082 (<code>IPP_TAG_INTEGER</code>).</p>
4083 <h3 class="function"><a id="ippAddIntegers">ippAddIntegers</a></h3>
4084         <p class="description">Add an array of integer values.</p>
4085 <p class="code">
4086 <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>
4087 <h4 class="parameters">Parameters</h4>
4088 <table class="list"><tbody>
4089 <tr><th>ipp</th>
4090         <td class="description">IPP message</td></tr>
4091 <tr><th>group</th>
4092         <td class="description">IPP group</td></tr>
4093 <tr><th>value_tag</th>
4094         <td class="description">Type of attribute</td></tr>
4095 <tr><th>name</th>
4096         <td class="description">Name of attribute</td></tr>
4097 <tr><th>num_values</th>
4098         <td class="description">Number of values</td></tr>
4099 <tr><th>values</th>
4100         <td class="description">Values</td></tr>
4101 </tbody></table>
4102 <h4 class="returnvalue">Return Value</h4>
4103         <p class="description">New attribute</p>
4104 <h4 class="discussion">Discussion</h4>
4105         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4106 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>
4107 <br>
4108 The <code>group</code> parameter specifies the IPP attribute group tag: none
4109 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4110 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4111 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4112 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br>
4113 <br>
4114 Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer
4115 (<code>IPP_TAG_INTEGER</code>).</p>
4116 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="ippAddOctetString">ippAddOctetString</a></h3>
4117         <p class="description">Add an octetString value to an IPP message.</p>
4118 <p class="code">
4119 <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>
4120 <h4 class="parameters">Parameters</h4>
4121 <table class="list"><tbody>
4122 <tr><th>ipp</th>
4123         <td class="description">IPP message</td></tr>
4124 <tr><th>group</th>
4125         <td class="description">IPP group</td></tr>
4126 <tr><th>name</th>
4127         <td class="description">Name of attribute</td></tr>
4128 <tr><th>data</th>
4129         <td class="description">octetString data</td></tr>
4130 <tr><th>datalen</th>
4131         <td class="description">Length of data in bytes</td></tr>
4132 </tbody></table>
4133 <h4 class="returnvalue">Return Value</h4>
4134         <p class="description">New attribute</p>
4135 <h4 class="discussion">Discussion</h4>
4136         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4137 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>
4138 <br>
4139 The <code>group</code> parameter specifies the IPP attribute group tag: none
4140 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4141 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4142 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4143 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).
4144
4145 </p>
4146 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippAddOutOfBand">ippAddOutOfBand</a></h3>
4147         <p class="description">Add an out-of-band value to an IPP message.</p>
4148 <p class="code">
4149 <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>
4150 <h4 class="parameters">Parameters</h4>
4151 <table class="list"><tbody>
4152 <tr><th>ipp</th>
4153         <td class="description">IPP message</td></tr>
4154 <tr><th>group</th>
4155         <td class="description">IPP group</td></tr>
4156 <tr><th>value_tag</th>
4157         <td class="description">Type of attribute</td></tr>
4158 <tr><th>name</th>
4159         <td class="description">Name of attribute</td></tr>
4160 </tbody></table>
4161 <h4 class="returnvalue">Return Value</h4>
4162         <p class="description">New attribute</p>
4163 <h4 class="discussion">Discussion</h4>
4164         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4165 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>
4166 <br>
4167 The <code>group</code> parameter specifies the IPP attribute group tag: none
4168 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4169 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4170 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4171 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br>
4172 <br>
4173 Supported out-of-band values include unsupported-value
4174 (<code>IPP_TAG_UNSUPPORTED_VALUE</code>), default (<code>IPP_TAG_DEFAULT</code>), unknown
4175 (<code>IPP_TAG_UNKNOWN</code>), no-value (<code>IPP_TAG_NOVALUE</code>), not-settable
4176 (<code>IPP_TAG_NOTSETTABLE</code>), delete-attribute (<code>IPP_TAG_DELETEATTR</code>), and
4177 admin-define (<code>IPP_TAG_ADMINDEFINE</code>).
4178
4179 </p>
4180 <h3 class="function"><a id="ippAddRange">ippAddRange</a></h3>
4181         <p class="description">Add a range of values to an IPP message.</p>
4182 <p class="code">
4183 <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>
4184 <h4 class="parameters">Parameters</h4>
4185 <table class="list"><tbody>
4186 <tr><th>ipp</th>
4187         <td class="description">IPP message</td></tr>
4188 <tr><th>group</th>
4189         <td class="description">IPP group</td></tr>
4190 <tr><th>name</th>
4191         <td class="description">Name of attribute</td></tr>
4192 <tr><th>lower</th>
4193         <td class="description">Lower value</td></tr>
4194 <tr><th>upper</th>
4195         <td class="description">Upper value</td></tr>
4196 </tbody></table>
4197 <h4 class="returnvalue">Return Value</h4>
4198         <p class="description">New attribute</p>
4199 <h4 class="discussion">Discussion</h4>
4200         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4201 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>
4202 <br>
4203 The <code>group</code> parameter specifies the IPP attribute group tag: none
4204 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4205 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4206 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4207 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br>
4208 <br>
4209 The <code>lower</code> parameter must be less than or equal to the <code>upper</code> parameter.</p>
4210 <h3 class="function"><a id="ippAddRanges">ippAddRanges</a></h3>
4211         <p class="description">Add ranges of values to an IPP message.</p>
4212 <p class="code">
4213 <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>
4214 <h4 class="parameters">Parameters</h4>
4215 <table class="list"><tbody>
4216 <tr><th>ipp</th>
4217         <td class="description">IPP message</td></tr>
4218 <tr><th>group</th>
4219         <td class="description">IPP group</td></tr>
4220 <tr><th>name</th>
4221         <td class="description">Name of attribute</td></tr>
4222 <tr><th>num_values</th>
4223         <td class="description">Number of values</td></tr>
4224 <tr><th>lower</th>
4225         <td class="description">Lower values</td></tr>
4226 <tr><th>upper</th>
4227         <td class="description">Upper values</td></tr>
4228 </tbody></table>
4229 <h4 class="returnvalue">Return Value</h4>
4230         <p class="description">New attribute</p>
4231 <h4 class="discussion">Discussion</h4>
4232         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4233 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>
4234 <br>
4235 The <code>group</code> parameter specifies the IPP attribute group tag: none
4236 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4237 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4238 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4239 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p>
4240 <h3 class="function"><a id="ippAddResolution">ippAddResolution</a></h3>
4241         <p class="description">Add a resolution value to an IPP message.</p>
4242 <p class="code">
4243 <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>
4244 <h4 class="parameters">Parameters</h4>
4245 <table class="list"><tbody>
4246 <tr><th>ipp</th>
4247         <td class="description">IPP message</td></tr>
4248 <tr><th>group</th>
4249         <td class="description">IPP group</td></tr>
4250 <tr><th>name</th>
4251         <td class="description">Name of attribute</td></tr>
4252 <tr><th>units</th>
4253         <td class="description">Units for resolution</td></tr>
4254 <tr><th>xres</th>
4255         <td class="description">X resolution</td></tr>
4256 <tr><th>yres</th>
4257         <td class="description">Y resolution</td></tr>
4258 </tbody></table>
4259 <h4 class="returnvalue">Return Value</h4>
4260         <p class="description">New attribute</p>
4261 <h4 class="discussion">Discussion</h4>
4262         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4263 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>
4264 <br>
4265 The <code>group</code> parameter specifies the IPP attribute group tag: none
4266 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4267 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4268 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4269 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p>
4270 <h3 class="function"><a id="ippAddResolutions">ippAddResolutions</a></h3>
4271         <p class="description">Add resolution values to an IPP message.</p>
4272 <p class="code">
4273 <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>
4274 <h4 class="parameters">Parameters</h4>
4275 <table class="list"><tbody>
4276 <tr><th>ipp</th>
4277         <td class="description">IPP message</td></tr>
4278 <tr><th>group</th>
4279         <td class="description">IPP group</td></tr>
4280 <tr><th>name</th>
4281         <td class="description">Name of attribute</td></tr>
4282 <tr><th>num_values</th>
4283         <td class="description">Number of values</td></tr>
4284 <tr><th>units</th>
4285         <td class="description">Units for resolution</td></tr>
4286 <tr><th>xres</th>
4287         <td class="description">X resolutions</td></tr>
4288 <tr><th>yres</th>
4289         <td class="description">Y resolutions</td></tr>
4290 </tbody></table>
4291 <h4 class="returnvalue">Return Value</h4>
4292         <p class="description">New attribute</p>
4293 <h4 class="discussion">Discussion</h4>
4294         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4295 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>
4296 <br>
4297 The <code>group</code> parameter specifies the IPP attribute group tag: none
4298 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4299 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4300 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4301 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p>
4302 <h3 class="function"><a id="ippAddSeparator">ippAddSeparator</a></h3>
4303         <p class="description">Add a group separator to an IPP message.</p>
4304 <p class="code">
4305 <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddSeparator(<a href="#ipp_t">ipp_t</a> *ipp);</p>
4306 <h4 class="parameters">Parameters</h4>
4307 <table class="list"><tbody>
4308 <tr><th>ipp</th>
4309         <td class="description">IPP message</td></tr>
4310 </tbody></table>
4311 <h4 class="returnvalue">Return Value</h4>
4312         <p class="description">New attribute</p>
4313 <h4 class="discussion">Discussion</h4>
4314         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4315 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>
4316 <h3 class="function"><a id="ippAddString">ippAddString</a></h3>
4317         <p class="description">Add a language-encoded string to an IPP message.</p>
4318 <p class="code">
4319 <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>
4320 <h4 class="parameters">Parameters</h4>
4321 <table class="list"><tbody>
4322 <tr><th>ipp</th>
4323         <td class="description">IPP message</td></tr>
4324 <tr><th>group</th>
4325         <td class="description">IPP group</td></tr>
4326 <tr><th>value_tag</th>
4327         <td class="description">Type of attribute</td></tr>
4328 <tr><th>name</th>
4329         <td class="description">Name of attribute</td></tr>
4330 <tr><th>language</th>
4331         <td class="description">Language code</td></tr>
4332 <tr><th>value</th>
4333         <td class="description">Value</td></tr>
4334 </tbody></table>
4335 <h4 class="returnvalue">Return Value</h4>
4336         <p class="description">New attribute</p>
4337 <h4 class="discussion">Discussion</h4>
4338         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4339 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>
4340 <br>
4341 The <code>group</code> parameter specifies the IPP attribute group tag: none
4342 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4343 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4344 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4345 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br>
4346 <br>
4347 Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword
4348 (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType
4349 (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage
4350 (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage
4351 (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme
4352 (<code>IPP_TAG_URISCHEME</code>).<br>
4353 <br>
4354 The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and
4355 textWithLanguage string values and must be <code>NULL</code> for all other string values.</p>
4356 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippAddStringf">ippAddStringf</a></h3>
4357         <p class="description">Add a formatted string to an IPP message.</p>
4358 <p class="code">
4359 <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>
4360 <h4 class="parameters">Parameters</h4>
4361 <table class="list"><tbody>
4362 <tr><th>ipp</th>
4363         <td class="description">IPP message</td></tr>
4364 <tr><th>group</th>
4365         <td class="description">IPP group</td></tr>
4366 <tr><th>value_tag</th>
4367         <td class="description">Type of attribute</td></tr>
4368 <tr><th>name</th>
4369         <td class="description">Name of attribute</td></tr>
4370 <tr><th>language</th>
4371         <td class="description">Language code (<code>NULL</code> for default)</td></tr>
4372 <tr><th>format</th>
4373         <td class="description">Printf-style format string</td></tr>
4374 <tr><th>...</th>
4375         <td class="description">Additional arguments as needed</td></tr>
4376 </tbody></table>
4377 <h4 class="returnvalue">Return Value</h4>
4378         <p class="description">New attribute</p>
4379 <h4 class="discussion">Discussion</h4>
4380         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4381 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>
4382 <br>
4383 The <code>group</code> parameter specifies the IPP attribute group tag: none
4384 (<code>IPP_TAG_ZERO</code>, for member attributes), document
4385 (<code>IPP_TAG_DOCUMENT</code>), event notification
4386 (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>),
4387 printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>),
4388 or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br>
4389 <br>
4390 Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword
4391 (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType
4392 (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage
4393 (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage
4394 (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme
4395 (<code>IPP_TAG_URISCHEME</code>).<br>
4396 <br>
4397 The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage
4398 and textWithLanguage string values and must be <code>NULL</code> for all other
4399 string values.<br>
4400 <br>
4401 The <code>format</code> parameter uses formatting characters compatible with the
4402 printf family of standard functions.  Additional arguments follow it as
4403 needed.  The formatted string is truncated as needed to the maximum length of
4404 the corresponding value type.
4405
4406 </p>
4407 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippAddStringfv">ippAddStringfv</a></h3>
4408         <p class="description">Add a formatted string to an IPP message.</p>
4409 <p class="code">
4410 <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>
4411 <h4 class="parameters">Parameters</h4>
4412 <table class="list"><tbody>
4413 <tr><th>ipp</th>
4414         <td class="description">IPP message</td></tr>
4415 <tr><th>group</th>
4416         <td class="description">IPP group</td></tr>
4417 <tr><th>value_tag</th>
4418         <td class="description">Type of attribute</td></tr>
4419 <tr><th>name</th>
4420         <td class="description">Name of attribute</td></tr>
4421 <tr><th>language</th>
4422         <td class="description">Language code (<code>NULL</code> for default)</td></tr>
4423 <tr><th>format</th>
4424         <td class="description">Printf-style format string</td></tr>
4425 <tr><th>ap</th>
4426         <td class="description">Additional arguments</td></tr>
4427 </tbody></table>
4428 <h4 class="returnvalue">Return Value</h4>
4429         <p class="description">New attribute</p>
4430 <h4 class="discussion">Discussion</h4>
4431         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4432 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>
4433 <br>
4434 The <code>group</code> parameter specifies the IPP attribute group tag: none
4435 (<code>IPP_TAG_ZERO</code>, for member attributes), document
4436 (<code>IPP_TAG_DOCUMENT</code>), event notification
4437 (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>),
4438 printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>),
4439 or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br>
4440 <br>
4441 Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword
4442 (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType
4443 (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage
4444 (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage
4445 (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme
4446 (<code>IPP_TAG_URISCHEME</code>).<br>
4447 <br>
4448 The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage
4449 and textWithLanguage string values and must be <code>NULL</code> for all other
4450 string values.<br>
4451 <br>
4452 The <code>format</code> parameter uses formatting characters compatible with the
4453 printf family of standard functions.  Additional arguments are passed in the
4454 stdarg pointer <code>ap</code>.  The formatted string is truncated as needed to the
4455 maximum length of the corresponding value type.
4456
4457 </p>
4458 <h3 class="function"><a id="ippAddStrings">ippAddStrings</a></h3>
4459         <p class="description">Add language-encoded strings to an IPP message.</p>
4460 <p class="code">
4461 <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>
4462 <h4 class="parameters">Parameters</h4>
4463 <table class="list"><tbody>
4464 <tr><th>ipp</th>
4465         <td class="description">IPP message</td></tr>
4466 <tr><th>group</th>
4467         <td class="description">IPP group</td></tr>
4468 <tr><th>value_tag</th>
4469         <td class="description">Type of attribute</td></tr>
4470 <tr><th>name</th>
4471         <td class="description">Name of attribute</td></tr>
4472 <tr><th>num_values</th>
4473         <td class="description">Number of values</td></tr>
4474 <tr><th>language</th>
4475         <td class="description">Language code (<code>NULL</code> for default)</td></tr>
4476 <tr><th>values</th>
4477         <td class="description">Values</td></tr>
4478 </tbody></table>
4479 <h4 class="returnvalue">Return Value</h4>
4480         <p class="description">New attribute</p>
4481 <h4 class="discussion">Discussion</h4>
4482         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
4483 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>
4484 <br>
4485 The <code>group</code> parameter specifies the IPP attribute group tag: none
4486 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
4487 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
4488 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
4489 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br>
4490 <br>
4491 Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword
4492 (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType
4493 (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage
4494 (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage
4495 (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme
4496 (<code>IPP_TAG_URISCHEME</code>).<br>
4497 <br>
4498 The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and
4499 textWithLanguage string values and must be <code>NULL</code> for all other string values.</p>
4500 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippAttributeString">ippAttributeString</a></h3>
4501         <p class="description">Convert the attribute's value to a string.</p>
4502 <p class="code">
4503 size_t ippAttributeString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, char *buffer, size_t bufsize);</p>
4504 <h4 class="parameters">Parameters</h4>
4505 <table class="list"><tbody>
4506 <tr><th>attr</th>
4507         <td class="description">Attribute</td></tr>
4508 <tr><th>buffer</th>
4509         <td class="description">String buffer or NULL</td></tr>
4510 <tr><th>bufsize</th>
4511         <td class="description">Size of string buffer</td></tr>
4512 </tbody></table>
4513 <h4 class="returnvalue">Return Value</h4>
4514         <p class="description">Number of bytes less nul</p>
4515 <h4 class="discussion">Discussion</h4>
4516         <p class="discussion">Returns the number of bytes that would be written, not including the
4517 trailing nul. The buffer pointer can be NULL to get the required length,
4518 just like (v)snprintf.
4519
4520 </p>
4521 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippContainsInteger">ippContainsInteger</a></h3>
4522         <p class="description">Determine whether an attribute contains the
4523 specified value or is within the list of ranges.</p>
4524 <p class="code">
4525 int ippContainsInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int value);</p>
4526 <h4 class="parameters">Parameters</h4>
4527 <table class="list"><tbody>
4528 <tr><th>attr</th>
4529         <td class="description">Attribute</td></tr>
4530 <tr><th>value</th>
4531         <td class="description">Integer/enum value</td></tr>
4532 </tbody></table>
4533 <h4 class="returnvalue">Return Value</h4>
4534         <p class="description">1 on a match, 0 on no match</p>
4535 <h4 class="discussion">Discussion</h4>
4536         <p class="discussion">Returns non-zero when the attribute contains either a matching integer or
4537 enum value, or the value falls within one of the rangeOfInteger values for
4538 the attribute.
4539
4540 </p>
4541 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippContainsString">ippContainsString</a></h3>
4542         <p class="description">Determine whether an attribute contains the
4543 specified string value.</p>
4544 <p class="code">
4545 int ippContainsString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, const char *value);</p>
4546 <h4 class="parameters">Parameters</h4>
4547 <table class="list"><tbody>
4548 <tr><th>attr</th>
4549         <td class="description">Attribute</td></tr>
4550 <tr><th>value</th>
4551         <td class="description">String value</td></tr>
4552 </tbody></table>
4553 <h4 class="returnvalue">Return Value</h4>
4554         <p class="description">1 on a match, 0 on no match</p>
4555 <h4 class="discussion">Discussion</h4>
4556         <p class="discussion">Returns non-zero when the attribute contains a matching charset, keyword,
4557 naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value.
4558
4559 </p>
4560 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippCopyAttribute">ippCopyAttribute</a></h3>
4561         <p class="description">Copy an attribute.</p>
4562 <p class="code">
4563 <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>
4564 <h4 class="parameters">Parameters</h4>
4565 <table class="list"><tbody>
4566 <tr><th>dst</th>
4567         <td class="description">Destination IPP message</td></tr>
4568 <tr><th>srcattr</th>
4569         <td class="description">Attribute to copy</td></tr>
4570 <tr><th>quickcopy</th>
4571         <td class="description">1 for a referenced copy, 0 for normal</td></tr>
4572 </tbody></table>
4573 <h4 class="returnvalue">Return Value</h4>
4574         <p class="description">New attribute</p>
4575 <h4 class="discussion">Discussion</h4>
4576         <p class="discussion">The specified attribute, <code>attr</code>, is copied to the destination IPP message.
4577 When <code>quickcopy</code> is non-zero, a &quot;shallow&quot; reference copy of the attribute is
4578 created - this should only be done as long as the original source IPP message will
4579 not be freed for the life of the destination.
4580
4581 </p>
4582 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippCopyAttributes">ippCopyAttributes</a></h3>
4583         <p class="description">Copy attributes from one IPP message to another.</p>
4584 <p class="code">
4585 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>
4586 <h4 class="parameters">Parameters</h4>
4587 <table class="list"><tbody>
4588 <tr><th>dst</th>
4589         <td class="description">Destination IPP message</td></tr>
4590 <tr><th>src</th>
4591         <td class="description">Source IPP message</td></tr>
4592 <tr><th>quickcopy</th>
4593         <td class="description">1 for a referenced copy, 0 for normal</td></tr>
4594 <tr><th>cb</th>
4595         <td class="description">Copy callback or <code>NULL</code> for none</td></tr>
4596 <tr><th>context</th>
4597         <td class="description">Context pointer</td></tr>
4598 </tbody></table>
4599 <h4 class="returnvalue">Return Value</h4>
4600         <p class="description">1 on success, 0 on error</p>
4601 <h4 class="discussion">Discussion</h4>
4602         <p class="discussion">Zero or more attributes are copied from the source IPP message, <code>src</code>, to the
4603 destination IPP message, <code>dst</code>. When <code>quickcopy</code> is non-zero, a &quot;shallow&quot;
4604 reference copy of the attribute is created - this should only be done as long as the
4605 original source IPP message will not be freed for the life of the destination.<br>
4606 <br>
4607 The <code>cb</code> and <code>context</code> parameters provide a generic way to &quot;filter&quot; the
4608 attributes that are copied - the function must return 1 to copy the attribute or
4609 0 to skip it. The function may also choose to do a partial copy of the source attribute
4610 itself.
4611
4612 </p>
4613 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippCreateRequestedArray">ippCreateRequestedArray</a></h3>
4614         <p class="description">Create a CUPS array of attribute names from the
4615 given requested-attributes attribute.</p>
4616 <p class="code">
4617 cups_array_t *ippCreateRequestedArray(<a href="#ipp_t">ipp_t</a> *request);</p>
4618 <h4 class="parameters">Parameters</h4>
4619 <table class="list"><tbody>
4620 <tr><th>request</th>
4621         <td class="description">IPP request</td></tr>
4622 </tbody></table>
4623 <h4 class="returnvalue">Return Value</h4>
4624         <p class="description">CUPS array or <code>NULL</code> if all</p>
4625 <h4 class="discussion">Discussion</h4>
4626         <p class="discussion">This function creates a (sorted) CUPS array of attribute names matching the
4627 list of &quot;requested-attribute&quot; values supplied in an IPP request.  All IANA-
4628 registered values are supported in addition to the CUPS IPP extension
4629 attributes.<br>
4630 <br>
4631 The <code>request</code> parameter specifies the request message that was read from
4632 the client.
4633
4634 <code>NULL</code> is returned if all attributes should be returned.  Otherwise, the
4635 result is a sorted array of attribute names, where <code>cupsArrayFind(array,
4636 "attribute-name")</code> will return a non-NULL pointer.  The array must be freed
4637 using the <code>cupsArrayDelete</code> function.
4638
4639 </p>
4640 <h3 class="function"><a id="ippDateToTime">ippDateToTime</a></h3>
4641         <p class="description">Convert from RFC 2579 Date/Time format to time in
4642 seconds.</p>
4643 <p class="code">
4644 time_t ippDateToTime(const <a href="#ipp_uchar_t">ipp_uchar_t</a> *date);</p>
4645 <h4 class="parameters">Parameters</h4>
4646 <table class="list"><tbody>
4647 <tr><th>date</th>
4648         <td class="description">RFC 2579 date info</td></tr>
4649 </tbody></table>
4650 <h4 class="returnvalue">Return Value</h4>
4651         <p class="description">UNIX time value</p>
4652 <h3 class="function"><a id="ippDelete">ippDelete</a></h3>
4653         <p class="description">Delete an IPP message.</p>
4654 <p class="code">
4655 void ippDelete(<a href="#ipp_t">ipp_t</a> *ipp);</p>
4656 <h4 class="parameters">Parameters</h4>
4657 <table class="list"><tbody>
4658 <tr><th>ipp</th>
4659         <td class="description">IPP message</td></tr>
4660 </tbody></table>
4661 <h3 class="function"><span class="info">&#160;CUPS 1.1.19/macOS 10.3&#160;</span><a id="ippDeleteAttribute">ippDeleteAttribute</a></h3>
4662         <p class="description">Delete a single attribute in an IPP message.</p>
4663 <p class="code">
4664 void ippDeleteAttribute(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p>
4665 <h4 class="parameters">Parameters</h4>
4666 <table class="list"><tbody>
4667 <tr><th>ipp</th>
4668         <td class="description">IPP message</td></tr>
4669 <tr><th>attr</th>
4670         <td class="description">Attribute to delete</td></tr>
4671 </tbody></table>
4672 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippDeleteValues">ippDeleteValues</a></h3>
4673         <p class="description">Delete values in an attribute.</p>
4674 <p class="code">
4675 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>
4676 <h4 class="parameters">Parameters</h4>
4677 <table class="list"><tbody>
4678 <tr><th>ipp</th>
4679         <td class="description">IPP message</td></tr>
4680 <tr><th>attr</th>
4681         <td class="description">Attribute</td></tr>
4682 <tr><th>element</th>
4683         <td class="description">Index of first value to delete (0-based)</td></tr>
4684 <tr><th>count</th>
4685         <td class="description">Number of values to delete</td></tr>
4686 </tbody></table>
4687 <h4 class="returnvalue">Return Value</h4>
4688         <p class="description">1 on success, 0 on failure</p>
4689 <h4 class="discussion">Discussion</h4>
4690         <p class="discussion">The <code>element</code> parameter specifies the first value to delete, starting at
4691 0. It must be less than the number of values returned by <a href="#ippGetCount"><code>ippGetCount</code></a>.<br>
4692 <br>
4693 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
4694 <br>
4695 Deleting all values in an attribute deletes the attribute.
4696
4697 </p>
4698 <h3 class="function"><a id="ippEnumString">ippEnumString</a></h3>
4699         <p class="description">Return a string corresponding to the enum value.</p>
4700 <p class="code">
4701 const char *ippEnumString(const char *attrname, int enumvalue);</p>
4702 <h4 class="parameters">Parameters</h4>
4703 <table class="list"><tbody>
4704 <tr><th>attrname</th>
4705         <td class="description">Attribute name</td></tr>
4706 <tr><th>enumvalue</th>
4707         <td class="description">Enum value</td></tr>
4708 </tbody></table>
4709 <h4 class="returnvalue">Return Value</h4>
4710         <p class="description">Enum string</p>
4711 <h3 class="function"><a id="ippEnumValue">ippEnumValue</a></h3>
4712         <p class="description">Return the value associated with a given enum string.</p>
4713 <p class="code">
4714 int ippEnumValue(const char *attrname, const char *enumstring);</p>
4715 <h4 class="parameters">Parameters</h4>
4716 <table class="list"><tbody>
4717 <tr><th>attrname</th>
4718         <td class="description">Attribute name</td></tr>
4719 <tr><th>enumstring</th>
4720         <td class="description">Enum string</td></tr>
4721 </tbody></table>
4722 <h4 class="returnvalue">Return Value</h4>
4723         <p class="description">Enum value or -1 if unknown</p>
4724 <h3 class="function"><a id="ippErrorString">ippErrorString</a></h3>
4725         <p class="description">Return a name for the given status code.</p>
4726 <p class="code">
4727 const char *ippErrorString(ipp_status_t error);</p>
4728 <h4 class="parameters">Parameters</h4>
4729 <table class="list"><tbody>
4730 <tr><th>error</th>
4731         <td class="description">Error status</td></tr>
4732 </tbody></table>
4733 <h4 class="returnvalue">Return Value</h4>
4734         <p class="description">Text string</p>
4735 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="ippErrorValue">ippErrorValue</a></h3>
4736         <p class="description">Return a status code for the given name.</p>
4737 <p class="code">
4738 ipp_status_t ippErrorValue(const char *name);</p>
4739 <h4 class="parameters">Parameters</h4>
4740 <table class="list"><tbody>
4741 <tr><th>name</th>
4742         <td class="description">Name</td></tr>
4743 </tbody></table>
4744 <h4 class="returnvalue">Return Value</h4>
4745         <p class="description">IPP status code</p>
4746 <h3 class="function"><a id="ippFindAttribute">ippFindAttribute</a></h3>
4747         <p class="description">Find a named attribute in a request.</p>
4748 <p class="code">
4749 <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>
4750 <h4 class="parameters">Parameters</h4>
4751 <table class="list"><tbody>
4752 <tr><th>ipp</th>
4753         <td class="description">IPP message</td></tr>
4754 <tr><th>name</th>
4755         <td class="description">Name of attribute</td></tr>
4756 <tr><th>type</th>
4757         <td class="description">Type of attribute</td></tr>
4758 </tbody></table>
4759 <h4 class="returnvalue">Return Value</h4>
4760         <p class="description">Matching attribute</p>
4761 <h4 class="discussion">Discussion</h4>
4762         <p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list
4763 of attribute and member names separated by slashes, for example
4764 &quot;media-col/media-size&quot;.</p>
4765 <h3 class="function"><a id="ippFindNextAttribute">ippFindNextAttribute</a></h3>
4766         <p class="description">Find the next named attribute in a request.</p>
4767 <p class="code">
4768 <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>
4769 <h4 class="parameters">Parameters</h4>
4770 <table class="list"><tbody>
4771 <tr><th>ipp</th>
4772         <td class="description">IPP message</td></tr>
4773 <tr><th>name</th>
4774         <td class="description">Name of attribute</td></tr>
4775 <tr><th>type</th>
4776         <td class="description">Type of attribute</td></tr>
4777 </tbody></table>
4778 <h4 class="returnvalue">Return Value</h4>
4779         <p class="description">Matching attribute</p>
4780 <h4 class="discussion">Discussion</h4>
4781         <p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list
4782 of attribute and member names separated by slashes, for example
4783 &quot;media-col/media-size&quot;.</p>
4784 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippFirstAttribute">ippFirstAttribute</a></h3>
4785         <p class="description">Return the first attribute in the message.</p>
4786 <p class="code">
4787 <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFirstAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p>
4788 <h4 class="parameters">Parameters</h4>
4789 <table class="list"><tbody>
4790 <tr><th>ipp</th>
4791         <td class="description">IPP message</td></tr>
4792 </tbody></table>
4793 <h4 class="returnvalue">Return Value</h4>
4794         <p class="description">First attribute or <code>NULL</code> if none</p>
4795 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetBoolean">ippGetBoolean</a></h3>
4796         <p class="description">Get a boolean value for an attribute.</p>
4797 <p class="code">
4798 int ippGetBoolean(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p>
4799 <h4 class="parameters">Parameters</h4>
4800 <table class="list"><tbody>
4801 <tr><th>attr</th>
4802         <td class="description">IPP attribute</td></tr>
4803 <tr><th>element</th>
4804         <td class="description">Value number (0-based)</td></tr>
4805 </tbody></table>
4806 <h4 class="returnvalue">Return Value</h4>
4807         <p class="description">Boolean value or 0 on error</p>
4808 <h4 class="discussion">Discussion</h4>
4809         <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to
4810 <code>ippGetCount(attr)</code> - 1.
4811
4812 </p>
4813 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetCollection">ippGetCollection</a></h3>
4814         <p class="description">Get a collection value for an attribute.</p>
4815 <p class="code">
4816 <a href="#ipp_t">ipp_t</a> *ippGetCollection(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p>
4817 <h4 class="parameters">Parameters</h4>
4818 <table class="list"><tbody>
4819 <tr><th>attr</th>
4820         <td class="description">IPP attribute</td></tr>
4821 <tr><th>element</th>
4822         <td class="description">Value number (0-based)</td></tr>
4823 </tbody></table>
4824 <h4 class="returnvalue">Return Value</h4>
4825         <p class="description">Collection value or <code>NULL</code> on error</p>
4826 <h4 class="discussion">Discussion</h4>
4827         <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to
4828 <code>ippGetCount(attr)</code> - 1.
4829
4830 </p>
4831 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetCount">ippGetCount</a></h3>
4832         <p class="description">Get the number of values in an attribute.</p>
4833 <p class="code">
4834 int ippGetCount(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p>
4835 <h4 class="parameters">Parameters</h4>
4836 <table class="list"><tbody>
4837 <tr><th>attr</th>
4838         <td class="description">IPP attribute</td></tr>
4839 </tbody></table>
4840 <h4 class="returnvalue">Return Value</h4>
4841         <p class="description">Number of values or 0 on error</p>
4842 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetDate">ippGetDate</a></h3>
4843         <p class="description">Get a dateTime value for an attribute.</p>
4844 <p class="code">
4845 const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippGetDate(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p>
4846 <h4 class="parameters">Parameters</h4>
4847 <table class="list"><tbody>
4848 <tr><th>attr</th>
4849         <td class="description">IPP attribute</td></tr>
4850 <tr><th>element</th>
4851         <td class="description">Value number (0-based)</td></tr>
4852 </tbody></table>
4853 <h4 class="returnvalue">Return Value</h4>
4854         <p class="description">dateTime value or <code>NULL</code></p>
4855 <h4 class="discussion">Discussion</h4>
4856         <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to
4857 <code>ippGetCount(attr)</code> - 1.
4858
4859 </p>
4860 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetGroupTag">ippGetGroupTag</a></h3>
4861         <p class="description">Get the group associated with an attribute.</p>
4862 <p class="code">
4863 ipp_tag_t ippGetGroupTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p>
4864 <h4 class="parameters">Parameters</h4>
4865 <table class="list"><tbody>
4866 <tr><th>attr</th>
4867         <td class="description">IPP attribute</td></tr>
4868 </tbody></table>
4869 <h4 class="returnvalue">Return Value</h4>
4870         <p class="description">Group tag or <code>IPP_TAG_ZERO</code> on error</p>
4871 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetInteger">ippGetInteger</a></h3>
4872         <p class="description">Get the integer/enum value for an attribute.</p>
4873 <p class="code">
4874 int ippGetInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p>
4875 <h4 class="parameters">Parameters</h4>
4876 <table class="list"><tbody>
4877 <tr><th>attr</th>
4878         <td class="description">IPP attribute</td></tr>
4879 <tr><th>element</th>
4880         <td class="description">Value number (0-based)</td></tr>
4881 </tbody></table>
4882 <h4 class="returnvalue">Return Value</h4>
4883         <p class="description">Value or 0 on error</p>
4884 <h4 class="discussion">Discussion</h4>
4885         <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to
4886 <code>ippGetCount(attr)</code> - 1.
4887
4888 </p>
4889 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetName">ippGetName</a></h3>
4890         <p class="description">Get the attribute name.</p>
4891 <p class="code">
4892 const char *ippGetName(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p>
4893 <h4 class="parameters">Parameters</h4>
4894 <table class="list"><tbody>
4895 <tr><th>attr</th>
4896         <td class="description">IPP attribute</td></tr>
4897 </tbody></table>
4898 <h4 class="returnvalue">Return Value</h4>
4899         <p class="description">Attribute name or <code>NULL</code> for separators</p>
4900 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippGetOctetString">ippGetOctetString</a></h3>
4901         <p class="description">Get an octetString value from an IPP attribute.</p>
4902 <p class="code">
4903 void *ippGetOctetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *datalen);</p>
4904 <h4 class="parameters">Parameters</h4>
4905 <table class="list"><tbody>
4906 <tr><th>attr</th>
4907         <td class="description">IPP attribute</td></tr>
4908 <tr><th>element</th>
4909         <td class="description">Value number (0-based)</td></tr>
4910 <tr><th>datalen</th>
4911         <td class="description">Length of octetString data</td></tr>
4912 </tbody></table>
4913 <h4 class="returnvalue">Return Value</h4>
4914         <p class="description">Pointer to octetString data</p>
4915 <h4 class="discussion">Discussion</h4>
4916         <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to
4917 <code>ippGetCount(attr)</code> - 1.
4918
4919 </p>
4920 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetOperation">ippGetOperation</a></h3>
4921         <p class="description">Get the operation ID in an IPP message.</p>
4922 <p class="code">
4923 ipp_op_t ippGetOperation(<a href="#ipp_t">ipp_t</a> *ipp);</p>
4924 <h4 class="parameters">Parameters</h4>
4925 <table class="list"><tbody>
4926 <tr><th>ipp</th>
4927         <td class="description">IPP request message</td></tr>
4928 </tbody></table>
4929 <h4 class="returnvalue">Return Value</h4>
4930         <p class="description">Operation ID or 0 on error</p>
4931 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetRange">ippGetRange</a></h3>
4932         <p class="description">Get a rangeOfInteger value from an attribute.</p>
4933 <p class="code">
4934 int ippGetRange(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *uppervalue);</p>
4935 <h4 class="parameters">Parameters</h4>
4936 <table class="list"><tbody>
4937 <tr><th>attr</th>
4938         <td class="description">IPP attribute</td></tr>
4939 <tr><th>element</th>
4940         <td class="description">Value number (0-based)</td></tr>
4941 <tr><th>uppervalue</th>
4942         <td class="description">Upper value of range</td></tr>
4943 </tbody></table>
4944 <h4 class="returnvalue">Return Value</h4>
4945         <p class="description">Lower value of range or 0</p>
4946 <h4 class="discussion">Discussion</h4>
4947         <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to
4948 <code>ippGetCount(attr)</code> - 1.
4949
4950 </p>
4951 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetRequestId">ippGetRequestId</a></h3>
4952         <p class="description">Get the request ID from an IPP message.</p>
4953 <p class="code">
4954 int ippGetRequestId(<a href="#ipp_t">ipp_t</a> *ipp);</p>
4955 <h4 class="parameters">Parameters</h4>
4956 <table class="list"><tbody>
4957 <tr><th>ipp</th>
4958         <td class="description">IPP message</td></tr>
4959 </tbody></table>
4960 <h4 class="returnvalue">Return Value</h4>
4961         <p class="description">Request ID or 0 on error</p>
4962 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetResolution">ippGetResolution</a></h3>
4963         <p class="description">Get a resolution value for an attribute.</p>
4964 <p class="code">
4965 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>
4966 <h4 class="parameters">Parameters</h4>
4967 <table class="list"><tbody>
4968 <tr><th>attr</th>
4969         <td class="description">IPP attribute</td></tr>
4970 <tr><th>element</th>
4971         <td class="description">Value number (0-based)</td></tr>
4972 <tr><th>yres</th>
4973         <td class="description">Vertical/feed resolution</td></tr>
4974 <tr><th>units</th>
4975         <td class="description">Units for resolution</td></tr>
4976 </tbody></table>
4977 <h4 class="returnvalue">Return Value</h4>
4978         <p class="description">Horizontal/cross feed resolution or 0</p>
4979 <h4 class="discussion">Discussion</h4>
4980         <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to
4981 <code>ippGetCount(attr)</code> - 1.
4982
4983 </p>
4984 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetState">ippGetState</a></h3>
4985         <p class="description">Get the IPP message state.</p>
4986 <p class="code">
4987 <a href="#ipp_state_t">ipp_state_t</a> ippGetState(<a href="#ipp_t">ipp_t</a> *ipp);</p>
4988 <h4 class="parameters">Parameters</h4>
4989 <table class="list"><tbody>
4990 <tr><th>ipp</th>
4991         <td class="description">IPP message</td></tr>
4992 </tbody></table>
4993 <h4 class="returnvalue">Return Value</h4>
4994         <p class="description">IPP message state value</p>
4995 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetStatusCode">ippGetStatusCode</a></h3>
4996         <p class="description">Get the status code from an IPP response or event message.</p>
4997 <p class="code">
4998 ipp_status_t ippGetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp);</p>
4999 <h4 class="parameters">Parameters</h4>
5000 <table class="list"><tbody>
5001 <tr><th>ipp</th>
5002         <td class="description">IPP response or event message</td></tr>
5003 </tbody></table>
5004 <h4 class="returnvalue">Return Value</h4>
5005         <p class="description">Status code in IPP message</p>
5006 <h3 class="function"><a id="ippGetString">ippGetString</a></h3>
5007         <p class="description"></p>
5008 <p class="code">
5009 const char *ippGetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, const char **language);</p>
5010 <h4 class="parameters">Parameters</h4>
5011 <table class="list"><tbody>
5012 <tr><th>attr</th>
5013         <td class="description">IPP attribute</td></tr>
5014 <tr><th>element</th>
5015         <td class="description">Value number (0-based)</td></tr>
5016 <tr><th>language</th>
5017         <td class="description">Language code (<code>NULL</code> for don't care)</td></tr>
5018 </tbody></table>
5019 <h4 class="returnvalue">Return Value</h4>
5020         <p class="description">Get the string and optionally the language code for an attribute.</p>
5021         <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to
5022 <code>ippGetCount(attr)</code> - 1.
5023
5024 </p>
5025 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetValueTag">ippGetValueTag</a></h3>
5026         <p class="description">Get the value tag for an attribute.</p>
5027 <p class="code">
5028 ipp_tag_t ippGetValueTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p>
5029 <h4 class="parameters">Parameters</h4>
5030 <table class="list"><tbody>
5031 <tr><th>attr</th>
5032         <td class="description">IPP attribute</td></tr>
5033 </tbody></table>
5034 <h4 class="returnvalue">Return Value</h4>
5035         <p class="description">Value tag or <code>IPP_TAG_ZERO</code> on error</p>
5036 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippGetVersion">ippGetVersion</a></h3>
5037         <p class="description">Get the major and minor version number from an IPP message.</p>
5038 <p class="code">
5039 int ippGetVersion(<a href="#ipp_t">ipp_t</a> *ipp, int *minor);</p>
5040 <h4 class="parameters">Parameters</h4>
5041 <table class="list"><tbody>
5042 <tr><th>ipp</th>
5043         <td class="description">IPP message</td></tr>
5044 <tr><th>minor</th>
5045         <td class="description">Minor version number or <code>NULL</code> for don't care</td></tr>
5046 </tbody></table>
5047 <h4 class="returnvalue">Return Value</h4>
5048         <p class="description">Major version number or 0 on error</p>
5049 <h3 class="function"><a id="ippLength">ippLength</a></h3>
5050         <p class="description">Compute the length of an IPP message.</p>
5051 <p class="code">
5052 size_t ippLength(<a href="#ipp_t">ipp_t</a> *ipp);</p>
5053 <h4 class="parameters">Parameters</h4>
5054 <table class="list"><tbody>
5055 <tr><th>ipp</th>
5056         <td class="description">IPP message</td></tr>
5057 </tbody></table>
5058 <h4 class="returnvalue">Return Value</h4>
5059         <p class="description">Size of IPP message</p>
5060 <h3 class="function"><a id="ippNew">ippNew</a></h3>
5061         <p class="description">Allocate a new IPP message.</p>
5062 <p class="code">
5063 <a href="#ipp_t">ipp_t</a> *ippNew(void);</p>
5064 <h4 class="returnvalue">Return Value</h4>
5065         <p class="description">New IPP message</p>
5066 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="ippNewRequest">ippNewRequest</a></h3>
5067         <p class="description">Allocate a new IPP request message.</p>
5068 <p class="code">
5069 <a href="#ipp_t">ipp_t</a> *ippNewRequest(ipp_op_t op);</p>
5070 <h4 class="parameters">Parameters</h4>
5071 <table class="list"><tbody>
5072 <tr><th>op</th>
5073         <td class="description">Operation code</td></tr>
5074 </tbody></table>
5075 <h4 class="returnvalue">Return Value</h4>
5076         <p class="description">IPP request message</p>
5077 <h4 class="discussion">Discussion</h4>
5078         <p class="discussion">The new request message is initialized with the &quot;attributes-charset&quot; and
5079 &quot;attributes-natural-language&quot; attributes added. The
5080 &quot;attributes-natural-language&quot; value is derived from the current locale.
5081
5082 </p>
5083 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippNewResponse">ippNewResponse</a></h3>
5084         <p class="description">Allocate a new IPP response message.</p>
5085 <p class="code">
5086 <a href="#ipp_t">ipp_t</a> *ippNewResponse(<a href="#ipp_t">ipp_t</a> *request);</p>
5087 <h4 class="parameters">Parameters</h4>
5088 <table class="list"><tbody>
5089 <tr><th>request</th>
5090         <td class="description">IPP request message</td></tr>
5091 </tbody></table>
5092 <h4 class="returnvalue">Return Value</h4>
5093         <p class="description">IPP response message</p>
5094 <h4 class="discussion">Discussion</h4>
5095         <p class="discussion">The new response message is initialized with the same &quot;version-number&quot;,
5096 &quot;request-id&quot;, &quot;attributes-charset&quot;, and &quot;attributes-natural-language&quot; as the
5097 provided request message.  If the &quot;attributes-charset&quot; or
5098 &quot;attributes-natural-language&quot; attributes are missing from the request,
5099 'utf-8' and a value derived from the current locale are substituted,
5100 respectively.
5101
5102 </p>
5103 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippNextAttribute">ippNextAttribute</a></h3>
5104         <p class="description">Return the next attribute in the message.</p>
5105 <p class="code">
5106 <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippNextAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p>
5107 <h4 class="parameters">Parameters</h4>
5108 <table class="list"><tbody>
5109 <tr><th>ipp</th>
5110         <td class="description">IPP message</td></tr>
5111 </tbody></table>
5112 <h4 class="returnvalue">Return Value</h4>
5113         <p class="description">Next attribute or <code>NULL</code> if none</p>
5114 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="ippOpString">ippOpString</a></h3>
5115         <p class="description">Return a name for the given operation id.</p>
5116 <p class="code">
5117 const char *ippOpString(ipp_op_t op);</p>
5118 <h4 class="parameters">Parameters</h4>
5119 <table class="list"><tbody>
5120 <tr><th>op</th>
5121         <td class="description">Operation ID</td></tr>
5122 </tbody></table>
5123 <h4 class="returnvalue">Return Value</h4>
5124         <p class="description">Name</p>
5125 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="ippOpValue">ippOpValue</a></h3>
5126         <p class="description">Return an operation id for the given name.</p>
5127 <p class="code">
5128 ipp_op_t ippOpValue(const char *name);</p>
5129 <h4 class="parameters">Parameters</h4>
5130 <table class="list"><tbody>
5131 <tr><th>name</th>
5132         <td class="description">Textual name</td></tr>
5133 </tbody></table>
5134 <h4 class="returnvalue">Return Value</h4>
5135         <p class="description">Operation ID</p>
5136 <h3 class="function"><a id="ippPort">ippPort</a></h3>
5137         <p class="description">Return the default IPP port number.</p>
5138 <p class="code">
5139 int ippPort(void);</p>
5140 <h4 class="returnvalue">Return Value</h4>
5141         <p class="description">Port number</p>
5142 <h3 class="function"><a id="ippRead">ippRead</a></h3>
5143         <p class="description">Read data for an IPP message from a HTTP connection.</p>
5144 <p class="code">
5145 <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>
5146 <h4 class="parameters">Parameters</h4>
5147 <table class="list"><tbody>
5148 <tr><th>http</th>
5149         <td class="description">HTTP connection</td></tr>
5150 <tr><th>ipp</th>
5151         <td class="description">IPP data</td></tr>
5152 </tbody></table>
5153 <h4 class="returnvalue">Return Value</h4>
5154         <p class="description">Current state</p>
5155 <h3 class="function"><span class="info">&#160;CUPS 1.1.19/macOS 10.3&#160;</span><a id="ippReadFile">ippReadFile</a></h3>
5156         <p class="description">Read data for an IPP message from a file.</p>
5157 <p class="code">
5158 <a href="#ipp_state_t">ipp_state_t</a> ippReadFile(int fd, <a href="#ipp_t">ipp_t</a> *ipp);</p>
5159 <h4 class="parameters">Parameters</h4>
5160 <table class="list"><tbody>
5161 <tr><th>fd</th>
5162         <td class="description">HTTP data</td></tr>
5163 <tr><th>ipp</th>
5164         <td class="description">IPP data</td></tr>
5165 </tbody></table>
5166 <h4 class="returnvalue">Return Value</h4>
5167         <p class="description">Current state</p>
5168 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="ippReadIO">ippReadIO</a></h3>
5169         <p class="description">Read data for an IPP message.</p>
5170 <p class="code">
5171 <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>
5172 <h4 class="parameters">Parameters</h4>
5173 <table class="list"><tbody>
5174 <tr><th>src</th>
5175         <td class="description">Data source</td></tr>
5176 <tr><th>cb</th>
5177         <td class="description">Read callback function</td></tr>
5178 <tr><th>blocking</th>
5179         <td class="description">Use blocking IO?</td></tr>
5180 <tr><th>parent</th>
5181         <td class="description">Parent request, if any</td></tr>
5182 <tr><th>ipp</th>
5183         <td class="description">IPP data</td></tr>
5184 </tbody></table>
5185 <h4 class="returnvalue">Return Value</h4>
5186         <p class="description">Current state</p>
5187 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetBoolean">ippSetBoolean</a></h3>
5188         <p class="description">Set a boolean value in an attribute.</p>
5189 <p class="code">
5190 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>
5191 <h4 class="parameters">Parameters</h4>
5192 <table class="list"><tbody>
5193 <tr><th>ipp</th>
5194         <td class="description">IPP message</td></tr>
5195 <tr><th>attr</th>
5196         <td class="description">IPP attribute</td></tr>
5197 <tr><th>element</th>
5198         <td class="description">Value number (0-based)</td></tr>
5199 <tr><th>boolvalue</th>
5200         <td class="description">Boolean value</td></tr>
5201 </tbody></table>
5202 <h4 class="returnvalue">Return Value</h4>
5203         <p class="description">1 on success, 0 on failure</p>
5204 <h4 class="discussion">Discussion</h4>
5205         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5206 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>
5207 <br>
5208 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5209 <br>
5210 The <code>element</code> parameter specifies which value to set from 0 to
5211 <code>ippGetCount(attr)</code>.
5212
5213 </p>
5214 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetCollection">ippSetCollection</a></h3>
5215         <p class="description">Set a collection value in an attribute.</p>
5216 <p class="code">
5217 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>
5218 <h4 class="parameters">Parameters</h4>
5219 <table class="list"><tbody>
5220 <tr><th>ipp</th>
5221         <td class="description">IPP message</td></tr>
5222 <tr><th>attr</th>
5223         <td class="description">IPP attribute</td></tr>
5224 <tr><th>element</th>
5225         <td class="description">Value number (0-based)</td></tr>
5226 <tr><th>colvalue</th>
5227         <td class="description">Collection value</td></tr>
5228 </tbody></table>
5229 <h4 class="returnvalue">Return Value</h4>
5230         <p class="description">1 on success, 0 on failure</p>
5231 <h4 class="discussion">Discussion</h4>
5232         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5233 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>
5234 <br>
5235 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5236 <br>
5237 The <code>element</code> parameter specifies which value to set from 0 to
5238 <code>ippGetCount(attr)</code>.
5239
5240 </p>
5241 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetDate">ippSetDate</a></h3>
5242         <p class="description">Set a dateTime value in an attribute.</p>
5243 <p class="code">
5244 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>
5245 <h4 class="parameters">Parameters</h4>
5246 <table class="list"><tbody>
5247 <tr><th>ipp</th>
5248         <td class="description">IPP message</td></tr>
5249 <tr><th>attr</th>
5250         <td class="description">IPP attribute</td></tr>
5251 <tr><th>element</th>
5252         <td class="description">Value number (0-based)</td></tr>
5253 <tr><th>datevalue</th>
5254         <td class="description">dateTime value</td></tr>
5255 </tbody></table>
5256 <h4 class="returnvalue">Return Value</h4>
5257         <p class="description">1 on success, 0 on failure</p>
5258 <h4 class="discussion">Discussion</h4>
5259         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5260 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>
5261 <br>
5262 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5263 <br>
5264 The <code>element</code> parameter specifies which value to set from 0 to
5265 <code>ippGetCount(attr)</code>.
5266
5267 </p>
5268 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetGroupTag">ippSetGroupTag</a></h3>
5269         <p class="description">Set the group tag of an attribute.</p>
5270 <p class="code">
5271 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>
5272 <h4 class="parameters">Parameters</h4>
5273 <table class="list"><tbody>
5274 <tr><th>ipp</th>
5275         <td class="description">IPP message</td></tr>
5276 <tr><th>attr</th>
5277         <td class="description">Attribute</td></tr>
5278 <tr><th>group_tag</th>
5279         <td class="description">Group tag</td></tr>
5280 </tbody></table>
5281 <h4 class="returnvalue">Return Value</h4>
5282         <p class="description">1 on success, 0 on failure</p>
5283 <h4 class="discussion">Discussion</h4>
5284         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5285 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>
5286 <br>
5287 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5288 <br>
5289 The <code>group</code> parameter specifies the IPP attribute group tag: none
5290 (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>),
5291 event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation
5292 (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription
5293 (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).
5294
5295 </p>
5296 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetInteger">ippSetInteger</a></h3>
5297         <p class="description">Set an integer or enum value in an attribute.</p>
5298 <p class="code">
5299 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>
5300 <h4 class="parameters">Parameters</h4>
5301 <table class="list"><tbody>
5302 <tr><th>ipp</th>
5303         <td class="description">IPP message</td></tr>
5304 <tr><th>attr</th>
5305         <td class="description">IPP attribute</td></tr>
5306 <tr><th>element</th>
5307         <td class="description">Value number (0-based)</td></tr>
5308 <tr><th>intvalue</th>
5309         <td class="description">Integer/enum value</td></tr>
5310 </tbody></table>
5311 <h4 class="returnvalue">Return Value</h4>
5312         <p class="description">1 on success, 0 on failure</p>
5313 <h4 class="discussion">Discussion</h4>
5314         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5315 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>
5316 <br>
5317 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5318 <br>
5319 The <code>element</code> parameter specifies which value to set from 0 to
5320 <code>ippGetCount(attr)</code>.
5321
5322 </p>
5323 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetName">ippSetName</a></h3>
5324         <p class="description">Set the name of an attribute.</p>
5325 <p class="code">
5326 int ippSetName(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, const char *name);</p>
5327 <h4 class="parameters">Parameters</h4>
5328 <table class="list"><tbody>
5329 <tr><th>ipp</th>
5330         <td class="description">IPP message</td></tr>
5331 <tr><th>attr</th>
5332         <td class="description">IPP attribute</td></tr>
5333 <tr><th>name</th>
5334         <td class="description">Attribute name</td></tr>
5335 </tbody></table>
5336 <h4 class="returnvalue">Return Value</h4>
5337         <p class="description">1 on success, 0 on failure</p>
5338 <h4 class="discussion">Discussion</h4>
5339         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5340 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>
5341 <br>
5342 The <code>attr</code> parameter may be modified as a result of setting the value.
5343
5344 </p>
5345 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippSetOctetString">ippSetOctetString</a></h3>
5346         <p class="description">Set an octetString value in an IPP attribute.</p>
5347 <p class="code">
5348 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>
5349 <h4 class="parameters">Parameters</h4>
5350 <table class="list"><tbody>
5351 <tr><th>ipp</th>
5352         <td class="description">IPP message</td></tr>
5353 <tr><th>attr</th>
5354         <td class="description">IPP attribute</td></tr>
5355 <tr><th>element</th>
5356         <td class="description">Value number (0-based)</td></tr>
5357 <tr><th>data</th>
5358         <td class="description">Pointer to octetString data</td></tr>
5359 <tr><th>datalen</th>
5360         <td class="description">Length of octetString data</td></tr>
5361 </tbody></table>
5362 <h4 class="returnvalue">Return Value</h4>
5363         <p class="description">1 on success, 0 on failure</p>
5364 <h4 class="discussion">Discussion</h4>
5365         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5366 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>
5367 <br>
5368 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5369 <br>
5370 The <code>element</code> parameter specifies which value to set from 0 to
5371 <code>ippGetCount(attr)</code>.
5372
5373 </p>
5374 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetOperation">ippSetOperation</a></h3>
5375         <p class="description">Set the operation ID in an IPP request message.</p>
5376 <p class="code">
5377 int ippSetOperation(<a href="#ipp_t">ipp_t</a> *ipp, ipp_op_t op);</p>
5378 <h4 class="parameters">Parameters</h4>
5379 <table class="list"><tbody>
5380 <tr><th>ipp</th>
5381         <td class="description">IPP request message</td></tr>
5382 <tr><th>op</th>
5383         <td class="description">Operation ID</td></tr>
5384 </tbody></table>
5385 <h4 class="returnvalue">Return Value</h4>
5386         <p class="description">1 on success, 0 on failure</p>
5387 <h4 class="discussion">Discussion</h4>
5388         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5389 the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or  <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.
5390
5391 </p>
5392 <h3 class="function"><a id="ippSetPort">ippSetPort</a></h3>
5393         <p class="description">Set the default port number.</p>
5394 <p class="code">
5395 void ippSetPort(int p);</p>
5396 <h4 class="parameters">Parameters</h4>
5397 <table class="list"><tbody>
5398 <tr><th>p</th>
5399         <td class="description">Port number to use</td></tr>
5400 </tbody></table>
5401 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetRange">ippSetRange</a></h3>
5402         <p class="description">Set a rangeOfInteger value in an attribute.</p>
5403 <p class="code">
5404 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>
5405 <h4 class="parameters">Parameters</h4>
5406 <table class="list"><tbody>
5407 <tr><th>ipp</th>
5408         <td class="description">IPP message</td></tr>
5409 <tr><th>attr</th>
5410         <td class="description">IPP attribute</td></tr>
5411 <tr><th>element</th>
5412         <td class="description">Value number (0-based)</td></tr>
5413 <tr><th>lowervalue</th>
5414         <td class="description">Lower bound for range</td></tr>
5415 <tr><th>uppervalue</th>
5416         <td class="description">Upper bound for range</td></tr>
5417 </tbody></table>
5418 <h4 class="returnvalue">Return Value</h4>
5419         <p class="description">1 on success, 0 on failure</p>
5420 <h4 class="discussion">Discussion</h4>
5421         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5422 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>
5423 <br>
5424 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5425 <br>
5426 The <code>element</code> parameter specifies which value to set from 0 to
5427 <code>ippGetCount(attr)</code>.
5428
5429 </p>
5430 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetRequestId">ippSetRequestId</a></h3>
5431         <p class="description">Set the request ID in an IPP message.</p>
5432 <p class="code">
5433 int ippSetRequestId(<a href="#ipp_t">ipp_t</a> *ipp, int request_id);</p>
5434 <h4 class="parameters">Parameters</h4>
5435 <table class="list"><tbody>
5436 <tr><th>ipp</th>
5437         <td class="description">IPP message</td></tr>
5438 <tr><th>request_id</th>
5439         <td class="description">Request ID</td></tr>
5440 </tbody></table>
5441 <h4 class="returnvalue">Return Value</h4>
5442         <p class="description">1 on success, 0 on failure</p>
5443 <h4 class="discussion">Discussion</h4>
5444         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5445 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>
5446 <br>
5447 The <code>request_id</code> parameter must be greater than 0.
5448
5449 </p>
5450 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetResolution">ippSetResolution</a></h3>
5451         <p class="description">Set a resolution value in an attribute.</p>
5452 <p class="code">
5453 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>
5454 <h4 class="parameters">Parameters</h4>
5455 <table class="list"><tbody>
5456 <tr><th>ipp</th>
5457         <td class="description">IPP message</td></tr>
5458 <tr><th>attr</th>
5459         <td class="description">IPP attribute</td></tr>
5460 <tr><th>element</th>
5461         <td class="description">Value number (0-based)</td></tr>
5462 <tr><th>unitsvalue</th>
5463         <td class="description">Resolution units</td></tr>
5464 <tr><th>xresvalue</th>
5465         <td class="description">Horizontal/cross feed resolution</td></tr>
5466 <tr><th>yresvalue</th>
5467         <td class="description">Vertical/feed resolution</td></tr>
5468 </tbody></table>
5469 <h4 class="returnvalue">Return Value</h4>
5470         <p class="description">1 on success, 0 on failure</p>
5471 <h4 class="discussion">Discussion</h4>
5472         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5473 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>
5474 <br>
5475 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5476 <br>
5477 The <code>element</code> parameter specifies which value to set from 0 to
5478 <code>ippGetCount(attr)</code>.
5479
5480 </p>
5481 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetState">ippSetState</a></h3>
5482         <p class="description">Set the current state of the IPP message.</p>
5483 <p class="code">
5484 int ippSetState(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_state_t">ipp_state_t</a> state);</p>
5485 <h4 class="parameters">Parameters</h4>
5486 <table class="list"><tbody>
5487 <tr><th>ipp</th>
5488         <td class="description">IPP message</td></tr>
5489 <tr><th>state</th>
5490         <td class="description">IPP state value</td></tr>
5491 </tbody></table>
5492 <h4 class="returnvalue">Return Value</h4>
5493         <p class="description">1 on success, 0 on failure</p>
5494 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetStatusCode">ippSetStatusCode</a></h3>
5495         <p class="description">Set the status code in an IPP response or event message.</p>
5496 <p class="code">
5497 int ippSetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp, ipp_status_t status);</p>
5498 <h4 class="parameters">Parameters</h4>
5499 <table class="list"><tbody>
5500 <tr><th>ipp</th>
5501         <td class="description">IPP response or event message</td></tr>
5502 <tr><th>status</th>
5503         <td class="description">Status code</td></tr>
5504 </tbody></table>
5505 <h4 class="returnvalue">Return Value</h4>
5506         <p class="description">1 on success, 0 on failure</p>
5507 <h4 class="discussion">Discussion</h4>
5508         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5509 the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or  <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.
5510
5511 </p>
5512 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetString">ippSetString</a></h3>
5513         <p class="description">Set a string value in an attribute.</p>
5514 <p class="code">
5515 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>
5516 <h4 class="parameters">Parameters</h4>
5517 <table class="list"><tbody>
5518 <tr><th>ipp</th>
5519         <td class="description">IPP message</td></tr>
5520 <tr><th>attr</th>
5521         <td class="description">IPP attribute</td></tr>
5522 <tr><th>element</th>
5523         <td class="description">Value number (0-based)</td></tr>
5524 <tr><th>strvalue</th>
5525         <td class="description">String value</td></tr>
5526 </tbody></table>
5527 <h4 class="returnvalue">Return Value</h4>
5528         <p class="description">1 on success, 0 on failure</p>
5529 <h4 class="discussion">Discussion</h4>
5530         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5531 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>
5532 <br>
5533 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5534 <br>
5535 The <code>element</code> parameter specifies which value to set from 0 to
5536 <code>ippGetCount(attr)</code>.
5537
5538 </p>
5539 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippSetStringf">ippSetStringf</a></h3>
5540         <p class="description">Set a formatted string value of an attribute.</p>
5541 <p class="code">
5542 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>
5543 <h4 class="parameters">Parameters</h4>
5544 <table class="list"><tbody>
5545 <tr><th>ipp</th>
5546         <td class="description">IPP message</td></tr>
5547 <tr><th>attr</th>
5548         <td class="description">IPP attribute</td></tr>
5549 <tr><th>element</th>
5550         <td class="description">Value number (0-based)</td></tr>
5551 <tr><th>format</th>
5552         <td class="description">Printf-style format string</td></tr>
5553 <tr><th>...</th>
5554         <td class="description">Additional arguments as needed</td></tr>
5555 </tbody></table>
5556 <h4 class="returnvalue">Return Value</h4>
5557         <p class="description">1 on success, 0 on failure</p>
5558 <h4 class="discussion">Discussion</h4>
5559         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5560 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>
5561 <br>
5562 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5563 <br>
5564 The <code>element</code> parameter specifies which value to set from 0 to
5565 <code>ippGetCount(attr)</code>.<br>
5566 <br>
5567 The <code>format</code> parameter uses formatting characters compatible with the
5568 printf family of standard functions.  Additional arguments follow it as
5569 needed.  The formatted string is truncated as needed to the maximum length of
5570 the corresponding value type.
5571
5572 </p>
5573 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippSetStringfv">ippSetStringfv</a></h3>
5574         <p class="description">Set a formatted string value of an attribute.</p>
5575 <p class="code">
5576 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>
5577 <h4 class="parameters">Parameters</h4>
5578 <table class="list"><tbody>
5579 <tr><th>ipp</th>
5580         <td class="description">IPP message</td></tr>
5581 <tr><th>attr</th>
5582         <td class="description">IPP attribute</td></tr>
5583 <tr><th>element</th>
5584         <td class="description">Value number (0-based)</td></tr>
5585 <tr><th>format</th>
5586         <td class="description">Printf-style format string</td></tr>
5587 <tr><th>ap</th>
5588         <td class="description">Pointer to additional arguments</td></tr>
5589 </tbody></table>
5590 <h4 class="returnvalue">Return Value</h4>
5591         <p class="description">1 on success, 0 on failure</p>
5592 <h4 class="discussion">Discussion</h4>
5593         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5594 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>
5595 <br>
5596 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5597 <br>
5598 The <code>element</code> parameter specifies which value to set from 0 to
5599 <code>ippGetCount(attr)</code>.<br>
5600 <br>
5601 The <code>format</code> parameter uses formatting characters compatible with the
5602 printf family of standard functions.  Additional arguments follow it as
5603 needed.  The formatted string is truncated as needed to the maximum length of
5604 the corresponding value type.
5605
5606 </p>
5607 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetValueTag">ippSetValueTag</a></h3>
5608         <p class="description">Set the value tag of an attribute.</p>
5609 <p class="code">
5610 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>
5611 <h4 class="parameters">Parameters</h4>
5612 <table class="list"><tbody>
5613 <tr><th>ipp</th>
5614         <td class="description">IPP message</td></tr>
5615 <tr><th>attr</th>
5616         <td class="description">IPP attribute</td></tr>
5617 <tr><th>value_tag</th>
5618         <td class="description">Value tag</td></tr>
5619 </tbody></table>
5620 <h4 class="returnvalue">Return Value</h4>
5621         <p class="description">1 on success, 0 on failure</p>
5622 <h4 class="discussion">Discussion</h4>
5623         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5624 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>
5625 <br>
5626 The <code>attr</code> parameter may be modified as a result of setting the value.<br>
5627 <br>
5628 Integer (<code>IPP_TAG_INTEGER</code>) values can be promoted to rangeOfInteger
5629 (<code>IPP_TAG_RANGE</code>) values, the various string tags can be promoted to name
5630 (<code>IPP_TAG_NAME</code>) or nameWithLanguage (<code>IPP_TAG_NAMELANG</code>) values, text
5631 (<code>IPP_TAG_TEXT</code>) values can be promoted to textWithLanguage
5632 (<code>IPP_TAG_TEXTLANG</code>) values, and all values can be demoted to the various
5633 out-of-band value tags such as no-value (<code>IPP_TAG_NOVALUE</code>). All other changes
5634 will be rejected.<br>
5635 <br>
5636 Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language
5637 code in the &quot;attributes-natural-language&quot; attribute or, if not present, the language
5638 code for the current locale.
5639
5640 </p>
5641 <h3 class="function"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="ippSetVersion">ippSetVersion</a></h3>
5642         <p class="description">Set the version number in an IPP message.</p>
5643 <p class="code">
5644 int ippSetVersion(<a href="#ipp_t">ipp_t</a> *ipp, int major, int minor);</p>
5645 <h4 class="parameters">Parameters</h4>
5646 <table class="list"><tbody>
5647 <tr><th>ipp</th>
5648         <td class="description">IPP message</td></tr>
5649 <tr><th>major</th>
5650         <td class="description">Major version number (major.minor)</td></tr>
5651 <tr><th>minor</th>
5652         <td class="description">Minor version number (major.minor)</td></tr>
5653 </tbody></table>
5654 <h4 class="returnvalue">Return Value</h4>
5655         <p class="description">1 on success, 0 on failure</p>
5656 <h4 class="discussion">Discussion</h4>
5657         <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using
5658 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>
5659 <br>
5660 The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2.
5661
5662 </p>
5663 <h3 class="function"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span><a id="ippStateString">ippStateString</a></h3>
5664         <p class="description">Return the name corresponding to a state value.</p>
5665 <p class="code">
5666 const char *ippStateString(<a href="#ipp_state_t">ipp_state_t</a> state);</p>
5667 <h4 class="parameters">Parameters</h4>
5668 <table class="list"><tbody>
5669 <tr><th>state</th>
5670         <td class="description">State value</td></tr>
5671 </tbody></table>
5672 <h4 class="returnvalue">Return Value</h4>
5673         <p class="description">State name</p>
5674 <h3 class="function"><span class="info">&#160;CUPS 1.4/macOS 10.6&#160;</span><a id="ippTagString">ippTagString</a></h3>
5675         <p class="description">Return the tag name corresponding to a tag value.</p>
5676 <p class="code">
5677 const char *ippTagString(ipp_tag_t tag);</p>
5678 <h4 class="parameters">Parameters</h4>
5679 <table class="list"><tbody>
5680 <tr><th>tag</th>
5681         <td class="description">Tag value</td></tr>
5682 </tbody></table>
5683 <h4 class="returnvalue">Return Value</h4>
5684         <p class="description">Tag name</p>
5685 <h4 class="discussion">Discussion</h4>
5686         <p class="discussion">The returned names are defined in RFC 8011 and the IANA IPP Registry.
5687
5688 </p>
5689 <h3 class="function"><span class="info">&#160;CUPS 1.4/macOS 10.6&#160;</span><a id="ippTagValue">ippTagValue</a></h3>
5690         <p class="description">Return the tag value corresponding to a tag name.</p>
5691 <p class="code">
5692 ipp_tag_t ippTagValue(const char *name);</p>
5693 <h4 class="parameters">Parameters</h4>
5694 <table class="list"><tbody>
5695 <tr><th>name</th>
5696         <td class="description">Tag name</td></tr>
5697 </tbody></table>
5698 <h4 class="returnvalue">Return Value</h4>
5699         <p class="description">Tag value</p>
5700 <h4 class="discussion">Discussion</h4>
5701         <p class="discussion">The tag names are defined in RFC 8011 and the IANA IPP Registry.
5702
5703 </p>
5704 <h3 class="function"><a id="ippTimeToDate">ippTimeToDate</a></h3>
5705         <p class="description">Convert from time in seconds to RFC 2579 format.</p>
5706 <p class="code">
5707 const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippTimeToDate(time_t t);</p>
5708 <h4 class="parameters">Parameters</h4>
5709 <table class="list"><tbody>
5710 <tr><th>t</th>
5711         <td class="description">Time in seconds</td></tr>
5712 </tbody></table>
5713 <h4 class="returnvalue">Return Value</h4>
5714         <p class="description">RFC-2579 date/time data</p>
5715 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippValidateAttribute">ippValidateAttribute</a></h3>
5716         <p class="description">Validate the contents of an attribute.</p>
5717 <p class="code">
5718 int ippValidateAttribute(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p>
5719 <h4 class="parameters">Parameters</h4>
5720 <table class="list"><tbody>
5721 <tr><th>attr</th>
5722         <td class="description">Attribute</td></tr>
5723 </tbody></table>
5724 <h4 class="returnvalue">Return Value</h4>
5725         <p class="description">1 if valid, 0 otherwise</p>
5726 <h4 class="discussion">Discussion</h4>
5727         <p class="discussion">This function validates the contents of an attribute based on the name and
5728 value tag.  1 is returned if the attribute is valid, 0 otherwise.  On
5729 failure, <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> is set to a human-readable message.
5730
5731 </p>
5732 <h3 class="function"><span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span><a id="ippValidateAttributes">ippValidateAttributes</a></h3>
5733         <p class="description">Validate all attributes in an IPP message.</p>
5734 <p class="code">
5735 int ippValidateAttributes(<a href="#ipp_t">ipp_t</a> *ipp);</p>
5736 <h4 class="parameters">Parameters</h4>
5737 <table class="list"><tbody>
5738 <tr><th>ipp</th>
5739         <td class="description">IPP message</td></tr>
5740 </tbody></table>
5741 <h4 class="returnvalue">Return Value</h4>
5742         <p class="description">1 if valid, 0 otherwise</p>
5743 <h4 class="discussion">Discussion</h4>
5744         <p class="discussion">This function validates the contents of the IPP message, including each
5745 attribute.  Like <a href="#ippValidateAttribute"><code>ippValidateAttribute</code></a>, <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> is
5746 set to a human-readable message on failure.
5747
5748 </p>
5749 <h3 class="function"><a id="ippWrite">ippWrite</a></h3>
5750         <p class="description">Write data for an IPP message to a HTTP connection.</p>
5751 <p class="code">
5752 <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>
5753 <h4 class="parameters">Parameters</h4>
5754 <table class="list"><tbody>
5755 <tr><th>http</th>
5756         <td class="description">HTTP connection</td></tr>
5757 <tr><th>ipp</th>
5758         <td class="description">IPP data</td></tr>
5759 </tbody></table>
5760 <h4 class="returnvalue">Return Value</h4>
5761         <p class="description">Current state</p>
5762 <h3 class="function"><span class="info">&#160;CUPS 1.1.19/macOS 10.3&#160;</span><a id="ippWriteFile">ippWriteFile</a></h3>
5763         <p class="description">Write data for an IPP message to a file.</p>
5764 <p class="code">
5765 <a href="#ipp_state_t">ipp_state_t</a> ippWriteFile(int fd, <a href="#ipp_t">ipp_t</a> *ipp);</p>
5766 <h4 class="parameters">Parameters</h4>
5767 <table class="list"><tbody>
5768 <tr><th>fd</th>
5769         <td class="description">HTTP data</td></tr>
5770 <tr><th>ipp</th>
5771         <td class="description">IPP data</td></tr>
5772 </tbody></table>
5773 <h4 class="returnvalue">Return Value</h4>
5774         <p class="description">Current state</p>
5775 <h3 class="function"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span><a id="ippWriteIO">ippWriteIO</a></h3>
5776         <p class="description">Write data for an IPP message.</p>
5777 <p class="code">
5778 <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>
5779 <h4 class="parameters">Parameters</h4>
5780 <table class="list"><tbody>
5781 <tr><th>dst</th>
5782         <td class="description">Destination</td></tr>
5783 <tr><th>cb</th>
5784         <td class="description">Write callback function</td></tr>
5785 <tr><th>blocking</th>
5786         <td class="description">Use blocking IO?</td></tr>
5787 <tr><th>parent</th>
5788         <td class="description">Parent IPP message</td></tr>
5789 <tr><th>ipp</th>
5790         <td class="description">IPP data</td></tr>
5791 </tbody></table>
5792 <h4 class="returnvalue">Return Value</h4>
5793         <p class="description">Current state</p>
5794       <h2 class="title"><a id="TYPES">Data Types</a></h2>
5795       <h3 class="typedef"><a id="cups_client_cert_cb_t"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span>cups_client_cert_cb_t</a></h3>
5796         <p class="description">Client credentials callback
5797 </p>
5798       <p class="code">
5799 typedef int(*)(http_t *http, void *tls, cups_array_t *distinguished_names, void *user_data)cups_client_cert_cb_t;
5800 </p>
5801       <h3 class="typedef"><a id="cups_dest_cb_t"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span>cups_dest_cb_t</a></h3>
5802         <p class="description">Destination enumeration callback
5803 </p>
5804       <p class="code">
5805 typedef int(*)(void *user_data, unsigned flags, <a href="#cups_dest_t">cups_dest_t</a> *dest)cups_dest_cb_t;
5806 </p>
5807       <h3 class="typedef"><a id="cups_dest_t">cups_dest_t</a></h3>
5808         <p class="description">Destination</p>
5809       <p class="code">
5810 typedef struct <a href="#cups_dest_s">cups_dest_s</a> cups_dest_t;
5811 </p>
5812       <h3 class="typedef"><a id="cups_dinfo_t"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span>cups_dinfo_t</a></h3>
5813         <p class="description">Destination capability and status
5814 information </p>
5815       <p class="code">
5816 typedef struct _cups_dinfo_s cups_dinfo_t;
5817 </p>
5818       <h3 class="typedef"><a id="cups_job_t">cups_job_t</a></h3>
5819         <p class="description">Job</p>
5820       <p class="code">
5821 typedef struct <a href="#cups_job_s">cups_job_s</a> cups_job_t;
5822 </p>
5823       <h3 class="typedef"><a id="cups_option_t">cups_option_t</a></h3>
5824         <p class="description">Printer Options</p>
5825       <p class="code">
5826 typedef struct <a href="#cups_option_s">cups_option_s</a> cups_option_t;
5827 </p>
5828       <h3 class="typedef"><a id="cups_password_cb2_t"><span class="info">&#160;CUPS 1.4/macOS 10.6&#160;</span>cups_password_cb2_t</a></h3>
5829         <p class="description">New password callback
5830 </p>
5831       <p class="code">
5832 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;
5833 </p>
5834       <h3 class="typedef"><a id="cups_ptype_t">cups_ptype_t</a></h3>
5835         <p class="description">Printer type/capability bits</p>
5836       <p class="code">
5837 typedef unsigned cups_ptype_t;
5838 </p>
5839       <h3 class="typedef"><a id="cups_server_cert_cb_t"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span>cups_server_cert_cb_t</a></h3>
5840         <p class="description">Server credentials callback
5841 </p>
5842       <p class="code">
5843 typedef int(*)(http_t *http, void *tls, cups_array_t *certs, void *user_data)cups_server_cert_cb_t;
5844 </p>
5845       <h3 class="typedef"><a id="cups_size_t"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span>cups_size_t</a></h3>
5846         <p class="description">Media Size </p>
5847       <p class="code">
5848 typedef struct <a href="#cups_size_s">cups_size_s</a> cups_size_t;
5849 </p>
5850       <h3 class="typedef"><a id="http_addr_t"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span>http_addr_t</a></h3>
5851         <p class="description">Socket address union, which
5852 makes using IPv6 and other
5853 address types easier and
5854 more portable. </p>
5855       <p class="code">
5856 typedef union _http_addr_u / http_addr_t;
5857 </p>
5858       <h3 class="typedef"><a id="http_encoding_t">http_encoding_t</a></h3>
5859         <p class="description">HTTP transfer encoding values</p>
5860       <p class="code">
5861 typedef enum <a href="#http_encoding_e">http_encoding_e</a> http_encoding_t;
5862 </p>
5863       <h3 class="typedef"><a id="http_encryption_t">http_encryption_t</a></h3>
5864         <p class="description">HTTP encryption values</p>
5865       <p class="code">
5866 typedef enum <a href="#http_encryption_e">http_encryption_e</a> http_encryption_t;
5867 </p>
5868       <h3 class="typedef"><a id="http_field_t">http_field_t</a></h3>
5869         <p class="description">HTTP field names</p>
5870       <p class="code">
5871 typedef enum <a href="#http_field_e">http_field_e</a> http_field_t;
5872 </p>
5873       <h3 class="typedef"><a id="http_keepalive_t">http_keepalive_t</a></h3>
5874         <p class="description">HTTP keep-alive values</p>
5875       <p class="code">
5876 typedef enum <a href="#http_keepalive_e">http_keepalive_e</a> http_keepalive_t;
5877 </p>
5878       <h3 class="typedef"><a id="http_state_t">http_state_t</a></h3>
5879         <p class="description">HTTP state values; states
5880 are server-oriented...</p>
5881       <p class="code">
5882 typedef enum <a href="#http_state_e">http_state_e</a> http_state_t;
5883 </p>
5884       <h3 class="typedef"><a id="http_t">http_t</a></h3>
5885         <p class="description">HTTP connection type</p>
5886       <p class="code">
5887 typedef struct _http_s http_t;
5888 </p>
5889       <h3 class="typedef"><a id="http_timeout_cb_t"><span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span>http_timeout_cb_t</a></h3>
5890         <p class="description">HTTP timeout callback </p>
5891       <p class="code">
5892 typedef int(*)(http_t *http, void *user_data)http_timeout_cb_t;
5893 </p>
5894       <h3 class="typedef"><a id="http_trust_t"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span>http_trust_t</a></h3>
5895         <p class="description">Level of trust for credentials </p>
5896       <p class="code">
5897 typedef enum <a href="#http_trust_e">http_trust_e</a> http_trust_t;
5898 </p>
5899       <h3 class="typedef"><a id="http_uri_coding_t">http_uri_coding_t</a></h3>
5900         <p class="description">URI en/decode flags</p>
5901       <p class="code">
5902 typedef enum <a href="#http_uri_coding_e">http_uri_coding_e</a> http_uri_coding_t;
5903 </p>
5904       <h3 class="typedef"><a id="http_uri_status_t"><span class="info">&#160;CUPS 1.2&#160;</span>http_uri_status_t</a></h3>
5905         <p class="description">URI separation status </p>
5906       <p class="code">
5907 typedef enum <a href="#http_uri_status_e">http_uri_status_e</a> http_uri_status_t;
5908 </p>
5909       <h3 class="typedef"><a id="ipp_attribute_t">ipp_attribute_t</a></h3>
5910         <p class="description">IPP attribute</p>
5911       <p class="code">
5912 typedef struct _ipp_attribute_s ipp_attribute_t;
5913 </p>
5914       <h3 class="typedef"><a id="ipp_copycb_t"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span>ipp_copycb_t</a></h3>
5915         <p class="description">ippCopyAttributes callback function </p>
5916       <p class="code">
5917 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;
5918 </p>
5919       <h3 class="typedef"><a id="ipp_iocb_t"><span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span>ipp_iocb_t</a></h3>
5920         <p class="description">ippReadIO/ippWriteIO callback function </p>
5921       <p class="code">
5922 typedef ssize_t(*)(void *context, ipp_uchar_t *buffer, size_t bytes) ipp_iocb_t;
5923 </p>
5924       <h3 class="typedef"><a id="ipp_orient_t">ipp_orient_t</a></h3>
5925         <p class="description">Orientation values</p>
5926       <p class="code">
5927 typedef enum <a href="#ipp_orient_e">ipp_orient_e</a> ipp_orient_t;
5928 </p>
5929       <h3 class="typedef"><a id="ipp_pstate_t">ipp_pstate_t</a></h3>
5930         <p class="description">Printer state values</p>
5931       <p class="code">
5932 typedef enum <a href="#ipp_pstate_e">ipp_pstate_e</a> ipp_pstate_t;
5933 </p>
5934       <h3 class="typedef"><a id="ipp_quality_t">ipp_quality_t</a></h3>
5935         <p class="description">Print quality values</p>
5936       <p class="code">
5937 typedef enum <a href="#ipp_quality_e">ipp_quality_e</a> ipp_quality_t;
5938 </p>
5939       <h3 class="typedef"><a id="ipp_res_t">ipp_res_t</a></h3>
5940         <p class="description">Resolution units</p>
5941       <p class="code">
5942 typedef enum <a href="#ipp_res_e">ipp_res_e</a> ipp_res_t;
5943 </p>
5944       <h3 class="typedef"><a id="ipp_rstate_t">ipp_rstate_t</a></h3>
5945         <p class="description">resource-state values</p>
5946       <p class="code">
5947 typedef enum <a href="#ipp_rstate_e">ipp_rstate_e</a> ipp_rstate_t;
5948 </p>
5949       <h3 class="typedef"><a id="ipp_sstate_t">ipp_sstate_t</a></h3>
5950         <p class="description">system-state values</p>
5951       <p class="code">
5952 typedef enum <a href="#ipp_sstate_e">ipp_sstate_e</a> ipp_sstate_t;
5953 </p>
5954       <h3 class="typedef"><a id="ipp_state_t">ipp_state_t</a></h3>
5955         <p class="description">ipp_t state values</p>
5956       <p class="code">
5957 typedef enum <a href="#ipp_state_e">ipp_state_e</a> ipp_state_t;
5958 </p>
5959       <h3 class="typedef"><a id="ipp_t">ipp_t</a></h3>
5960         <p class="description">IPP request/response data</p>
5961       <p class="code">
5962 typedef struct _ipp_s ipp_t;
5963 </p>
5964       <h2 class="title"><a id="STRUCTURES">Structures</a></h2>
5965 <h3 class="struct"><a id="cups_dest_s">cups_dest_s</a></h3>
5966         <p class="description">Destination</p>
5967 <p class="code">struct cups_dest_s {<br>
5968 &#160;&#160;&#160;&#160;char *name, *instance;<br>
5969 &#160;&#160;&#160;&#160;int is_default;<br>
5970 &#160;&#160;&#160;&#160;int num_options;<br>
5971 &#160;&#160;&#160;&#160;<a href="#cups_option_t">cups_option_t</a> *options;<br>
5972 };</p>
5973 <h4 class="members">Members</h4>
5974 <table class="list"><tbody>
5975 <tr><th>instance </th>
5976         <td class="description">Local instance name or NULL</td></tr>
5977 <tr><th>is_default </th>
5978         <td class="description">Is this printer the default?</td></tr>
5979 <tr><th>num_options </th>
5980         <td class="description">Number of options</td></tr>
5981 <tr><th>options </th>
5982         <td class="description">Options</td></tr>
5983 </tbody></table>
5984 <h3 class="struct"><a id="cups_job_s">cups_job_s</a></h3>
5985         <p class="description">Job</p>
5986 <p class="code">struct cups_job_s {<br>
5987 &#160;&#160;&#160;&#160;time_t completed_time;<br>
5988 &#160;&#160;&#160;&#160;time_t creation_time;<br>
5989 &#160;&#160;&#160;&#160;char *dest;<br>
5990 &#160;&#160;&#160;&#160;char *format;<br>
5991 &#160;&#160;&#160;&#160;int id;<br>
5992 &#160;&#160;&#160;&#160;int priority;<br>
5993 &#160;&#160;&#160;&#160;time_t processing_time;<br>
5994 &#160;&#160;&#160;&#160;int size;<br>
5995 &#160;&#160;&#160;&#160;ipp_jstate_t state;<br>
5996 &#160;&#160;&#160;&#160;char *title;<br>
5997 &#160;&#160;&#160;&#160;char *user;<br>
5998 };</p>
5999 <h4 class="members">Members</h4>
6000 <table class="list"><tbody>
6001 <tr><th>completed_time </th>
6002         <td class="description">Time the job was completed</td></tr>
6003 <tr><th>creation_time </th>
6004         <td class="description">Time the job was created</td></tr>
6005 <tr><th>dest </th>
6006         <td class="description">Printer or class name</td></tr>
6007 <tr><th>format </th>
6008         <td class="description">Document format</td></tr>
6009 <tr><th>id </th>
6010         <td class="description">The job ID</td></tr>
6011 <tr><th>priority </th>
6012         <td class="description">Priority (1-100)</td></tr>
6013 <tr><th>processing_time </th>
6014         <td class="description">Time the job was processed</td></tr>
6015 <tr><th>size </th>
6016         <td class="description">Size in kilobytes</td></tr>
6017 <tr><th>state </th>
6018         <td class="description">Job state</td></tr>
6019 <tr><th>title </th>
6020         <td class="description">Title/job name</td></tr>
6021 <tr><th>user </th>
6022         <td class="description">User that submitted the job</td></tr>
6023 </tbody></table>
6024 <h3 class="struct"><a id="cups_option_s">cups_option_s</a></h3>
6025         <p class="description">Printer Options</p>
6026 <p class="code">struct cups_option_s {<br>
6027 &#160;&#160;&#160;&#160;char *name;<br>
6028 &#160;&#160;&#160;&#160;char *value;<br>
6029 };</p>
6030 <h4 class="members">Members</h4>
6031 <table class="list"><tbody>
6032 <tr><th>name </th>
6033         <td class="description">Name of option</td></tr>
6034 <tr><th>value </th>
6035         <td class="description">Value of option</td></tr>
6036 </tbody></table>
6037 <h3 class="struct"><span class="info">&#160;CUPS 1.6/macOS 10.8&#160;</span><a id="cups_size_s">cups_size_s</a></h3>
6038         <p class="description">Media Size </p>
6039 <p class="code">struct cups_size_s {<br>
6040 &#160;&#160;&#160;&#160;char media[128];<br>
6041 &#160;&#160;&#160;&#160;int width, length, bottom, left, right, top;<br>
6042 };</p>
6043 <h4 class="members">Members</h4>
6044 <table class="list"><tbody>
6045 <tr><th>media[128] </th>
6046         <td class="description">Media name to use</td></tr>
6047 <tr><th>top </th>
6048         <td class="description">Top margin in hundredths of
6049 millimeters</td></tr>
6050 </tbody></table>
6051       <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2>
6052       <h3 class="enumeration"><a id="cups_ptype_e">cups_ptype_e</a></h3>
6053         <p class="description">Printer type/capability bit
6054 constants</p>
6055       <h4 class="constants">Constants</h4>
6056       <table class="list"><tbody>
6057         <tr><th>CUPS_PRINTER_AUTHENTICATED <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Printer requires authentication
6058 </td></tr>
6059         <tr><th>CUPS_PRINTER_BIND </th>        <td class="description">Can bind output</td></tr>
6060         <tr><th>CUPS_PRINTER_BW </th>        <td class="description">Can do B&amp;W printing</td></tr>
6061         <tr><th>CUPS_PRINTER_CLASS </th>        <td class="description">Printer class</td></tr>
6062         <tr><th>CUPS_PRINTER_COLLATE </th>        <td class="description">Can quickly collate copies</td></tr>
6063         <tr><th>CUPS_PRINTER_COLOR </th>        <td class="description">Can do color printing</td></tr>
6064         <tr><th>CUPS_PRINTER_COMMANDS <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Printer supports maintenance commands
6065 </td></tr>
6066         <tr><th>CUPS_PRINTER_COPIES </th>        <td class="description">Can do copies in hardware</td></tr>
6067         <tr><th>CUPS_PRINTER_COVER </th>        <td class="description">Can cover output</td></tr>
6068         <tr><th>CUPS_PRINTER_DEFAULT </th>        <td class="description">Default printer on network</td></tr>
6069         <tr><th>CUPS_PRINTER_DISCOVERED <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Printer was discovered </td></tr>
6070         <tr><th>CUPS_PRINTER_DUPLEX </th>        <td class="description">Can do two-sided printing</td></tr>
6071         <tr><th>CUPS_PRINTER_FAX </th>        <td class="description">Fax queue</td></tr>
6072         <tr><th>CUPS_PRINTER_LARGE </th>        <td class="description">Can print on D/E/A1/A0-size media</td></tr>
6073         <tr><th>CUPS_PRINTER_LOCAL </th>        <td class="description">Local printer or class</td></tr>
6074         <tr><th>CUPS_PRINTER_MEDIUM </th>        <td class="description">Can print on Tabloid/B/C/A3/A2-size media</td></tr>
6075         <tr><th>CUPS_PRINTER_NOT_SHARED <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Printer is not shared
6076 </td></tr>
6077         <tr><th>CUPS_PRINTER_PUNCH </th>        <td class="description">Can punch output</td></tr>
6078         <tr><th>CUPS_PRINTER_REJECTING </th>        <td class="description">Printer is rejecting jobs</td></tr>
6079         <tr><th>CUPS_PRINTER_REMOTE </th>        <td class="description">Remote printer or class</td></tr>
6080         <tr><th>CUPS_PRINTER_SMALL </th>        <td class="description">Can print on Letter/Legal/A4-size media</td></tr>
6081         <tr><th>CUPS_PRINTER_SORT </th>        <td class="description">Can sort output</td></tr>
6082         <tr><th>CUPS_PRINTER_STAPLE </th>        <td class="description">Can staple output</td></tr>
6083         <tr><th>CUPS_PRINTER_VARIABLE </th>        <td class="description">Can print on rolls and custom-size media</td></tr>
6084 </tbody></table>
6085       <h3 class="enumeration"><a id="http_encoding_e">http_encoding_e</a></h3>
6086         <p class="description">HTTP transfer encoding values</p>
6087       <h4 class="constants">Constants</h4>
6088       <table class="list"><tbody>
6089         <tr><th>HTTP_ENCODING_CHUNKED </th>        <td class="description">Data is chunked</td></tr>
6090         <tr><th>HTTP_ENCODING_FIELDS </th>        <td class="description">Sending HTTP fields</td></tr>
6091         <tr><th>HTTP_ENCODING_LENGTH </th>        <td class="description">Data is sent with Content-Length</td></tr>
6092 </tbody></table>
6093       <h3 class="enumeration"><a id="http_encryption_e">http_encryption_e</a></h3>
6094         <p class="description">HTTP encryption values</p>
6095       <h4 class="constants">Constants</h4>
6096       <table class="list"><tbody>
6097         <tr><th>HTTP_ENCRYPTION_ALWAYS </th>        <td class="description">Always encrypt (SSL)</td></tr>
6098         <tr><th>HTTP_ENCRYPTION_IF_REQUESTED </th>        <td class="description">Encrypt if requested (TLS upgrade)</td></tr>
6099         <tr><th>HTTP_ENCRYPTION_NEVER </th>        <td class="description">Never encrypt</td></tr>
6100         <tr><th>HTTP_ENCRYPTION_REQUIRED </th>        <td class="description">Encryption is required (TLS upgrade)</td></tr>
6101 </tbody></table>
6102       <h3 class="enumeration"><a id="http_field_e">http_field_e</a></h3>
6103         <p class="description">HTTP field names</p>
6104       <h4 class="constants">Constants</h4>
6105       <table class="list"><tbody>
6106         <tr><th>HTTP_FIELD_ACCEPT_ENCODING <span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span></th>        <td class="description">Accepting-Encoding field </td></tr>
6107         <tr><th>HTTP_FIELD_ACCEPT_LANGUAGE </th>        <td class="description">Accept-Language field</td></tr>
6108         <tr><th>HTTP_FIELD_ACCEPT_RANGES </th>        <td class="description">Accept-Ranges field</td></tr>
6109         <tr><th>HTTP_FIELD_ALLOW <span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span></th>        <td class="description">Allow field </td></tr>
6110         <tr><th>HTTP_FIELD_AUTHORIZATION </th>        <td class="description">Authorization field</td></tr>
6111         <tr><th>HTTP_FIELD_CONNECTION </th>        <td class="description">Connection field</td></tr>
6112         <tr><th>HTTP_FIELD_CONTENT_ENCODING </th>        <td class="description">Content-Encoding field</td></tr>
6113         <tr><th>HTTP_FIELD_CONTENT_LANGUAGE </th>        <td class="description">Content-Language field</td></tr>
6114         <tr><th>HTTP_FIELD_CONTENT_LENGTH </th>        <td class="description">Content-Length field</td></tr>
6115         <tr><th>HTTP_FIELD_CONTENT_LOCATION </th>        <td class="description">Content-Location field</td></tr>
6116         <tr><th>HTTP_FIELD_CONTENT_MD5 </th>        <td class="description">Content-MD5 field</td></tr>
6117         <tr><th>HTTP_FIELD_CONTENT_RANGE </th>        <td class="description">Content-Range field</td></tr>
6118         <tr><th>HTTP_FIELD_CONTENT_TYPE </th>        <td class="description">Content-Type field</td></tr>
6119         <tr><th>HTTP_FIELD_CONTENT_VERSION </th>        <td class="description">Content-Version field</td></tr>
6120         <tr><th>HTTP_FIELD_DATE </th>        <td class="description">Date field</td></tr>
6121         <tr><th>HTTP_FIELD_HOST </th>        <td class="description">Host field</td></tr>
6122         <tr><th>HTTP_FIELD_IF_MODIFIED_SINCE </th>        <td class="description">If-Modified-Since field</td></tr>
6123         <tr><th>HTTP_FIELD_IF_UNMODIFIED_SINCE </th>        <td class="description">If-Unmodified-Since field</td></tr>
6124         <tr><th>HTTP_FIELD_KEEP_ALIVE </th>        <td class="description">Keep-Alive field</td></tr>
6125         <tr><th>HTTP_FIELD_LAST_MODIFIED </th>        <td class="description">Last-Modified field</td></tr>
6126         <tr><th>HTTP_FIELD_LINK </th>        <td class="description">Link field</td></tr>
6127         <tr><th>HTTP_FIELD_LOCATION </th>        <td class="description">Location field</td></tr>
6128         <tr><th>HTTP_FIELD_MAX </th>        <td class="description">Maximum field index</td></tr>
6129         <tr><th>HTTP_FIELD_RANGE </th>        <td class="description">Range field</td></tr>
6130         <tr><th>HTTP_FIELD_REFERER </th>        <td class="description">Referer field</td></tr>
6131         <tr><th>HTTP_FIELD_RETRY_AFTER </th>        <td class="description">Retry-After field</td></tr>
6132         <tr><th>HTTP_FIELD_SERVER <span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span></th>        <td class="description">Server field </td></tr>
6133         <tr><th>HTTP_FIELD_TRANSFER_ENCODING </th>        <td class="description">Transfer-Encoding field</td></tr>
6134         <tr><th>HTTP_FIELD_UNKNOWN </th>        <td class="description">Unknown field</td></tr>
6135         <tr><th>HTTP_FIELD_UPGRADE </th>        <td class="description">Upgrade field</td></tr>
6136         <tr><th>HTTP_FIELD_USER_AGENT </th>        <td class="description">User-Agent field</td></tr>
6137         <tr><th>HTTP_FIELD_WWW_AUTHENTICATE </th>        <td class="description">WWW-Authenticate field</td></tr>
6138 </tbody></table>
6139       <h3 class="enumeration"><a id="http_keepalive_e">http_keepalive_e</a></h3>
6140         <p class="description">HTTP keep-alive values</p>
6141       <h4 class="constants">Constants</h4>
6142       <table class="list"><tbody>
6143         <tr><th>HTTP_KEEPALIVE_OFF </th>        <td class="description">No keep alive support</td></tr>
6144         <tr><th>HTTP_KEEPALIVE_ON </th>        <td class="description">Use keep alive</td></tr>
6145 </tbody></table>
6146       <h3 class="enumeration"><a id="http_state_e">http_state_e</a></h3>
6147         <p class="description">HTTP state values; states
6148 are server-oriented...</p>
6149       <h4 class="constants">Constants</h4>
6150       <table class="list"><tbody>
6151         <tr><th>HTTP_STATE_CONNECT </th>        <td class="description">CONNECT command, waiting for blank line</td></tr>
6152         <tr><th>HTTP_STATE_DELETE </th>        <td class="description">DELETE command, waiting for blank line</td></tr>
6153         <tr><th>HTTP_STATE_ERROR </th>        <td class="description">Error on socket</td></tr>
6154         <tr><th>HTTP_STATE_GET </th>        <td class="description">GET command, waiting for blank line</td></tr>
6155         <tr><th>HTTP_STATE_GET_SEND </th>        <td class="description">GET command, sending data</td></tr>
6156         <tr><th>HTTP_STATE_HEAD </th>        <td class="description">HEAD command, waiting for blank line</td></tr>
6157         <tr><th>HTTP_STATE_OPTIONS </th>        <td class="description">OPTIONS command, waiting for blank line</td></tr>
6158         <tr><th>HTTP_STATE_POST </th>        <td class="description">POST command, waiting for blank line</td></tr>
6159         <tr><th>HTTP_STATE_POST_RECV </th>        <td class="description">POST command, receiving data</td></tr>
6160         <tr><th>HTTP_STATE_POST_SEND </th>        <td class="description">POST command, sending data</td></tr>
6161         <tr><th>HTTP_STATE_PUT </th>        <td class="description">PUT command, waiting for blank line</td></tr>
6162         <tr><th>HTTP_STATE_PUT_RECV </th>        <td class="description">PUT command, receiving data</td></tr>
6163         <tr><th>HTTP_STATE_STATUS </th>        <td class="description">Command complete, sending status</td></tr>
6164         <tr><th>HTTP_STATE_TRACE </th>        <td class="description">TRACE command, waiting for blank line</td></tr>
6165         <tr><th>HTTP_STATE_UNKNOWN_METHOD <span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span></th>        <td class="description">Unknown request method, waiting for blank line </td></tr>
6166         <tr><th>HTTP_STATE_UNKNOWN_VERSION <span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span></th>        <td class="description">Unknown request method, waiting for blank line </td></tr>
6167         <tr><th>HTTP_STATE_WAITING </th>        <td class="description">Waiting for command</td></tr>
6168 </tbody></table>
6169       <h3 class="enumeration"><a id="http_status_e">http_status_e</a></h3>
6170         <p class="description">HTTP status codes</p>
6171       <h4 class="constants">Constants</h4>
6172       <table class="list"><tbody>
6173         <tr><th>HTTP_STATUS_ACCEPTED </th>        <td class="description">DELETE command was successful</td></tr>
6174         <tr><th>HTTP_STATUS_BAD_GATEWAY </th>        <td class="description">Bad gateway</td></tr>
6175         <tr><th>HTTP_STATUS_BAD_REQUEST </th>        <td class="description">Bad request</td></tr>
6176         <tr><th>HTTP_STATUS_CONFLICT </th>        <td class="description">Request is self-conflicting</td></tr>
6177         <tr><th>HTTP_STATUS_CONTINUE </th>        <td class="description">Everything OK, keep going...</td></tr>
6178         <tr><th>HTTP_STATUS_CREATED </th>        <td class="description">PUT command was successful</td></tr>
6179         <tr><th>HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED <span class="info">&#160;CUPS 1.4&#160;</span></th>        <td class="description">User canceled authorization </td></tr>
6180         <tr><th>HTTP_STATUS_CUPS_PKI_ERROR <span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span></th>        <td class="description">Error negotiating a secure connection </td></tr>
6181         <tr><th>HTTP_STATUS_ERROR </th>        <td class="description">An error response from httpXxxx()</td></tr>
6182         <tr><th>HTTP_STATUS_EXPECTATION_FAILED </th>        <td class="description">The expectation given in an Expect header field was not met</td></tr>
6183         <tr><th>HTTP_STATUS_FORBIDDEN </th>        <td class="description">Forbidden to access this URI</td></tr>
6184         <tr><th>HTTP_STATUS_FOUND </th>        <td class="description">Document was found at a different URI</td></tr>
6185         <tr><th>HTTP_STATUS_GATEWAY_TIMEOUT </th>        <td class="description">Gateway connection timed out</td></tr>
6186         <tr><th>HTTP_STATUS_GONE </th>        <td class="description">Server has gone away</td></tr>
6187         <tr><th>HTTP_STATUS_LENGTH_REQUIRED </th>        <td class="description">A content length or encoding is required</td></tr>
6188         <tr><th>HTTP_STATUS_METHOD_NOT_ALLOWED </th>        <td class="description">Method is not allowed</td></tr>
6189         <tr><th>HTTP_STATUS_MOVED_PERMANENTLY </th>        <td class="description">Document has moved permanently</td></tr>
6190         <tr><th>HTTP_STATUS_MULTIPLE_CHOICES </th>        <td class="description">Multiple files match request</td></tr>
6191         <tr><th>HTTP_STATUS_NONE <span class="info">&#160;CUPS 1.7/macOS 10.9&#160;</span></th>        <td class="description">No Expect value </td></tr>
6192         <tr><th>HTTP_STATUS_NOT_ACCEPTABLE </th>        <td class="description">Not Acceptable</td></tr>
6193         <tr><th>HTTP_STATUS_NOT_AUTHORITATIVE </th>        <td class="description">Information isn't authoritative</td></tr>
6194         <tr><th>HTTP_STATUS_NOT_FOUND </th>        <td class="description">URI was not found</td></tr>
6195         <tr><th>HTTP_STATUS_NOT_IMPLEMENTED </th>        <td class="description">Feature not implemented</td></tr>
6196         <tr><th>HTTP_STATUS_NOT_MODIFIED </th>        <td class="description">File not modified</td></tr>
6197         <tr><th>HTTP_STATUS_NOT_SUPPORTED </th>        <td class="description">HTTP version not supported</td></tr>
6198         <tr><th>HTTP_STATUS_NO_CONTENT </th>        <td class="description">Successful command, no new data</td></tr>
6199         <tr><th>HTTP_STATUS_OK </th>        <td class="description">OPTIONS/GET/HEAD/POST/TRACE command was successful</td></tr>
6200         <tr><th>HTTP_STATUS_PARTIAL_CONTENT </th>        <td class="description">Only a partial file was received/sent</td></tr>
6201         <tr><th>HTTP_STATUS_PAYMENT_REQUIRED </th>        <td class="description">Payment required</td></tr>
6202         <tr><th>HTTP_STATUS_PRECONDITION </th>        <td class="description">Precondition failed</td></tr>
6203         <tr><th>HTTP_STATUS_PROXY_AUTHENTICATION </th>        <td class="description">Proxy Authentication is Required</td></tr>
6204         <tr><th>HTTP_STATUS_REQUESTED_RANGE </th>        <td class="description">The requested range is not satisfiable</td></tr>
6205         <tr><th>HTTP_STATUS_REQUEST_TIMEOUT </th>        <td class="description">Request timed out</td></tr>
6206         <tr><th>HTTP_STATUS_REQUEST_TOO_LARGE </th>        <td class="description">Request entity too large</td></tr>
6207         <tr><th>HTTP_STATUS_RESET_CONTENT </th>        <td class="description">Content was reset/recreated</td></tr>
6208         <tr><th>HTTP_STATUS_SEE_OTHER </th>        <td class="description">See this other link</td></tr>
6209         <tr><th>HTTP_STATUS_SERVER_ERROR </th>        <td class="description">Internal server error</td></tr>
6210         <tr><th>HTTP_STATUS_SERVICE_UNAVAILABLE </th>        <td class="description">Service is unavailable</td></tr>
6211         <tr><th>HTTP_STATUS_SWITCHING_PROTOCOLS </th>        <td class="description">HTTP upgrade to TLS/SSL</td></tr>
6212         <tr><th>HTTP_STATUS_TEMPORARY_REDIRECT </th>        <td class="description">Temporary redirection</td></tr>
6213         <tr><th>HTTP_STATUS_UNAUTHORIZED </th>        <td class="description">Unauthorized to access host</td></tr>
6214         <tr><th>HTTP_STATUS_UNSUPPORTED_MEDIATYPE </th>        <td class="description">The requested media type is unsupported</td></tr>
6215         <tr><th>HTTP_STATUS_UPGRADE_REQUIRED </th>        <td class="description">Upgrade to SSL/TLS required</td></tr>
6216         <tr><th>HTTP_STATUS_URI_TOO_LONG </th>        <td class="description">URI too long</td></tr>
6217         <tr><th>HTTP_STATUS_USE_PROXY </th>        <td class="description">Must use a proxy to access this URI</td></tr>
6218 </tbody></table>
6219       <h3 class="enumeration"><a id="http_trust_e"><span class="info">&#160;CUPS 2.0/OS 10.10&#160;</span>http_trust_e</a></h3>
6220         <p class="description">Level of trust for credentials </p>
6221       <h4 class="constants">Constants</h4>
6222       <table class="list"><tbody>
6223         <tr><th>HTTP_TRUST_CHANGED </th>        <td class="description">Credentials have changed</td></tr>
6224         <tr><th>HTTP_TRUST_EXPIRED </th>        <td class="description">Credentials are expired</td></tr>
6225         <tr><th>HTTP_TRUST_INVALID </th>        <td class="description">Credentials are invalid</td></tr>
6226         <tr><th>HTTP_TRUST_OK </th>        <td class="description">Credentials are OK/trusted</td></tr>
6227         <tr><th>HTTP_TRUST_RENEWED </th>        <td class="description">Credentials have been renewed</td></tr>
6228         <tr><th>HTTP_TRUST_UNKNOWN </th>        <td class="description">Credentials are unknown/new</td></tr>
6229 </tbody></table>
6230       <h3 class="enumeration"><a id="http_uri_coding_e">http_uri_coding_e</a></h3>
6231         <p class="description">URI en/decode flags</p>
6232       <h4 class="constants">Constants</h4>
6233       <table class="list"><tbody>
6234         <tr><th>HTTP_URI_CODING_ALL </th>        <td class="description">En/decode everything</td></tr>
6235         <tr><th>HTTP_URI_CODING_HOSTNAME </th>        <td class="description">En/decode the hostname portion</td></tr>
6236         <tr><th>HTTP_URI_CODING_MOST </th>        <td class="description">En/decode all but the query</td></tr>
6237         <tr><th>HTTP_URI_CODING_NONE </th>        <td class="description">Don't en/decode anything</td></tr>
6238         <tr><th>HTTP_URI_CODING_QUERY </th>        <td class="description">En/decode the query portion</td></tr>
6239         <tr><th>HTTP_URI_CODING_RESOURCE </th>        <td class="description">En/decode the resource portion</td></tr>
6240         <tr><th>HTTP_URI_CODING_RFC6874 </th>        <td class="description">Use RFC 6874 address format</td></tr>
6241         <tr><th>HTTP_URI_CODING_USERNAME </th>        <td class="description">En/decode the username portion</td></tr>
6242 </tbody></table>
6243       <h3 class="enumeration"><a id="http_uri_status_e"><span class="info">&#160;CUPS 1.2&#160;</span>http_uri_status_e</a></h3>
6244         <p class="description">URI separation status </p>
6245       <h4 class="constants">Constants</h4>
6246       <table class="list"><tbody>
6247         <tr><th>HTTP_URI_STATUS_BAD_ARGUMENTS </th>        <td class="description">Bad arguments to function (error)</td></tr>
6248         <tr><th>HTTP_URI_STATUS_BAD_HOSTNAME </th>        <td class="description">Bad hostname in URI (error)</td></tr>
6249         <tr><th>HTTP_URI_STATUS_BAD_PORT </th>        <td class="description">Bad port number in URI (error)</td></tr>
6250         <tr><th>HTTP_URI_STATUS_BAD_RESOURCE </th>        <td class="description">Bad resource in URI (error)</td></tr>
6251         <tr><th>HTTP_URI_STATUS_BAD_SCHEME </th>        <td class="description">Bad scheme in URI (error)</td></tr>
6252         <tr><th>HTTP_URI_STATUS_BAD_URI </th>        <td class="description">Bad/empty URI (error)</td></tr>
6253         <tr><th>HTTP_URI_STATUS_BAD_USERNAME </th>        <td class="description">Bad username in URI (error)</td></tr>
6254         <tr><th>HTTP_URI_STATUS_MISSING_RESOURCE </th>        <td class="description">Missing resource in URI (warning)</td></tr>
6255         <tr><th>HTTP_URI_STATUS_MISSING_SCHEME </th>        <td class="description">Missing scheme in URI (warning)</td></tr>
6256         <tr><th>HTTP_URI_STATUS_OK </th>        <td class="description">URI decoded OK</td></tr>
6257         <tr><th>HTTP_URI_STATUS_OVERFLOW </th>        <td class="description">URI buffer for httpAssembleURI is too small</td></tr>
6258         <tr><th>HTTP_URI_STATUS_UNKNOWN_SCHEME </th>        <td class="description">Unknown scheme in URI (warning)</td></tr>
6259 </tbody></table>
6260       <h3 class="enumeration"><a id="ipp_finishings_e">ipp_finishings_e</a></h3>
6261         <p class="description">Finishings values</p>
6262       <h4 class="constants">Constants</h4>
6263       <table class="list"><tbody>
6264         <tr><th>IPP_FINISHINGS_BALE </th>        <td class="description">Bale (any type)</td></tr>
6265         <tr><th>IPP_FINISHINGS_BIND </th>        <td class="description">Bind</td></tr>
6266         <tr><th>IPP_FINISHINGS_BIND_BOTTOM </th>        <td class="description">Bind on bottom</td></tr>
6267         <tr><th>IPP_FINISHINGS_BIND_LEFT </th>        <td class="description">Bind on left</td></tr>
6268         <tr><th>IPP_FINISHINGS_BIND_RIGHT </th>        <td class="description">Bind on right</td></tr>
6269         <tr><th>IPP_FINISHINGS_BIND_TOP </th>        <td class="description">Bind on top</td></tr>
6270         <tr><th>IPP_FINISHINGS_BOOKLET_MAKER </th>        <td class="description">Fold to make booklet</td></tr>
6271         <tr><th>IPP_FINISHINGS_COAT </th>        <td class="description">Apply protective liquid or powder coating</td></tr>
6272         <tr><th>IPP_FINISHINGS_COVER </th>        <td class="description">Add cover</td></tr>
6273         <tr><th>IPP_FINISHINGS_EDGE_STITCH </th>        <td class="description">Stitch along any side</td></tr>
6274         <tr><th>IPP_FINISHINGS_EDGE_STITCH_BOTTOM </th>        <td class="description">Stitch along bottom edge</td></tr>
6275         <tr><th>IPP_FINISHINGS_EDGE_STITCH_LEFT </th>        <td class="description">Stitch along left side</td></tr>
6276         <tr><th>IPP_FINISHINGS_EDGE_STITCH_RIGHT </th>        <td class="description">Stitch along right side</td></tr>
6277         <tr><th>IPP_FINISHINGS_EDGE_STITCH_TOP </th>        <td class="description">Stitch along top edge</td></tr>
6278         <tr><th>IPP_FINISHINGS_FOLD </th>        <td class="description">Fold (any type)</td></tr>
6279         <tr><th>IPP_FINISHINGS_FOLD_ACCORDIAN </th>        <td class="description">Accordian-fold the paper vertically into four sections</td></tr>
6280         <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>
6281         <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>
6282         <tr><th>IPP_FINISHINGS_FOLD_GATE </th>        <td class="description">Fold the top and bottom quarters of the paper towards the midline</td></tr>
6283         <tr><th>IPP_FINISHINGS_FOLD_HALF </th>        <td class="description">Fold the paper in half vertically</td></tr>
6284         <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>
6285         <tr><th>IPP_FINISHINGS_FOLD_LEFT_GATE </th>        <td class="description">Fold the top quarter of the paper towards the midline</td></tr>
6286         <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>
6287         <tr><th>IPP_FINISHINGS_FOLD_PARALLEL </th>        <td class="description">Fold the paper in half vertically two times, yielding four sections</td></tr>
6288         <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>
6289         <tr><th>IPP_FINISHINGS_FOLD_RIGHT_GATE </th>        <td class="description">Fold the bottom quarter of the paper towards the midline</td></tr>
6290         <tr><th>IPP_FINISHINGS_FOLD_Z </th>        <td class="description">Fold the paper vertically into three sections, forming a Z</td></tr>
6291         <tr><th>IPP_FINISHINGS_JOG_OFFSET </th>        <td class="description">Offset for binding (any type)</td></tr>
6292         <tr><th>IPP_FINISHINGS_LAMINATE </th>        <td class="description">Apply protective (solid) material</td></tr>
6293         <tr><th>IPP_FINISHINGS_NONE </th>        <td class="description">No finishing</td></tr>
6294         <tr><th>IPP_FINISHINGS_PUNCH </th>        <td class="description">Punch (any location/count)</td></tr>
6295         <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_LEFT </th>        <td class="description">Punch 1 hole bottom left</td></tr>
6296         <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_RIGHT </th>        <td class="description">Punch 1 hole bottom right</td></tr>
6297         <tr><th>IPP_FINISHINGS_PUNCH_DUAL_BOTTOM </th>        <td class="description">Punch 2 holes bottom edge</td></tr>
6298         <tr><th>IPP_FINISHINGS_PUNCH_DUAL_LEFT </th>        <td class="description">Punch 2 holes left side</td></tr>
6299         <tr><th>IPP_FINISHINGS_PUNCH_DUAL_RIGHT </th>        <td class="description">Punch 2 holes right side</td></tr>
6300         <tr><th>IPP_FINISHINGS_PUNCH_DUAL_TOP </th>        <td class="description">Punch 2 holes top edge</td></tr>
6301         <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_BOTTOM </th>        <td class="description">Pucnh multiple holes bottom edge</td></tr>
6302         <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_LEFT </th>        <td class="description">Pucnh multiple holes left side</td></tr>
6303         <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_RIGHT </th>        <td class="description">Pucnh multiple holes right side</td></tr>
6304         <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_TOP </th>        <td class="description">Pucnh multiple holes top edge</td></tr>
6305         <tr><th>IPP_FINISHINGS_PUNCH_QUAD_BOTTOM </th>        <td class="description">Punch 4 holes bottom edge</td></tr>
6306         <tr><th>IPP_FINISHINGS_PUNCH_QUAD_LEFT </th>        <td class="description">Punch 4 holes left side</td></tr>
6307         <tr><th>IPP_FINISHINGS_PUNCH_QUAD_RIGHT </th>        <td class="description">Punch 4 holes right side</td></tr>
6308         <tr><th>IPP_FINISHINGS_PUNCH_QUAD_TOP </th>        <td class="description">Punch 4 holes top edge</td></tr>
6309         <tr><th>IPP_FINISHINGS_PUNCH_TOP_LEFT </th>        <td class="description">Punch 1 hole top left</td></tr>
6310         <tr><th>IPP_FINISHINGS_PUNCH_TOP_RIGHT </th>        <td class="description">Punch 1 hole top right</td></tr>
6311         <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_BOTTOM </th>        <td class="description">Punch 3 holes bottom edge</td></tr>
6312         <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_LEFT </th>        <td class="description">Punch 3 holes left side</td></tr>
6313         <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_RIGHT </th>        <td class="description">Punch 3 holes right side</td></tr>
6314         <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_TOP </th>        <td class="description">Punch 3 holes top edge</td></tr>
6315         <tr><th>IPP_FINISHINGS_SADDLE_STITCH </th>        <td class="description">Staple interior</td></tr>
6316         <tr><th>IPP_FINISHINGS_STAPLE </th>        <td class="description">Staple (any location/method)</td></tr>
6317         <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_LEFT </th>        <td class="description">Staple bottom left corner</td></tr>
6318         <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT </th>        <td class="description">Staple bottom right corner</td></tr>
6319         <tr><th>IPP_FINISHINGS_STAPLE_DUAL_BOTTOM </th>        <td class="description">Two staples on bottom</td></tr>
6320         <tr><th>IPP_FINISHINGS_STAPLE_DUAL_LEFT </th>        <td class="description">Two staples on left</td></tr>
6321         <tr><th>IPP_FINISHINGS_STAPLE_DUAL_RIGHT </th>        <td class="description">Two staples on right</td></tr>
6322         <tr><th>IPP_FINISHINGS_STAPLE_DUAL_TOP </th>        <td class="description">Two staples on top</td></tr>
6323         <tr><th>IPP_FINISHINGS_STAPLE_TOP_LEFT </th>        <td class="description">Staple top left corner</td></tr>
6324         <tr><th>IPP_FINISHINGS_STAPLE_TOP_RIGHT </th>        <td class="description">Staple top right corner</td></tr>
6325         <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_BOTTOM </th>        <td class="description">Three staples on bottom</td></tr>
6326         <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_LEFT </th>        <td class="description">Three staples on left</td></tr>
6327         <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_RIGHT </th>        <td class="description">Three staples on right</td></tr>
6328         <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_TOP </th>        <td class="description">Three staples on top</td></tr>
6329         <tr><th>IPP_FINISHINGS_TRIM </th>        <td class="description">Trim (any type)</td></tr>
6330         <tr><th>IPP_FINISHINGS_TRIM_AFTER_COPIES </th>        <td class="description">Trim output after each copy</td></tr>
6331         <tr><th>IPP_FINISHINGS_TRIM_AFTER_DOCUMENTS </th>        <td class="description">Trim output after each document</td></tr>
6332         <tr><th>IPP_FINISHINGS_TRIM_AFTER_JOB </th>        <td class="description">Trim output after job</td></tr>
6333         <tr><th>IPP_FINISHINGS_TRIM_AFTER_PAGES </th>        <td class="description">Trim output after each page</td></tr>
6334 </tbody></table>
6335       <h3 class="enumeration"><a id="ipp_jstate_e">ipp_jstate_e</a></h3>
6336         <p class="description">Job states</p>
6337       <h4 class="constants">Constants</h4>
6338       <table class="list"><tbody>
6339         <tr><th>IPP_JSTATE_ABORTED </th>        <td class="description">Job has aborted due to error</td></tr>
6340         <tr><th>IPP_JSTATE_CANCELED </th>        <td class="description">Job has been canceled</td></tr>
6341         <tr><th>IPP_JSTATE_COMPLETED </th>        <td class="description">Job has completed successfully</td></tr>
6342         <tr><th>IPP_JSTATE_HELD </th>        <td class="description">Job is held for printing</td></tr>
6343         <tr><th>IPP_JSTATE_PENDING </th>        <td class="description">Job is waiting to be printed</td></tr>
6344         <tr><th>IPP_JSTATE_PROCESSING </th>        <td class="description">Job is currently printing</td></tr>
6345         <tr><th>IPP_JSTATE_STOPPED </th>        <td class="description">Job has been stopped</td></tr>
6346 </tbody></table>
6347       <h3 class="enumeration"><a id="ipp_op_e">ipp_op_e</a></h3>
6348         <p class="description">IPP operations</p>
6349       <h4 class="constants">Constants</h4>
6350       <table class="list"><tbody>
6351         <tr><th>IPP_OP_ALLOCATE_PRINTER_RESOURCES </th>        <td class="description">Allocate-Printer-Resources: Use resources for a printer.</td></tr>
6352         <tr><th>IPP_OP_CANCEL_CURRENT_JOB </th>        <td class="description">Cancel-Current-Job: Cancel the current job</td></tr>
6353         <tr><th>IPP_OP_CANCEL_JOB </th>        <td class="description">Cancel-Job: Cancel a job</td></tr>
6354         <tr><th>IPP_OP_CANCEL_JOBS </th>        <td class="description">Cancel-Jobs: Cancel all jobs (administrative)</td></tr>
6355         <tr><th>IPP_OP_CANCEL_MY_JOBS </th>        <td class="description">Cancel-My-Jobs: Cancel a user's jobs</td></tr>
6356         <tr><th>IPP_OP_CANCEL_RESOURCE </th>        <td class="description">Cancel-Resource: Uninstall a resource.</td></tr>
6357         <tr><th>IPP_OP_CANCEL_SUBSCRIPTION <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Cancel-Subscription: Cancel a subscription </td></tr>
6358         <tr><th>IPP_OP_CLOSE_JOB </th>        <td class="description">Close-Job: Close a job and start printing</td></tr>
6359         <tr><th>IPP_OP_CREATE_JOB </th>        <td class="description">Create-Job: Create an empty print job</td></tr>
6360         <tr><th>IPP_OP_CREATE_JOB_SUBSCRIPTIONS <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Create-Job-Subscriptions: Create one of more job subscriptions </td></tr>
6361         <tr><th>IPP_OP_CREATE_PRINTER </th>        <td class="description">Create-Printer: Create a new service.</td></tr>
6362         <tr><th>IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Create-Printer-Subscriptions: Create one or more printer subscriptions </td></tr>
6363         <tr><th>IPP_OP_CREATE_RESOURCE </th>        <td class="description">Create-Resource: Create a new (empty) resource.</td></tr>
6364         <tr><th>IPP_OP_CREATE_RESOURCE_SUBSCRIPTIONS </th>        <td class="description">Create-Resource-Subscriptions: Create event subscriptions for a resource.</td></tr>
6365         <tr><th>IPP_OP_CREATE_SYSTEM_SUBSCRIPTIONS </th>        <td class="description">Create-System-Subscriptions: Create event subscriptions for a system.</td></tr>
6366         <tr><th>IPP_OP_CUPS_ADD_MODIFY_CLASS </th>        <td class="description">CUPS-Add-Modify-Class: Add or modify a class</td></tr>
6367         <tr><th>IPP_OP_CUPS_ADD_MODIFY_PRINTER </th>        <td class="description">CUPS-Add-Modify-Printer: Add or modify a printer</td></tr>
6368         <tr><th>IPP_OP_CUPS_AUTHENTICATE_JOB <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">CUPS-Authenticate-Job: Authenticate a job </td></tr>
6369         <tr><th>IPP_OP_CUPS_CREATE_LOCAL_PRINTER <span class="info">&#160;CUPS 2.2&#160;</span></th>        <td class="description">CUPS-Create-Local-Printer: Create a local (temporary) printer </td></tr>
6370         <tr><th>IPP_OP_CUPS_DELETE_CLASS </th>        <td class="description">CUPS-Delete-Class: Delete a class</td></tr>
6371         <tr><th>IPP_OP_CUPS_DELETE_PRINTER </th>        <td class="description">CUPS-Delete-Printer: Delete a printer</td></tr>
6372         <tr><th>IPP_OP_CUPS_GET_DEFAULT </th>        <td class="description">CUPS-Get-Default: Get the default printer</td></tr>
6373         <tr><th>IPP_OP_CUPS_GET_DEVICES <span class="info">&#160;DEPRECATED&#160;</span></th>        <td class="description">CUPS-Get-Devices: Get a list of supported devices </td></tr>
6374         <tr><th>IPP_OP_CUPS_GET_DOCUMENT <span class="info">&#160;CUPS 1.4/macOS 10.6&#160;</span></th>        <td class="description">CUPS-Get-Document: Get a document file </td></tr>
6375         <tr><th>IPP_OP_CUPS_GET_PPD <span class="info">&#160;DEPRECATED&#160;</span></th>        <td class="description">CUPS-Get-PPD: Get a PPD file </td></tr>
6376         <tr><th>IPP_OP_CUPS_GET_PPDS <span class="info">&#160;DEPRECATED&#160;</span></th>        <td class="description">CUPS-Get-PPDs: Get a list of supported drivers </td></tr>
6377         <tr><th>IPP_OP_CUPS_GET_PRINTERS </th>        <td class="description">CUPS-Get-Printers: Get a list of printers and/or classes</td></tr>
6378         <tr><th>IPP_OP_CUPS_INVALID </th>        <td class="description">Invalid operation name for <a href="#ippOpValue"><code>ippOpValue</code></a></td></tr>
6379         <tr><th>IPP_OP_CUPS_MOVE_JOB </th>        <td class="description">CUPS-Move-Job: Move a job to a different printer</td></tr>
6380         <tr><th>IPP_OP_CUPS_SET_DEFAULT </th>        <td class="description">CUPS-Set-Default: Set the default printer</td></tr>
6381         <tr><th>IPP_OP_DEALLOCATE_PRINTER_RESOURCES </th>        <td class="description">Deallocate-Printer-Resources: Stop using resources for a printer.</td></tr>
6382         <tr><th>IPP_OP_DELETE_PRINTER </th>        <td class="description">Delete-Printer: Delete an existing service.</td></tr>
6383         <tr><th>IPP_OP_DISABLE_ALL_PRINTERS </th>        <td class="description">Disable-All-Printers: Stop accepting new jobs on all services.</td></tr>
6384         <tr><th>IPP_OP_DISABLE_PRINTER </th>        <td class="description">Disable-Printer: Reject new jobs for a printer</td></tr>
6385         <tr><th>IPP_OP_ENABLE_ALL_PRINTERS </th>        <td class="description">Enable-All-Printers: Start accepting new jobs on all services.</td></tr>
6386         <tr><th>IPP_OP_ENABLE_PRINTER </th>        <td class="description">Enable-Printer: Accept new jobs for a printer</td></tr>
6387         <tr><th>IPP_OP_GET_JOBS </th>        <td class="description">Get-Jobs: Get a list of jobs</td></tr>
6388         <tr><th>IPP_OP_GET_JOB_ATTRIBUTES </th>        <td class="description">Get-Job-Attribute: Get information about a job</td></tr>
6389         <tr><th>IPP_OP_GET_NOTIFICATIONS <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Get-Notifications: Get notification events </td></tr>
6390         <tr><th>IPP_OP_GET_PRINTERS </th>        <td class="description">Get-Printers: Get a list of services.</td></tr>
6391         <tr><th>IPP_OP_GET_PRINTER_ATTRIBUTES </th>        <td class="description">Get-Printer-Attributes: Get information about a printer</td></tr>
6392         <tr><th>IPP_OP_GET_PRINTER_SUPPORTED_VALUES </th>        <td class="description">Get-Printer-Supported-Values: Get supported values</td></tr>
6393         <tr><th>IPP_OP_GET_SUBSCRIPTIONS <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Get-Subscriptions: Get list of subscriptions </td></tr>
6394         <tr><th>IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Get-Subscription-Attributes: Get subscription information </td></tr>
6395         <tr><th>IPP_OP_GET_SYSTEM_ATTRIBUTES </th>        <td class="description">Get-System-Attributes: Get system object attributes.</td></tr>
6396         <tr><th>IPP_OP_GET_SYSTEM_SUPPORTED_VALUES </th>        <td class="description">Get-System-Supported-Values: Get supported values for system object attributes.</td></tr>
6397         <tr><th>IPP_OP_HOLD_JOB </th>        <td class="description">Hold-Job: Hold a job for printing</td></tr>
6398         <tr><th>IPP_OP_HOLD_NEW_JOBS </th>        <td class="description">Hold-New-Jobs: Hold new jobs</td></tr>
6399         <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>
6400         <tr><th>IPP_OP_INSTALL_RESOURCE </th>        <td class="description">Install-Resource: Install a resource.</td></tr>
6401         <tr><th>IPP_OP_PAUSE_ALL_PRINTERS </th>        <td class="description">Pause-All-Printers: Stop all services immediately.</td></tr>
6402         <tr><th>IPP_OP_PAUSE_ALL_PRINTERS_AFTER_CURRENT_JOB </th>        <td class="description">Pause-All-Printers-After-Current-Job: Stop all services after processing the current jobs.</td></tr>
6403         <tr><th>IPP_OP_PAUSE_PRINTER </th>        <td class="description">Pause-Printer: Stop a printer</td></tr>
6404         <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>
6405         <tr><th>IPP_OP_PRINT_JOB </th>        <td class="description">Print-Job: Print a single file</td></tr>
6406         <tr><th>IPP_OP_PROMOTE_JOB </th>        <td class="description">Promote-Job: Promote a job to print sooner</td></tr>
6407         <tr><th>IPP_OP_REGISTER_OUTPUT_DEVICE </th>        <td class="description">Register-Output-Device: Register a remote service.</td></tr>
6408         <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>
6409         <tr><th>IPP_OP_RELEASE_JOB </th>        <td class="description">Release-Job: Release a job for printing</td></tr>
6410         <tr><th>IPP_OP_RENEW_SUBSCRIPTION <span class="info">&#160;CUPS 1.2/macOS 10.5&#160;</span></th>        <td class="description">Renew-Subscription: Renew a printer subscription </td></tr>
6411         <tr><th>IPP_OP_RESTART_JOB <span class="info">&#160;DEPRECATED&#160;</span></th>        <td class="description">Restart-Job: Reprint a job </td></tr>
6412         <tr><th>IPP_OP_RESTART_SYSTEM </th>        <td class="description">Restart-System: Restart all services.</td></tr>
6413         <tr><th>IPP_OP_RESUME_ALL_PRINTERS </th>        <td class="description">Resume-All-Printers: Start job processing on all services.</td></tr>
6414         <tr><th>IPP_OP_RESUME_JOB </th>        <td class="description">Resume-Job: Resume the current job</td></tr>
6415         <tr><th>IPP_OP_RESUME_PRINTER </th>        <td class="description">Resume-Printer: Start a printer</td></tr>
6416         <tr><th>IPP_OP_SCHEDULE_JOB_AFTER </th>        <td class="description">Schedule-Job-After: Schedule a job to print after another</td></tr>
6417         <tr><th>IPP_OP_SEND_DOCUMENT </th>        <td class="description">Send-Document: Add a file to a job</td></tr>
6418         <tr><th>IPP_OP_SEND_RESOURCE_DATA </th>        <td class="description">Send-Resource-Data: Upload the data for a resource.</td></tr>
6419         <tr><th>IPP_OP_SET_JOB_ATTRIBUTES </th>        <td class="description">Set-Job-Attributes: Set job values</td></tr>
6420         <tr><th>IPP_OP_SET_PRINTER_ATTRIBUTES </th>        <td class="description">Set-Printer-Attributes: Set printer values</td></tr>
6421         <tr><th>IPP_OP_SET_RESOURCE_ATTRIBUTES </th>        <td class="description">Set-Resource-Attributes: Set resource object  attributes.</td></tr>
6422         <tr><th>IPP_OP_SET_SYSTEM_ATTRIBUTES </th>        <td class="description">Set-System-Attributes: Set system object attributes.</td></tr>
6423         <tr><th>IPP_OP_SHUTDOWN_ALL_PRINTERS </th>        <td class="description">Shutdown-All-Printers: Shutdown all services.</td></tr>
6424         <tr><th>IPP_OP_SHUTDOWN_ONE_PRINTER </th>        <td class="description">Shutdown-One-Printer: Shutdown a service.</td></tr>
6425         <tr><th>IPP_OP_STARTUP_ALL_PRINTERS </th>        <td class="description">Startup-All-Printers: Startup all services.</td></tr>
6426         <tr><th>IPP_OP_STARTUP_ONE_PRINTER </th>        <td class="description">Startup-One-Printer: Start a service.</td></tr>
6427         <tr><th>IPP_OP_SUSPEND_CURRENT_JOB </th>        <td class="description">Suspend-Current-Job: Suspend the current job</td></tr>
6428         <tr><th>IPP_OP_VALIDATE_JOB </th>        <td class="description">Validate-Job: Validate job values prior to submission</td></tr>
6429 </tbody></table>
6430       <h3 class="enumeration"><a id="ipp_orient_e">ipp_orient_e</a></h3>
6431         <p class="description">Orientation values</p>
6432       <h4 class="constants">Constants</h4>
6433       <table class="list"><tbody>
6434         <tr><th>IPP_ORIENT_LANDSCAPE </th>        <td class="description">90 degrees counter-clockwise</td></tr>
6435         <tr><th>IPP_ORIENT_NONE </th>        <td class="description">No rotation</td></tr>
6436         <tr><th>IPP_ORIENT_PORTRAIT </th>        <td class="description">No rotation</td></tr>
6437         <tr><th>IPP_ORIENT_REVERSE_LANDSCAPE </th>        <td class="description">90 degrees clockwise</td></tr>
6438         <tr><th>IPP_ORIENT_REVERSE_PORTRAIT </th>        <td class="description">180 degrees</td></tr>
6439 </tbody></table>
6440       <h3 class="enumeration"><a id="ipp_pstate_e">ipp_pstate_e</a></h3>
6441         <p class="description">Printer state values</p>
6442       <h4 class="constants">Constants</h4>
6443       <table class="list"><tbody>
6444         <tr><th>IPP_PSTATE_IDLE </th>        <td class="description">Printer is idle</td></tr>
6445         <tr><th>IPP_PSTATE_PROCESSING </th>        <td class="description">Printer is working</td></tr>
6446         <tr><th>IPP_PSTATE_STOPPED </th>        <td class="description">Printer is stopped</td></tr>
6447 </tbody></table>
6448       <h3 class="enumeration"><a id="ipp_quality_e">ipp_quality_e</a></h3>
6449         <p class="description">Print quality values</p>
6450       <h4 class="constants">Constants</h4>
6451       <table class="list"><tbody>
6452         <tr><th>IPP_QUALITY_DRAFT </th>        <td class="description">Draft quality</td></tr>
6453         <tr><th>IPP_QUALITY_HIGH </th>        <td class="description">High quality</td></tr>
6454         <tr><th>IPP_QUALITY_NORMAL </th>        <td class="description">Normal quality</td></tr>
6455 </tbody></table>
6456       <h3 class="enumeration"><a id="ipp_res_e">ipp_res_e</a></h3>
6457         <p class="description">Resolution units</p>
6458       <h4 class="constants">Constants</h4>
6459       <table class="list"><tbody>
6460         <tr><th>IPP_RES_PER_CM </th>        <td class="description">Pixels per centimeter</td></tr>
6461         <tr><th>IPP_RES_PER_INCH </th>        <td class="description">Pixels per inch</td></tr>
6462 </tbody></table>
6463       <h3 class="enumeration"><a id="ipp_rstate_e">ipp_rstate_e</a></h3>
6464         <p class="description">resource-state values</p>
6465       <h4 class="constants">Constants</h4>
6466       <table class="list"><tbody>
6467         <tr><th>IPP_RSTATE_ABORTED </th>        <td class="description">Resource has been aborted and is pending deletion.</td></tr>
6468         <tr><th>IPP_RSTATE_AVAILABLE </th>        <td class="description">Resource is available for installation.</td></tr>
6469         <tr><th>IPP_RSTATE_CANCELED </th>        <td class="description">Resource has been canceled and is pending deletion.</td></tr>
6470         <tr><th>IPP_RSTATE_INSTALLED </th>        <td class="description">Resource is installed.</td></tr>
6471         <tr><th>IPP_RSTATE_PENDING </th>        <td class="description">Resource is created but has no data yet.</td></tr>
6472 </tbody></table>
6473       <h3 class="enumeration"><a id="ipp_sstate_e">ipp_sstate_e</a></h3>
6474         <p class="description">system-state values</p>
6475       <h4 class="constants">Constants</h4>
6476       <table class="list"><tbody>
6477         <tr><th>IPP_SSTATE_IDLE </th>        <td class="description">At least one printer is idle and none are processing a job.</td></tr>
6478         <tr><th>IPP_SSTATE_PROCESSING </th>        <td class="description">At least one printer is processing a job.</td></tr>
6479         <tr><th>IPP_SSTATE_STOPPED </th>        <td class="description">All printers are stopped.</td></tr>
6480 </tbody></table>
6481       <h3 class="enumeration"><a id="ipp_state_e">ipp_state_e</a></h3>
6482         <p class="description">ipp_t state values</p>
6483       <h4 class="constants">Constants</h4>
6484       <table class="list"><tbody>
6485         <tr><th>IPP_STATE_ATTRIBUTE </th>        <td class="description">One or more attributes need to be sent/received</td></tr>
6486         <tr><th>IPP_STATE_DATA </th>        <td class="description">IPP request data needs to be sent/received</td></tr>
6487         <tr><th>IPP_STATE_ERROR </th>        <td class="description">An error occurred</td></tr>
6488         <tr><th>IPP_STATE_HEADER </th>        <td class="description">The request header needs to be sent/received</td></tr>
6489         <tr><th>IPP_STATE_IDLE </th>        <td class="description">Nothing is happening/request completed</td></tr>
6490 </tbody></table>
6491       <h3 class="enumeration"><a id="ipp_status_e">ipp_status_e</a></h3>
6492         <p class="description">IPP status code values</p>
6493       <h4 class="constants">Constants</h4>
6494       <table class="list"><tbody>
6495         <tr><th>IPP_STATUS_CUPS_INVALID </th>        <td class="description">Invalid status name for <a href="#ippErrorValue"><code>ippErrorValue</code></a></td></tr>
6496         <tr><th>IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED </th>        <td class="description">client-error-account-authorization-failed</td></tr>
6497         <tr><th>IPP_STATUS_ERROR_ACCOUNT_CLOSED </th>        <td class="description">client-error-account-closed</td></tr>
6498         <tr><th>IPP_STATUS_ERROR_ACCOUNT_INFO_NEEDED </th>        <td class="description">client-error-account-info-needed</td></tr>
6499         <tr><th>IPP_STATUS_ERROR_ACCOUNT_LIMIT_REACHED </th>        <td class="description">client-error-account-limit-reached</td></tr>
6500         <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE </th>        <td class="description">client-error-attributes-not-settable</td></tr>
6501         <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES </th>        <td class="description">client-error-attributes-or-values-not-supported</td></tr>
6502         <tr><th>IPP_STATUS_ERROR_BAD_REQUEST </th>        <td class="description">client-error-bad-request</td></tr>
6503         <tr><th>IPP_STATUS_ERROR_BUSY </th>        <td class="description">server-error-busy</td></tr>
6504         <tr><th>IPP_STATUS_ERROR_CHARSET </th>        <td class="description">client-error-charset-not-supported</td></tr>
6505         <tr><th>IPP_STATUS_ERROR_COMPRESSION_ERROR </th>        <td class="description">client-error-compression-error</td></tr>
6506         <tr><th>IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED </th>        <td class="description">client-error-compression-not-supported</td></tr>
6507         <tr><th>IPP_STATUS_ERROR_CONFLICTING </th>        <td class="description">client-error-conflicting-attributes</td></tr>
6508         <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED <span class="info">&#160;DEPRECATED&#160;</span></th>        <td class="description">cups-error-account-authorization-failed </td></tr>
6509         <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED </th>        <td class="description">cups-error-account-closed @deprecate@</td></tr>
6510         <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED <span class="info">&#160;DEPRECATED&#160;</span></th>        <td class="description">cups-error-account-info-needed </td></tr>
6511         <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED <span class="info">&#160;DEPRECATED&#160;</span></th>        <td class="description">cups-error-account-limit-reached </td></tr>
6512         <tr><th>IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED <span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span></th>        <td class="description">cups-authentication-canceled - Authentication canceled by user </td></tr>
6513         <tr><th>IPP_STATUS_ERROR_CUPS_PKI <span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span></th>        <td class="description">cups-pki-error - Error negotiating a secure connection </td></tr>
6514         <tr><th>IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED <span class="info">&#160;CUPS 1.5/macOS 10.7&#160;</span></th>        <td class="description">cups-upgrade-required - TLS upgrade required </td></tr>
6515         <tr><th>IPP_STATUS_ERROR_DEVICE </th>        <td class="description">server-error-device-error</td></tr>
6516         <tr><th>IPP_STATUS_ERROR_DOCUMENT_ACCESS </th>        <td class="description">client-error-document-access-error</td></tr>
6517         <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR </th>        <td class="description">client-error-document-format-error</td></tr>
6518         <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED </th>        <td class="description">client-error-document-format-not-supported</td></tr>
6519         <tr><th>IPP_STATUS_ERROR_DOCUMENT_PASSWORD </th>        <td class="description">client-error-document-password-error</td></tr>
6520         <tr><th>IPP_STATUS_ERROR_DOCUMENT_PERMISSION </th>        <td class="description">client-error-document-permission-error</td></tr>
6521         <tr><th>IPP_STATUS_ERROR_DOCUMENT_SECURITY </th>        <td class="description">client-error-document-security-error</td></tr>
6522         <tr><th>IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE </th>        <td class="description">client-error-document-unprintable-error</td></tr>
6523         <tr><th>IPP_STATUS_ERROR_FORBIDDEN </th>        <td class="description">client-error-forbidden</td></tr>
6524         <tr><th>IPP_STATUS_ERROR_GONE </th>        <td class="description">client-error-gone</td></tr>
6525         <tr><th>IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS </th>        <td class="description">client-error-ignored-all-subscriptions</td></tr>
6526         <tr><th>IPP_STATUS_ERROR_INTERNAL </th>        <td class="description">server-error-internal-error</td></tr>
6527         <tr><th>IPP_STATUS_ERROR_JOB_CANCELED </th>        <td class="description">server-error-job-canceled</td></tr>
6528         <tr><th>IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED </th>        <td class="description">server-error-multiple-document-jobs-not-supported</td></tr>
6529         <tr><th>IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS </th>        <td class="description">server-error-not-accepting-jobs</td></tr>
6530         <tr><th>IPP_STATUS_ERROR_NOT_AUTHENTICATED </th>        <td class="description">client-error-not-authenticated</td></tr>
6531         <tr><th>IPP_STATUS_ERROR_NOT_AUTHORIZED </th>        <td class="description">client-error-not-authorized</td></tr>
6532         <tr><th>IPP_STATUS_ERROR_NOT_FETCHABLE </th>        <td class="description">client-error-not-fetchable</td></tr>
6533         <tr><th>IPP_STATUS_ERROR_NOT_FOUND </th>        <td class="description">client-error-not-found</td></tr>
6534         <tr><th>IPP_STATUS_ERROR_NOT_POSSIBLE </th>        <td class="description">client-error-not-possible</td></tr>
6535         <tr><th>IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED </th>        <td class="description">server-error-operation-not-supported</td></tr>
6536         <tr><th>IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED </th>        <td class="description">server-error-printer-is-deactivated</td></tr>
6537         <tr><th>IPP_STATUS_ERROR_REQUEST_ENTITY </th>        <td class="description">client-error-request-entity-too-large</td></tr>
6538         <tr><th>IPP_STATUS_ERROR_REQUEST_VALUE </th>        <td class="description">client-error-request-value-too-long</td></tr>
6539         <tr><th>IPP_STATUS_ERROR_SERVICE_UNAVAILABLE </th>        <td class="description">server-error-service-unavailable</td></tr>
6540         <tr><th>IPP_STATUS_ERROR_TEMPORARY </th>        <td class="description">server-error-temporary-error</td></tr>
6541         <tr><th>IPP_STATUS_ERROR_TIMEOUT </th>        <td class="description">client-error-timeout</td></tr>
6542         <tr><th>IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS </th>        <td class="description">server-error-too-many-documents</td></tr>
6543         <tr><th>IPP_STATUS_ERROR_TOO_MANY_JOBS </th>        <td class="description">server-error-too-many-jobs</td></tr>
6544         <tr><th>IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS </th>        <td class="description">client-error-too-many-subscriptions</td></tr>
6545         <tr><th>IPP_STATUS_ERROR_URI_SCHEME </th>        <td class="description">client-error-uri-scheme-not-supported</td></tr>
6546         <tr><th>IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED </th>        <td class="description">server-error-version-not-supported</td></tr>
6547         <tr><th>IPP_STATUS_OK </th>        <td class="description">successful-ok</td></tr>
6548         <tr><th>IPP_STATUS_OK_CONFLICTING </th>        <td class="description">successful-ok-conflicting-attributes</td></tr>
6549         <tr><th>IPP_STATUS_OK_EVENTS_COMPLETE </th>        <td class="description">successful-ok-events-complete</td></tr>
6550         <tr><th>IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED </th>        <td class="description">successful-ok-ignored-or-substituted-attributes</td></tr>
6551         <tr><th>IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS </th>        <td class="description">successful-ok-ignored-subscriptions</td></tr>
6552         <tr><th>IPP_STATUS_OK_TOO_MANY_EVENTS </th>        <td class="description">successful-ok-too-many-events</td></tr>
6553 </tbody></table>
6554       <h3 class="enumeration"><a id="ipp_tag_e">ipp_tag_e</a></h3>
6555         <p class="description">Value and group tag values for attributes</p>
6556       <h4 class="constants">Constants</h4>
6557       <table class="list"><tbody>
6558         <tr><th>IPP_TAG_ADMINDEFINE </th>        <td class="description">Admin-defined value</td></tr>
6559         <tr><th>IPP_TAG_BOOLEAN </th>        <td class="description">Boolean value</td></tr>
6560         <tr><th>IPP_TAG_CHARSET </th>        <td class="description">Character set value</td></tr>
6561         <tr><th>IPP_TAG_CUPS_INVALID </th>        <td class="description">Invalid tag name for <a href="#ippTagValue"><code>ippTagValue</code></a></td></tr>
6562         <tr><th>IPP_TAG_DATE </th>        <td class="description">Date/time value</td></tr>
6563         <tr><th>IPP_TAG_DEFAULT </th>        <td class="description">Default value</td></tr>
6564         <tr><th>IPP_TAG_DELETEATTR </th>        <td class="description">Delete-attribute value</td></tr>
6565         <tr><th>IPP_TAG_DOCUMENT </th>        <td class="description">Document group</td></tr>
6566         <tr><th>IPP_TAG_END </th>        <td class="description">End-of-attributes</td></tr>
6567         <tr><th>IPP_TAG_ENUM </th>        <td class="description">Enumeration value</td></tr>
6568         <tr><th>IPP_TAG_EVENT_NOTIFICATION </th>        <td class="description">Event group</td></tr>
6569         <tr><th>IPP_TAG_INTEGER </th>        <td class="description">Integer value</td></tr>
6570         <tr><th>IPP_TAG_JOB </th>        <td class="description">Job group</td></tr>
6571         <tr><th>IPP_TAG_KEYWORD </th>        <td class="description">Keyword value</td></tr>
6572         <tr><th>IPP_TAG_LANGUAGE </th>        <td class="description">Language value</td></tr>
6573         <tr><th>IPP_TAG_MIMETYPE </th>        <td class="description">MIME media type value</td></tr>
6574         <tr><th>IPP_TAG_NAME </th>        <td class="description">Name value</td></tr>
6575         <tr><th>IPP_TAG_NAMELANG </th>        <td class="description">Name-with-language value</td></tr>
6576         <tr><th>IPP_TAG_NOTSETTABLE </th>        <td class="description">Not-settable value</td></tr>
6577         <tr><th>IPP_TAG_NOVALUE </th>        <td class="description">No-value value</td></tr>
6578         <tr><th>IPP_TAG_OPERATION </th>        <td class="description">Operation group</td></tr>
6579         <tr><th>IPP_TAG_PRINTER </th>        <td class="description">Printer group</td></tr>
6580         <tr><th>IPP_TAG_RANGE </th>        <td class="description">Range value</td></tr>
6581         <tr><th>IPP_TAG_RESOLUTION </th>        <td class="description">Resolution value</td></tr>
6582         <tr><th>IPP_TAG_RESOURCE </th>        <td class="description">Resource group</td></tr>
6583         <tr><th>IPP_TAG_STRING </th>        <td class="description">Octet string value</td></tr>
6584         <tr><th>IPP_TAG_SUBSCRIPTION </th>        <td class="description">Subscription group</td></tr>
6585         <tr><th>IPP_TAG_SYSTEM </th>        <td class="description">System group</td></tr>
6586         <tr><th>IPP_TAG_TEXT </th>        <td class="description">Text value</td></tr>
6587         <tr><th>IPP_TAG_TEXTLANG </th>        <td class="description">Text-with-language value</td></tr>
6588         <tr><th>IPP_TAG_UNKNOWN </th>        <td class="description">Unknown value</td></tr>
6589         <tr><th>IPP_TAG_UNSUPPORTED_GROUP </th>        <td class="description">Unsupported attributes group</td></tr>
6590         <tr><th>IPP_TAG_UNSUPPORTED_VALUE </th>        <td class="description">Unsupported value</td></tr>
6591         <tr><th>IPP_TAG_URI </th>        <td class="description">URI value</td></tr>
6592         <tr><th>IPP_TAG_URISCHEME </th>        <td class="description">URI scheme value</td></tr>
6593         <tr><th>IPP_TAG_ZERO </th>        <td class="description">Zero tag - used for separators</td></tr>
6594 </tbody></table>
6595     </div>
6596   </body>
6597 </html>