| | 1 | <!DOCTYPE html> |
| | 2 | <html lang="en-US"> |
| | 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="generator" content="codedoc v3.8"> |
| | 9 | <meta name="author" content="Michael R Sweet"> |
| | 10 | <meta name="language" content="en-US"> |
| | 11 | <meta name="copyright" content="Copyright © 2020-2025 by OpenPrinting. All Rights Reserved."> |
| | 12 | <meta name="version" content="2.5.0"> |
| | 13 | <style type="text/css"><!-- |
| | 14 | body { |
| | 15 | background: white; |
| | 16 | color: black; |
| | 17 | font-family: sans-serif; |
| | 18 | font-size: 12pt; |
| | 19 | } |
| | 20 | a { |
| | 21 | color: black; |
| | 22 | } |
| | 23 | a:link, a:visited { |
| | 24 | color: #00f; |
| | 25 | } |
| | 26 | a:link:hover, a:visited:hover, a:active { |
| | 27 | color: #c0c; |
| | 28 | } |
| | 29 | body, p, h1, h2, h3, h4, h5, h6 { |
| | 30 | font-family: sans-serif; |
| | 31 | line-height: 1.4; |
| | 32 | } |
| | 33 | h1, h2, h3, h4, h5, h6 { |
| | 34 | font-weight: bold; |
| | 35 | page-break-inside: avoid; |
| | 36 | } |
| | 37 | h1 { |
| | 38 | font-size: 250%; |
| | 39 | margin: 0; |
| | 40 | } |
| | 41 | h2 { |
| | 42 | font-size: 250%; |
| | 43 | margin-top: 1.5em; |
| | 44 | } |
| | 45 | h3 { |
| | 46 | font-size: 200%; |
| | 47 | margin-bottom: 0.5em; |
| | 48 | margin-top: 1.5em; |
| | 49 | } |
| | 50 | h4 { |
| | 51 | font-size: 150%; |
| | 52 | margin-bottom: 0.5em; |
| | 53 | margin-top: 1.5em; |
| | 54 | } |
| | 55 | h5 { |
| | 56 | font-size: 125%; |
| | 57 | margin-bottom: 0.5em; |
| | 58 | margin-top: 1.5em; |
| | 59 | } |
| | 60 | h6 { |
| | 61 | font-size: 110%; |
| | 62 | margin-bottom: 0.5em; |
| | 63 | margin-top: 1.5em; |
| | 64 | } |
| | 65 | img.title { |
| | 66 | width: 256px; |
| | 67 | } |
| | 68 | div.header h1, div.header p { |
| | 69 | text-align: center; |
| | 70 | } |
| | 71 | div.contents, div.body, div.footer { |
| | 72 | page-break-before: always; |
| | 73 | } |
| | 74 | .class, .enumeration, .function, .struct, .typedef, .union { |
| | 75 | border-bottom: solid 2px gray; |
| | 76 | } |
| | 77 | .description { |
| | 78 | margin-top: 0.5em; |
| | 79 | } |
| | 80 | .function { |
| | 81 | margin-bottom: 0; |
| | 82 | } |
| | 83 | blockquote { |
| | 84 | border: solid thin gray; |
| | 85 | box-shadow: 3px 3px 5px rgba(127,127,127,0.25); |
| | 86 | margin: 1em 0; |
| | 87 | padding: 10px; |
| | 88 | page-break-inside: avoid; |
| | 89 | } |
| | 90 | blockquote :first-child { |
| | 91 | margin-top: 0; |
| | 92 | } |
| | 93 | blockquote :first-child { |
| | 94 | margin-bottom: 0; |
| | 95 | } |
| | 96 | p code, li code, p.code, pre, ul.code li { |
| | 97 | font-family: monospace; |
| | 98 | hyphens: manual; |
| | 99 | -webkit-hyphens: manual; |
| | 100 | } |
| | 101 | p.code, pre, ul.code li { |
| | 102 | background: rgba(127,127,127,0.25); |
| | 103 | border: thin dotted gray; |
| | 104 | padding: 10px; |
| | 105 | page-break-inside: avoid; |
| | 106 | } |
| | 107 | pre { |
| | 108 | white-space: pre-wrap; |
| | 109 | } |
| | 110 | a:link, a:visited { |
| | 111 | text-decoration: none; |
| | 112 | } |
| | 113 | span.info { |
| | 114 | background: black; |
| | 115 | border: solid thin black; |
| | 116 | color: white; |
| | 117 | font-size: 80%; |
| | 118 | font-style: italic; |
| | 119 | font-weight: bold; |
| | 120 | white-space: nowrap; |
| | 121 | } |
| | 122 | h1 span.info, h2 span.info, h3 span.info, h4 span.info { |
| | 123 | border-top-left-radius: 10px; |
| | 124 | border-top-right-radius: 10px; |
| | 125 | float: right; |
| | 126 | padding: 3px 6px; |
| | 127 | } |
| | 128 | ul.code, ul.contents, ul.subcontents { |
| | 129 | list-style-type: none; |
| | 130 | margin: 0; |
| | 131 | padding-left: 0; |
| | 132 | } |
| | 133 | ul.code li { |
| | 134 | margin: 0; |
| | 135 | } |
| | 136 | ul.contents > li { |
| | 137 | margin-top: 1em; |
| | 138 | } |
| | 139 | ul.contents li ul.code, ul.contents li ul.subcontents { |
| | 140 | padding-left: 2em; |
| | 141 | } |
| | 142 | table { |
| | 143 | border-collapse: collapse; |
| | 144 | border-spacing: 0; |
| | 145 | } |
| | 146 | td { |
| | 147 | border: solid 1px gray; |
| | 148 | padding: 5px 10px; |
| | 149 | vertical-align: top; |
| | 150 | } |
| | 151 | td.left { |
| | 152 | text-align: left; |
| | 153 | } |
| | 154 | td.center { |
| | 155 | text-align: center; |
| | 156 | } |
| | 157 | td.right { |
| | 158 | text-align: right; |
| | 159 | } |
| | 160 | th { |
| | 161 | border-bottom: solid 2px gray; |
| | 162 | padding: 1px 5px; |
| | 163 | text-align: center; |
| | 164 | vertical-align: bottom; |
| | 165 | } |
| | 166 | tr:nth-child(even) { |
| | 167 | background: rgba(127,127,127,0.25); |
| | 168 | } |
| | 169 | table.list { |
| | 170 | border-collapse: collapse; |
| | 171 | width: 100%; |
| | 172 | } |
| | 173 | table.list th { |
| | 174 | border-bottom: none; |
| | 175 | border-right: 2px solid gray; |
| | 176 | font-family: monospace; |
| | 177 | font-weight: normal; |
| | 178 | padding: 5px 10px 5px 2px; |
| | 179 | text-align: right; |
| | 180 | vertical-align: top; |
| | 181 | } |
| | 182 | table.list td { |
| | 183 | border: none; |
| | 184 | padding: 5px 2px 5px 10px; |
| | 185 | text-align: left; |
| | 186 | vertical-align: top; |
| | 187 | } |
| | 188 | h2.title, h3.title { |
| | 189 | border-bottom: solid 2px gray; |
| | 190 | } |
| | 191 | /* Syntax highlighting */ |
| | 192 | span.comment { |
| | 193 | color: darkgreen; |
| | 194 | } |
| | 195 | span.directive { |
| | 196 | color: red; |
| | 197 | } |
| | 198 | span.number { |
| | 199 | color: brown; |
| | 200 | } |
| | 201 | span.reserved { |
| | 202 | color: blue; |
| | 203 | } |
| | 204 | span.string { |
| | 205 | color: magenta; |
| | 206 | } |
| | 207 | /* Dark mode overrides */ |
| | 208 | @media (prefers-color-scheme: dark) { |
| | 209 | body { |
| | 210 | background: black; |
| | 211 | color: #ccc; |
| | 212 | } |
| | 213 | a { |
| | 214 | color: #ccc; |
| | 215 | } |
| | 216 | a:link, a:visited { |
| | 217 | color: #66f; |
| | 218 | } |
| | 219 | a:link:hover, a:visited:hover, a:active { |
| | 220 | color: #f06; |
| | 221 | } |
| | 222 | } |
| | 223 | /* Show contents on left side in web browser */ |
| | 224 | @media screen and (min-width: 800px) { |
| | 225 | div.contents { |
| | 226 | border-right: solid thin gray; |
| | 227 | bottom: 0px; |
| | 228 | box-shadow: 3px 3px 5px rgba(127,127,127,0.5); |
| | 229 | font-size: 10pt; |
| | 230 | left: 0px; |
| | 231 | overflow: scroll; |
| | 232 | padding: 1%; |
| | 233 | position: fixed; |
| | 234 | top: 0px; |
| | 235 | width: 18%; |
| | 236 | } |
| | 237 | div.contents h2.title { |
| | 238 | margin-top: 0px; |
| | 239 | } |
| | 240 | div.header, div.body, div.footer { |
| | 241 | margin-left: 20%; |
| | 242 | padding: 1% 2%; |
| | 243 | } |
| | 244 | } |
| | 245 | /* Center title page content vertically */ |
| | 246 | @media print { |
| | 247 | div.header { |
| | 248 | padding-top: 33%; |
| | 249 | } |
| | 250 | } |
| | 251 | --></style> |
| | 252 | </head> |
| | 253 | <body> |
| | 254 | <div class="header"> |
| | 255 | <h1 class="title">CUPS Programming Manual</h1> |
| | 256 | <p>Michael R Sweet</p> |
| | 257 | <p>Copyright © 2020-2025 by OpenPrinting. All Rights Reserved.</p> |
| | 258 | </div> |
| | 259 | <div class="contents"> |
| | 260 | <h2 class="title">Contents</h2> |
| | 261 | <ul class="contents"> |
| | 262 | <li><a href="#introduction">Introduction</a><ul class="subcontents"> |
| | 263 | <li><a href="#guidelines">Guidelines</a></li> |
| | 264 | <li><a href="#terms-used-in-this-document">Terms Used in This Document</a></li> |
| | 265 | <li><a href="#compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></li> |
| | 266 | </ul></li> |
| | 267 | <li><a href="#working-with-destinations">Working with Destinations</a><ul class="subcontents"> |
| | 268 | <li><a href="#finding-available-destinations">Finding Available Destinations</a></li> |
| | 269 | <li><a href="#basic-destination-information">Basic Destination Information</a></li> |
| | 270 | <li><a href="#detailed-destination-information">Detailed Destination Information</a></li> |
| | 271 | <li><a href="#submitting-a-print-job">Submitting a Print Job</a></li> |
| | 272 | </ul></li> |
| | 273 | <li><a href="#sending-ipp-requests">Sending IPP Requests</a><ul class="subcontents"> |
| | 274 | <li><a href="#connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</a></li> |
| | 275 | <li><a href="#creating-an-ipp-request">Creating an IPP Request</a></li> |
| | 276 | <li><a href="#sending-the-ipp-request">Sending the IPP Request</a></li> |
| | 277 | <li><a href="#processing-the-ipp-response">Processing the IPP Response</a></li> |
| | 278 | <li><a href="#authentication">Authentication</a></li> |
| | 279 | </ul></li> |
| | 280 | <li><a href="#ipp-data-file-api">IPP Data File API</a><ul class="subcontents"> |
| | 281 | <li><a href="#creating-an-ipp-data-file">Creating an IPP Data File</a></li> |
| | 282 | <li><a href="#reading-a-data-file">Reading a Data File</a></li> |
| | 283 | <li><a href="#variables">Variables</a></li> |
| | 284 | <li><a href="#writing-ipp-data-files">Writing IPP Data Files</a></li> |
| | 285 | </ul></li> |
| | 286 | <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents"> |
| | 287 | <li><a href="#cupsAddDest">cupsAddDest</a></li> |
| | 288 | <li><a href="#cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></li> |
| | 289 | <li><a href="#cupsAddDestMediaOptions2">cupsAddDestMediaOptions2</a></li> |
| | 290 | <li><a href="#cupsAddIntegerOption">cupsAddIntegerOption</a></li> |
| | 291 | <li><a href="#cupsAddOption">cupsAddOption</a></li> |
| | 292 | <li><a href="#cupsAreCredentialsValidForName">cupsAreCredentialsValidForName</a></li> |
| | 293 | <li><a href="#cupsArrayAdd">cupsArrayAdd</a></li> |
| | 294 | <li><a href="#cupsArrayAddStrings">cupsArrayAddStrings</a></li> |
| | 295 | <li><a href="#cupsArrayClear">cupsArrayClear</a></li> |
| | 296 | <li><a href="#cupsArrayDelete">cupsArrayDelete</a></li> |
| | 297 | <li><a href="#cupsArrayDup">cupsArrayDup</a></li> |
| | 298 | <li><a href="#cupsArrayFind">cupsArrayFind</a></li> |
| | 299 | <li><a href="#cupsArrayGetCount">cupsArrayGetCount</a></li> |
| | 300 | <li><a href="#cupsArrayGetCurrent">cupsArrayGetCurrent</a></li> |
| | 301 | <li><a href="#cupsArrayGetElement">cupsArrayGetElement</a></li> |
| | 302 | <li><a href="#cupsArrayGetFirst">cupsArrayGetFirst</a></li> |
| | 303 | <li><a href="#cupsArrayGetIndex">cupsArrayGetIndex</a></li> |
| | 304 | <li><a href="#cupsArrayGetInsert">cupsArrayGetInsert</a></li> |
| | 305 | <li><a href="#cupsArrayGetLast">cupsArrayGetLast</a></li> |
| | 306 | <li><a href="#cupsArrayGetNext">cupsArrayGetNext</a></li> |
| | 307 | <li><a href="#cupsArrayGetPrev">cupsArrayGetPrev</a></li> |
| | 308 | <li><a href="#cupsArrayGetUserData">cupsArrayGetUserData</a></li> |
| | 309 | <li><a href="#cupsArrayInsert">cupsArrayInsert</a></li> |
| | 310 | <li><a href="#cupsArrayNew3">cupsArrayNew3</a></li> |
| | 311 | <li><a href="#cupsArrayNewStrings">cupsArrayNewStrings</a></li> |
| | 312 | <li><a href="#cupsArrayRemove">cupsArrayRemove</a></li> |
| | 313 | <li><a href="#cupsArrayRestore">cupsArrayRestore</a></li> |
| | 314 | <li><a href="#cupsArraySave">cupsArraySave</a></li> |
| | 315 | <li><a href="#cupsCancelDestJob">cupsCancelDestJob</a></li> |
| | 316 | <li><a href="#cupsCharsetToUTF8">cupsCharsetToUTF8</a></li> |
| | 317 | <li><a href="#cupsCheckDestSupported">cupsCheckDestSupported</a></li> |
| | 318 | <li><a href="#cupsCloseDestJob">cupsCloseDestJob</a></li> |
| | 319 | <li><a href="#cupsConcatString">cupsConcatString</a></li> |
| | 320 | <li><a href="#cupsCondBroadcast">cupsCondBroadcast</a></li> |
| | 321 | <li><a href="#cupsCondDestroy">cupsCondDestroy</a></li> |
| | 322 | <li><a href="#cupsCondInit">cupsCondInit</a></li> |
| | 323 | <li><a href="#cupsCondWait">cupsCondWait</a></li> |
| | 324 | <li><a href="#cupsConnectDest">cupsConnectDest</a></li> |
| | 325 | <li><a href="#cupsCopyCredentials">cupsCopyCredentials</a></li> |
| | 326 | <li><a href="#cupsCopyCredentialsKey">cupsCopyCredentialsKey</a></li> |
| | 327 | <li><a href="#cupsCopyCredentialsPublicKey">cupsCopyCredentialsPublicKey</a></li> |
| | 328 | <li><a href="#cupsCopyCredentialsRequest">cupsCopyCredentialsRequest</a></li> |
| | 329 | <li><a href="#cupsCopyDest">cupsCopyDest</a></li> |
| | 330 | <li><a href="#cupsCopyDestConflicts">cupsCopyDestConflicts</a></li> |
| | 331 | <li><a href="#cupsCopyDestInfo">cupsCopyDestInfo</a></li> |
| | 332 | <li><a href="#cupsCopyDestInfo2">cupsCopyDestInfo2</a></li> |
| | 333 | <li><a href="#cupsCopyString">cupsCopyString</a></li> |
| | 334 | <li><a href="#cupsCreateCredentials">cupsCreateCredentials</a></li> |
| | 335 | <li><a href="#cupsCreateCredentialsRequest">cupsCreateCredentialsRequest</a></li> |
| | 336 | <li><a href="#cupsCreateDestJob">cupsCreateDestJob</a></li> |
| | 337 | <li><a href="#cupsCreateTempFd">cupsCreateTempFd</a></li> |
| | 338 | <li><a href="#cupsCreateTempFile">cupsCreateTempFile</a></li> |
| | 339 | <li><a href="#cupsDNSSDAssembleFullName">cupsDNSSDAssembleFullName</a></li> |
| | 340 | <li><a href="#cupsDNSSDBrowseDelete">cupsDNSSDBrowseDelete</a></li> |
| | 341 | <li><a href="#cupsDNSSDBrowseGetContext">cupsDNSSDBrowseGetContext</a></li> |
| | 342 | <li><a href="#cupsDNSSDBrowseNew">cupsDNSSDBrowseNew</a></li> |
| | 343 | <li><a href="#cupsDNSSDCopyComputerName">cupsDNSSDCopyComputerName</a></li> |
| | 344 | <li><a href="#cupsDNSSDCopyHostName">cupsDNSSDCopyHostName</a></li> |
| | 345 | <li><a href="#cupsDNSSDDecodeTXT">cupsDNSSDDecodeTXT</a></li> |
| | 346 | <li><a href="#cupsDNSSDDelete">cupsDNSSDDelete</a></li> |
| | 347 | <li><a href="#cupsDNSSDGetConfigChanges">cupsDNSSDGetConfigChanges</a></li> |
| | 348 | <li><a href="#cupsDNSSDNew">cupsDNSSDNew</a></li> |
| | 349 | <li><a href="#cupsDNSSDQueryDelete">cupsDNSSDQueryDelete</a></li> |
| | 350 | <li><a href="#cupsDNSSDQueryGetContext">cupsDNSSDQueryGetContext</a></li> |
| | 351 | <li><a href="#cupsDNSSDQueryNew">cupsDNSSDQueryNew</a></li> |
| | 352 | <li><a href="#cupsDNSSDResolveDelete">cupsDNSSDResolveDelete</a></li> |
| | 353 | <li><a href="#cupsDNSSDResolveGetContext">cupsDNSSDResolveGetContext</a></li> |
| | 354 | <li><a href="#cupsDNSSDResolveNew">cupsDNSSDResolveNew</a></li> |
| | 355 | <li><a href="#cupsDNSSDSeparateFullName">cupsDNSSDSeparateFullName</a></li> |
| | 356 | <li><a href="#cupsDNSSDServiceAdd">cupsDNSSDServiceAdd</a></li> |
| | 357 | <li><a href="#cupsDNSSDServiceDelete">cupsDNSSDServiceDelete</a></li> |
| | 358 | <li><a href="#cupsDNSSDServiceGetContext">cupsDNSSDServiceGetContext</a></li> |
| | 359 | <li><a href="#cupsDNSSDServiceGetName">cupsDNSSDServiceGetName</a></li> |
| | 360 | <li><a href="#cupsDNSSDServiceNew">cupsDNSSDServiceNew</a></li> |
| | 361 | <li><a href="#cupsDNSSDServicePublish">cupsDNSSDServicePublish</a></li> |
| | 362 | <li><a href="#cupsDNSSDServiceSetLocation">cupsDNSSDServiceSetLocation</a></li> |
| | 363 | <li><a href="#cupsDirClose">cupsDirClose</a></li> |
| | 364 | <li><a href="#cupsDirOpen">cupsDirOpen</a></li> |
| | 365 | <li><a href="#cupsDirRead">cupsDirRead</a></li> |
| | 366 | <li><a href="#cupsDirRewind">cupsDirRewind</a></li> |
| | 367 | <li><a href="#cupsDoAuthentication">cupsDoAuthentication</a></li> |
| | 368 | <li><a href="#cupsDoFileRequest">cupsDoFileRequest</a></li> |
| | 369 | <li><a href="#cupsDoIORequest">cupsDoIORequest</a></li> |
| | 370 | <li><a href="#cupsDoRequest">cupsDoRequest</a></li> |
| | 371 | <li><a href="#cupsEncodeOption">cupsEncodeOption</a></li> |
| | 372 | <li><a href="#cupsEncodeOptions">cupsEncodeOptions</a></li> |
| | 373 | <li><a href="#cupsEncodeOptions2">cupsEncodeOptions2</a></li> |
| | 374 | <li><a href="#cupsEncryption">cupsEncryption</a></li> |
| | 375 | <li><a href="#cupsEnumDests">cupsEnumDests</a></li> |
| | 376 | <li><a href="#cupsFileClose">cupsFileClose</a></li> |
| | 377 | <li><a href="#cupsFileEOF">cupsFileEOF</a></li> |
| | 378 | <li><a href="#cupsFileFind">cupsFileFind</a></li> |
| | 379 | <li><a href="#cupsFileFlush">cupsFileFlush</a></li> |
| | 380 | <li><a href="#cupsFileGetChar">cupsFileGetChar</a></li> |
| | 381 | <li><a href="#cupsFileGetConf">cupsFileGetConf</a></li> |
| | 382 | <li><a href="#cupsFileGetLine">cupsFileGetLine</a></li> |
| | 383 | <li><a href="#cupsFileGets">cupsFileGets</a></li> |
| | 384 | <li><a href="#cupsFileIsCompressed">cupsFileIsCompressed</a></li> |
| | 385 | <li><a href="#cupsFileLock">cupsFileLock</a></li> |
| | 386 | <li><a href="#cupsFileNumber">cupsFileNumber</a></li> |
| | 387 | <li><a href="#cupsFileOpen">cupsFileOpen</a></li> |
| | 388 | <li><a href="#cupsFileOpenFd">cupsFileOpenFd</a></li> |
| | 389 | <li><a href="#cupsFilePeekChar">cupsFilePeekChar</a></li> |
| | 390 | <li><a href="#cupsFilePrintf">cupsFilePrintf</a></li> |
| | 391 | <li><a href="#cupsFilePutChar">cupsFilePutChar</a></li> |
| | 392 | <li><a href="#cupsFilePutConf">cupsFilePutConf</a></li> |
| | 393 | <li><a href="#cupsFilePuts">cupsFilePuts</a></li> |
| | 394 | <li><a href="#cupsFileRead">cupsFileRead</a></li> |
| | 395 | <li><a href="#cupsFileRewind">cupsFileRewind</a></li> |
| | 396 | <li><a href="#cupsFileSeek">cupsFileSeek</a></li> |
| | 397 | <li><a href="#cupsFileStderr">cupsFileStderr</a></li> |
| | 398 | <li><a href="#cupsFileStdin">cupsFileStdin</a></li> |
| | 399 | <li><a href="#cupsFileStdout">cupsFileStdout</a></li> |
| | 400 | <li><a href="#cupsFileTell">cupsFileTell</a></li> |
| | 401 | <li><a href="#cupsFileUnlock">cupsFileUnlock</a></li> |
| | 402 | <li><a href="#cupsFileWrite">cupsFileWrite</a></li> |
| | 403 | <li><a href="#cupsFindDestDefault">cupsFindDestDefault</a></li> |
| | 404 | <li><a href="#cupsFindDestReady">cupsFindDestReady</a></li> |
| | 405 | <li><a href="#cupsFindDestSupported">cupsFindDestSupported</a></li> |
| | 406 | <li><a href="#cupsFinishDestDocument">cupsFinishDestDocument</a></li> |
| | 407 | <li><a href="#cupsFormDecode">cupsFormDecode</a></li> |
| | 408 | <li><a href="#cupsFormEncode">cupsFormEncode</a></li> |
| | 409 | <li><a href="#cupsFormatString">cupsFormatString</a></li> |
| | 410 | <li><a href="#cupsFormatStringv">cupsFormatStringv</a></li> |
| | 411 | <li><a href="#cupsFreeDestInfo">cupsFreeDestInfo</a></li> |
| | 412 | <li><a href="#cupsFreeDests">cupsFreeDests</a></li> |
| | 413 | <li><a href="#cupsFreeJobs">cupsFreeJobs</a></li> |
| | 414 | <li><a href="#cupsFreeOptions">cupsFreeOptions</a></li> |
| | 415 | <li><a href="#cupsGetClock">cupsGetClock</a></li> |
| | 416 | <li><a href="#cupsGetCredentialsExpiration">cupsGetCredentialsExpiration</a></li> |
| | 417 | <li><a href="#cupsGetCredentialsInfo">cupsGetCredentialsInfo</a></li> |
| | 418 | <li><a href="#cupsGetCredentialsTrust">cupsGetCredentialsTrust</a></li> |
| | 419 | <li><a href="#cupsGetDest">cupsGetDest</a></li> |
| | 420 | <li><a href="#cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></li> |
| | 421 | <li><a href="#cupsGetDestMediaByIndex2">cupsGetDestMediaByIndex2</a></li> |
| | 422 | <li><a href="#cupsGetDestMediaByName">cupsGetDestMediaByName</a></li> |
| | 423 | <li><a href="#cupsGetDestMediaByName2">cupsGetDestMediaByName2</a></li> |
| | 424 | <li><a href="#cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></li> |
| | 425 | <li><a href="#cupsGetDestMediaBySize2">cupsGetDestMediaBySize2</a></li> |
| | 426 | <li><a href="#cupsGetDestMediaCount">cupsGetDestMediaCount</a></li> |
| | 427 | <li><a href="#cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></li> |
| | 428 | <li><a href="#cupsGetDestMediaDefault2">cupsGetDestMediaDefault2</a></li> |
| | 429 | <li><a href="#cupsGetDestWithURI">cupsGetDestWithURI</a></li> |
| | 430 | <li><a href="#cupsGetDests2">cupsGetDests2</a></li> |
| | 431 | <li><a href="#cupsGetEncryption">cupsGetEncryption</a></li> |
| | 432 | <li><a href="#cupsGetError">cupsGetError</a></li> |
| | 433 | <li><a href="#cupsGetErrorString">cupsGetErrorString</a></li> |
| | 434 | <li><a href="#cupsGetFd">cupsGetFd</a></li> |
| | 435 | <li><a href="#cupsGetFile">cupsGetFile</a></li> |
| | 436 | <li><a href="#cupsGetIntegerOption">cupsGetIntegerOption</a></li> |
| | 437 | <li><a href="#cupsGetJobs2">cupsGetJobs2</a></li> |
| | 438 | <li><a href="#cupsGetNamedDest">cupsGetNamedDest</a></li> |
| | 439 | <li><a href="#cupsGetOption">cupsGetOption</a></li> |
| | 440 | <li><a href="#cupsGetPassword2">cupsGetPassword2</a></li> |
| | 441 | <li><a href="#cupsGetRand">cupsGetRand</a></li> |
| | 442 | <li><a href="#cupsGetResponse">cupsGetResponse</a></li> |
| | 443 | <li><a href="#cupsGetServer">cupsGetServer</a></li> |
| | 444 | <li><a href="#cupsGetUser">cupsGetUser</a></li> |
| | 445 | <li><a href="#cupsGetUserAgent">cupsGetUserAgent</a></li> |
| | 446 | <li><a href="#cupsHMACData">cupsHMACData</a></li> |
| | 447 | <li><a href="#cupsHashData">cupsHashData</a></li> |
| | 448 | <li><a href="#cupsHashString">cupsHashString</a></li> |
| | 449 | <li><a href="#cupsJSONAdd">cupsJSONAdd</a></li> |
| | 450 | <li><a href="#cupsJSONDelete">cupsJSONDelete</a></li> |
| | 451 | <li><a href="#cupsJSONExportFile">cupsJSONExportFile</a></li> |
| | 452 | <li><a href="#cupsJSONExportString">cupsJSONExportString</a></li> |
| | 453 | <li><a href="#cupsJSONFind">cupsJSONFind</a></li> |
| | 454 | <li><a href="#cupsJSONGetChild">cupsJSONGetChild</a></li> |
| | 455 | <li><a href="#cupsJSONGetCount">cupsJSONGetCount</a></li> |
| | 456 | <li><a href="#cupsJSONGetKey">cupsJSONGetKey</a></li> |
| | 457 | <li><a href="#cupsJSONGetNumber">cupsJSONGetNumber</a></li> |
| | 458 | <li><a href="#cupsJSONGetParent">cupsJSONGetParent</a></li> |
| | 459 | <li><a href="#cupsJSONGetSibling">cupsJSONGetSibling</a></li> |
| | 460 | <li><a href="#cupsJSONGetString">cupsJSONGetString</a></li> |
| | 461 | <li><a href="#cupsJSONGetType">cupsJSONGetType</a></li> |
| | 462 | <li><a href="#cupsJSONImportFile">cupsJSONImportFile</a></li> |
| | 463 | <li><a href="#cupsJSONImportString">cupsJSONImportString</a></li> |
| | 464 | <li><a href="#cupsJSONImportURL">cupsJSONImportURL</a></li> |
| | 465 | <li><a href="#cupsJSONNew">cupsJSONNew</a></li> |
| | 466 | <li><a href="#cupsJSONNewKey">cupsJSONNewKey</a></li> |
| | 467 | <li><a href="#cupsJSONNewNumber">cupsJSONNewNumber</a></li> |
| | 468 | <li><a href="#cupsJSONNewString">cupsJSONNewString</a></li> |
| | 469 | <li><a href="#cupsJWTDelete">cupsJWTDelete</a></li> |
| | 470 | <li><a href="#cupsJWTExportString">cupsJWTExportString</a></li> |
| | 471 | <li><a href="#cupsJWTGetAlgorithm">cupsJWTGetAlgorithm</a></li> |
| | 472 | <li><a href="#cupsJWTGetClaimNumber">cupsJWTGetClaimNumber</a></li> |
| | 473 | <li><a href="#cupsJWTGetClaimString">cupsJWTGetClaimString</a></li> |
| | 474 | <li><a href="#cupsJWTGetClaimType">cupsJWTGetClaimType</a></li> |
| | 475 | <li><a href="#cupsJWTGetClaimValue">cupsJWTGetClaimValue</a></li> |
| | 476 | <li><a href="#cupsJWTGetClaims">cupsJWTGetClaims</a></li> |
| | 477 | <li><a href="#cupsJWTGetHeaderNumber">cupsJWTGetHeaderNumber</a></li> |
| | 478 | <li><a href="#cupsJWTGetHeaderString">cupsJWTGetHeaderString</a></li> |
| | 479 | <li><a href="#cupsJWTGetHeaderType">cupsJWTGetHeaderType</a></li> |
| | 480 | <li><a href="#cupsJWTGetHeaderValue">cupsJWTGetHeaderValue</a></li> |
| | 481 | <li><a href="#cupsJWTGetHeaders">cupsJWTGetHeaders</a></li> |
| | 482 | <li><a href="#cupsJWTHasValidSignature">cupsJWTHasValidSignature</a></li> |
| | 483 | <li><a href="#cupsJWTImportString">cupsJWTImportString</a></li> |
| | 484 | <li><a href="#cupsJWTLoadCredentials">cupsJWTLoadCredentials</a></li> |
| | 485 | <li><a href="#cupsJWTMakePrivateKey">cupsJWTMakePrivateKey</a></li> |
| | 486 | <li><a href="#cupsJWTMakePublicKey">cupsJWTMakePublicKey</a></li> |
| | 487 | <li><a href="#cupsJWTNew">cupsJWTNew</a></li> |
| | 488 | <li><a href="#cupsJWTSetClaimNumber">cupsJWTSetClaimNumber</a></li> |
| | 489 | <li><a href="#cupsJWTSetClaimString">cupsJWTSetClaimString</a></li> |
| | 490 | <li><a href="#cupsJWTSetClaimValue">cupsJWTSetClaimValue</a></li> |
| | 491 | <li><a href="#cupsJWTSetHeaderNumber">cupsJWTSetHeaderNumber</a></li> |
| | 492 | <li><a href="#cupsJWTSetHeaderString">cupsJWTSetHeaderString</a></li> |
| | 493 | <li><a href="#cupsJWTSetHeaderValue">cupsJWTSetHeaderValue</a></li> |
| | 494 | <li><a href="#cupsJWTSign">cupsJWTSign</a></li> |
| | 495 | <li><a href="#cupsLangDefault">cupsLangDefault</a></li> |
| | 496 | <li><a href="#cupsLangEncoding">cupsLangEncoding</a></li> |
| | 497 | <li><a href="#cupsLangFlush">cupsLangFlush</a></li> |
| | 498 | <li><a href="#cupsLangFree">cupsLangFree</a></li> |
| | 499 | <li><a href="#cupsLangGet">cupsLangGet</a></li> |
| | 500 | <li><a href="#cupsLastError">cupsLastError</a></li> |
| | 501 | <li><a href="#cupsLastErrorString">cupsLastErrorString</a></li> |
| | 502 | <li><a href="#cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></li> |
| | 503 | <li><a href="#cupsLocalizeDestMedia2">cupsLocalizeDestMedia2</a></li> |
| | 504 | <li><a href="#cupsLocalizeDestOption">cupsLocalizeDestOption</a></li> |
| | 505 | <li><a href="#cupsLocalizeDestValue">cupsLocalizeDestValue</a></li> |
| | 506 | <li><a href="#cupsMutexDestroy">cupsMutexDestroy</a></li> |
| | 507 | <li><a href="#cupsMutexInit">cupsMutexInit</a></li> |
| | 508 | <li><a href="#cupsMutexLock">cupsMutexLock</a></li> |
| | 509 | <li><a href="#cupsMutexUnlock">cupsMutexUnlock</a></li> |
| | 510 | <li><a href="#cupsNotifySubject">cupsNotifySubject</a></li> |
| | 511 | <li><a href="#cupsNotifyText">cupsNotifyText</a></li> |
| | 512 | <li><a href="#cupsOAuthClearTokens">cupsOAuthClearTokens</a></li> |
| | 513 | <li><a href="#cupsOAuthCopyAccessToken">cupsOAuthCopyAccessToken</a></li> |
| | 514 | <li><a href="#cupsOAuthCopyClientId">cupsOAuthCopyClientId</a></li> |
| | 515 | <li><a href="#cupsOAuthCopyRefreshToken">cupsOAuthCopyRefreshToken</a></li> |
| | 516 | <li><a href="#cupsOAuthCopyUserId">cupsOAuthCopyUserId</a></li> |
| | 517 | <li><a href="#cupsOAuthGetAuthorizationCode">cupsOAuthGetAuthorizationCode</a></li> |
| | 518 | <li><a href="#cupsOAuthGetClientId">cupsOAuthGetClientId</a></li> |
| | 519 | <li><a href="#cupsOAuthGetJWKS">cupsOAuthGetJWKS</a></li> |
| | 520 | <li><a href="#cupsOAuthGetMetadata">cupsOAuthGetMetadata</a></li> |
| | 521 | <li><a href="#cupsOAuthGetTokens">cupsOAuthGetTokens</a></li> |
| | 522 | <li><a href="#cupsOAuthGetUserId">cupsOAuthGetUserId</a></li> |
| | 523 | <li><a href="#cupsOAuthMakeAuthorizationURL">cupsOAuthMakeAuthorizationURL</a></li> |
| | 524 | <li><a href="#cupsOAuthMakeBase64Random">cupsOAuthMakeBase64Random</a></li> |
| | 525 | <li><a href="#cupsOAuthSaveClientData">cupsOAuthSaveClientData</a></li> |
| | 526 | <li><a href="#cupsOAuthSaveTokens">cupsOAuthSaveTokens</a></li> |
| | 527 | <li><a href="#cupsParseOptions">cupsParseOptions</a></li> |
| | 528 | <li><a href="#cupsParseOptions2">cupsParseOptions2</a></li> |
| | 529 | <li><a href="#cupsPutFd">cupsPutFd</a></li> |
| | 530 | <li><a href="#cupsPutFile">cupsPutFile</a></li> |
| | 531 | <li><a href="#cupsRWDestroy">cupsRWDestroy</a></li> |
| | 532 | <li><a href="#cupsRWInit">cupsRWInit</a></li> |
| | 533 | <li><a href="#cupsRWLockRead">cupsRWLockRead</a></li> |
| | 534 | <li><a href="#cupsRWLockWrite">cupsRWLockWrite</a></li> |
| | 535 | <li><a href="#cupsRWUnlock">cupsRWUnlock</a></li> |
| | 536 | <li><a href="#cupsRasterClose">cupsRasterClose</a></li> |
| | 537 | <li><a href="#cupsRasterGetErrorString">cupsRasterGetErrorString</a></li> |
| | 538 | <li><a href="#cupsRasterInitHeader">cupsRasterInitHeader</a></li> |
| | 539 | <li><a href="#cupsRasterOpen">cupsRasterOpen</a></li> |
| | 540 | <li><a href="#cupsRasterOpenIO">cupsRasterOpenIO</a></li> |
| | 541 | <li><a href="#cupsRasterReadHeader">cupsRasterReadHeader</a></li> |
| | 542 | <li><a href="#cupsRasterReadHeader2">cupsRasterReadHeader2</a></li> |
| | 543 | <li><a href="#cupsRasterReadPixels">cupsRasterReadPixels</a></li> |
| | 544 | <li><a href="#cupsRasterWriteHeader">cupsRasterWriteHeader</a></li> |
| | 545 | <li><a href="#cupsRasterWriteHeader2">cupsRasterWriteHeader2</a></li> |
| | 546 | <li><a href="#cupsRasterWritePixels">cupsRasterWritePixels</a></li> |
| | 547 | <li><a href="#cupsReadResponseData">cupsReadResponseData</a></li> |
| | 548 | <li><a href="#cupsRemoveDest">cupsRemoveDest</a></li> |
| | 549 | <li><a href="#cupsRemoveOption">cupsRemoveOption</a></li> |
| | 550 | <li><a href="#cupsSaveCredentials">cupsSaveCredentials</a></li> |
| | 551 | <li><a href="#cupsSendRequest">cupsSendRequest</a></li> |
| | 552 | <li><a href="#cupsServer">cupsServer</a></li> |
| | 553 | <li><a href="#cupsSetClientCertCB">cupsSetClientCertCB</a></li> |
| | 554 | <li><a href="#cupsSetClientCredentials">cupsSetClientCredentials</a></li> |
| | 555 | <li><a href="#cupsSetCredentials">cupsSetCredentials</a></li> |
| | 556 | <li><a href="#cupsSetDefaultDest">cupsSetDefaultDest</a></li> |
| | 557 | <li><a href="#cupsSetDests2">cupsSetDests2</a></li> |
| | 558 | <li><a href="#cupsSetEncryption">cupsSetEncryption</a></li> |
| | 559 | <li><a href="#cupsSetOAuthCB">cupsSetOAuthCB</a></li> |
| | 560 | <li><a href="#cupsSetPasswordCB2">cupsSetPasswordCB2</a></li> |
| | 561 | <li><a href="#cupsSetServer">cupsSetServer</a></li> |
| | 562 | <li><a href="#cupsSetServerCertCB">cupsSetServerCertCB</a></li> |
| | 563 | <li><a href="#cupsSetServerCredentials">cupsSetServerCredentials</a></li> |
| | 564 | <li><a href="#cupsSetUser">cupsSetUser</a></li> |
| | 565 | <li><a href="#cupsSetUserAgent">cupsSetUserAgent</a></li> |
| | 566 | <li><a href="#cupsSignCredentialsRequest">cupsSignCredentialsRequest</a></li> |
| | 567 | <li><a href="#cupsStartDestDocument">cupsStartDestDocument</a></li> |
| | 568 | <li><a href="#cupsTempFd">cupsTempFd</a></li> |
| | 569 | <li><a href="#cupsTempFile">cupsTempFile</a></li> |
| | 570 | <li><a href="#cupsTempFile2">cupsTempFile2</a></li> |
| | 571 | <li><a href="#cupsThreadCancel">cupsThreadCancel</a></li> |
| | 572 | <li><a href="#cupsThreadCreate">cupsThreadCreate</a></li> |
| | 573 | <li><a href="#cupsThreadDetach">cupsThreadDetach</a></li> |
| | 574 | <li><a href="#cupsThreadWait">cupsThreadWait</a></li> |
| | 575 | <li><a href="#cupsUTF32ToUTF8">cupsUTF32ToUTF8</a></li> |
| | 576 | <li><a href="#cupsUTF8ToCharset">cupsUTF8ToCharset</a></li> |
| | 577 | <li><a href="#cupsUTF8ToUTF32">cupsUTF8ToUTF32</a></li> |
| | 578 | <li><a href="#cupsUser">cupsUser</a></li> |
| | 579 | <li><a href="#cupsUserAgent">cupsUserAgent</a></li> |
| | 580 | <li><a href="#cupsWriteRequestData">cupsWriteRequestData</a></li> |
| | 581 | <li><a href="#httpAcceptConnection">httpAcceptConnection</a></li> |
| | 582 | <li><a href="#httpAddrClose">httpAddrClose</a></li> |
| | 583 | <li><a href="#httpAddrConnect2">httpAddrConnect2</a></li> |
| | 584 | <li><a href="#httpAddrCopyList">httpAddrCopyList</a></li> |
| | 585 | <li><a href="#httpAddrFreeList">httpAddrFreeList</a></li> |
| | 586 | <li><a href="#httpAddrGetFamily">httpAddrGetFamily</a></li> |
| | 587 | <li><a href="#httpAddrGetLength">httpAddrGetLength</a></li> |
| | 588 | <li><a href="#httpAddrGetList">httpAddrGetList</a></li> |
| | 589 | <li><a href="#httpAddrGetPort">httpAddrGetPort</a></li> |
| | 590 | <li><a href="#httpAddrGetString">httpAddrGetString</a></li> |
| | 591 | <li><a href="#httpAddrIsAny">httpAddrIsAny</a></li> |
| | 592 | <li><a href="#httpAddrIsEqual">httpAddrIsEqual</a></li> |
| | 593 | <li><a href="#httpAddrIsLocalhost">httpAddrIsLocalhost</a></li> |
| | 594 | <li><a href="#httpAddrListen">httpAddrListen</a></li> |
| | 595 | <li><a href="#httpAddrLookup">httpAddrLookup</a></li> |
| | 596 | <li><a href="#httpAddrSetPort">httpAddrSetPort</a></li> |
| | 597 | <li><a href="#httpAssembleURI">httpAssembleURI</a></li> |
| | 598 | <li><a href="#httpAssembleURIf">httpAssembleURIf</a></li> |
| | 599 | <li><a href="#httpAssembleUUID">httpAssembleUUID</a></li> |
| | 600 | <li><a href="#httpBlocking">httpBlocking</a></li> |
| | 601 | <li><a href="#httpCheck">httpCheck</a></li> |
| | 602 | <li><a href="#httpClearCookie">httpClearCookie</a></li> |
| | 603 | <li><a href="#httpClearFields">httpClearFields</a></li> |
| | 604 | <li><a href="#httpClose">httpClose</a></li> |
| | 605 | <li><a href="#httpConnect2">httpConnect2</a></li> |
| | 606 | <li><a href="#httpConnectAgain">httpConnectAgain</a></li> |
| | 607 | <li><a href="#httpConnectURI">httpConnectURI</a></li> |
| | 608 | <li><a href="#httpCopyPeerCredentials">httpCopyPeerCredentials</a></li> |
| | 609 | <li><a href="#httpDecode64_3">httpDecode64_3</a></li> |
| | 610 | <li><a href="#httpEncode64_3">httpEncode64_3</a></li> |
| | 611 | <li><a href="#httpFieldValue">httpFieldValue</a></li> |
| | 612 | <li><a href="#httpFlush">httpFlush</a></li> |
| | 613 | <li><a href="#httpFlushWrite">httpFlushWrite</a></li> |
| | 614 | <li><a href="#httpGetActivity">httpGetActivity</a></li> |
| | 615 | <li><a href="#httpGetAddress">httpGetAddress</a></li> |
| | 616 | <li><a href="#httpGetAuthString">httpGetAuthString</a></li> |
| | 617 | <li><a href="#httpGetBlocking">httpGetBlocking</a></li> |
| | 618 | <li><a href="#httpGetContentEncoding">httpGetContentEncoding</a></li> |
| | 619 | <li><a href="#httpGetCookie">httpGetCookie</a></li> |
| | 620 | <li><a href="#httpGetCookieValue">httpGetCookieValue</a></li> |
| | 621 | <li><a href="#httpGetDateString2">httpGetDateString2</a></li> |
| | 622 | <li><a href="#httpGetDateTime">httpGetDateTime</a></li> |
| | 623 | <li><a href="#httpGetEncryption">httpGetEncryption</a></li> |
| | 624 | <li><a href="#httpGetError">httpGetError</a></li> |
| | 625 | <li><a href="#httpGetExpect">httpGetExpect</a></li> |
| | 626 | <li><a href="#httpGetFd">httpGetFd</a></li> |
| | 627 | <li><a href="#httpGetField">httpGetField</a></li> |
| | 628 | <li><a href="#httpGetHostname">httpGetHostname</a></li> |
| | 629 | <li><a href="#httpGetKeepAlive">httpGetKeepAlive</a></li> |
| | 630 | <li><a href="#httpGetLength2">httpGetLength2</a></li> |
| | 631 | <li><a href="#httpGetPending">httpGetPending</a></li> |
| | 632 | <li><a href="#httpGetReady">httpGetReady</a></li> |
| | 633 | <li><a href="#httpGetRemaining">httpGetRemaining</a></li> |
| | 634 | <li><a href="#httpGetSecurity">httpGetSecurity</a></li> |
| | 635 | <li><a href="#httpGetState">httpGetState</a></li> |
| | 636 | <li><a href="#httpGetStatus">httpGetStatus</a></li> |
| | 637 | <li><a href="#httpGetSubField2">httpGetSubField2</a></li> |
| | 638 | <li><a href="#httpGetVersion">httpGetVersion</a></li> |
| | 639 | <li><a href="#httpGets2">httpGets2</a></li> |
| | 640 | <li><a href="#httpInitialize">httpInitialize</a></li> |
| | 641 | <li><a href="#httpIsChunked">httpIsChunked</a></li> |
| | 642 | <li><a href="#httpIsEncrypted">httpIsEncrypted</a></li> |
| | 643 | <li><a href="#httpMD5">httpMD5</a></li> |
| | 644 | <li><a href="#httpMD5Final">httpMD5Final</a></li> |
| | 645 | <li><a href="#httpMD5String">httpMD5String</a></li> |
| | 646 | <li><a href="#httpPeek">httpPeek</a></li> |
| | 647 | <li><a href="#httpRead2">httpRead2</a></li> |
| | 648 | <li><a href="#httpReadRequest">httpReadRequest</a></li> |
| | 649 | <li><a href="#httpResolveHostname">httpResolveHostname</a></li> |
| | 650 | <li><a href="#httpResolveURI">httpResolveURI</a></li> |
| | 651 | <li><a href="#httpSeparateURI">httpSeparateURI</a></li> |
| | 652 | <li><a href="#httpSetAuthString">httpSetAuthString</a></li> |
| | 653 | <li><a href="#httpSetBlocking">httpSetBlocking</a></li> |
| | 654 | <li><a href="#httpSetCookie">httpSetCookie</a></li> |
| | 655 | <li><a href="#httpSetDefaultField">httpSetDefaultField</a></li> |
| | 656 | <li><a href="#httpSetEncryption">httpSetEncryption</a></li> |
| | 657 | <li><a href="#httpSetExpect">httpSetExpect</a></li> |
| | 658 | <li><a href="#httpSetField">httpSetField</a></li> |
| | 659 | <li><a href="#httpSetKeepAlive">httpSetKeepAlive</a></li> |
| | 660 | <li><a href="#httpSetLength">httpSetLength</a></li> |
| | 661 | <li><a href="#httpSetTimeout">httpSetTimeout</a></li> |
| | 662 | <li><a href="#httpShutdown">httpShutdown</a></li> |
| | 663 | <li><a href="#httpStateString">httpStateString</a></li> |
| | 664 | <li><a href="#httpStatusString">httpStatusString</a></li> |
| | 665 | <li><a href="#httpURIStatusString">httpURIStatusString</a></li> |
| | 666 | <li><a href="#httpUpdate">httpUpdate</a></li> |
| | 667 | <li><a href="#httpWait">httpWait</a></li> |
| | 668 | <li><a href="#httpWrite2">httpWrite2</a></li> |
| | 669 | <li><a href="#httpWriteRequest">httpWriteRequest</a></li> |
| | 670 | <li><a href="#httpWriteResponse">httpWriteResponse</a></li> |
| | 671 | <li><a href="#ippAddBoolean">ippAddBoolean</a></li> |
| | 672 | <li><a href="#ippAddBooleans">ippAddBooleans</a></li> |
| | 673 | <li><a href="#ippAddCollection">ippAddCollection</a></li> |
| | 674 | <li><a href="#ippAddCollections">ippAddCollections</a></li> |
| | 675 | <li><a href="#ippAddCredentialsString">ippAddCredentialsString</a></li> |
| | 676 | <li><a href="#ippAddDate">ippAddDate</a></li> |
| | 677 | <li><a href="#ippAddInteger">ippAddInteger</a></li> |
| | 678 | <li><a href="#ippAddIntegers">ippAddIntegers</a></li> |
| | 679 | <li><a href="#ippAddOctetString">ippAddOctetString</a></li> |
| | 680 | <li><a href="#ippAddOutOfBand">ippAddOutOfBand</a></li> |
| | 681 | <li><a href="#ippAddRange">ippAddRange</a></li> |
| | 682 | <li><a href="#ippAddRanges">ippAddRanges</a></li> |
| | 683 | <li><a href="#ippAddResolution">ippAddResolution</a></li> |
| | 684 | <li><a href="#ippAddResolutions">ippAddResolutions</a></li> |
| | 685 | <li><a href="#ippAddSeparator">ippAddSeparator</a></li> |
| | 686 | <li><a href="#ippAddString">ippAddString</a></li> |
| | 687 | <li><a href="#ippAddStringf">ippAddStringf</a></li> |
| | 688 | <li><a href="#ippAddStringfv">ippAddStringfv</a></li> |
| | 689 | <li><a href="#ippAddStrings">ippAddStrings</a></li> |
| | 690 | <li><a href="#ippAttributeString">ippAttributeString</a></li> |
| | 691 | <li><a href="#ippContainsInteger">ippContainsInteger</a></li> |
| | 692 | <li><a href="#ippContainsString">ippContainsString</a></li> |
| | 693 | <li><a href="#ippCopyAttribute">ippCopyAttribute</a></li> |
| | 694 | <li><a href="#ippCopyAttributes">ippCopyAttributes</a></li> |
| | 695 | <li><a href="#ippCopyCredentialsString">ippCopyCredentialsString</a></li> |
| | 696 | <li><a href="#ippCreateRequestedArray">ippCreateRequestedArray</a></li> |
| | 697 | <li><a href="#ippDateToTime">ippDateToTime</a></li> |
| | 698 | <li><a href="#ippDelete">ippDelete</a></li> |
| | 699 | <li><a href="#ippDeleteAttribute">ippDeleteAttribute</a></li> |
| | 700 | <li><a href="#ippDeleteValues">ippDeleteValues</a></li> |
| | 701 | <li><a href="#ippEnumString">ippEnumString</a></li> |
| | 702 | <li><a href="#ippEnumValue">ippEnumValue</a></li> |
| | 703 | <li><a href="#ippErrorString">ippErrorString</a></li> |
| | 704 | <li><a href="#ippErrorValue">ippErrorValue</a></li> |
| | 705 | <li><a href="#ippFileClose">ippFileClose</a></li> |
| | 706 | <li><a href="#ippFileDelete">ippFileDelete</a></li> |
| | 707 | <li><a href="#ippFileExpandVars">ippFileExpandVars</a></li> |
| | 708 | <li><a href="#ippFileGetAttribute">ippFileGetAttribute</a></li> |
| | 709 | <li><a href="#ippFileGetAttributes">ippFileGetAttributes</a></li> |
| | 710 | <li><a href="#ippFileGetFilename">ippFileGetFilename</a></li> |
| | 711 | <li><a href="#ippFileGetLineNumber">ippFileGetLineNumber</a></li> |
| | 712 | <li><a href="#ippFileGetVar">ippFileGetVar</a></li> |
| | 713 | <li><a href="#ippFileNew">ippFileNew</a></li> |
| | 714 | <li><a href="#ippFileOpen">ippFileOpen</a></li> |
| | 715 | <li><a href="#ippFileRead">ippFileRead</a></li> |
| | 716 | <li><a href="#ippFileReadCollection">ippFileReadCollection</a></li> |
| | 717 | <li><a href="#ippFileReadToken">ippFileReadToken</a></li> |
| | 718 | <li><a href="#ippFileRestorePosition">ippFileRestorePosition</a></li> |
| | 719 | <li><a href="#ippFileSavePosition">ippFileSavePosition</a></li> |
| | 720 | <li><a href="#ippFileSetAttributes">ippFileSetAttributes</a></li> |
| | 721 | <li><a href="#ippFileSetGroupTag">ippFileSetGroupTag</a></li> |
| | 722 | <li><a href="#ippFileSetVar">ippFileSetVar</a></li> |
| | 723 | <li><a href="#ippFileSetVarf">ippFileSetVarf</a></li> |
| | 724 | <li><a href="#ippFileWriteAttributes">ippFileWriteAttributes</a></li> |
| | 725 | <li><a href="#ippFileWriteComment">ippFileWriteComment</a></li> |
| | 726 | <li><a href="#ippFileWriteToken">ippFileWriteToken</a></li> |
| | 727 | <li><a href="#ippFileWriteTokenf">ippFileWriteTokenf</a></li> |
| | 728 | <li><a href="#ippFindAttribute">ippFindAttribute</a></li> |
| | 729 | <li><a href="#ippFindNextAttribute">ippFindNextAttribute</a></li> |
| | 730 | <li><a href="#ippGetBoolean">ippGetBoolean</a></li> |
| | 731 | <li><a href="#ippGetCollection">ippGetCollection</a></li> |
| | 732 | <li><a href="#ippGetCount">ippGetCount</a></li> |
| | 733 | <li><a href="#ippGetDate">ippGetDate</a></li> |
| | 734 | <li><a href="#ippGetFirstAttribute">ippGetFirstAttribute</a></li> |
| | 735 | <li><a href="#ippGetGroupTag">ippGetGroupTag</a></li> |
| | 736 | <li><a href="#ippGetInteger">ippGetInteger</a></li> |
| | 737 | <li><a href="#ippGetLength">ippGetLength</a></li> |
| | 738 | <li><a href="#ippGetName">ippGetName</a></li> |
| | 739 | <li><a href="#ippGetNextAttribute">ippGetNextAttribute</a></li> |
| | 740 | <li><a href="#ippGetOctetString">ippGetOctetString</a></li> |
| | 741 | <li><a href="#ippGetOperation">ippGetOperation</a></li> |
| | 742 | <li><a href="#ippGetPort">ippGetPort</a></li> |
| | 743 | <li><a href="#ippGetRange">ippGetRange</a></li> |
| | 744 | <li><a href="#ippGetRequestId">ippGetRequestId</a></li> |
| | 745 | <li><a href="#ippGetResolution">ippGetResolution</a></li> |
| | 746 | <li><a href="#ippGetState">ippGetState</a></li> |
| | 747 | <li><a href="#ippGetStatusCode">ippGetStatusCode</a></li> |
| | 748 | <li><a href="#ippGetString">ippGetString</a></li> |
| | 749 | <li><a href="#ippGetValueTag">ippGetValueTag</a></li> |
| | 750 | <li><a href="#ippGetVersion">ippGetVersion</a></li> |
| | 751 | <li><a href="#ippNew">ippNew</a></li> |
| | 752 | <li><a href="#ippNewRequest">ippNewRequest</a></li> |
| | 753 | <li><a href="#ippNewResponse">ippNewResponse</a></li> |
| | 754 | <li><a href="#ippOpString">ippOpString</a></li> |
| | 755 | <li><a href="#ippOpValue">ippOpValue</a></li> |
| | 756 | <li><a href="#ippRead">ippRead</a></li> |
| | 757 | <li><a href="#ippReadFile">ippReadFile</a></li> |
| | 758 | <li><a href="#ippReadIO">ippReadIO</a></li> |
| | 759 | <li><a href="#ippRestore">ippRestore</a></li> |
| | 760 | <li><a href="#ippSave">ippSave</a></li> |
| | 761 | <li><a href="#ippSetBoolean">ippSetBoolean</a></li> |
| | 762 | <li><a href="#ippSetCollection">ippSetCollection</a></li> |
| | 763 | <li><a href="#ippSetDate">ippSetDate</a></li> |
| | 764 | <li><a href="#ippSetGroupTag">ippSetGroupTag</a></li> |
| | 765 | <li><a href="#ippSetInteger">ippSetInteger</a></li> |
| | 766 | <li><a href="#ippSetName">ippSetName</a></li> |
| | 767 | <li><a href="#ippSetOctetString">ippSetOctetString</a></li> |
| | 768 | <li><a href="#ippSetOperation">ippSetOperation</a></li> |
| | 769 | <li><a href="#ippSetPort">ippSetPort</a></li> |
| | 770 | <li><a href="#ippSetRange">ippSetRange</a></li> |
| | 771 | <li><a href="#ippSetRequestId">ippSetRequestId</a></li> |
| | 772 | <li><a href="#ippSetResolution">ippSetResolution</a></li> |
| | 773 | <li><a href="#ippSetState">ippSetState</a></li> |
| | 774 | <li><a href="#ippSetStatusCode">ippSetStatusCode</a></li> |
| | 775 | <li><a href="#ippSetString">ippSetString</a></li> |
| | 776 | <li><a href="#ippSetStringf">ippSetStringf</a></li> |
| | 777 | <li><a href="#ippSetStringfv">ippSetStringfv</a></li> |
| | 778 | <li><a href="#ippSetValueTag">ippSetValueTag</a></li> |
| | 779 | <li><a href="#ippSetVersion">ippSetVersion</a></li> |
| | 780 | <li><a href="#ippStateString">ippStateString</a></li> |
| | 781 | <li><a href="#ippTagString">ippTagString</a></li> |
| | 782 | <li><a href="#ippTagValue">ippTagValue</a></li> |
| | 783 | <li><a href="#ippTimeToDate">ippTimeToDate</a></li> |
| | 784 | <li><a href="#ippValidateAttribute">ippValidateAttribute</a></li> |
| | 785 | <li><a href="#ippValidateAttributes">ippValidateAttributes</a></li> |
| | 786 | <li><a href="#ippWrite">ippWrite</a></li> |
| | 787 | <li><a href="#ippWriteFile">ippWriteFile</a></li> |
| | 788 | <li><a href="#ippWriteIO">ippWriteIO</a></li> |
| | 789 | <li><a href="#pwgFormatSizeName">pwgFormatSizeName</a></li> |
| | 790 | <li><a href="#pwgInitSize">pwgInitSize</a></li> |
| | 791 | <li><a href="#pwgMediaForLegacy">pwgMediaForLegacy</a></li> |
| | 792 | <li><a href="#pwgMediaForPPD">pwgMediaForPPD</a></li> |
| | 793 | <li><a href="#pwgMediaForPWG">pwgMediaForPWG</a></li> |
| | 794 | <li><a href="#pwgMediaForSize">pwgMediaForSize</a></li> |
| | 795 | </ul></li> |
| | 796 | <li><a href="#TYPES">Data Types</a><ul class="subcontents"> |
| | 797 | <li><a href="#cups_acopy_cb_t">cups_acopy_cb_t</a></li> |
| | 798 | <li><a href="#cups_adv_t">cups_adv_t</a></li> |
| | 799 | <li><a href="#cups_afree_cb_t">cups_afree_cb_t</a></li> |
| | 800 | <li><a href="#cups_ahash_cb_t">cups_ahash_cb_t</a></li> |
| | 801 | <li><a href="#cups_array_cb_t">cups_array_cb_t</a></li> |
| | 802 | <li><a href="#cups_array_t">cups_array_t</a></li> |
| | 803 | <li><a href="#cups_bool_t">cups_bool_t</a></li> |
| | 804 | <li><a href="#cups_cert_san_cb_t">cups_cert_san_cb_t</a></li> |
| | 805 | <li><a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a></li> |
| | 806 | <li><a href="#cups_cond_t">cups_cond_t</a></li> |
| | 807 | <li><a href="#cups_credpurpose_t">cups_credpurpose_t</a></li> |
| | 808 | <li><a href="#cups_credtype_t">cups_credtype_t</a></li> |
| | 809 | <li><a href="#cups_credusage_t">cups_credusage_t</a></li> |
| | 810 | <li><a href="#cups_cspace_t">cups_cspace_t</a></li> |
| | 811 | <li><a href="#cups_cut_t">cups_cut_t</a></li> |
| | 812 | <li><a href="#cups_dbcs_t">cups_dbcs_t</a></li> |
| | 813 | <li><a href="#cups_dentry_t">cups_dentry_t</a></li> |
| | 814 | <li><a href="#cups_dest_cb_t">cups_dest_cb_t</a></li> |
| | 815 | <li><a href="#cups_dest_flags_t">cups_dest_flags_t</a></li> |
| | 816 | <li><a href="#cups_dest_t">cups_dest_t</a></li> |
| | 817 | <li><a href="#cups_dinfo_t">cups_dinfo_t</a></li> |
| | 818 | <li><a href="#cups_dir_t">cups_dir_t</a></li> |
| | 819 | <li><a href="#cups_dnssd_browse_cb_t">cups_dnssd_browse_cb_t</a></li> |
| | 820 | <li><a href="#cups_dnssd_error_cb_t">cups_dnssd_error_cb_t</a></li> |
| | 821 | <li><a href="#cups_dnssd_flags_t">cups_dnssd_flags_t</a></li> |
| | 822 | <li><a href="#cups_dnssd_query_cb_t">cups_dnssd_query_cb_t</a></li> |
| | 823 | <li><a href="#cups_dnssd_query_t">cups_dnssd_query_t</a></li> |
| | 824 | <li><a href="#cups_dnssd_resolve_cb_t">cups_dnssd_resolve_cb_t</a></li> |
| | 825 | <li><a href="#cups_dnssd_resolve_t">cups_dnssd_resolve_t</a></li> |
| | 826 | <li><a href="#cups_dnssd_browse_t">cups_dnssd_browse_t</a></li> |
| | 827 | <li><a href="#cups_dnssd_service_cb_t">cups_dnssd_service_cb_t</a></li> |
| | 828 | <li><a href="#cups_dnssd_service_t">cups_dnssd_service_t</a></li> |
| | 829 | <li><a href="#cups_dnssd_t">cups_dnssd_t</a></li> |
| | 830 | <li><a href="#cups_edge_t">cups_edge_t</a></li> |
| | 831 | <li><a href="#cups_file_t">cups_file_t</a></li> |
| | 832 | <li><a href="#cups_job_t">cups_job_t</a></li> |
| | 833 | <li><a href="#cups_jog_t">cups_jog_t</a></li> |
| | 834 | <li><a href="#cups_json_t">cups_json_t</a></li> |
| | 835 | <li><a href="#cups_jtype_t">cups_jtype_t</a></li> |
| | 836 | <li><a href="#cups_jwa_t">cups_jwa_t</a></li> |
| | 837 | <li><a href="#cups_jws_format_t">cups_jws_format_t</a></li> |
| | 838 | <li><a href="#cups_jwt_t">cups_jwt_t</a></li> |
| | 839 | <li><a href="#cups_lang_t">cups_lang_t</a></li> |
| | 840 | <li><a href="#cups_media_flags_t">cups_media_flags_t</a></li> |
| | 841 | <li><a href="#cups_media_t">cups_media_t</a></li> |
| | 842 | <li><a href="#cups_mutex_t">cups_mutex_t</a></li> |
| | 843 | <li><a href="#cups_oauth_cb_t">cups_oauth_cb_t</a></li> |
| | 844 | <li><a href="#cups_ogrant_t">cups_ogrant_t</a></li> |
| | 845 | <li><a href="#cups_option_t">cups_option_t</a></li> |
| | 846 | <li><a href="#cups_order_t">cups_order_t</a></li> |
| | 847 | <li><a href="#cups_orient_t">cups_orient_t</a></li> |
| | 848 | <li><a href="#cups_page_header2_t">cups_page_header2_t</a></li> |
| | 849 | <li><a href="#cups_page_header_t">cups_page_header_t</a></li> |
| | 850 | <li><a href="#cups_password_cb2_t">cups_password_cb2_t</a></li> |
| | 851 | <li><a href="#cups_ptype_t">cups_ptype_t</a></li> |
| | 852 | <li><a href="#cups_raster_cb_t">cups_raster_cb_t</a></li> |
| | 853 | <li><a href="#cups_raster_mode_t">cups_raster_mode_t</a></li> |
| | 854 | <li><a href="#cups_raster_t">cups_raster_t</a></li> |
| | 855 | <li><a href="#cups_rwlock_t">cups_rwlock_t</a></li> |
| | 856 | <li><a href="#cups_sbcs_t">cups_sbcs_t</a></li> |
| | 857 | <li><a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a></li> |
| | 858 | <li><a href="#cups_size_t">cups_size_t</a></li> |
| | 859 | <li><a href="#cups_thread_func_t">cups_thread_func_t</a></li> |
| | 860 | <li><a href="#cups_thread_key_t">cups_thread_key_t</a></li> |
| | 861 | <li><a href="#cups_thread_t">cups_thread_t</a></li> |
| | 862 | <li><a href="#cups_ucs2_t">cups_ucs2_t</a></li> |
| | 863 | <li><a href="#cups_ucs4_t">cups_ucs4_t</a></li> |
| | 864 | <li><a href="#cups_utf32_t">cups_utf32_t</a></li> |
| | 865 | <li><a href="#cups_utf8_t">cups_utf8_t</a></li> |
| | 866 | <li><a href="#cups_vbcs_t">cups_vbcs_t</a></li> |
| | 867 | <li><a href="#cups_whichjobs_t">cups_whichjobs_t</a></li> |
| | 868 | <li><a href="#http_addr_t">http_addr_t</a></li> |
| | 869 | <li><a href="#http_encoding_t">http_encoding_t</a></li> |
| | 870 | <li><a href="#http_encryption_t">http_encryption_t</a></li> |
| | 871 | <li><a href="#http_field_t">http_field_t</a></li> |
| | 872 | <li><a href="#http_keepalive_t">http_keepalive_t</a></li> |
| | 873 | <li><a href="#http_resolve_cb_t">http_resolve_cb_t</a></li> |
| | 874 | <li><a href="#http_resolve_t">http_resolve_t</a></li> |
| | 875 | <li><a href="#http_state_t">http_state_t</a></li> |
| | 876 | <li><a href="#http_t">http_t</a></li> |
| | 877 | <li><a href="#http_timeout_cb_t">http_timeout_cb_t</a></li> |
| | 878 | <li><a href="#http_trust_t">http_trust_t</a></li> |
| | 879 | <li><a href="#http_uri_coding_t">http_uri_coding_t</a></li> |
| | 880 | <li><a href="#http_uri_status_t">http_uri_status_t</a></li> |
| | 881 | <li><a href="#ipp_attribute_t">ipp_attribute_t</a></li> |
| | 882 | <li><a href="#ipp_copy_cb_t">ipp_copy_cb_t</a></li> |
| | 883 | <li><a href="#ipp_fattr_cb_t">ipp_fattr_cb_t</a></li> |
| | 884 | <li><a href="#ipp_ferror_cb_t">ipp_ferror_cb_t</a></li> |
| | 885 | <li><a href="#ipp_file_t">ipp_file_t</a></li> |
| | 886 | <li><a href="#ipp_ftoken_cb_t">ipp_ftoken_cb_t</a></li> |
| | 887 | <li><a href="#ipp_io_cb_t">ipp_io_cb_t</a></li> |
| | 888 | <li><a href="#ipp_jstate_t">ipp_jstate_t</a></li> |
| | 889 | <li><a href="#ipp_op_t">ipp_op_t</a></li> |
| | 890 | <li><a href="#ipp_orient_t">ipp_orient_t</a></li> |
| | 891 | <li><a href="#ipp_pstate_t">ipp_pstate_t</a></li> |
| | 892 | <li><a href="#ipp_quality_t">ipp_quality_t</a></li> |
| | 893 | <li><a href="#ipp_res_t">ipp_res_t</a></li> |
| | 894 | <li><a href="#ipp_rstate_t">ipp_rstate_t</a></li> |
| | 895 | <li><a href="#ipp_sstate_t">ipp_sstate_t</a></li> |
| | 896 | <li><a href="#ipp_state_t">ipp_state_t</a></li> |
| | 897 | <li><a href="#ipp_t">ipp_t</a></li> |
| | 898 | <li><a href="#pwg_media_t">pwg_media_t</a></li> |
| | 899 | </ul></li> |
| | 900 | <li><a href="#STRUCTURES">Structures</a><ul class="subcontents"> |
| | 901 | <li><a href="#cups_dentry_s">cups_dentry_s</a></li> |
| | 902 | <li><a href="#cups_dest_s">cups_dest_s</a></li> |
| | 903 | <li><a href="#cups_job_s">cups_job_s</a></li> |
| | 904 | <li><a href="#cups_lang_s">cups_lang_s</a></li> |
| | 905 | <li><a href="#cups_media_s">cups_media_s</a></li> |
| | 906 | <li><a href="#cups_option_s">cups_option_s</a></li> |
| | 907 | <li><a href="#cups_page_header2_s">cups_page_header2_s</a></li> |
| | 908 | <li><a href="#cups_page_header_s">cups_page_header_s</a></li> |
| | 909 | <li><a href="#cups_size_s">cups_size_s</a></li> |
| | 910 | <li><a href="#pwg_media_s">pwg_media_s</a></li> |
| | 911 | </ul></li> |
| | 912 | <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> |
| | 913 | <li><a href="#cups_adv_e">cups_adv_e</a></li> |
| | 914 | <li><a href="#cups_bool_e">cups_bool_e</a></li> |
| | 915 | <li><a href="#cups_credpurpose_e">cups_credpurpose_e</a></li> |
| | 916 | <li><a href="#cups_credtype_e">cups_credtype_e</a></li> |
| | 917 | <li><a href="#cups_credusage_e">cups_credusage_e</a></li> |
| | 918 | <li><a href="#cups_cspace_e">cups_cspace_e</a></li> |
| | 919 | <li><a href="#cups_cut_e">cups_cut_e</a></li> |
| | 920 | <li><a href="#cups_dest_flags_e">cups_dest_flags_e</a></li> |
| | 921 | <li><a href="#cups_dnssd_flags_e">cups_dnssd_flags_e</a></li> |
| | 922 | <li><a href="#cups_dnssd_rrtype_e">cups_dnssd_rrtype_e</a></li> |
| | 923 | <li><a href="#cups_edge_e">cups_edge_e</a></li> |
| | 924 | <li><a href="#cups_jog_e">cups_jog_e</a></li> |
| | 925 | <li><a href="#cups_jtype_e">cups_jtype_e</a></li> |
| | 926 | <li><a href="#cups_jwa_e">cups_jwa_e</a></li> |
| | 927 | <li><a href="#cups_jws_format_e">cups_jws_format_e</a></li> |
| | 928 | <li><a href="#cups_media_flags_e">cups_media_flags_e</a></li> |
| | 929 | <li><a href="#cups_ogrant_e">cups_ogrant_e</a></li> |
| | 930 | <li><a href="#cups_order_e">cups_order_e</a></li> |
| | 931 | <li><a href="#cups_orient_e">cups_orient_e</a></li> |
| | 932 | <li><a href="#cups_ptype_e">cups_ptype_e</a></li> |
| | 933 | <li><a href="#cups_raster_mode_e">cups_raster_mode_e</a></li> |
| | 934 | <li><a href="#cups_whichjobs_e">cups_whichjobs_e</a></li> |
| | 935 | <li><a href="#http_encoding_e">http_encoding_e</a></li> |
| | 936 | <li><a href="#http_encryption_e">http_encryption_e</a></li> |
| | 937 | <li><a href="#http_field_e">http_field_e</a></li> |
| | 938 | <li><a href="#http_keepalive_e">http_keepalive_e</a></li> |
| | 939 | <li><a href="#http_resolve_e">http_resolve_e</a></li> |
| | 940 | <li><a href="#http_state_e">http_state_e</a></li> |
| | 941 | <li><a href="#http_status_e">http_status_e</a></li> |
| | 942 | <li><a href="#http_trust_e">http_trust_e</a></li> |
| | 943 | <li><a href="#http_uri_coding_e">http_uri_coding_e</a></li> |
| | 944 | <li><a href="#http_uri_status_e">http_uri_status_e</a></li> |
| | 945 | <li><a href="#ipp_finishings_e">ipp_finishings_e</a></li> |
| | 946 | <li><a href="#ipp_jstate_e">ipp_jstate_e</a></li> |
| | 947 | <li><a href="#ipp_op_e">ipp_op_e</a></li> |
| | 948 | <li><a href="#ipp_orient_e">ipp_orient_e</a></li> |
| | 949 | <li><a href="#ipp_pstate_e">ipp_pstate_e</a></li> |
| | 950 | <li><a href="#ipp_quality_e">ipp_quality_e</a></li> |
| | 951 | <li><a href="#ipp_res_e">ipp_res_e</a></li> |
| | 952 | <li><a href="#ipp_rstate_e">ipp_rstate_e</a></li> |
| | 953 | <li><a href="#ipp_sstate_e">ipp_sstate_e</a></li> |
| | 954 | <li><a href="#ipp_state_e">ipp_state_e</a></li> |
| | 955 | <li><a href="#ipp_status_e">ipp_status_e</a></li> |
| | 956 | <li><a href="#ipp_tag_e">ipp_tag_e</a></li> |
| | 957 | </ul></li> |
| | 958 | </ul> |
| | 959 | </div> |
| | 960 | <div class="body"> |
| | 961 | <blockquote> |
| | 962 | <p>Please <a href="https://github.com/openprinting/cups/issues">file issues on GitHub</a> to provide feedback on this document.</p> |
| | 963 | </blockquote> |
| | 964 | <h2 class="title" id="introduction">Introduction</h2> |
| | 965 | <p>CUPS provides the "cups" library to talk to the different parts of CUPS and with Internet Printing Protocol (IPP) printers. The "cups" library functions are accessed by including the <code><cups/cups.h></code> header.</p> |
| | 966 | <p>CUPS is based on the Internet Printing Protocol ("IPP"), which allows clients (applications) to communicate with a server (the scheduler, printers, etc.) to get a list of destinations, send print jobs, and so forth. You identify which server you want to communicate with using a pointer to the opaque structure <code>http_t</code>. The <code>CUPS_HTTP_DEFAULT</code> constant can be used when you want to talk to the CUPS scheduler.</p> |
| | 967 | <h3 class="title" id="guidelines">Guidelines</h3> |
| | 968 | <p>When writing software (other than printer drivers) that uses the "cups" library:</p> |
| | 969 | <ul> |
| | 970 | <li><p>Do not use undocumented or deprecated APIs,</p> |
| | 971 | </li> |
| | 972 | <li><p>Do not rely on pre-configured printers,</p> |
| | 973 | </li> |
| | 974 | <li><p>Do not assume that printers support specific features or formats, and</p> |
| | 975 | </li> |
| | 976 | <li><p>Do not rely on implementation details (PPDs, etc.)</p> |
| | 977 | </li> |
| | 978 | </ul> |
| | 979 | <p>CUPS is designed to insulate users and developers from the implementation details of printers and file formats. The goal is to allow an application to supply a print file in a standard format with the user intent ("print four copies, two-sided on A4 media, and staple each copy") and have the printing system manage the printer communication and format conversion needed.</p> |
| | 980 | <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> |
| | 981 | <blockquote> |
| | 982 | <p><strong>Note:</strong></p> |
| | 983 | <p>CUPS printer drivers necessarily depend on specific file formats and certain implementation details of the CUPS software. Please consult the Postscript and raster printer driver developer documentation on the <a href="https://openprinting.github.io/cups">OpenPrinting CUPS website</a> for more information.</p> |
| | 984 | </blockquote> |
| | 985 | <h3 class="title" id="terms-used-in-this-document">Terms Used in This Document</h3> |
| | 986 | <p>A <em>Destination</em> is a printer or print queue that accepts print jobs. A <em>Print Job</em> is a collection of 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> |
| | 987 | <h3 class="title" id="compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</h3> |
| | 988 | <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> |
| | 989 | <p>The following simple program lists the available destinations:</p> |
| | 990 | <pre><code class="language-c"><span class="directive">#include <stdio.h></span> |
| | 991 | <span class="directive">#include <cups/cups.h></span> |
| | 992 | |
| | 993 | <span class="reserved">int</span> print_dest(<span class="reserved">void</span> *user_data, <span class="reserved">unsigned</span> flags, cups_dest_t *dest) |
| | 994 | { |
| | 995 | <span class="reserved">if</span> (dest->instance) |
| | 996 | printf(<span class="string">"%s/%s\n"</span>, dest->name, dest->instance); |
| | 997 | <span class="reserved">else</span> |
| | 998 | puts(dest->name); |
| | 999 | |
| | 1000 | <span class="reserved">return</span> (<span class="number">1</span>); |
| | 1001 | } |
| | 1002 | |
| | 1003 | <span class="reserved">int</span> main(<span class="reserved">void</span>) |
| | 1004 | { |
| | 1005 | cupsEnumDests(CUPS_DEST_FLAGS_NONE, <span class="number">1000</span>, NULL, <span class="number">0</span>, <span class="number">0</span>, print_dest, NULL); |
| | 1006 | |
| | 1007 | <span class="reserved">return</span> (<span class="number">0</span>); |
| | 1008 | } |
| | 1009 | </code></pre> |
| | 1010 | <h4 id="compiling-with-xcode">Compiling with Xcode</h4> |
| | 1011 | <p>In Xcode, choose <em>New Project...</em> from the <em>File</em> menu (or press SHIFT+CMD+N), then select the <em>Command Line Tool</em> under the macOS Application project type. Click <em>Next</em> and enter a name for the project, for example "firstcups". Click <em>Next</em> and choose a project directory. The click <em>Next</em> to create the project.</p> |
| | 1012 | <p>In the project window, click on the <em>Build Phases</em> group and expand the <em>Link Binary with Libraries</em> section. Click <em>+</em>, type "libcups" to show the library, and then double-click on <code>libcups.tbd</code>.</p> |
| | 1013 | <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> |
| | 1014 | <h4 id="compiling-with-gcc">Compiling with GCC</h4> |
| | 1015 | <p>From the command-line, create a file called <code>simple.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> |
| | 1016 | <pre><code>gcc -o simple `pkg-config --cflags cups` simple.c `pkg-config --libs cups` |
| | 1017 | ./simple |
| | 1018 | </code></pre> |
| | 1019 | <p>The <code>pkg-config</code> command provides the compiler flags (<code>pkg-config --cflags cups</code>) and libraries (<code>pkg-config --libs cups</code>) needed for the local system.</p> |
| | 1020 | <h2 class="title" id="working-with-destinations">Working with Destinations</h2> |
| | 1021 | <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> |
| | 1022 | <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> |
| | 1023 | <h3 class="title" id="finding-available-destinations">Finding Available Destinations</h3> |
| | 1024 | <p>The <a href="#cupsEnumDests"><code>cupsEnumDests</code></a> function finds all of the available destinations:</p> |
| | 1025 | <pre><code class="language-c"><span class="reserved">int</span> |
| | 1026 | cupsEnumDests(<span class="reserved">unsigned</span> flags, <span class="reserved">int</span> msec, <span class="reserved">int</span> *cancel, |
| | 1027 | cups_ptype_t type, cups_ptype_t mask, |
| | 1028 | cups_dest_cb_t cb, <span class="reserved">void</span> *user_data) |
| | 1029 | </code></pre> |
| | 1030 | <p>The <code>flags</code> argument specifies enumeration options, which at present must be <code>CUPS_DEST_FLAGS_NONE</code>.</p> |
| | 1031 | <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> |
| | 1032 | <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> |
| | 1033 | <p>The <code>type</code> and <code>mask</code> arguments are bitfields that allow the caller to filter the destinations based on categories and/or capabilities. The destination's "printer-type" value is masked by the <code>mask</code> value and compared to the <code>type</code> value when filtering. For example, to only enumerate destinations that are hosted on the local system, pass <code>CUPS_PTYPE_LOCAL</code> for the <code>type</code> argument and <code>CUPS_PTYPE_DISCOVERED</code> for the <code>mask</code> argument. The following constants can be used for filtering:</p> |
| | 1034 | <ul> |
| | 1035 | <li><p><code>CUPS_PTYPE_CLASS</code>: A collection of destinations.</p> |
| | 1036 | </li> |
| | 1037 | <li><p><code>CUPS_PTYPE_FAX</code>: A facsimile device.</p> |
| | 1038 | </li> |
| | 1039 | <li><p><code>CUPS_PTYPE_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_PTYPE_REMOTE</code> or <code>CUPS_PTYPE_DISCOVERED</code> constant passed in the <code>mask</code> argument.</p> |
| | 1040 | </li> |
| | 1041 | <li><p><code>CUPS_PTYPE_REMOTE</code>: A remote (shared) printer or class.</p> |
| | 1042 | </li> |
| | 1043 | <li><p><code>CUPS_PTYPE_DISCOVERED</code>: An available network printer or class.</p> |
| | 1044 | </li> |
| | 1045 | <li><p><code>CUPS_PTYPE_BW</code>: Can do B&W printing.</p> |
| | 1046 | </li> |
| | 1047 | <li><p><code>CUPS_PTYPE_COLOR</code>: Can do color printing.</p> |
| | 1048 | </li> |
| | 1049 | <li><p><code>CUPS_PTYPE_DUPLEX</code>: Can do two-sided printing.</p> |
| | 1050 | </li> |
| | 1051 | <li><p><code>CUPS_PTYPE_STAPLE</code>: Can staple output.</p> |
| | 1052 | </li> |
| | 1053 | <li><p><code>CUPS_PTYPE_COLLATE</code>: Can quickly collate copies.</p> |
| | 1054 | </li> |
| | 1055 | <li><p><code>CUPS_PTYPE_PUNCH</code>: Can punch output.</p> |
| | 1056 | </li> |
| | 1057 | <li><p><code>CUPS_PTYPE_COVER</code>: Can cover output.</p> |
| | 1058 | </li> |
| | 1059 | <li><p><code>CUPS_PTYPE_BIND</code>: Can bind output.</p> |
| | 1060 | </li> |
| | 1061 | <li><p><code>CUPS_PTYPE_SORT</code>: Can sort output (mailboxes, etc.)</p> |
| | 1062 | </li> |
| | 1063 | <li><p><code>CUPS_PTYPE_SMALL</code>: Can print on Letter/Legal/A4-size media.</p> |
| | 1064 | </li> |
| | 1065 | <li><p><code>CUPS_PTYPE_MEDIUM</code>: Can print on Tabloid/B/C/A3/A2-size media.</p> |
| | 1066 | </li> |
| | 1067 | <li><p><code>CUPS_PTYPE_LARGE</code>: Can print on D/E/A1/A0-size media.</p> |
| | 1068 | </li> |
| | 1069 | <li><p><code>CUPS_PTYPE_VARIABLE</code>: Can print on rolls and custom-size media.</p> |
| | 1070 | </li> |
| | 1071 | </ul> |
| | 1072 | <p>The <code>cb</code> argument specifies a function to call for every destination that is found:</p> |
| | 1073 | <pre><code class="language-c"><span class="reserved">typedef</span> <span class="reserved">int</span> (*cups_dest_cb_t)(<span class="reserved">void</span> *user_data, |
| | 1074 | <span class="reserved">unsigned</span> flags, |
| | 1075 | cups_dest_t *dest); |
| | 1076 | </code></pre> |
| | 1077 | <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> |
| | 1078 | <ul> |
| | 1079 | <li><p><code>CUPS_DEST_FLAGS_MORE</code>: There are more destinations coming.</p> |
| | 1080 | </li> |
| | 1081 | <li><p><code>CUPS_DEST_FLAGS_REMOVED</code>: The destination has gone away and should be removed from the list of destinations a user can select.</p> |
| | 1082 | </li> |
| | 1083 | <li><p><code>CUPS_DEST_FLAGS_ERROR</code>: An error occurred. The reason for the error can be found by calling the <a href="#cupsGetError"><code>cupsGetError</code></a> and/or <a href="#cupsGetErrorString"><code>cupsGetErrorString</code></a> functions.</p> |
| | 1084 | </li> |
| | 1085 | </ul> |
| | 1086 | <p>The callback function returns <code>0</code> to stop enumeration or <code>1</code> to continue.</p> |
| | 1087 | <blockquote> |
| | 1088 | <p><strong>Note:</strong></p> |
| | 1089 | <p>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> |
| | 1090 | </blockquote> |
| | 1091 | <p>The following example shows how to use <code>cupsEnumDests</code> to get a filtered array of destinations:</p> |
| | 1092 | <pre><code class="language-c"><span class="reserved">typedef</span> <span class="reserved">struct</span> |
| | 1093 | { |
| | 1094 | <span class="reserved">int</span> num_dests; |
| | 1095 | cups_dest_t *dests; |
| | 1096 | } my_user_data_t; |
| | 1097 | |
| | 1098 | <span class="reserved">int</span> |
| | 1099 | my_dest_cb(my_user_data_t *user_data, <span class="reserved">unsigned</span> flags, |
| | 1100 | cups_dest_t *dest) |
| | 1101 | { |
| | 1102 | <span class="reserved">if</span> (flags & CUPS_DEST_FLAGS_REMOVED) |
| | 1103 | { |
| | 1104 | <span class="comment">/*</span> |
| | 1105 | <span class="comment"> * Remove destination from array...</span> |
| | 1106 | <span class="comment"> */</span> |
| | 1107 | |
| | 1108 | user_data->num_dests = |
| | 1109 | cupsRemoveDest(dest->name, dest->instance, |
| | 1110 | user_data->num_dests, |
| | 1111 | &(user_data->dests)); |
| | 1112 | } |
| | 1113 | <span class="reserved">else</span> |
| | 1114 | { |
| | 1115 | <span class="comment">/*</span> |
| | 1116 | <span class="comment"> * Add destination to array...</span> |
| | 1117 | <span class="comment"> */</span> |
| | 1118 | |
| | 1119 | user_data->num_dests = |
| | 1120 | cupsCopyDest(dest, user_data->num_dests, |
| | 1121 | &(user_data->dests)); |
| | 1122 | } |
| | 1123 | |
| | 1124 | <span class="reserved">return</span> (<span class="number">1</span>); |
| | 1125 | } |
| | 1126 | |
| | 1127 | <span class="reserved">int</span> |
| | 1128 | my_get_dests(cups_ptype_t type, cups_ptype_t mask, |
| | 1129 | cups_dest_t **dests) |
| | 1130 | { |
| | 1131 | my_user_data_t user_data = { <span class="number">0</span>, NULL }; |
| | 1132 | |
| | 1133 | <span class="reserved">if</span> (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, <span class="number">1000</span>, NULL, type, |
| | 1134 | mask, (cups_dest_cb_t)my_dest_cb, |
| | 1135 | &user_data)) |
| | 1136 | { |
| | 1137 | <span class="comment">/*</span> |
| | 1138 | <span class="comment"> * An error occurred, free all of the destinations and</span> |
| | 1139 | <span class="comment"> * return...</span> |
| | 1140 | <span class="comment"> */</span> |
| | 1141 | |
| | 1142 | cupsFreeDests(user_data.num_dests, user_data.dests); |
| | 1143 | |
| | 1144 | *dests = NULL; |
| | 1145 | |
| | 1146 | <span class="reserved">return</span> (<span class="number">0</span>); |
| | 1147 | } |
| | 1148 | |
| | 1149 | <span class="comment">/*</span> |
| | 1150 | <span class="comment"> * Return the destination array...</span> |
| | 1151 | <span class="comment"> */</span> |
| | 1152 | |
| | 1153 | *dests = user_data.dests; |
| | 1154 | |
| | 1155 | <span class="reserved">return</span> (user_data.num_dests); |
| | 1156 | } |
| | 1157 | </code></pre> |
| | 1158 | <h3 class="title" id="basic-destination-information">Basic Destination Information</h3> |
| | 1159 | <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> |
| | 1160 | <ul> |
| | 1161 | <li><p>"auth-info-required": The type of authentication required for printing to this destination: "none", "username,password", "domain,username,password", or "negotiate" (Kerberos).</p> |
| | 1162 | </li> |
| | 1163 | <li><p>"printer-info": The human-readable description of the destination such as "My Laser Printer".</p> |
| | 1164 | </li> |
| | 1165 | <li><p>"printer-is-accepting-jobs": "true" if the destination is accepting new jobs, "false" otherwise.</p> |
| | 1166 | </li> |
| | 1167 | <li><p>"printer-is-shared": "true" if the destination is being shared with other computers, "false" otherwise.</p> |
| | 1168 | </li> |
| | 1169 | <li><p>"printer-location": The human-readable location of the destination such as "Lab 4".</p> |
| | 1170 | </li> |
| | 1171 | <li><p>"printer-make-and-model": The human-readable make and model of the destination such as "ExampleCorp LaserPrinter 4000 Series".</p> |
| | 1172 | </li> |
| | 1173 | <li><p>"printer-state": "3" if the destination is idle, "4" if the destination is printing a job, and "5" if the destination is stopped.</p> |
| | 1174 | </li> |
| | 1175 | <li><p>"printer-state-change-time": The UNIX time when the destination entered the current state.</p> |
| | 1176 | </li> |
| | 1177 | <li><p>"printer-state-reasons": Additional comma-delimited state keywords for the destination such as "media-tray-empty-error" and "toner-low-warning".</p> |
| | 1178 | </li> |
| | 1179 | <li><p>"printer-type": The <code>cups_ptype_t</code> value associated with the destination.</p> |
| | 1180 | </li> |
| | 1181 | <li><p>"printer-uri-supported": The URI associated with the destination; if not set, this destination was discovered but is not yet setup as a local printer.</p> |
| | 1182 | </li> |
| | 1183 | </ul> |
| | 1184 | <p>Use the <a href="#cupsGetOption"><code>cupsGetOption</code></a> function to retrieve the value. For example, the following code gets the make and model of a destination:</p> |
| | 1185 | <pre><code class="language-c"><span class="reserved">const</span> <span class="reserved">char</span> *model = cupsGetOption(<span class="string">"printer-make-and-model"</span>, |
| | 1186 | dest->num_options, |
| | 1187 | dest->options); |
| | 1188 | </code></pre> |
| | 1189 | <h3 class="title" id="detailed-destination-information">Detailed Destination Information</h3> |
| | 1190 | <p>Once a destination has been chosen, the <a href="#cupsCopyDestInfo"><code>cupsCopyDestInfo</code></a> function can be used to gather detailed information about the destination:</p> |
| | 1191 | <pre><code class="language-c">cups_dinfo_t * |
| | 1192 | cupsCopyDestInfo(http_t *http, cups_dest_t *dest); |
| | 1193 | </code></pre> |
| | 1194 | <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> |
| | 1195 | <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> |
| | 1196 | <h4 id="getting-supported-options-and-values">Getting Supported Options and Values</h4> |
| | 1197 | <p>The <a href="#cupsCheckDestSupported"><code>cupsCheckDestSupported</code></a> function can be used to test whether a particular option or option and value is supported:</p> |
| | 1198 | <pre><code class="language-c"><span class="reserved">int</span> |
| | 1199 | cupsCheckDestSupported(http_t *http, cups_dest_t *dest, |
| | 1200 | cups_dinfo_t *info, |
| | 1201 | <span class="reserved">const</span> <span class="reserved">char</span> *option, |
| | 1202 | <span class="reserved">const</span> <span class="reserved">char</span> *value); |
| | 1203 | </code></pre> |
| | 1204 | <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> |
| | 1205 | <ul> |
| | 1206 | <li><p><code>CUPS_COPIES</code>: Controls the number of copies that are produced.</p> |
| | 1207 | </li> |
| | 1208 | <li><p><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.</p> |
| | 1209 | </li> |
| | 1210 | <li><p><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>.</p> |
| | 1211 | </li> |
| | 1212 | <li><p><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>.</p> |
| | 1213 | </li> |
| | 1214 | <li><p><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>.</p> |
| | 1215 | </li> |
| | 1216 | <li><p><code>CUPS_NUMBER_UP</code>: Controls the number of document pages that are placed on each media side.</p> |
| | 1217 | </li> |
| | 1218 | <li><p><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>.</p> |
| | 1219 | </li> |
| | 1220 | <li><p><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>).</p> |
| | 1221 | </li> |
| | 1222 | <li><p><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>.</p> |
| | 1223 | </li> |
| | 1224 | <li><p><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>.</p> |
| | 1225 | </li> |
| | 1226 | </ul> |
| | 1227 | <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> |
| | 1228 | <p>The <a href="#cupsFindDestSupported"><code>cupsFindDestSupported</code></a> function returns the IPP attribute containing the supported values for a given option:</p> |
| | 1229 | <pre><code class="language-c">ipp_attribute_t * |
| | 1230 | cupsFindDestSupported(http_t *http, cups_dest_t *dest, |
| | 1231 | cups_dinfo_t *dinfo, |
| | 1232 | <span class="reserved">const</span> <span class="reserved">char</span> *option); |
| | 1233 | </code></pre> |
| | 1234 | <p>For example, the following code prints the supported finishing processes for a destination, if any, to the standard output:</p> |
| | 1235 | <pre><code class="language-c">cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT, |
| | 1236 | dest); |
| | 1237 | |
| | 1238 | <span class="reserved">if</span> (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info, |
| | 1239 | CUPS_FINISHINGS, NULL)) |
| | 1240 | { |
| | 1241 | ipp_attribute_t *finishings = |
| | 1242 | cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, |
| | 1243 | CUPS_FINISHINGS); |
| | 1244 | <span class="reserved">int</span> i, count = ippGetCount(finishings); |
| | 1245 | |
| | 1246 | puts(<span class="string">"finishings supported:"</span>); |
| | 1247 | <span class="reserved">for</span> (i = <span class="number">0</span>; i < count; i ++) |
| | 1248 | { |
| | 1249 | <span class="reserved">int</span> val = ippGetInteger(finishings, i); |
| | 1250 | printf(<span class="string">" %d (%s)\n"</span>, val, |
| | 1251 | ippEnumString(<span class="string">"finishings"</span>, val)); |
| | 1252 | } |
| | 1253 | <span class="reserved">else</span> |
| | 1254 | { |
| | 1255 | puts(<span class="string">"finishings not supported."</span>); |
| | 1256 | } |
| | 1257 | </code></pre> |
| | 1258 | <p>The "job-creation-attributes" option can be queried to get a list of supported options. For example, the following code prints the list of supported options to the standard output:</p> |
| | 1259 | <pre><code class="language-c">ipp_attribute_t *attrs = |
| | 1260 | cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, |
| | 1261 | <span class="string">"job-creation-attributes"</span>); |
| | 1262 | <span class="reserved">int</span> i, count = ippGetCount(attrs); |
| | 1263 | |
| | 1264 | <span class="reserved">for</span> (i = <span class="number">0</span>; i < count; i ++) |
| | 1265 | puts(ippGetString(attrs, i, NULL)); |
| | 1266 | </code></pre> |
| | 1267 | <h4 id="getting-default-values">Getting Default Values</h4> |
| | 1268 | <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 <a href="#cupsFindDestDefault"><code>cupsFindDestDefault</code></a> function which returns the IPP attribute containing the default value(s) for a given option:</p> |
| | 1269 | <pre><code class="language-c">ipp_attribute_t * |
| | 1270 | cupsFindDestDefault(http_t *http, cups_dest_t *dest, |
| | 1271 | cups_dinfo_t *dinfo, |
| | 1272 | <span class="reserved">const</span> <span class="reserved">char</span> *option); |
| | 1273 | </code></pre> |
| | 1274 | <p>The user defaults from <a href="#cupsGetOption"><code>cupsGetOption</code></a> should always take preference over the destination defaults. For example, the following code prints the default finishings value(s) to the standard output:</p> |
| | 1275 | <pre><code class="language-c"><span class="reserved">const</span> <span class="reserved">char</span> *def_value = |
| | 1276 | cupsGetOption(CUPS_FINISHINGS, dest->num_options, |
| | 1277 | dest->options); |
| | 1278 | ipp_attribute_t *def_attr = |
| | 1279 | cupsFindDestDefault(CUPS_HTTP_DEFAULT, dest, info, |
| | 1280 | CUPS_FINISHINGS); |
| | 1281 | |
| | 1282 | <span class="reserved">if</span> (def_value != NULL) |
| | 1283 | { |
| | 1284 | printf(<span class="string">"Default finishings: %s\n"</span>, def_value); |
| | 1285 | } |
| | 1286 | <span class="reserved">else</span> |
| | 1287 | { |
| | 1288 | <span class="reserved">int</span> i, count = ippGetCount(def_attr); |
| | 1289 | |
| | 1290 | printf(<span class="string">"Default finishings: %d"</span>, |
| | 1291 | ippGetInteger(def_attr, <span class="number">0</span>)); |
| | 1292 | <span class="reserved">for</span> (i = <span class="number">1</span>; i < count; i ++) |
| | 1293 | printf(<span class="string">",%d"</span>, ippGetInteger(def_attr, i)); |
| | 1294 | putchar(<span class="string">'\n'</span>); |
| | 1295 | } |
| | 1296 | </code></pre> |
| | 1297 | <h4 id="getting-ready-loaded-values">Getting Ready (Loaded) Values</h4> |
| | 1298 | <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> |
| | 1299 | <p>The <a href="#cupsFindDestReady"><code>cupsFindDestReady</code></a> function finds the IPP attribute containing the ready values for a given option:</p> |
| | 1300 | <pre><code class="language-c">ipp_attribute_t * |
| | 1301 | cupsFindDestReady(http_t *http, cups_dest_t *dest, |
| | 1302 | cups_dinfo_t *dinfo, <span class="reserved">const</span> <span class="reserved">char</span> *option); |
| | 1303 | </code></pre> |
| | 1304 | <p>For example, the following code lists the ready finishing processes:</p> |
| | 1305 | <pre><code class="language-c">ipp_attribute_t *ready_finishings = |
| | 1306 | cupsFindDestReady(CUPS_HTTP_DEFAULT, dest, info, |
| | 1307 | CUPS_FINISHINGS); |
| | 1308 | |
| | 1309 | <span class="reserved">if</span> (ready_finishings != NULL) |
| | 1310 | { |
| | 1311 | <span class="reserved">int</span> i, count = ippGetCount(ready_finishings); |
| | 1312 | |
| | 1313 | puts(<span class="string">"finishings ready:"</span>); |
| | 1314 | <span class="reserved">for</span> (i = <span class="number">0</span>; i < count; i ++) |
| | 1315 | { |
| | 1316 | <span class="reserved">int</span> val = ippGetInteger(ready_finishings, i); |
| | 1317 | printf(<span class="string">" %d (%s)\n"</span>, val, |
| | 1318 | ippEnumString(<span class="string">"finishings"</span>, val)); |
| | 1319 | } |
| | 1320 | <span class="reserved">else</span> |
| | 1321 | { |
| | 1322 | puts(<span class="string">"no finishings are ready."</span>); |
| | 1323 | } |
| | 1324 | </code></pre> |
| | 1325 | <h4 id="media-options">Media Options</h4> |
| | 1326 | <p>CUPS provides functions for querying the dimensions, margins, color, source (tray/roll), and type for each of the supported media size options. The <code>cups_media_t</code> structure is used to describe media:</p> |
| | 1327 | <pre><code class="language-c"><span class="reserved">typedef</span> <span class="reserved">struct</span> cups_media_s |
| | 1328 | { |
| | 1329 | <span class="reserved">char</span> media[<span class="number">128</span>]; |
| | 1330 | <span class="reserved">char</span> color[<span class="number">128</span>]; |
| | 1331 | <span class="reserved">char</span> source[<span class="number">128</span>]; |
| | 1332 | <span class="reserved">char</span> type[<span class="number">128</span>]; |
| | 1333 | <span class="reserved">int</span> width, length; |
| | 1334 | <span class="reserved">int</span> bottom, left, right, top; |
| | 1335 | } cups_media_t; |
| | 1336 | </code></pre> |
| | 1337 | <p>The "media" member specifies a PWG self-describing media size name such as "na_letter_8.5x11in", "iso_a4_210x297mm", etc. The "color" member specifies a PWG media color name such as "white", "blue", etc. The "source" member specifies a standard keyword for the paper tray or roll such as "tray-1", "manual", "by-pass-tray" (multi-purpose tray), etc. The "type" member specifies a PWG media type name such as "stationery" (plain paper), "photographic", "envelope", "transparency", etc.</p> |
| | 1338 | <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> |
| | 1339 | <p>The <a href="#cupsGetDestMediaByName2"><code>cupsGetDestMediaByName2</code></a> and <a href="#cupsGetDestMediaBySize2"><code>cupsGetDestMediaBySize2</code></a> functions lookup the media information using a standard media size name or dimensions in hundredths of millimeters:</p> |
| | 1340 | <pre><code class="language-c"><span class="reserved">bool</span> |
| | 1341 | cupsGetDestMediaByName2(http_t *http, cups_dest_t *dest, |
| | 1342 | cups_dinfo_t *dinfo, |
| | 1343 | <span class="reserved">const</span> <span class="reserved">char</span> *name, |
| | 1344 | <span class="reserved">unsigned</span> flags, cups_media_t *media); |
| | 1345 | |
| | 1346 | <span class="reserved">bool</span> |
| | 1347 | cupsGetDestMediaBySize2(http_t *http, cups_dest_t *dest, |
| | 1348 | cups_dinfo_t *dinfo, |
| | 1349 | <span class="reserved">int</span> width, <span class="reserved">int</span> length, |
| | 1350 | <span class="reserved">unsigned</span> flags, cups_media_t *media); |
| | 1351 | </code></pre> |
| | 1352 | <p>The <code>name</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> |
| | 1353 | <ul> |
| | 1354 | <li><p><code>CUPS_MEDIA_FLAGS_DEFAULT</code>: Find the closest size supported by the printer.</p> |
| | 1355 | </li> |
| | 1356 | <li><p><code>CUPS_MEDIA_FLAGS_BORDERLESS</code>: Find a borderless size.</p> |
| | 1357 | </li> |
| | 1358 | <li><p><code>CUPS_MEDIA_FLAGS_DUPLEX</code>: Find a size compatible with two-sided printing.</p> |
| | 1359 | </li> |
| | 1360 | <li><p><code>CUPS_MEDIA_FLAGS_EXACT</code>: Find an exact match for the size.</p> |
| | 1361 | </li> |
| | 1362 | <li><p><code>CUPS_MEDIA_FLAGS_READY</code>: If the printer supports media sensing or configuration of the media in each tray/source, find the size amongst the "ready" media.</p> |
| | 1363 | </li> |
| | 1364 | </ul> |
| | 1365 | <p>If a matching size is found for the destination, the size information is stored in the structure pointed to by the <code>media</code> argument and <code>true</code> is returned. Otherwise <code>false</code> is returned.</p> |
| | 1366 | <p>For example, the following code prints the margins for two-sided printing on US Letter media:</p> |
| | 1367 | <pre><code class="language-c">cups_media_t media: |
| | 1368 | |
| | 1369 | <span class="reserved">if</span> (cupsGetDestMediaByName2(CUPS_HTTP_DEFAULT, dest, info, |
| | 1370 | CUPS_MEDIA_LETTER, |
| | 1371 | CUPS_MEDIA_FLAGS_DUPLEX, &size)) |
| | 1372 | { |
| | 1373 | puts(<span class="string">"Margins for duplex US Letter:"</span>); |
| | 1374 | printf(<span class="string">" Bottom: %.2fin\n"</span>, media.bottom / <span class="number">2540.0</span>); |
| | 1375 | printf(<span class="string">" Left: %.2fin\n"</span>, media.left / <span class="number">2540.0</span>); |
| | 1376 | printf(<span class="string">" Right: %.2fin\n"</span>, media.right / <span class="number">2540.0</span>); |
| | 1377 | printf(<span class="string">" Top: %.2fin\n"</span>, media.top / <span class="number">2540.0</span>); |
| | 1378 | } |
| | 1379 | <span class="reserved">else</span> |
| | 1380 | { |
| | 1381 | puts(<span class="string">"Margins for duplex US Letter are not available."</span>); |
| | 1382 | } |
| | 1383 | </code></pre> |
| | 1384 | <p>You can also enumerate all of the sizes that match a given <code>flags</code> value using the <a href="#cupsGetDestMediaByIndex2"><code>cupsGetDestMediaByIndex2</code></a> and <a href="#cupsGetDestMediaCount"><code>cupsGetDestMediaCount</code></a> functions:</p> |
| | 1385 | <pre><code class="language-c"><span class="reserved">bool</span> |
| | 1386 | cupsGetDestMediaByIndex2(http_t *http, cups_dest_t *dest, |
| | 1387 | cups_dinfo_t *dinfo, size_t n, |
| | 1388 | <span class="reserved">unsigned</span> flags, cups_media_t *media); |
| | 1389 | |
| | 1390 | <span class="reserved">int</span> |
| | 1391 | cupsGetDestMediaCount(http_t *http, cups_dest_t *dest, |
| | 1392 | cups_dinfo_t *dinfo, <span class="reserved">unsigned</span> flags); |
| | 1393 | </code></pre> |
| | 1394 | <p>For example, the following code prints the list of ready media and corresponding margins:</p> |
| | 1395 | <pre><code class="language-c">cups_media_t media; |
| | 1396 | size_t i; |
| | 1397 | size_t count = (size_t)cupsGetDestMediaCount(CUPS_HTTP_DEFAULT, |
| | 1398 | dest, info, |
| | 1399 | CUPS_MEDIA_FLAGS_READY); |
| | 1400 | |
| | 1401 | <span class="reserved">for</span> (i = <span class="number">0</span>; i < count; i ++) |
| | 1402 | { |
| | 1403 | <span class="reserved">if</span> (cupsGetDestMediaByIndex2(CUPS_HTTP_DEFAULT, dest, info, |
| | 1404 | i, CUPS_MEDIA_FLAGS_READY, |
| | 1405 | &media)) |
| | 1406 | { |
| | 1407 | printf(<span class="string">"%s:\n"</span>, media.name); |
| | 1408 | printf(<span class="string">" Width: %.2fin\n"</span>, media.width / <span class="number">2540.0</span>); |
| | 1409 | printf(<span class="string">" Length: %.2fin\n"</span>, media.length / <span class="number">2540.0</span>); |
| | 1410 | printf(<span class="string">" Bottom: %.2fin\n"</span>, media.bottom / <span class="number">2540.0</span>); |
| | 1411 | printf(<span class="string">" Left: %.2fin\n"</span>, media.left / <span class="number">2540.0</span>); |
| | 1412 | printf(<span class="string">" Right: %.2fin\n"</span>, media.right / <span class="number">2540.0</span>); |
| | 1413 | printf(<span class="string">" Top: %.2fin\n"</span>, media.top / <span class="number">2540.0</span>); |
| | 1414 | } |
| | 1415 | } |
| | 1416 | </code></pre> |
| | 1417 | <p>Finally, the <a href="#cupsGetDestMediaDefault2"><code>cupsGetDestMediaDefault2</code></a> function returns the default media:</p> |
| | 1418 | <pre><code class="language-c"><span class="reserved">int</span> |
| | 1419 | cupsGetDestMediaDefault2(http_t *http, cups_dest_t *dest, |
| | 1420 | cups_dinfo_t *dinfo, <span class="reserved">unsigned</span> flags, |
| | 1421 | cups_media_t *media); |
| | 1422 | </code></pre> |
| | 1423 | <h4 id="localizing-options-and-values">Localizing Options and Values</h4> |
| | 1424 | <p>CUPS provides three functions to get localized, human-readable strings in the user's current locale for options and values: <a href="#cupsLocalizeDestMedia2"><code>cupsLocalizeDestMedia2</code></a>, <a href="#cupsLocalizeDestOption"><code>cupsLocalizeDestOption</code></a>, and <a href="#cupsLocalizeDestValue"><code>cupsLocalizeDestValue</code></a>:</p> |
| | 1425 | <pre><code class="language-c"><span class="reserved">const</span> <span class="reserved">char</span> * |
| | 1426 | cupsLocalizeDestMedia2(http_t *http, cups_dest_t *dest, |
| | 1427 | cups_dinfo_t *info, <span class="reserved">unsigned</span> flags, |
| | 1428 | cups_media_t *media); |
| | 1429 | |
| | 1430 | <span class="reserved">const</span> <span class="reserved">char</span> * |
| | 1431 | cupsLocalizeDestOption(http_t *http, cups_dest_t *dest, |
| | 1432 | cups_dinfo_t *info, |
| | 1433 | <span class="reserved">const</span> <span class="reserved">char</span> *option); |
| | 1434 | |
| | 1435 | <span class="reserved">const</span> <span class="reserved">char</span> * |
| | 1436 | cupsLocalizeDestValue(http_t *http, cups_dest_t *dest, |
| | 1437 | cups_dinfo_t *info, |
| | 1438 | <span class="reserved">const</span> <span class="reserved">char</span> *option, <span class="reserved">const</span> <span class="reserved">char</span> *value); |
| | 1439 | </code></pre> |
| | 1440 | <blockquote> |
| | 1441 | <p><strong>Note:</strong></p> |
| | 1442 | <p>These functions require a valid <code>http_t</code> connection to work. Use the <a href="#cupsConnectDest"><code>cupsConnectDest</code></a> function to connect to the destination for its localization information.</p> |
| | 1443 | </blockquote> |
| | 1444 | <p>For example, the following code will list the localized media names for a destination:</p> |
| | 1445 | <pre><code class="language-c"><span class="reserved">char</span> resource[<span class="number">256</span>]; |
| | 1446 | http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_NONE, |
| | 1447 | <span class="comment">/*msec*/</span><span class="number">30000</span>, <span class="comment">/*cancel*/</span>NULL, |
| | 1448 | resource, <span class="reserved">sizeof</span>(resource), |
| | 1449 | <span class="comment">/*dest_cb*/</span>NULL, <span class="comment">/*user_data*/</span>NULL); |
| | 1450 | |
| | 1451 | size_t i; |
| | 1452 | size_t count = (size_t)cupsGetDestMediaCount(http, dest, info, |
| | 1453 | CUPS_MEDIA_FLAGS_DEFAULT); |
| | 1454 | cups_media_t media; |
| | 1455 | <span class="reserved">for</span> (i = <span class="number">0</span>; i < count; i ++) |
| | 1456 | { |
| | 1457 | <span class="reserved">if</span> (cupsGetDestMediaByIndex2(http, dest, info, i, |
| | 1458 | CUPS_MEDIA_FLAGS_DEFAULT, &media)) |
| | 1459 | printf(<span class="string">"%s: %s\n"</span>, media.name, |
| | 1460 | cupsLocalizeDestMedia2(http, dest, info, |
| | 1461 | CUPS_MEDIA_FLAGS_DEFAULT, &media)); |
| | 1462 | } |
| | 1463 | </code></pre> |
| | 1464 | <h3 class="title" id="submitting-a-print-job">Submitting a Print Job</h3> |
| | 1465 | <p>Once you are ready to submit a print job, you create a job using the <a href="#cupsCreateDestJob"><code>cupsCreateDestJob</code></a> function:</p> |
| | 1466 | <pre><code class="language-c">ipp_status_t |
| | 1467 | cupsCreateDestJob(http_t *http, cups_dest_t *dest, |
| | 1468 | cups_dinfo_t *info, <span class="reserved">int</span> *job_id, |
| | 1469 | <span class="reserved">const</span> <span class="reserved">char</span> *title, <span class="reserved">int</span> num_options, |
| | 1470 | cups_option_t *options); |
| | 1471 | </code></pre> |
| | 1472 | <p>The <code>title</code> argument specifies a name for the print job such as "My Document". The <code>num_options</code> and <code>options</code> arguments specify the options for the print job which are allocated using the <code>cupsAddOption</code> function.</p> |
| | 1473 | <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> |
| | 1474 | <p>For example, the following code creates a new job that will print 42 copies of a two-sided US Letter document:</p> |
| | 1475 | <pre><code class="language-c"><span class="reserved">int</span> job_id = <span class="number">0</span>; |
| | 1476 | <span class="reserved">int</span> num_options = <span class="number">0</span>; |
| | 1477 | cups_option_t *options = NULL; |
| | 1478 | |
| | 1479 | num_options = cupsAddOption(CUPS_COPIES, <span class="string">"42"</span>, |
| | 1480 | num_options, &options); |
| | 1481 | num_options = cupsAddOption(CUPS_MEDIA, CUPS_MEDIA_LETTER, |
| | 1482 | num_options, &options); |
| | 1483 | num_options = cupsAddOption(CUPS_SIDES, |
| | 1484 | CUPS_SIDES_TWO_SIDED_PORTRAIT, |
| | 1485 | num_options, &options); |
| | 1486 | |
| | 1487 | <span class="reserved">if</span> (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info, |
| | 1488 | &job_id, <span class="string">"My Document"</span>, num_options, |
| | 1489 | options) == IPP_STATUS_OK) |
| | 1490 | printf(<span class="string">"Created job: %d\n"</span>, job_id); |
| | 1491 | <span class="reserved">else</span> |
| | 1492 | printf(<span class="string">"Unable to create job: %s\n"</span>, |
| | 1493 | cupsGetErrorString()); |
| | 1494 | </code></pre> |
| | 1495 | <p>Once the job is created, you submit documents for the job using the <a href="#cupsStartDestDocument"><code>cupsStartDestDocument</code></a>, <a href="#cupsWriteRequestData"><code>cupsWriteRequestData</code></a>, and <a href="#cupsFinishDestDocument"><code>cupsFinishDestDocument</code></a> functions:</p> |
| | 1496 | <pre><code class="language-c">http_status_t |
| | 1497 | cupsStartDestDocument(http_t *http, cups_dest_t *dest, |
| | 1498 | cups_dinfo_t *info, <span class="reserved">int</span> job_id, |
| | 1499 | <span class="reserved">const</span> <span class="reserved">char</span> *docname, |
| | 1500 | <span class="reserved">const</span> <span class="reserved">char</span> *format, |
| | 1501 | <span class="reserved">int</span> num_options, |
| | 1502 | cups_option_t *options, |
| | 1503 | <span class="reserved">int</span> last_document); |
| | 1504 | |
| | 1505 | http_status_t |
| | 1506 | cupsWriteRequestData(http_t *http, <span class="reserved">const</span> <span class="reserved">char</span> *buffer, |
| | 1507 | size_t length); |
| | 1508 | |
| | 1509 | ipp_status_t |
| | 1510 | cupsFinishDestDocument(http_t *http, cups_dest_t *dest, |
| | 1511 | cups_dinfo_t *info); |
| | 1512 | </code></pre> |
| | 1513 | <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> |
| | 1514 | <ul> |
| | 1515 | <li><p><code>CUPS_FORMAT_AUTO</code>: "application/octet-stream"</p> |
| | 1516 | </li> |
| | 1517 | <li><p><code>CUPS_FORMAT_JPEG</code>: "image/jpeg"</p> |
| | 1518 | </li> |
| | 1519 | <li><p><code>CUPS_FORMAT_PDF</code>: "application/pdf"</p> |
| | 1520 | </li> |
| | 1521 | <li><p><code>CUPS_FORMAT_TEXT</code>: "text/plain"</p> |
| | 1522 | </li> |
| | 1523 | </ul> |
| | 1524 | <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> |
| | 1525 | <p>For example, the following code submits a PDF file to the job that was just created:</p> |
| | 1526 | <pre><code class="language-c">FILE *fp = fopen(<span class="string">"filename.pdf"</span>, <span class="string">"rb"</span>); |
| | 1527 | size_t bytes; |
| | 1528 | <span class="reserved">char</span> buffer[<span class="number">65536</span>]; |
| | 1529 | |
| | 1530 | <span class="reserved">if</span> (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info, |
| | 1531 | job_id, <span class="string">"filename.pdf"</span>, <span class="number">0</span>, NULL, |
| | 1532 | <span class="number">1</span>) == HTTP_STATUS_CONTINUE) |
| | 1533 | { |
| | 1534 | <span class="reserved">while</span> ((bytes = fread(buffer, <span class="number">1</span>, <span class="reserved">sizeof</span>(buffer), fp)) > <span class="number">0</span>) |
| | 1535 | { |
| | 1536 | <span class="reserved">if</span> (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer, |
| | 1537 | bytes) != HTTP_STATUS_CONTINUE) |
| | 1538 | <span class="reserved">break</span>; |
| | 1539 | } |
| | 1540 | |
| | 1541 | <span class="reserved">if</span> (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest, |
| | 1542 | info) == IPP_STATUS_OK) |
| | 1543 | puts(<span class="string">"Document send succeeded."</span>); |
| | 1544 | <span class="reserved">else</span> |
| | 1545 | printf(<span class="string">"Document send failed: %s\n"</span>, |
| | 1546 | cupsGetErrorString()); |
| | 1547 | } |
| | 1548 | |
| | 1549 | fclose(fp); |
| | 1550 | </code></pre> |
| | 1551 | <h2 class="title" id="sending-ipp-requests">Sending IPP Requests</h2> |
| | 1552 | <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> |
| | 1553 | <h3 class="title" id="connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</h3> |
| | 1554 | <p>The connection to the scheduler or printer is represented by the HTTP connection type <code>http_t</code>. The <a href="#cupsConnectDest"><code>cupsConnectDest</code></a> function connects to the scheduler or printer associated with the destination:</p> |
| | 1555 | <pre><code class="language-c">http_t * |
| | 1556 | cupsConnectDest(cups_dest_t *dest, <span class="reserved">unsigned</span> flags, <span class="reserved">int</span> msec, |
| | 1557 | <span class="reserved">int</span> *cancel, <span class="reserved">char</span> *resource, |
| | 1558 | size_t resourcesize, cups_dest_cb_t cb, |
| | 1559 | <span class="reserved">void</span> *user_data); |
| | 1560 | </code></pre> |
| | 1561 | <p>The <code>dest</code> argument specifies the destination to connect to.</p> |
| | 1562 | <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> |
| | 1563 | <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> |
| | 1564 | <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> |
| | 1565 | <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> |
| | 1566 | <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 works the same way as the one used for the <a href="#cupsEnumDests"><code>cupsEnumDests</code></a> function.</p> |
| | 1567 | <p>On success, a HTTP connection is returned that can be used to send IPP requests and get IPP responses.</p> |
| | 1568 | <p>For example, the following code connects to the printer associated with a destination with a 30 second timeout:</p> |
| | 1569 | <pre><code class="language-c"><span class="reserved">char</span> resource[<span class="number">256</span>]; |
| | 1570 | http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_DEVICE, |
| | 1571 | <span class="number">30000</span>, <span class="comment">/*cancel*/</span>NULL, resource, |
| | 1572 | <span class="reserved">sizeof</span>(resource), |
| | 1573 | <span class="comment">/*cb*/</span>NULL, <span class="comment">/*user_data*/</span>NULL); |
| | 1574 | </code></pre> |
| | 1575 | <h3 class="title" id="creating-an-ipp-request">Creating an IPP Request</h3> |
| | 1576 | <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> |
| | 1577 | <p>The <code>ippNewRequest</code> function creates a new IPP request:</p> |
| | 1578 | <pre><code class="language-c">ipp_t * |
| | 1579 | ippNewRequest(ipp_op_t op); |
| | 1580 | </code></pre> |
| | 1581 | <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> |
| | 1582 | <pre><code class="language-c">ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES); |
| | 1583 | </code></pre> |
| | 1584 | <p>The request identifier is automatically set to a unique value for the current process.</p> |
| | 1585 | <p>Each IPP request starts with two IPP attributes, "attributes-charset" and "attributes-natural-language", followed by IPP attribute(s) that specify the target of the operation. The <code>ippNewRequest</code> automatically adds the correct "attributes-charset" and "attributes-natural-language" attributes, but you must add the target attribute(s). For example, the following code adds the "printer-uri" attribute to the IPP Get-Printer-Attributes request to specify which printer is being queried:</p> |
| | 1586 | <pre><code class="language-c"><span class="reserved">const</span> <span class="reserved">char</span> *printer_uri = cupsGetOption(<span class="string">"device-uri"</span>, |
| | 1587 | dest->num_options, |
| | 1588 | dest->options); |
| | 1589 | |
| | 1590 | ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, |
| | 1591 | <span class="string">"printer-uri"</span>, <span class="comment">/*language*/</span>NULL, printer_uri); |
| | 1592 | ```c |
| | 1593 | |
| | 1594 | > **Note:** |
| | 1595 | > |
| | 1596 | > If we wanted to query the scheduler instead of the device, we would look |
| | 1597 | > up the <span class="string">"printer-uri-supported"</span> option instead of the <span class="string">"device-uri"</span> value. |
| | 1598 | |
| | 1599 | The [`ippAddString`](@@) function adds the <span class="string">"printer-uri"</span> attribute to the IPP |
| | 1600 | request. The `IPP_TAG_OPERATION` argument specifies that the attribute is part |
| | 1601 | of the operation. The `IPP_TAG_URI` argument specifies that the value is a |
| | 1602 | Universal Resource Identifier (URI) string. The `NULL` argument specifies there |
| | 1603 | is no language (English, French, Japanese, etc.) associated with the string, <span class="reserved">and</span> |
| | 1604 | the `printer_uri` argument specifies the string value. |
| | 1605 | |
| | 1606 | The IPP Get-Printer-Attributes request also supports an IPP attribute called |
| | 1607 | <span class="string">"requested-attributes"</span> that lists the attributes <span class="reserved">and</span> values you are interested |
| | 1608 | in. For example, the following code requests the printer state attributes: |
| | 1609 | |
| | 1610 | ```c |
| | 1611 | <span class="reserved">static</span> <span class="reserved">const</span> <span class="reserved">char</span> * <span class="reserved">const</span> requested_attributes[] = |
| | 1612 | { |
| | 1613 | <span class="string">"printer-state"</span>, |
| | 1614 | <span class="string">"printer-state-message"</span>, |
| | 1615 | <span class="string">"printer-state-reasons"</span> |
| | 1616 | }; |
| | 1617 | |
| | 1618 | ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD, |
| | 1619 | <span class="string">"requested-attributes"</span>, <span class="number">3</span>, <span class="comment">/*language*/</span>NULL, |
| | 1620 | requested_attributes); |
| | 1621 | </code></pre> |
| | 1622 | <p>The <a href="#ippAddStrings"><code>ippAddStrings</code></a> 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> for none), and the attribute will contain the three strings in the array <code>requested_attributes</code>.</p> |
| | 1623 | <p>CUPS provides many functions to adding attributes of different types:</p> |
| | 1624 | <ul> |
| | 1625 | <li><p><a href="#ippAddBoolean"><code>ippAddBoolean</code></a> adds a boolean (<code>IPP_TAG_BOOLEAN</code>) attribute with one value.</p> |
| | 1626 | </li> |
| | 1627 | <li><p><a href="#ippAddInteger"><code>ippAddInteger</code></a> adds an enum (<code>IPP_TAG_ENUM</code>) or integer (<code>IPP_TAG_INTEGER</code>) attribute with one value.</p> |
| | 1628 | </li> |
| | 1629 | <li><p><a href="#ippAddIntegers"><code>ippAddIntegers</code></a> adds an enum or integer attribute with one or more values.</p> |
| | 1630 | </li> |
| | 1631 | <li><p><a href="#ippAddOctetString"><code>ippAddOctetString</code></a> adds an octetString attribute with one value.</p> |
| | 1632 | </li> |
| | 1633 | <li><p><a href="#ippAddOutOfBand"><code>ippAddOutOfBand</code></a> 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.</p> |
| | 1634 | </li> |
| | 1635 | <li><p><a href="#ippAddRange"><code>ippAddRange</code></a> adds a rangeOfInteger attribute with one range.</p> |
| | 1636 | </li> |
| | 1637 | <li><p><a href="#ippAddRanges"><code>ippAddRanges</code></a> adds a rangeOfInteger attribute with one or more ranges.</p> |
| | 1638 | </li> |
| | 1639 | <li><p><a href="#ippAddResolution"><code>ippAddResolution</code></a> adds a resolution attribute with one resolution.</p> |
| | 1640 | </li> |
| | 1641 | <li><p><a href="#ippAddResolutions"><code>ippAddResolutions</code></a> adds a resolution attribute with one or more resolutions.</p> |
| | 1642 | </li> |
| | 1643 | <li><p><a href="#ippAddString"><code>ippAddString</code></a> 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.</p> |
| | 1644 | </li> |
| | 1645 | <li><p><a href="#ippAddStrings"><code>ippAddStrings</code></a> adds a charset, keyword, mimeMediaType, name, naturalLanguage, text, uri, or uriScheme attribute with one or more values.</p> |
| | 1646 | </li> |
| | 1647 | </ul> |
| | 1648 | <h3 class="title" id="sending-the-ipp-request">Sending the IPP Request</h3> |
| | 1649 | <p>Once you have created the IPP request, you can send it using the <a href="#cupsDoRequest"><code>cupsDoRequest</code></a> function. For example, the following code sends the IPP Get-Printer-Attributes request to the destination and saves the response:</p> |
| | 1650 | <pre><code class="language-c">ipp_t *response = cupsDoRequest(http, request, resource); |
| | 1651 | </code></pre> |
| | 1652 | <p>For requests like Send-Document that include a file, the <a href="#cupsDoFileRequest"><code>cupsDoFileRequest</code></a> function should be used:</p> |
| | 1653 | <pre><code class="language-c">ipp_t *response = cupsDoFileRequest(http, request, resource, |
| | 1654 | filename); |
| | 1655 | </code></pre> |
| | 1656 | <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> |
| | 1657 | <p>The status from the most recent request can be queried using the <a href="#cupsGetError"><code>cupsGetError</code></a> function, for example:</p> |
| | 1658 | <pre><code class="language-c"><span class="reserved">if</span> (cupsGetError() >= IPP_STATUS_ERROR_BAD_REQUEST) |
| | 1659 | { |
| | 1660 | <span class="comment">/* request failed */</span> |
| | 1661 | } |
| | 1662 | </code></pre> |
| | 1663 | <p>A human-readable error message is also available using the <code>cupsGetErrorString</code> function:</p> |
| | 1664 | <pre><code class="language-c"><span class="reserved">if</span> (cupsGetError() >= IPP_STATUS_ERROR_BAD_REQUEST) |
| | 1665 | { |
| | 1666 | <span class="comment">/* request failed */</span> |
| | 1667 | printf(<span class="string">"Request failed: %s\n"</span>, cupsGetErrorString()); |
| | 1668 | } |
| | 1669 | </code></pre> |
| | 1670 | <h3 class="title" id="processing-the-ipp-response">Processing the IPP Response</h3> |
| | 1671 | <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> |
| | 1672 | <p>For example, the following code finds the printer state attributes and prints their values:</p> |
| | 1673 | <pre><code class="language-c">ipp_attribute_t *attr; |
| | 1674 | |
| | 1675 | <span class="reserved">if</span> ((attr = ippFindAttribute(response, <span class="string">"printer-state"</span>, |
| | 1676 | IPP_TAG_ENUM)) != NULL) |
| | 1677 | { |
| | 1678 | printf(<span class="string">"printer-state=%s\n"</span>, |
| | 1679 | ippEnumString(<span class="string">"printer-state"</span>, ippGetInteger(attr, <span class="number">0</span>))); |
| | 1680 | } |
| | 1681 | <span class="reserved">else</span> |
| | 1682 | puts(<span class="string">"printer-state=unknown"</span>); |
| | 1683 | |
| | 1684 | <span class="reserved">if</span> ((attr = ippFindAttribute(response, <span class="string">"printer-state-message"</span>, |
| | 1685 | IPP_TAG_TEXT)) != NULL) |
| | 1686 | { |
| | 1687 | printf(<span class="string">"printer-state-message=\"%s\"\n"</span>, |
| | 1688 | ippGetString(attr, <span class="number">0</span>, NULL))); |
| | 1689 | } |
| | 1690 | |
| | 1691 | <span class="reserved">if</span> ((attr = ippFindAttribute(response, <span class="string">"printer-state-reasons"</span>, |
| | 1692 | IPP_TAG_KEYWORD)) != NULL) |
| | 1693 | { |
| | 1694 | <span class="reserved">int</span> i, count = ippGetCount(attr); |
| | 1695 | |
| | 1696 | puts(<span class="string">"printer-state-reasons="</span>); |
| | 1697 | <span class="reserved">for</span> (i = <span class="number">0</span>; i < count; i ++) |
| | 1698 | printf(<span class="string">" %s\n"</span>, ippGetString(attr, i, NULL))); |
| | 1699 | } |
| | 1700 | </code></pre> |
| | 1701 | <p>The <a href="#ippGetCount"><code>ippGetCount</code></a> function returns the number of values in an attribute.</p> |
| | 1702 | <p>The <a href="#ippGetInteger"><code>ippGetInteger</code></a> and <a href="#ippGetString"><code>ippGetString</code></a> functions return a single integer or string value from an attribute.</p> |
| | 1703 | <p>The <a href="#ippEnumString"><code>ippEnumString</code></a> function converts a enum value to its keyword (string) equivalent.</p> |
| | 1704 | <p>Once you are done using the IPP response message, free it using the <a href="#ippDelete"><code>ippDelete</code></a> function:</p> |
| | 1705 | <pre><code class="language-c">ippDelete(response); |
| | 1706 | </code></pre> |
| | 1707 | <h3 class="title" id="authentication">Authentication</h3> |
| | 1708 | <p>CUPS normally handles authentication through the console. GUI applications should set a password callback using the <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> function:</p> |
| | 1709 | <pre><code class="language-c"><span class="reserved">void</span> |
| | 1710 | cupsSetPasswordCB2(cups_password_cb2_t cb, <span class="reserved">void</span> *user_data); |
| | 1711 | </code></pre> |
| | 1712 | <p>The password callback will be called when needed and is responsible for setting the current user name using <a href="#cupsSetUser"><code>cupsSetUser</code></a> and returning a string:</p> |
| | 1713 | <pre><code class="language-c"><span class="reserved">const</span> <span class="reserved">char</span> * |
| | 1714 | cups_password_cb2(<span class="reserved">const</span> <span class="reserved">char</span> *prompt, http_t *http, |
| | 1715 | <span class="reserved">const</span> <span class="reserved">char</span> *method, <span class="reserved">const</span> <span class="reserved">char</span> *resource, |
| | 1716 | <span class="reserved">void</span> *user_data); |
| | 1717 | </code></pre> |
| | 1718 | <p>The <code>prompt</code> argument is a string from CUPS that should be displayed to the user.</p> |
| | 1719 | <p>The <code>http</code> argument is the connection hosting the request that is being authenticated. The password callback can call the <a href="#httpGetField"><code>httpGetField</code></a> and <a href="#httpGetSubField"><code>httpGetSubField</code></a> functions to look for additional details concerning the authentication challenge.</p> |
| | 1720 | <p>The <code>method</code> argument specifies the HTTP method used for the request and is typically "POST".</p> |
| | 1721 | <p>The <code>resource</code> argument specifies the path used for the request.</p> |
| | 1722 | <p>The <code>user_data</code> argument provides the user data pointer from the <code>cupsSetPasswordCB2</code> call.</p> |
| | 1723 | <h2 class="title" id="ipp-data-file-api">IPP Data File API</h2> |
| | 1724 | <p>The IPP data file API provides functions to read and write IPP attributes and other commands or data using a common base format that supports tools such as <code>ipptool</code> and <code>ippeveprinter</code>.</p> |
| | 1725 | <h3 class="title" id="creating-an-ipp-data-file">Creating an IPP Data File</h3> |
| | 1726 | <p>The <a href="#ippFileNew"><code>ippFileNew</code></a> function creates a new IPP data file (<code>ipp_file_t</code>) object:</p> |
| | 1727 | <pre><code class="language-c">ipp_file_t *parent = NULL; |
| | 1728 | <span class="reserved">void</span> *data; |
| | 1729 | ipp_file_t *file = ippFileNew(parent, attr_cb, error_cb, data); |
| | 1730 | </code></pre> |
| | 1731 | <p>The "parent" IPP data file pointer is typically used to support nested files and is normally <code>NULL</code> for a new file. The "data" argument supplies your application data to the callbacks. The "attr_cb" callback function is used to filter IPP attributes; return <code>true</code> to include the attribute and <code>false</code> to ignore it:</p> |
| | 1732 | <pre><code class="language-c"><span class="reserved">bool</span> |
| | 1733 | attr_cb(ipp_file_t *file, <span class="reserved">void</span> *cb_data, <span class="reserved">const</span> <span class="reserved">char</span> *name) |
| | 1734 | { |
| | 1735 | ... determine whether to use an attribute named <span class="string">"name"</span> ... |
| | 1736 | } |
| | 1737 | </code></pre> |
| | 1738 | <p>The "error_cb" callback function is used to record/report errors when reading the file:</p> |
| | 1739 | <pre><code class="language-c"><span class="reserved">bool</span> |
| | 1740 | error_cb(ipp_file_t *file, <span class="reserved">void</span> *cb_data, <span class="reserved">const</span> <span class="reserved">char</span> *error) |
| | 1741 | { |
| | 1742 | ... display/record error <span class="reserved">and</span> <span class="reserved">return</span> `<span class="reserved">true</span>` to <span class="reserved">continue</span> <span class="reserved">or</span> `<span class="reserved">false</span>` to stop ... |
| | 1743 | } |
| | 1744 | </code></pre> |
| | 1745 | <h3 class="title" id="reading-a-data-file">Reading a Data File</h3> |
| | 1746 | <p>The <a href="#ippFileOpen"><code>ippFileOpen</code></a> function opens the specified data file and <a href="#ippFileRead"><code>ippFileRead</code></a> reads from it:</p> |
| | 1747 | <pre><code class="language-c"><span class="reserved">if</span> (ippFileOpen(file, <span class="string">"somefile"</span>, <span class="string">"r"</span>)) |
| | 1748 | { |
| | 1749 | <span class="comment">// Opened successfully, now read it...</span> |
| | 1750 | ippFileRead(file, token_cb, <span class="comment">/*with_groups*/</span><span class="reserved">false</span>); |
| | 1751 | ippFileClose(file); |
| | 1752 | } |
| | 1753 | </code></pre> |
| | 1754 | <p>The token callback function passed to <code>ippFileRead</code> handles custom directives in your data file:</p> |
| | 1755 | <pre><code class="language-c"><span class="reserved">bool</span> |
| | 1756 | token_cb(ipp_file_t *file, <span class="reserved">void</span> *cb_data, <span class="reserved">const</span> <span class="reserved">char</span> *token) |
| | 1757 | { |
| | 1758 | ... handle token, <span class="reserved">return</span> `<span class="reserved">true</span>` to <span class="reserved">continue</span> <span class="reserved">or</span> `<span class="reserved">false</span>` to stop ... |
| | 1759 | } |
| | 1760 | </code></pre> |
| | 1761 | <p>The "token" parameter contains the token to be processed. The callback can use the <a href="#ippFileReadToken"><code>ippFileReadToken</code></a> function to read additional tokens from the file and the <a href="#ippFileExpandToken"><code>ippFileExpandToken</code></a> function to expand any variables in the token string. Return <code>false</code> to stop reading the file and <code>true</code> to continue. The default <code>NULL</code> callback reports an unknown token error through the error callback end returns <code>false</code>.</p> |
| | 1762 | <p>Once read, you call the <a href="#ippFileGetAttributes"><code>ippFileGetAttributes</code></a> function to get the IPP attributes from the file.</p> |
| | 1763 | <h3 class="title" id="variables">Variables</h3> |
| | 1764 | <p>Each IPP data file object has associated variables that can be used when reading the file. The default set of variables is:</p> |
| | 1765 | <ul> |
| | 1766 | <li><p>"date-current": Current date in ISO-8601 format</p> |
| | 1767 | </li> |
| | 1768 | <li><p>"date-start": Start date (when file opened) in ISO-8601 format</p> |
| | 1769 | </li> |
| | 1770 | <li><p>"filename": Associated data/document filename, if any</p> |
| | 1771 | </li> |
| | 1772 | <li><p>"filetype": MIME media type of associated data/document filename, if any</p> |
| | 1773 | </li> |
| | 1774 | <li><p>"hostname": Hostname or IP address from the "uri" value, if any</p> |
| | 1775 | </li> |
| | 1776 | <li><p>"port": Port number from the "uri" value, if any</p> |
| | 1777 | </li> |
| | 1778 | <li><p>"resource": Resource path from the "uri" value, if any</p> |
| | 1779 | </li> |
| | 1780 | <li><p>"scheme": URI scheme from the "uri" value, if any</p> |
| | 1781 | </li> |
| | 1782 | <li><p>"uri": URI, if any</p> |
| | 1783 | </li> |
| | 1784 | <li><p>"uriuser": Username from the "uri" value, if any</p> |
| | 1785 | </li> |
| | 1786 | <li><p>"uripassword": Password from the "uri" value, if any</p> |
| | 1787 | </li> |
| | 1788 | <li><p>"user": Current login user</p> |
| | 1789 | </li> |
| | 1790 | </ul> |
| | 1791 | <p>The <a href="#ippFileGetVar"><code>ippFileGetVar</code></a>, <a href="#ippFileSetVar"><code>ippFileSetVar</code></a>, and <a href="#ippFileSetVarf"><code>ippFileSetVarf</code></a> functions get and set file variables, respectively.</p> |
| | 1792 | <h3 class="title" id="writing-ipp-data-files">Writing IPP Data Files</h3> |
| | 1793 | <p>As when reading an IPP data file, the <a href="#ippFileNew"><code>ippFileNew</code></a> function creates a new file object, <a href="#ippFileOpen"><code>ippFileOpen</code></a> opens the file, and <a href="#ippFileClose"><code>ippFileClose</code></a> closes the file. However, you call <a href="#ippFileWriteAttributes"><code>ippFileWriteAttributes</code></a> to write the attributes in an IPP message (<code>ipp_t</code>), <a href="#ippFileWriteComment"><code>ippFileWriteComment</code></a> to write a comment in the file, and <a href="#ippWriteToken"><code>ippWriteToken</code></a> or <a href="#ippWriteTokenf"><code>ippWriteTokenf</code></a> to write a token or value to the file.</p> |
| | 1794 | <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> |
| | 1795 | <h3 class="function"><a id="cupsAddDest">cupsAddDest</a></h3> |
| | 1796 | <p class="description">Add a destination to the list of destinations.</p> |
| | 1797 | <p class="code"> |
| | 1798 | <span class="reserved">int</span> cupsAddDest(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *instance, <span class="reserved">int</span> num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
| | 1799 | <h4 class="parameters">Parameters</h4> |
| | 1800 | <table class="list"><tbody> |
| | 1801 | <tr><th>name</th> |
| | 1802 | <td class="description">Destination name</td></tr> |
| | 1803 | <tr><th>instance</th> |
| | 1804 | <td class="description">Instance name or <code>NULL</code> for none/primary</td></tr> |
| | 1805 | <tr><th>num_dests</th> |
| | 1806 | <td class="description">Number of destinations</td></tr> |
| | 1807 | <tr><th>dests</th> |
| | 1808 | <td class="description">Destinations</td></tr> |
| | 1809 | </tbody></table> |
| | 1810 | <h4 class="returnvalue">Return Value</h4> |
| | 1811 | <p class="description">New number of destinations</p> |
| | 1812 | <h4 class="discussion">Discussion</h4> |
| | 1813 | <p class="discussion">This function cannot be used to add a new class or printer queue, |
| | 1814 | it only adds a new container of saved options for the named |
| | 1815 | destination or instance.<br> |
| | 1816 | <br> |
| | 1817 | If the named destination already exists, the destination list is |
| | 1818 | returned unchanged. Adding a new instance of a destination creates |
| | 1819 | a copy of that destination's options.<br> |
| | 1820 | <br> |
| | 1821 | Use the <a href="#cupsSetDests"><code>cupsSetDests</code></a> function to save the updated list of |
| | 1822 | destinations to the user's lpoptions file.</p> |
| | 1823 | <h3 class="function"><span class="info"> CUPS 2.3 </span><a id="cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></h3> |
| | 1824 | <p class="description">Add the option corresponding to the specified media size.</p> |
| | 1825 | <p class="code"> |
| | 1826 | <span class="reserved">int</span> 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, <span class="reserved">unsigned</span> flags, <a href="#cups_size_t">cups_size_t</a> *size, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| | 1827 | <h4 class="parameters">Parameters</h4> |
| | 1828 | <table class="list"><tbody> |
| | 1829 | <tr><th>http</th> |
| | 1830 | <td class="description">Connection to destination</td></tr> |
| | 1831 | <tr><th>dest</th> |
| | 1832 | <td class="description">Destination</td></tr> |
| | 1833 | <tr><th>dinfo</th> |
| | 1834 | <td class="description">Destination information</td></tr> |
| | 1835 | <tr><th>flags</th> |
| | 1836 | <td class="description">Media matching flags</td></tr> |
| | 1837 | <tr><th>size</th> |
| | 1838 | <td class="description">Media size</td></tr> |
| | 1839 | <tr><th>num_options</th> |
| | 1840 | <td class="description">Current number of options</td></tr> |
| | 1841 | <tr><th>options</th> |
| | 1842 | <td class="description">Options</td></tr> |
| | 1843 | </tbody></table> |
| | 1844 | <h4 class="returnvalue">Return Value</h4> |
| | 1845 | <p class="description">New number of options</p> |
| | 1846 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsAddDestMediaOptions2">cupsAddDestMediaOptions2</a></h3> |
| | 1847 | <p class="description">Add the options corresponding to the specified media information.</p> |
| | 1848 | <p class="code"> |
| | 1849 | <span class="reserved">int</span> cupsAddDestMediaOptions2(<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, <span class="reserved">unsigned</span> flags, <a href="#cups_media_t">cups_media_t</a> *media, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| | 1850 | <h4 class="parameters">Parameters</h4> |
| | 1851 | <table class="list"><tbody> |
| | 1852 | <tr><th>http</th> |
| | 1853 | <td class="description">Connection to destination</td></tr> |
| | 1854 | <tr><th>dest</th> |
| | 1855 | <td class="description">Destination</td></tr> |
| | 1856 | <tr><th>dinfo</th> |
| | 1857 | <td class="description">Destination information</td></tr> |
| | 1858 | <tr><th>flags</th> |
| | 1859 | <td class="description">Media matching flags</td></tr> |
| | 1860 | <tr><th>media</th> |
| | 1861 | <td class="description">Media information</td></tr> |
| | 1862 | <tr><th>num_options</th> |
| | 1863 | <td class="description">Current number of options</td></tr> |
| | 1864 | <tr><th>options</th> |
| | 1865 | <td class="description">Options</td></tr> |
| | 1866 | </tbody></table> |
| | 1867 | <h4 class="returnvalue">Return Value</h4> |
| | 1868 | <p class="description">New number of options</p> |
| | 1869 | <h3 class="function"><span class="info"> CUPS 2.2.4 </span><a id="cupsAddIntegerOption">cupsAddIntegerOption</a></h3> |
| | 1870 | <p class="description">Add an integer option to an option array.</p> |
| | 1871 | <p class="code"> |
| | 1872 | <span class="reserved">int</span> cupsAddIntegerOption(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> value, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| | 1873 | <h4 class="parameters">Parameters</h4> |
| | 1874 | <table class="list"><tbody> |
| | 1875 | <tr><th>name</th> |
| | 1876 | <td class="description">Name of option</td></tr> |
| | 1877 | <tr><th>value</th> |
| | 1878 | <td class="description">Value of option</td></tr> |
| | 1879 | <tr><th>num_options</th> |
| | 1880 | <td class="description">Number of options</td></tr> |
| | 1881 | <tr><th>options</th> |
| | 1882 | <td class="description">Pointer to options</td></tr> |
| | 1883 | </tbody></table> |
| | 1884 | <h4 class="returnvalue">Return Value</h4> |
| | 1885 | <p class="description">Number of options</p> |
| | 1886 | <h4 class="discussion">Discussion</h4> |
| | 1887 | <p class="discussion">New option arrays can be initialized simply by passing 0 for the |
| | 1888 | "num_options" parameter. |
| | 1889 | |
| | 1890 | </p> |
| | 1891 | <h3 class="function"><a id="cupsAddOption">cupsAddOption</a></h3> |
| | 1892 | <p class="description">Add an option to an option array.</p> |
| | 1893 | <p class="code"> |
| | 1894 | <span class="reserved">int</span> cupsAddOption(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *value, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| | 1895 | <h4 class="parameters">Parameters</h4> |
| | 1896 | <table class="list"><tbody> |
| | 1897 | <tr><th>name</th> |
| | 1898 | <td class="description">Name of option</td></tr> |
| | 1899 | <tr><th>value</th> |
| | 1900 | <td class="description">Value of option</td></tr> |
| | 1901 | <tr><th>num_options</th> |
| | 1902 | <td class="description">Number of options</td></tr> |
| | 1903 | <tr><th>options</th> |
| | 1904 | <td class="description">Pointer to options</td></tr> |
| | 1905 | </tbody></table> |
| | 1906 | <h4 class="returnvalue">Return Value</h4> |
| | 1907 | <p class="description">Number of options</p> |
| | 1908 | <h4 class="discussion">Discussion</h4> |
| | 1909 | <p class="discussion">New option arrays can be initialized simply by passing 0 for the |
| | 1910 | "num_options" parameter.</p> |
| | 1911 | <h3 class="function"><a id="cupsAreCredentialsValidForName">cupsAreCredentialsValidForName</a></h3> |
| | 1912 | <p class="description">Return whether the credentials are valid |
| | 1913 | for the given name.</p> |
| | 1914 | <p class="code"> |
| | 1915 | <span class="reserved">bool</span> cupsAreCredentialsValidForName(<span class="reserved">const</span> <span class="reserved">char</span> *common_name, <span class="reserved">const</span> <span class="reserved">char</span> *credentials);</p> |
| | 1916 | <h4 class="parameters">Parameters</h4> |
| | 1917 | <table class="list"><tbody> |
| | 1918 | <tr><th>common_name</th> |
| | 1919 | <td class="description">Name to check</td></tr> |
| | 1920 | <tr><th>credentials</th> |
| | 1921 | <td class="description">Credentials</td></tr> |
| | 1922 | </tbody></table> |
| | 1923 | <h4 class="returnvalue">Return Value</h4> |
| | 1924 | <p class="description"><code>true</code> if valid, <code>false</code> otherwise</p> |
| | 1925 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsArrayAdd">cupsArrayAdd</a></h3> |
| | 1926 | <p class="description">Add an element to the array.</p> |
| | 1927 | <p class="code"> |
| | 1928 | <span class="reserved">int</span> cupsArrayAdd(<a href="#cups_array_t">cups_array_t</a> *a, <span class="reserved">void</span> *e);</p> |
| | 1929 | <h4 class="parameters">Parameters</h4> |
| | 1930 | <table class="list"><tbody> |
| | 1931 | <tr><th>a</th> |
| | 1932 | <td class="description">Array</td></tr> |
| | 1933 | <tr><th>e</th> |
| | 1934 | <td class="description">Element</td></tr> |
| | 1935 | </tbody></table> |
| | 1936 | <h4 class="returnvalue">Return Value</h4> |
| | 1937 | <p class="description">1 on success, 0 on failure</p> |
| | 1938 | <h4 class="discussion">Discussion</h4> |
| | 1939 | <p class="discussion">When adding an element to a sorted array, non-unique elements are |
| | 1940 | appended at the end of the run of identical elements. For unsorted arrays, |
| | 1941 | the element is appended to the end of the array. |
| | 1942 | |
| | 1943 | </p> |
| | 1944 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayAddStrings">cupsArrayAddStrings</a></h3> |
| | 1945 | <p class="description">Add zero or more delimited strings to an array.</p> |
| | 1946 | <p class="code"> |
| | 1947 | <span class="reserved">bool</span> cupsArrayAddStrings(<a href="#cups_array_t">cups_array_t</a> *a, <span class="reserved">const</span> <span class="reserved">char</span> *s, <span class="reserved">char</span> delim);</p> |
| | 1948 | <h4 class="parameters">Parameters</h4> |
| | 1949 | <table class="list"><tbody> |
| | 1950 | <tr><th>a</th> |
| | 1951 | <td class="description">Array</td></tr> |
| | 1952 | <tr><th>s</th> |
| | 1953 | <td class="description">Delimited strings or NULL</td></tr> |
| | 1954 | <tr><th>delim</th> |
| | 1955 | <td class="description">Delimiter character</td></tr> |
| | 1956 | </tbody></table> |
| | 1957 | <h4 class="returnvalue">Return Value</h4> |
| | 1958 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 1959 | <h4 class="discussion">Discussion</h4> |
| | 1960 | <p class="discussion">Note: The array MUST be created using the <a href="#_cupsArrayNewStrings"><code>_cupsArrayNewStrings</code></a> |
| | 1961 | function. Duplicate strings are NOT added. If the string pointer "s" is NULL |
| | 1962 | or the empty string, no strings are added to the array. |
| | 1963 | |
| | 1964 | </p> |
| | 1965 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsArrayClear">cupsArrayClear</a></h3> |
| | 1966 | <p class="description">Clear the array.</p> |
| | 1967 | <p class="code"> |
| | 1968 | <span class="reserved">void</span> cupsArrayClear(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 1969 | <h4 class="parameters">Parameters</h4> |
| | 1970 | <table class="list"><tbody> |
| | 1971 | <tr><th>a</th> |
| | 1972 | <td class="description">Array</td></tr> |
| | 1973 | </tbody></table> |
| | 1974 | <h4 class="discussion">Discussion</h4> |
| | 1975 | <p class="discussion">This function is equivalent to removing all elements in the array. |
| | 1976 | The caller is responsible for freeing the memory used by the |
| | 1977 | elements themselves. |
| | 1978 | |
| | 1979 | </p> |
| | 1980 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsArrayDelete">cupsArrayDelete</a></h3> |
| | 1981 | <p class="description">Free all memory used by the array.</p> |
| | 1982 | <p class="code"> |
| | 1983 | <span class="reserved">void</span> cupsArrayDelete(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 1984 | <h4 class="parameters">Parameters</h4> |
| | 1985 | <table class="list"><tbody> |
| | 1986 | <tr><th>a</th> |
| | 1987 | <td class="description">Array</td></tr> |
| | 1988 | </tbody></table> |
| | 1989 | <h4 class="discussion">Discussion</h4> |
| | 1990 | <p class="discussion">The caller is responsible for freeing the memory used by the |
| | 1991 | elements themselves. |
| | 1992 | |
| | 1993 | </p> |
| | 1994 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsArrayDup">cupsArrayDup</a></h3> |
| | 1995 | <p class="description">Duplicate the array.</p> |
| | 1996 | <p class="code"> |
| | 1997 | <a href="#cups_array_t">cups_array_t</a> *cupsArrayDup(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 1998 | <h4 class="parameters">Parameters</h4> |
| | 1999 | <table class="list"><tbody> |
| | 2000 | <tr><th>a</th> |
| | 2001 | <td class="description">Array</td></tr> |
| | 2002 | </tbody></table> |
| | 2003 | <h4 class="returnvalue">Return Value</h4> |
| | 2004 | <p class="description">Duplicate array</p> |
| | 2005 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsArrayFind">cupsArrayFind</a></h3> |
| | 2006 | <p class="description">Find an element in the array.</p> |
| | 2007 | <p class="code"> |
| | 2008 | <span class="reserved">void</span> *cupsArrayFind(<a href="#cups_array_t">cups_array_t</a> *a, <span class="reserved">void</span> *e);</p> |
| | 2009 | <h4 class="parameters">Parameters</h4> |
| | 2010 | <table class="list"><tbody> |
| | 2011 | <tr><th>a</th> |
| | 2012 | <td class="description">Array</td></tr> |
| | 2013 | <tr><th>e</th> |
| | 2014 | <td class="description">Element</td></tr> |
| | 2015 | </tbody></table> |
| | 2016 | <h4 class="returnvalue">Return Value</h4> |
| | 2017 | <p class="description">Element found or <code>NULL</code></p> |
| | 2018 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayGetCount">cupsArrayGetCount</a></h3> |
| | 2019 | <p class="description">Get the number of elements in the array.</p> |
| | 2020 | <p class="code"> |
| | 2021 | <span class="reserved">int</span> cupsArrayGetCount(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2022 | <h4 class="parameters">Parameters</h4> |
| | 2023 | <table class="list"><tbody> |
| | 2024 | <tr><th>a</th> |
| | 2025 | <td class="description">Array</td></tr> |
| | 2026 | </tbody></table> |
| | 2027 | <h4 class="returnvalue">Return Value</h4> |
| | 2028 | <p class="description">Number of elements</p> |
| | 2029 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayGetCurrent">cupsArrayGetCurrent</a></h3> |
| | 2030 | <p class="description">Return the current element in the array.</p> |
| | 2031 | <p class="code"> |
| | 2032 | <span class="reserved">void</span> *cupsArrayGetCurrent(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2033 | <h4 class="parameters">Parameters</h4> |
| | 2034 | <table class="list"><tbody> |
| | 2035 | <tr><th>a</th> |
| | 2036 | <td class="description">Array</td></tr> |
| | 2037 | </tbody></table> |
| | 2038 | <h4 class="returnvalue">Return Value</h4> |
| | 2039 | <p class="description">Element</p> |
| | 2040 | <h4 class="discussion">Discussion</h4> |
| | 2041 | <p class="discussion">The current element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, |
| | 2042 | <a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a>. |
| | 2043 | |
| | 2044 | </p> |
| | 2045 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayGetElement">cupsArrayGetElement</a></h3> |
| | 2046 | <p class="description">Get the N-th element in the array.</p> |
| | 2047 | <p class="code"> |
| | 2048 | <span class="reserved">void</span> *cupsArrayGetElement(<a href="#cups_array_t">cups_array_t</a> *a, <span class="reserved">int</span> n);</p> |
| | 2049 | <h4 class="parameters">Parameters</h4> |
| | 2050 | <table class="list"><tbody> |
| | 2051 | <tr><th>a</th> |
| | 2052 | <td class="description">Array</td></tr> |
| | 2053 | <tr><th>n</th> |
| | 2054 | <td class="description">Index into array, starting at 0</td></tr> |
| | 2055 | </tbody></table> |
| | 2056 | <h4 class="returnvalue">Return Value</h4> |
| | 2057 | <p class="description">N-th element or <code>NULL</code></p> |
| | 2058 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayGetFirst">cupsArrayGetFirst</a></h3> |
| | 2059 | <p class="description">Get the first element in the array.</p> |
| | 2060 | <p class="code"> |
| | 2061 | <span class="reserved">void</span> *cupsArrayGetFirst(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2062 | <h4 class="parameters">Parameters</h4> |
| | 2063 | <table class="list"><tbody> |
| | 2064 | <tr><th>a</th> |
| | 2065 | <td class="description">Array</td></tr> |
| | 2066 | </tbody></table> |
| | 2067 | <h4 class="returnvalue">Return Value</h4> |
| | 2068 | <p class="description">First element or <code>NULL</code> if the array is empty</p> |
| | 2069 | <h3 class="function"><span class="info"> CUPS 1.3 </span><a id="cupsArrayGetIndex">cupsArrayGetIndex</a></h3> |
| | 2070 | <p class="description">Get the index of the current element.</p> |
| | 2071 | <p class="code"> |
| | 2072 | <span class="reserved">int</span> cupsArrayGetIndex(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2073 | <h4 class="parameters">Parameters</h4> |
| | 2074 | <table class="list"><tbody> |
| | 2075 | <tr><th>a</th> |
| | 2076 | <td class="description">Array</td></tr> |
| | 2077 | </tbody></table> |
| | 2078 | <h4 class="returnvalue">Return Value</h4> |
| | 2079 | <p class="description">Index of the current element, starting at 0</p> |
| | 2080 | <h4 class="discussion">Discussion</h4> |
| | 2081 | <p class="discussion">The current element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, |
| | 2082 | <a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a>. |
| | 2083 | |
| | 2084 | </p> |
| | 2085 | <h3 class="function"><span class="info"> CUPS 1.3 </span><a id="cupsArrayGetInsert">cupsArrayGetInsert</a></h3> |
| | 2086 | <p class="description">Get the index of the last inserted element.</p> |
| | 2087 | <p class="code"> |
| | 2088 | <span class="reserved">int</span> cupsArrayGetInsert(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2089 | <h4 class="parameters">Parameters</h4> |
| | 2090 | <table class="list"><tbody> |
| | 2091 | <tr><th>a</th> |
| | 2092 | <td class="description">Array</td></tr> |
| | 2093 | </tbody></table> |
| | 2094 | <h4 class="returnvalue">Return Value</h4> |
| | 2095 | <p class="description">Index of the last inserted element, starting at 0</p> |
| | 2096 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayGetLast">cupsArrayGetLast</a></h3> |
| | 2097 | <p class="description">Get the last element in the array.</p> |
| | 2098 | <p class="code"> |
| | 2099 | <span class="reserved">void</span> *cupsArrayGetLast(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2100 | <h4 class="parameters">Parameters</h4> |
| | 2101 | <table class="list"><tbody> |
| | 2102 | <tr><th>a</th> |
| | 2103 | <td class="description">Array</td></tr> |
| | 2104 | </tbody></table> |
| | 2105 | <h4 class="returnvalue">Return Value</h4> |
| | 2106 | <p class="description">Last element or <code>NULL</code> if the array is empty</p> |
| | 2107 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayGetNext">cupsArrayGetNext</a></h3> |
| | 2108 | <p class="description">Get the next element in the array.</p> |
| | 2109 | <p class="code"> |
| | 2110 | <span class="reserved">void</span> *cupsArrayGetNext(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2111 | <h4 class="parameters">Parameters</h4> |
| | 2112 | <table class="list"><tbody> |
| | 2113 | <tr><th>a</th> |
| | 2114 | <td class="description">Array</td></tr> |
| | 2115 | </tbody></table> |
| | 2116 | <h4 class="returnvalue">Return Value</h4> |
| | 2117 | <p class="description">Next element or <code>NULL</code></p> |
| | 2118 | <h4 class="discussion">Discussion</h4> |
| | 2119 | <p class="discussion">This function is equivalent to "cupsArrayIndex(a, cupsArrayGetIndex(a) + 1)".<br> |
| | 2120 | <br> |
| | 2121 | The next element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, |
| | 2122 | <a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a> |
| | 2123 | to set the current element. |
| | 2124 | |
| | 2125 | </p> |
| | 2126 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayGetPrev">cupsArrayGetPrev</a></h3> |
| | 2127 | <p class="description">Get the previous element in the array.</p> |
| | 2128 | <p class="code"> |
| | 2129 | <span class="reserved">void</span> *cupsArrayGetPrev(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2130 | <h4 class="parameters">Parameters</h4> |
| | 2131 | <table class="list"><tbody> |
| | 2132 | <tr><th>a</th> |
| | 2133 | <td class="description">Array</td></tr> |
| | 2134 | </tbody></table> |
| | 2135 | <h4 class="returnvalue">Return Value</h4> |
| | 2136 | <p class="description">Previous element or <code>NULL</code></p> |
| | 2137 | <h4 class="discussion">Discussion</h4> |
| | 2138 | <p class="discussion">This function is equivalent to "cupsArrayIndex(a, cupsArrayGetIndex(a) - 1)".<br> |
| | 2139 | <br> |
| | 2140 | The previous element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, |
| | 2141 | <a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a> |
| | 2142 | to set the current element. |
| | 2143 | |
| | 2144 | </p> |
| | 2145 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayGetUserData">cupsArrayGetUserData</a></h3> |
| | 2146 | <p class="description">Return the user data for an array.</p> |
| | 2147 | <p class="code"> |
| | 2148 | <span class="reserved">void</span> *cupsArrayGetUserData(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2149 | <h4 class="parameters">Parameters</h4> |
| | 2150 | <table class="list"><tbody> |
| | 2151 | <tr><th>a</th> |
| | 2152 | <td class="description">Array</td></tr> |
| | 2153 | </tbody></table> |
| | 2154 | <h4 class="returnvalue">Return Value</h4> |
| | 2155 | <p class="description">User data</p> |
| | 2156 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsArrayInsert">cupsArrayInsert</a></h3> |
| | 2157 | <p class="description">Insert an element in the array.</p> |
| | 2158 | <p class="code"> |
| | 2159 | <span class="reserved">int</span> cupsArrayInsert(<a href="#cups_array_t">cups_array_t</a> *a, <span class="reserved">void</span> *e);</p> |
| | 2160 | <h4 class="parameters">Parameters</h4> |
| | 2161 | <table class="list"><tbody> |
| | 2162 | <tr><th>a</th> |
| | 2163 | <td class="description">Array</td></tr> |
| | 2164 | <tr><th>e</th> |
| | 2165 | <td class="description">Element</td></tr> |
| | 2166 | </tbody></table> |
| | 2167 | <h4 class="returnvalue">Return Value</h4> |
| | 2168 | <p class="description">0 on failure, 1 on success</p> |
| | 2169 | <h4 class="discussion">Discussion</h4> |
| | 2170 | <p class="discussion">When inserting an element in a sorted array, non-unique elements are |
| | 2171 | inserted at the beginning of the run of identical elements. For unsorted |
| | 2172 | arrays, the element is inserted at the beginning of the array. |
| | 2173 | |
| | 2174 | </p> |
| | 2175 | <h3 class="function"><span class="info"> CUPS 1.5 </span><a id="cupsArrayNew3">cupsArrayNew3</a></h3> |
| | 2176 | <p class="description">Create a new array with optional compare, hash, copy, and/or free callbacks.</p> |
| | 2177 | <p class="code"> |
| | 2178 | <a href="#cups_array_t">cups_array_t</a> *cupsArrayNew3(<a href="#cups_array_cb_t">cups_array_cb_t</a> f, <span class="reserved">void</span> *d, <a href="#cups_ahash_cb_t">cups_ahash_cb_t</a> h, <span class="reserved">int</span> hsize, <a href="#cups_acopy_cb_t">cups_acopy_cb_t</a> cf, <a href="#cups_afree_cb_t">cups_afree_cb_t</a> ff);</p> |
| | 2179 | <h4 class="parameters">Parameters</h4> |
| | 2180 | <table class="list"><tbody> |
| | 2181 | <tr><th>f</th> |
| | 2182 | <td class="description">Comparison callback or <code>NULL</code> for an unsorted array</td></tr> |
| | 2183 | <tr><th>d</th> |
| | 2184 | <td class="description">User data or <code>NULL</code></td></tr> |
| | 2185 | <tr><th>h</th> |
| | 2186 | <td class="description">Hash callback or <code>NULL</code> for unhashed lookups</td></tr> |
| | 2187 | <tr><th>hsize</th> |
| | 2188 | <td class="description">Hash size (>= 0)</td></tr> |
| | 2189 | <tr><th>cf</th> |
| | 2190 | <td class="description">Copy callback</td></tr> |
| | 2191 | <tr><th>ff</th> |
| | 2192 | <td class="description">Free callback</td></tr> |
| | 2193 | </tbody></table> |
| | 2194 | <h4 class="returnvalue">Return Value</h4> |
| | 2195 | <p class="description">Array</p> |
| | 2196 | <h4 class="discussion">Discussion</h4> |
| | 2197 | <p class="discussion">This function creates a new array with optional compare, hash, copy, and free |
| | 2198 | callbacks. The comparison callback ("f") is used to create a sorted array. |
| | 2199 | The callback receives pointers to two elements and the user data pointer |
| | 2200 | ("d").<br> |
| | 2201 | <br> |
| | 2202 | The hash callback ("h") is used to implement cached lookups with the |
| | 2203 | specified hash size ("hsize").<br> |
| | 2204 | <br> |
| | 2205 | The copy callback ("cf") is used to automatically copy/retain elements when |
| | 2206 | added or the array is duplicated with <a href="#cupsArrayDup"><code>cupsArrayDup</code></a>.<br> |
| | 2207 | <br> |
| | 2208 | The free callback ("cf") is used to automatically free/release elements when |
| | 2209 | removed with <a href="#cupsArrayRemove"><code>cupsArrayRemove</code></a> or the array is deleted with |
| | 2210 | <a href="#cupsArrayDelete"><code>cupsArrayDelete</code></a>. |
| | 2211 | |
| | 2212 | </p> |
| | 2213 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsArrayNewStrings">cupsArrayNewStrings</a></h3> |
| | 2214 | <p class="description">Create a new array of delimited strings.</p> |
| | 2215 | <p class="code"> |
| | 2216 | <a href="#cups_array_t">cups_array_t</a> *cupsArrayNewStrings(<span class="reserved">const</span> <span class="reserved">char</span> *s, <span class="reserved">char</span> delim);</p> |
| | 2217 | <h4 class="parameters">Parameters</h4> |
| | 2218 | <table class="list"><tbody> |
| | 2219 | <tr><th>s</th> |
| | 2220 | <td class="description">Delimited strings or <code>NULL</code></td></tr> |
| | 2221 | <tr><th>delim</th> |
| | 2222 | <td class="description">Delimiter character</td></tr> |
| | 2223 | </tbody></table> |
| | 2224 | <h4 class="returnvalue">Return Value</h4> |
| | 2225 | <p class="description">Array</p> |
| | 2226 | <h4 class="discussion">Discussion</h4> |
| | 2227 | <p class="discussion">This function creates a new array of strings that are delimited by the |
| | 2228 | specified character. The array automatically manages copies of the strings |
| | 2229 | passed. If the string pointer "s" is <code>NULL</code> or the empty string, no strings |
| | 2230 | are added to the newly created array. |
| | 2231 | |
| | 2232 | </p> |
| | 2233 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsArrayRemove">cupsArrayRemove</a></h3> |
| | 2234 | <p class="description">Remove an element from the array.</p> |
| | 2235 | <p class="code"> |
| | 2236 | <span class="reserved">int</span> cupsArrayRemove(<a href="#cups_array_t">cups_array_t</a> *a, <span class="reserved">void</span> *e);</p> |
| | 2237 | <h4 class="parameters">Parameters</h4> |
| | 2238 | <table class="list"><tbody> |
| | 2239 | <tr><th>a</th> |
| | 2240 | <td class="description">Array</td></tr> |
| | 2241 | <tr><th>e</th> |
| | 2242 | <td class="description">Element</td></tr> |
| | 2243 | </tbody></table> |
| | 2244 | <h4 class="returnvalue">Return Value</h4> |
| | 2245 | <p class="description">1 on success, 0 on failure</p> |
| | 2246 | <h4 class="discussion">Discussion</h4> |
| | 2247 | <p class="discussion">If more than one element matches "e", only the first matching element is |
| | 2248 | removed.<br> |
| | 2249 | <br> |
| | 2250 | The caller is responsible for freeing the memory used by the |
| | 2251 | removed element. |
| | 2252 | |
| | 2253 | </p> |
| | 2254 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsArrayRestore">cupsArrayRestore</a></h3> |
| | 2255 | <p class="description">Reset the current element to the last <a href="#cupsArraySave"><code>cupsArraySave</code></a>.</p> |
| | 2256 | <p class="code"> |
| | 2257 | <span class="reserved">void</span> *cupsArrayRestore(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2258 | <h4 class="parameters">Parameters</h4> |
| | 2259 | <table class="list"><tbody> |
| | 2260 | <tr><th>a</th> |
| | 2261 | <td class="description">Array</td></tr> |
| | 2262 | </tbody></table> |
| | 2263 | <h4 class="returnvalue">Return Value</h4> |
| | 2264 | <p class="description">New current element</p> |
| | 2265 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsArraySave">cupsArraySave</a></h3> |
| | 2266 | <p class="description">Mark the current element for a later <a href="#cupsArrayRestore"><code>cupsArrayRestore</code></a>.</p> |
| | 2267 | <p class="code"> |
| | 2268 | <span class="reserved">int</span> cupsArraySave(<a href="#cups_array_t">cups_array_t</a> *a);</p> |
| | 2269 | <h4 class="parameters">Parameters</h4> |
| | 2270 | <table class="list"><tbody> |
| | 2271 | <tr><th>a</th> |
| | 2272 | <td class="description">Array</td></tr> |
| | 2273 | </tbody></table> |
| | 2274 | <h4 class="returnvalue">Return Value</h4> |
| | 2275 | <p class="description">1 on success, 0 on failure</p> |
| | 2276 | <h4 class="discussion">Discussion</h4> |
| | 2277 | <p class="discussion">The current element is undefined until you call <a href="#cupsArrayFind"><code>cupsArrayFind</code></a>, |
| | 2278 | <a href="#cupsArrayFirst"><code>cupsArrayFirst</code></a>, or <a href="#cupsArrayIndex"><code>cupsArrayIndex</code></a>, or <a href="#cupsArrayLast"><code>cupsArrayLast</code></a> |
| | 2279 | to set the current element.<br> |
| | 2280 | <br> |
| | 2281 | The save/restore stack is guaranteed to be at least 32 elements deep. |
| | 2282 | |
| | 2283 | </p> |
| | 2284 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsCancelDestJob">cupsCancelDestJob</a></h3> |
| | 2285 | <p class="description">Cancel a job on a destination.</p> |
| | 2286 | <p class="code"> |
| | 2287 | ipp_status_t cupsCancelDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <span class="reserved">int</span> job_id);</p> |
| | 2288 | <h4 class="parameters">Parameters</h4> |
| | 2289 | <table class="list"><tbody> |
| | 2290 | <tr><th>http</th> |
| | 2291 | <td class="description">Connection to destination</td></tr> |
| | 2292 | <tr><th>dest</th> |
| | 2293 | <td class="description">Destination</td></tr> |
| | 2294 | <tr><th>job_id</th> |
| | 2295 | <td class="description">Job ID</td></tr> |
| | 2296 | </tbody></table> |
| | 2297 | <h4 class="returnvalue">Return Value</h4> |
| | 2298 | <p class="description">Status of cancel operation</p> |
| | 2299 | <h4 class="discussion">Discussion</h4> |
| | 2300 | <p class="discussion">The "job_id" is the number returned by cupsCreateDestJob.<br> |
| | 2301 | <br> |
| | 2302 | Returns <code>IPP_STATUS_OK</code> on success and |
| | 2303 | <code>IPP_STATUS_ERROR_NOT_AUTHORIZED</code> or |
| | 2304 | <code>IPP_STATUS_ERROR_FORBIDDEN</code> on failure. |
| | 2305 | |
| | 2306 | </p> |
| | 2307 | <h3 class="function"><a id="cupsCharsetToUTF8">cupsCharsetToUTF8</a></h3> |
| | 2308 | <p class="description">Convert legacy character set to UTF-8.</p> |
| | 2309 | <p class="code"> |
| | 2310 | <span class="reserved">int</span> cupsCharsetToUTF8(<a href="#cups_utf8_t">cups_utf8_t</a> *dest, <span class="reserved">const</span> <span class="reserved">char</span> *src, <span class="reserved">const</span> <span class="reserved">int</span> maxout, <span class="reserved">const</span> <a href="#cups_encoding_t">cups_encoding_t</a> encoding);</p> |
| | 2311 | <h4 class="parameters">Parameters</h4> |
| | 2312 | <table class="list"><tbody> |
| | 2313 | <tr><th>dest</th> |
| | 2314 | <td class="description">Target string</td></tr> |
| | 2315 | <tr><th>src</th> |
| | 2316 | <td class="description">Source string</td></tr> |
| | 2317 | <tr><th>maxout</th> |
| | 2318 | <td class="description">Max output</td></tr> |
| | 2319 | <tr><th>encoding</th> |
| | 2320 | <td class="description">Encoding</td></tr> |
| | 2321 | </tbody></table> |
| | 2322 | <h4 class="returnvalue">Return Value</h4> |
| | 2323 | <p class="description">Count or -1 on error</p> |
| | 2324 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsCheckDestSupported">cupsCheckDestSupported</a></h3> |
| | 2325 | <p class="description">Check that the option and value are supported |
| | 2326 | by the destination.</p> |
| | 2327 | <p class="code"> |
| | 2328 | <span class="reserved">int</span> 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, <span class="reserved">const</span> <span class="reserved">char</span> *option, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 2329 | <h4 class="parameters">Parameters</h4> |
| | 2330 | <table class="list"><tbody> |
| | 2331 | <tr><th>http</th> |
| | 2332 | <td class="description">Connection to destination</td></tr> |
| | 2333 | <tr><th>dest</th> |
| | 2334 | <td class="description">Destination</td></tr> |
| | 2335 | <tr><th>dinfo</th> |
| | 2336 | <td class="description">Destination information</td></tr> |
| | 2337 | <tr><th>option</th> |
| | 2338 | <td class="description">Option</td></tr> |
| | 2339 | <tr><th>value</th> |
| | 2340 | <td class="description">Value or <code>NULL</code></td></tr> |
| | 2341 | </tbody></table> |
| | 2342 | <h4 class="returnvalue">Return Value</h4> |
| | 2343 | <p class="description">1 if supported, 0 otherwise</p> |
| | 2344 | <h4 class="discussion">Discussion</h4> |
| | 2345 | <p class="discussion">Returns 1 if supported, 0 otherwise. |
| | 2346 | |
| | 2347 | </p> |
| | 2348 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsCloseDestJob">cupsCloseDestJob</a></h3> |
| | 2349 | <p class="description">Close a job and start printing.</p> |
| | 2350 | <p class="code"> |
| | 2351 | 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, <span class="reserved">int</span> job_id);</p> |
| | 2352 | <h4 class="parameters">Parameters</h4> |
| | 2353 | <table class="list"><tbody> |
| | 2354 | <tr><th>http</th> |
| | 2355 | <td class="description">Connection to destination</td></tr> |
| | 2356 | <tr><th>dest</th> |
| | 2357 | <td class="description">Destination</td></tr> |
| | 2358 | <tr><th>info</th> |
| | 2359 | <td class="description">Destination information</td></tr> |
| | 2360 | <tr><th>job_id</th> |
| | 2361 | <td class="description">Job ID</td></tr> |
| | 2362 | </tbody></table> |
| | 2363 | <h4 class="returnvalue">Return Value</h4> |
| | 2364 | <p class="description">IPP status code</p> |
| | 2365 | <h4 class="discussion">Discussion</h4> |
| | 2366 | <p class="discussion">Use when the last call to cupsStartDocument passed 0 for "last_document". |
| | 2367 | "job_id" is the job ID returned by cupsCreateDestJob. Returns <code>IPP_STATUS_OK</code> |
| | 2368 | on success. |
| | 2369 | |
| | 2370 | </p> |
| | 2371 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsConcatString">cupsConcatString</a></h3> |
| | 2372 | <p class="description">Safely concatenate two UTF-8 strings.</p> |
| | 2373 | <p class="code"> |
| | 2374 | size_t cupsConcatString(<span class="reserved">char</span> *dst, <span class="reserved">const</span> <span class="reserved">char</span> *src, size_t dstsize);</p> |
| | 2375 | <h4 class="parameters">Parameters</h4> |
| | 2376 | <table class="list"><tbody> |
| | 2377 | <tr><th>dst</th> |
| | 2378 | <td class="description">Destination string</td></tr> |
| | 2379 | <tr><th>src</th> |
| | 2380 | <td class="description">Source string</td></tr> |
| | 2381 | <tr><th>dstsize</th> |
| | 2382 | <td class="description">Size of destination string buffer</td></tr> |
| | 2383 | </tbody></table> |
| | 2384 | <h4 class="returnvalue">Return Value</h4> |
| | 2385 | <p class="description">Length of string</p> |
| | 2386 | <h3 class="function"><a id="cupsCondBroadcast">cupsCondBroadcast</a></h3> |
| | 2387 | <p class="description">Wake up waiting threads.</p> |
| | 2388 | <p class="code"> |
| | 2389 | <span class="reserved">void</span> cupsCondBroadcast(<a href="#cups_cond_t">cups_cond_t</a> *cond);</p> |
| | 2390 | <h4 class="parameters">Parameters</h4> |
| | 2391 | <table class="list"><tbody> |
| | 2392 | <tr><th>cond</th> |
| | 2393 | <td class="description">Condition</td></tr> |
| | 2394 | </tbody></table> |
| | 2395 | <h3 class="function"><a id="cupsCondDestroy">cupsCondDestroy</a></h3> |
| | 2396 | <p class="description">Destroy a condition variable.</p> |
| | 2397 | <p class="code"> |
| | 2398 | <span class="reserved">void</span> cupsCondDestroy(<a href="#cups_cond_t">cups_cond_t</a> *cond);</p> |
| | 2399 | <h4 class="parameters">Parameters</h4> |
| | 2400 | <table class="list"><tbody> |
| | 2401 | <tr><th>cond</th> |
| | 2402 | <td class="description">Condition</td></tr> |
| | 2403 | </tbody></table> |
| | 2404 | <h3 class="function"><a id="cupsCondInit">cupsCondInit</a></h3> |
| | 2405 | <p class="description">Initialize a condition variable.</p> |
| | 2406 | <p class="code"> |
| | 2407 | <span class="reserved">void</span> cupsCondInit(<a href="#cups_cond_t">cups_cond_t</a> *cond);</p> |
| | 2408 | <h4 class="parameters">Parameters</h4> |
| | 2409 | <table class="list"><tbody> |
| | 2410 | <tr><th>cond</th> |
| | 2411 | <td class="description">Condition</td></tr> |
| | 2412 | </tbody></table> |
| | 2413 | <h3 class="function"><a id="cupsCondWait">cupsCondWait</a></h3> |
| | 2414 | <p class="description">Wait for a condition with optional timeout.</p> |
| | 2415 | <p class="code"> |
| | 2416 | <span class="reserved">void</span> cupsCondWait(<a href="#cups_cond_t">cups_cond_t</a> *cond, <a href="#cups_mutex_t">cups_mutex_t</a> *mutex, <span class="reserved">double</span> timeout);</p> |
| | 2417 | <h4 class="parameters">Parameters</h4> |
| | 2418 | <table class="list"><tbody> |
| | 2419 | <tr><th>cond</th> |
| | 2420 | <td class="description">Condition</td></tr> |
| | 2421 | <tr><th>mutex</th> |
| | 2422 | <td class="description">Mutex</td></tr> |
| | 2423 | <tr><th>timeout</th> |
| | 2424 | <td class="description">Timeout in seconds (<code>0</code> or negative for none)</td></tr> |
| | 2425 | </tbody></table> |
| | 2426 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsConnectDest">cupsConnectDest</a></h3> |
| | 2427 | <p class="description">Open a connection to the destination.</p> |
| | 2428 | <p class="code"> |
| | 2429 | <a href="#http_t">http_t</a> *cupsConnectDest(<a href="#cups_dest_t">cups_dest_t</a> *dest, <span class="reserved">unsigned</span> flags, <span class="reserved">int</span> msec, <span class="reserved">int</span> *cancel, <span class="reserved">char</span> *resource, size_t resourcesize, <a href="#cups_dest_cb_t">cups_dest_cb_t</a> cb, <span class="reserved">void</span> *user_data);</p> |
| | 2430 | <h4 class="parameters">Parameters</h4> |
| | 2431 | <table class="list"><tbody> |
| | 2432 | <tr><th>dest</th> |
| | 2433 | <td class="description">Destination</td></tr> |
| | 2434 | <tr><th>flags</th> |
| | 2435 | <td class="description">Connection flags</td></tr> |
| | 2436 | <tr><th>msec</th> |
| | 2437 | <td class="description">Timeout in milliseconds</td></tr> |
| | 2438 | <tr><th>cancel</th> |
| | 2439 | <td class="description">Pointer to "cancel" variable</td></tr> |
| | 2440 | <tr><th>resource</th> |
| | 2441 | <td class="description">Resource buffer</td></tr> |
| | 2442 | <tr><th>resourcesize</th> |
| | 2443 | <td class="description">Size of resource buffer</td></tr> |
| | 2444 | <tr><th>cb</th> |
| | 2445 | <td class="description">Callback function</td></tr> |
| | 2446 | <tr><th>user_data</th> |
| | 2447 | <td class="description">User data pointer</td></tr> |
| | 2448 | </tbody></table> |
| | 2449 | <h4 class="returnvalue">Return Value</h4> |
| | 2450 | <p class="description">Connection to destination or <code>NULL</code></p> |
| | 2451 | <h4 class="discussion">Discussion</h4> |
| | 2452 | <p class="discussion">Connect to the destination, returning a new <code>http_t</code> connection object |
| | 2453 | and optionally the resource path to use for the destination. These calls |
| | 2454 | will block until a connection is made, the timeout expires, the integer |
| | 2455 | pointed to by "cancel" is non-zero, or the callback function (or block) |
| | 2456 | returns 0. The caller is responsible for calling <a href="#httpClose"><code>httpClose</code></a> on the |
| | 2457 | returned connection.<br> |
| | 2458 | <br> |
| | 2459 | Starting with CUPS 2.2.4, the caller can pass <code>CUPS_DEST_FLAGS_DEVICE</code> |
| | 2460 | for the "flags" argument to connect directly to the device associated with |
| | 2461 | the destination. Otherwise, the connection is made to the CUPS scheduler |
| | 2462 | associated with the destination. |
| | 2463 | |
| | 2464 | </p> |
| | 2465 | <h3 class="function"><a id="cupsCopyCredentials">cupsCopyCredentials</a></h3> |
| | 2466 | <p class="description"></p> |
| | 2467 | <p class="code"> |
| | 2468 | <span class="reserved">char</span> *cupsCopyCredentials(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">const</span> <span class="reserved">char</span> *common_name);</p> |
| | 2469 | <h4 class="parameters">Parameters</h4> |
| | 2470 | <table class="list"><tbody> |
| | 2471 | <tr><th>path</th> |
| | 2472 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 2473 | <tr><th>common_name</th> |
| | 2474 | <td class="description">Common name</td></tr> |
| | 2475 | </tbody></table> |
| | 2476 | <h4 class="returnvalue">Return Value</h4> |
| | 2477 | <p class="description">Copy the X.509 certificate chain to a string.</p> |
| | 2478 | <h3 class="function"><a id="cupsCopyCredentialsKey">cupsCopyCredentialsKey</a></h3> |
| | 2479 | <p class="description"></p> |
| | 2480 | <p class="code"> |
| | 2481 | <span class="reserved">char</span> *cupsCopyCredentialsKey(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">const</span> <span class="reserved">char</span> *common_name);</p> |
| | 2482 | <h4 class="parameters">Parameters</h4> |
| | 2483 | <table class="list"><tbody> |
| | 2484 | <tr><th>path</th> |
| | 2485 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 2486 | <tr><th>common_name</th> |
| | 2487 | <td class="description">Common name</td></tr> |
| | 2488 | </tbody></table> |
| | 2489 | <h4 class="returnvalue">Return Value</h4> |
| | 2490 | <p class="description">Copy the private key to a string.</p> |
| | 2491 | <h3 class="function"><a id="cupsCopyCredentialsPublicKey">cupsCopyCredentialsPublicKey</a></h3> |
| | 2492 | <p class="description">Copy the public key for a X.509 certificate request.</p> |
| | 2493 | <p class="code"> |
| | 2494 | <span class="reserved">char</span> *cupsCopyCredentialsPublicKey(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">const</span> <span class="reserved">char</span> *common_name);</p> |
| | 2495 | <h4 class="parameters">Parameters</h4> |
| | 2496 | <table class="list"><tbody> |
| | 2497 | <tr><th>path</th> |
| | 2498 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 2499 | <tr><th>common_name</th> |
| | 2500 | <td class="description">Common name</td></tr> |
| | 2501 | </tbody></table> |
| | 2502 | <h4 class="returnvalue">Return Value</h4> |
| | 2503 | <p class="description">PEM-encoded public key</p> |
| | 2504 | <h3 class="function"><a id="cupsCopyCredentialsRequest">cupsCopyCredentialsRequest</a></h3> |
| | 2505 | <p class="description">Copy the X.509 certificate signing request to a string.</p> |
| | 2506 | <p class="code"> |
| | 2507 | <span class="reserved">char</span> *cupsCopyCredentialsRequest(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">const</span> <span class="reserved">char</span> *common_name);</p> |
| | 2508 | <h4 class="parameters">Parameters</h4> |
| | 2509 | <table class="list"><tbody> |
| | 2510 | <tr><th>path</th> |
| | 2511 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 2512 | <tr><th>common_name</th> |
| | 2513 | <td class="description">Common name</td></tr> |
| | 2514 | </tbody></table> |
| | 2515 | <h4 class="returnvalue">Return Value</h4> |
| | 2516 | <p class="description">PEM-encoded X.509 certificate signing request</p> |
| | 2517 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsCopyDest">cupsCopyDest</a></h3> |
| | 2518 | <p class="description">Copy a destination.</p> |
| | 2519 | <p class="code"> |
| | 2520 | <span class="reserved">int</span> cupsCopyDest(<a href="#cups_dest_t">cups_dest_t</a> *dest, <span class="reserved">int</span> num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
| | 2521 | <h4 class="parameters">Parameters</h4> |
| | 2522 | <table class="list"><tbody> |
| | 2523 | <tr><th>dest</th> |
| | 2524 | <td class="description">Destination to copy</td></tr> |
| | 2525 | <tr><th>num_dests</th> |
| | 2526 | <td class="description">Number of destinations</td></tr> |
| | 2527 | <tr><th>dests</th> |
| | 2528 | <td class="description">Destination array</td></tr> |
| | 2529 | </tbody></table> |
| | 2530 | <h4 class="returnvalue">Return Value</h4> |
| | 2531 | <p class="description">New number of destinations</p> |
| | 2532 | <h4 class="discussion">Discussion</h4> |
| | 2533 | <p class="discussion">Make a copy of the destination to an array of destinations (or just a single |
| | 2534 | copy) - for use with the cupsEnumDests* functions. The caller is responsible |
| | 2535 | for calling cupsFreeDests() on the returned object(s). |
| | 2536 | |
| | 2537 | </p> |
| | 2538 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsCopyDestConflicts">cupsCopyDestConflicts</a></h3> |
| | 2539 | <p class="description">Get conflicts and resolutions for a new |
| | 2540 | option/value pair.</p> |
| | 2541 | <p class="code"> |
| | 2542 | <span class="reserved">int</span> 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, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> *options, <span class="reserved">const</span> <span class="reserved">char</span> *new_option, <span class="reserved">const</span> <span class="reserved">char</span> *new_value, <span class="reserved">int</span> *num_conflicts, <a href="#cups_option_t">cups_option_t</a> **conflicts, <span class="reserved">int</span> *num_resolved, <a href="#cups_option_t">cups_option_t</a> **resolved);</p> |
| | 2543 | <h4 class="parameters">Parameters</h4> |
| | 2544 | <table class="list"><tbody> |
| | 2545 | <tr><th>http</th> |
| | 2546 | <td class="description">Connection to destination</td></tr> |
| | 2547 | <tr><th>dest</th> |
| | 2548 | <td class="description">Destination</td></tr> |
| | 2549 | <tr><th>dinfo</th> |
| | 2550 | <td class="description">Destination information</td></tr> |
| | 2551 | <tr><th>num_options</th> |
| | 2552 | <td class="description">Number of current options</td></tr> |
| | 2553 | <tr><th>options</th> |
| | 2554 | <td class="description">Current options</td></tr> |
| | 2555 | <tr><th>new_option</th> |
| | 2556 | <td class="description">New option</td></tr> |
| | 2557 | <tr><th>new_value</th> |
| | 2558 | <td class="description">New value</td></tr> |
| | 2559 | <tr><th>num_conflicts</th> |
| | 2560 | <td class="description">Number of conflicting options</td></tr> |
| | 2561 | <tr><th>conflicts</th> |
| | 2562 | <td class="description">Conflicting options</td></tr> |
| | 2563 | <tr><th>num_resolved</th> |
| | 2564 | <td class="description">Number of options to resolve</td></tr> |
| | 2565 | <tr><th>resolved</th> |
| | 2566 | <td class="description">Resolved options</td></tr> |
| | 2567 | </tbody></table> |
| | 2568 | <h4 class="returnvalue">Return Value</h4> |
| | 2569 | <p class="description">1 if there is a conflict, 0 if none, -1 on error</p> |
| | 2570 | <h4 class="discussion">Discussion</h4> |
| | 2571 | <p class="discussion">"num_options" and "options" represent the currently selected options by the |
| | 2572 | user. "new_option" and "new_value" are the setting the user has just |
| | 2573 | changed.<br> |
| | 2574 | <br> |
| | 2575 | Returns 1 if there is a conflict, 0 if there are no conflicts, and -1 if |
| | 2576 | there was an unrecoverable error such as a resolver loop.<br> |
| | 2577 | <br> |
| | 2578 | If "num_conflicts" and "conflicts" are not <code>NULL</code>, they are set to |
| | 2579 | contain the list of conflicting option/value pairs. Similarly, if |
| | 2580 | "num_resolved" and "resolved" are not <code>NULL</code> they will be set to the |
| | 2581 | list of changes needed to resolve the conflict.<br> |
| | 2582 | <br> |
| | 2583 | If cupsCopyDestConflicts returns 1 but "num_resolved" and "resolved" are set |
| | 2584 | to 0 and <code>NULL</code>, respectively, then the conflict cannot be resolved. |
| | 2585 | |
| | 2586 | </p> |
| | 2587 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsCopyDestInfo">cupsCopyDestInfo</a></h3> |
| | 2588 | <p class="description">Get the supported values/capabilities for the |
| | 2589 | destination.</p> |
| | 2590 | <p class="code"> |
| | 2591 | <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> |
| | 2592 | <h4 class="parameters">Parameters</h4> |
| | 2593 | <table class="list"><tbody> |
| | 2594 | <tr><th>http</th> |
| | 2595 | <td class="description">Connection to destination</td></tr> |
| | 2596 | <tr><th>dest</th> |
| | 2597 | <td class="description">Destination</td></tr> |
| | 2598 | </tbody></table> |
| | 2599 | <h4 class="returnvalue">Return Value</h4> |
| | 2600 | <p class="description">Destination information</p> |
| | 2601 | <h4 class="discussion">Discussion</h4> |
| | 2602 | <p class="discussion">The caller is responsible for calling <a href="#cupsFreeDestInfo"><code>cupsFreeDestInfo</code></a> on the return |
| | 2603 | value. <code>NULL</code> is returned on error. |
| | 2604 | |
| | 2605 | </p> |
| | 2606 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsCopyDestInfo2">cupsCopyDestInfo2</a></h3> |
| | 2607 | <p class="description">Get the supported values/capabilities for the |
| | 2608 | destination.</p> |
| | 2609 | <p class="code"> |
| | 2610 | <a href="#cups_dinfo_t">cups_dinfo_t</a> *cupsCopyDestInfo2(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dest_flags_t">cups_dest_flags_t</a> dflags);</p> |
| | 2611 | <h4 class="parameters">Parameters</h4> |
| | 2612 | <table class="list"><tbody> |
| | 2613 | <tr><th>http</th> |
| | 2614 | <td class="description">Connection to destination</td></tr> |
| | 2615 | <tr><th>dest</th> |
| | 2616 | <td class="description">Destination</td></tr> |
| | 2617 | <tr><th>dflags</th> |
| | 2618 | <td class="description">Destination flags</td></tr> |
| | 2619 | </tbody></table> |
| | 2620 | <h4 class="returnvalue">Return Value</h4> |
| | 2621 | <p class="description">Destination information</p> |
| | 2622 | <h4 class="discussion">Discussion</h4> |
| | 2623 | <p class="discussion">The caller is responsible for calling <a href="#cupsFreeDestInfo"><code>cupsFreeDestInfo</code></a> on the return |
| | 2624 | value. <code>NULL</code> is returned on error. |
| | 2625 | |
| | 2626 | </p> |
| | 2627 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsCopyString">cupsCopyString</a></h3> |
| | 2628 | <p class="description">Safely copy a UTF-8 string.</p> |
| | 2629 | <p class="code"> |
| | 2630 | size_t cupsCopyString(<span class="reserved">char</span> *dst, <span class="reserved">const</span> <span class="reserved">char</span> *src, size_t dstsize);</p> |
| | 2631 | <h4 class="parameters">Parameters</h4> |
| | 2632 | <table class="list"><tbody> |
| | 2633 | <tr><th>dst</th> |
| | 2634 | <td class="description">Destination string</td></tr> |
| | 2635 | <tr><th>src</th> |
| | 2636 | <td class="description">Source string</td></tr> |
| | 2637 | <tr><th>dstsize</th> |
| | 2638 | <td class="description">Size of destination string buffer</td></tr> |
| | 2639 | </tbody></table> |
| | 2640 | <h4 class="returnvalue">Return Value</h4> |
| | 2641 | <p class="description">Length of string</p> |
| | 2642 | <h3 class="function"><a id="cupsCreateCredentials">cupsCreateCredentials</a></h3> |
| | 2643 | <p class="description">Make an X.509 certificate and private key pair.</p> |
| | 2644 | <p class="code"> |
| | 2645 | <span class="reserved">bool</span> cupsCreateCredentials(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">bool</span> ca_cert, <a href="#cups_credpurpose_t">cups_credpurpose_t</a> purpose, <a href="#cups_credtype_t">cups_credtype_t</a> type, <a href="#cups_credusage_t">cups_credusage_t</a> usage, <span class="reserved">const</span> <span class="reserved">char</span> *organization, <span class="reserved">const</span> <span class="reserved">char</span> *org_unit, <span class="reserved">const</span> <span class="reserved">char</span> *locality, <span class="reserved">const</span> <span class="reserved">char</span> *state_province, <span class="reserved">const</span> <span class="reserved">char</span> *country, <span class="reserved">const</span> <span class="reserved">char</span> *common_name, <span class="reserved">const</span> <span class="reserved">char</span> *email, size_t num_alt_names, <span class="reserved">const</span> <span class="reserved">char</span> *const *alt_names, <span class="reserved">const</span> <span class="reserved">char</span> *root_name, time_t expiration_date);</p> |
| | 2646 | <h4 class="parameters">Parameters</h4> |
| | 2647 | <table class="list"><tbody> |
| | 2648 | <tr><th>path</th> |
| | 2649 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 2650 | <tr><th>ca_cert</th> |
| | 2651 | <td class="description"><code>true</code> to create a CA certificate, <code>false</code> for a client/server certificate</td></tr> |
| | 2652 | <tr><th>purpose</th> |
| | 2653 | <td class="description">Credential purposes</td></tr> |
| | 2654 | <tr><th>type</th> |
| | 2655 | <td class="description">Credential type</td></tr> |
| | 2656 | <tr><th>usage</th> |
| | 2657 | <td class="description">Credential usages</td></tr> |
| | 2658 | <tr><th>organization</th> |
| | 2659 | <td class="description">Organization or <code>NULL</code> to use common name</td></tr> |
| | 2660 | <tr><th>org_unit</th> |
| | 2661 | <td class="description">Organizational unit or <code>NULL</code> for none</td></tr> |
| | 2662 | <tr><th>locality</th> |
| | 2663 | <td class="description">City/town or <code>NULL</code> for "Unknown"</td></tr> |
| | 2664 | <tr><th>state_province</th> |
| | 2665 | <td class="description">State/province or <code>NULL</code> for "Unknown"</td></tr> |
| | 2666 | <tr><th>country</th> |
| | 2667 | <td class="description">Country or <code>NULL</code> for locale-based default</td></tr> |
| | 2668 | <tr><th>common_name</th> |
| | 2669 | <td class="description">Common name</td></tr> |
| | 2670 | <tr><th>email</th> |
| | 2671 | <td class="description">Email address or <code>NULL</code> for none</td></tr> |
| | 2672 | <tr><th>num_alt_names</th> |
| | 2673 | <td class="description">Number of subject alternate names</td></tr> |
| | 2674 | <tr><th>alt_names</th> |
| | 2675 | <td class="description">Subject Alternate Names</td></tr> |
| | 2676 | <tr><th>root_name</th> |
| | 2677 | <td class="description">Root certificate/domain name or <code>NULL</code> for site/self-signed</td></tr> |
| | 2678 | <tr><th>expiration_date</th> |
| | 2679 | <td class="description">Expiration date</td></tr> |
| | 2680 | </tbody></table> |
| | 2681 | <h4 class="returnvalue">Return Value</h4> |
| | 2682 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 2683 | <h4 class="discussion">Discussion</h4> |
| | 2684 | <p class="discussion">This function creates an X.509 certificate and private key pair. The |
| | 2685 | certificate and key are stored in the directory "path" or, if "path" is |
| | 2686 | <code>NULL</code>, in a per-user or system-wide (when running as root) certificate/key |
| | 2687 | store. The generated certificate is signed by the named root certificate or, |
| | 2688 | if "root_name" is <code>NULL</code>, a site-wide default root certificate. When |
| | 2689 | "root_name" is <code>NULL</code> and there is no site-wide default root certificate, a |
| | 2690 | self-signed certificate is generated instead.<br> |
| | 2691 | <br> |
| | 2692 | The "ca_cert" argument specifies whether a CA certificate should be created.<br> |
| | 2693 | <br> |
| | 2694 | The "purpose" argument specifies the purpose(s) used for the credentials as a |
| | 2695 | bitwise OR of the following constants: |
| | 2696 | |
| | 2697 | </p><ul> |
| | 2698 | <li><code>CUPS_CREDPURPOSE_SERVER_AUTH</code> for validating TLS servers, |
| | 2699 | </li> |
| | 2700 | <li><code>CUPS_CREDPURPOSE_CLIENT_AUTH</code> for validating TLS clients, |
| | 2701 | </li> |
| | 2702 | <li><code>CUPS_CREDPURPOSE_CODE_SIGNING</code> for validating compiled code, |
| | 2703 | </li> |
| | 2704 | <li><code>CUPS_CREDPURPOSE_EMAIL_PROTECTION</code> for validating email messages, |
| | 2705 | </li> |
| | 2706 | <li><code>CUPS_CREDPURPOSE_TIME_STAMPING</code> for signing timestamps to objects, and/or |
| | 2707 | </li> |
| | 2708 | <li><code>CUPS_CREDPURPOSE_OCSP_SIGNING</code> for Online Certificate Status Protocol |
| | 2709 | message signing.</li> |
| | 2710 | </ul> |
| | 2711 | <p class="discussion">The "type" argument specifies the type of credentials using one of the |
| | 2712 | following constants: |
| | 2713 | |
| | 2714 | </p><ul> |
| | 2715 | <li><code>CUPS_CREDTYPE_DEFAULT</code>: default type (RSA-3072 or P-384), |
| | 2716 | </li> |
| | 2717 | <li><code>CUPS_CREDTYPE_RSA_2048_SHA256</code>: RSA with 2048-bit keys and SHA-256 hash, |
| | 2718 | </li> |
| | 2719 | <li><code>CUPS_CREDTYPE_RSA_3072_SHA256</code>: RSA with 3072-bit keys and SHA-256 hash, |
| | 2720 | </li> |
| | 2721 | <li><code>CUPS_CREDTYPE_RSA_4096_SHA256</code>: RSA with 4096-bit keys and SHA-256 hash, |
| | 2722 | </li> |
| | 2723 | <li><code>CUPS_CREDTYPE_ECDSA_P256_SHA256</code>: ECDSA using the P-256 curve with SHA-256 hash, |
| | 2724 | </li> |
| | 2725 | <li><code>CUPS_CREDTYPE_ECDSA_P384_SHA256</code>: ECDSA using the P-384 curve with SHA-256 hash, or |
| | 2726 | </li> |
| | 2727 | <li><code>CUPS_CREDTYPE_ECDSA_P521_SHA256</code>: ECDSA using the P-521 curve with SHA-256 hash.</li> |
| | 2728 | </ul> |
| | 2729 | <p class="discussion">The "usage" argument specifies the usage(s) for the credentials as a bitwise |
| | 2730 | OR of the following constants: |
| | 2731 | |
| | 2732 | </p><ul> |
| | 2733 | <li><code>CUPS_CREDUSAGE_DIGITAL_SIGNATURE</code>: digital signatures, |
| | 2734 | </li> |
| | 2735 | <li><code>CUPS_CREDUSAGE_NON_REPUDIATION</code>: non-repudiation/content commitment, |
| | 2736 | </li> |
| | 2737 | <li><code>CUPS_CREDUSAGE_KEY_ENCIPHERMENT</code>: key encipherment, |
| | 2738 | </li> |
| | 2739 | <li><code>CUPS_CREDUSAGE_DATA_ENCIPHERMENT</code>: data encipherment, |
| | 2740 | </li> |
| | 2741 | <li><code>CUPS_CREDUSAGE_KEY_AGREEMENT</code>: key agreement, |
| | 2742 | </li> |
| | 2743 | <li><code>CUPS_CREDUSAGE_KEY_CERT_SIGN</code>: key certicate signing, |
| | 2744 | </li> |
| | 2745 | <li><code>CUPS_CREDUSAGE_CRL_SIGN</code>: certificate revocation list signing, |
| | 2746 | </li> |
| | 2747 | <li><code>CUPS_CREDUSAGE_ENCIPHER_ONLY</code>: encipherment only, |
| | 2748 | </li> |
| | 2749 | <li><code>CUPS_CREDUSAGE_DECIPHER_ONLY</code>: decipherment only, |
| | 2750 | </li> |
| | 2751 | <li><code>CUPS_CREDUSAGE_DEFAULT_CA</code>: defaults for CA certificates, |
| | 2752 | </li> |
| | 2753 | <li><code>CUPS_CREDUSAGE_DEFAULT_TLS</code>: defaults for TLS certificates, and/or |
| | 2754 | </li> |
| | 2755 | <li><code>CUPS_CREDUSAGE_ALL</code>: all usages.</li> |
| | 2756 | </ul> |
| | 2757 | <p class="discussion">The "organization", "org_unit", "locality", "state_province", and "country" |
| | 2758 | arguments specify information about the identity and geolocation of the |
| | 2759 | issuer.<br> |
| | 2760 | <br> |
| | 2761 | The "common_name" argument specifies the common name and the "num_alt_names" |
| | 2762 | and "alt_names" arguments specify a list of DNS hostnames for the |
| | 2763 | certificate.<br> |
| | 2764 | <br> |
| | 2765 | The "expiration_date" argument specifies the expiration date and time as a |
| | 2766 | Unix <code>time_t</code> value in seconds.</p> |
| | 2767 | <h3 class="function"><a id="cupsCreateCredentialsRequest">cupsCreateCredentialsRequest</a></h3> |
| | 2768 | <p class="description">Make an X.509 Certificate Signing Request.</p> |
| | 2769 | <p class="code"> |
| | 2770 | <span class="reserved">bool</span> cupsCreateCredentialsRequest(<span class="reserved">const</span> <span class="reserved">char</span> *path, <a href="#cups_credpurpose_t">cups_credpurpose_t</a> purpose, <a href="#cups_credtype_t">cups_credtype_t</a> type, <a href="#cups_credusage_t">cups_credusage_t</a> usage, <span class="reserved">const</span> <span class="reserved">char</span> *organization, <span class="reserved">const</span> <span class="reserved">char</span> *org_unit, <span class="reserved">const</span> <span class="reserved">char</span> *locality, <span class="reserved">const</span> <span class="reserved">char</span> *state_province, <span class="reserved">const</span> <span class="reserved">char</span> *country, <span class="reserved">const</span> <span class="reserved">char</span> *common_name, <span class="reserved">const</span> <span class="reserved">char</span> *email, size_t num_alt_names, <span class="reserved">const</span> <span class="reserved">char</span> *const *alt_names);</p> |
| | 2771 | <h4 class="parameters">Parameters</h4> |
| | 2772 | <table class="list"><tbody> |
| | 2773 | <tr><th>path</th> |
| | 2774 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 2775 | <tr><th>purpose</th> |
| | 2776 | <td class="description">Credential purposes</td></tr> |
| | 2777 | <tr><th>type</th> |
| | 2778 | <td class="description">Credential type</td></tr> |
| | 2779 | <tr><th>usage</th> |
| | 2780 | <td class="description">Credential usages</td></tr> |
| | 2781 | <tr><th>organization</th> |
| | 2782 | <td class="description">Organization or <code>NULL</code> to use common name</td></tr> |
| | 2783 | <tr><th>org_unit</th> |
| | 2784 | <td class="description">Organizational unit or <code>NULL</code> for none</td></tr> |
| | 2785 | <tr><th>locality</th> |
| | 2786 | <td class="description">City/town or <code>NULL</code> for "Unknown"</td></tr> |
| | 2787 | <tr><th>state_province</th> |
| | 2788 | <td class="description">State/province or <code>NULL</code> for "Unknown"</td></tr> |
| | 2789 | <tr><th>country</th> |
| | 2790 | <td class="description">Country or <code>NULL</code> for locale-based default</td></tr> |
| | 2791 | <tr><th>common_name</th> |
| | 2792 | <td class="description">Common name</td></tr> |
| | 2793 | <tr><th>email</th> |
| | 2794 | <td class="description">Email address or <code>NULL</code> for none</td></tr> |
| | 2795 | <tr><th>num_alt_names</th> |
| | 2796 | <td class="description">Number of subject alternate names</td></tr> |
| | 2797 | <tr><th>alt_names</th> |
| | 2798 | <td class="description">Subject Alternate Names</td></tr> |
| | 2799 | </tbody></table> |
| | 2800 | <h4 class="returnvalue">Return Value</h4> |
| | 2801 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 2802 | <h4 class="discussion">Discussion</h4> |
| | 2803 | <p class="discussion">This function creates an X.509 certificate signing request (CSR) and |
| | 2804 | associated private key. The CSR and key are stored in the directory "path" |
| | 2805 | or, if "path" is <code>NULL</code>, in a per-user or system-wide (when running as root) |
| | 2806 | certificate/key store.<br> |
| | 2807 | <br> |
| | 2808 | The "purpose" argument specifies the purpose(s) used for the credentials as a |
| | 2809 | bitwise OR of the following constants: |
| | 2810 | |
| | 2811 | </p><ul> |
| | 2812 | <li><code>CUPS_CREDPURPOSE_SERVER_AUTH</code> for validating TLS servers, |
| | 2813 | </li> |
| | 2814 | <li><code>CUPS_CREDPURPOSE_CLIENT_AUTH</code> for validating TLS clients, |
| | 2815 | </li> |
| | 2816 | <li><code>CUPS_CREDPURPOSE_CODE_SIGNING</code> for validating compiled code, |
| | 2817 | </li> |
| | 2818 | <li><code>CUPS_CREDPURPOSE_EMAIL_PROTECTION</code> for validating email messages, |
| | 2819 | </li> |
| | 2820 | <li><code>CUPS_CREDPURPOSE_TIME_STAMPING</code> for signing timestamps to objects, and/or |
| | 2821 | </li> |
| | 2822 | <li><code>CUPS_CREDPURPOSE_OCSP_SIGNING</code> for Online Certificate Status Protocol |
| | 2823 | message signing.</li> |
| | 2824 | </ul> |
| | 2825 | <p class="discussion">The "type" argument specifies the type of credentials using one of the |
| | 2826 | following constants: |
| | 2827 | |
| | 2828 | </p><ul> |
| | 2829 | <li><code>CUPS_CREDTYPE_DEFAULT</code>: default type (RSA-3072 or P-384), |
| | 2830 | </li> |
| | 2831 | <li><code>CUPS_CREDTYPE_RSA_2048_SHA256</code>: RSA with 2048-bit keys and SHA-256 hash, |
| | 2832 | </li> |
| | 2833 | <li><code>CUPS_CREDTYPE_RSA_3072_SHA256</code>: RSA with 3072-bit keys and SHA-256 hash, |
| | 2834 | </li> |
| | 2835 | <li><code>CUPS_CREDTYPE_RSA_4096_SHA256</code>: RSA with 4096-bit keys and SHA-256 hash, |
| | 2836 | </li> |
| | 2837 | <li><code>CUPS_CREDTYPE_ECDSA_P256_SHA256</code>: ECDSA using the P-256 curve with SHA-256 hash, |
| | 2838 | </li> |
| | 2839 | <li><code>CUPS_CREDTYPE_ECDSA_P384_SHA256</code>: ECDSA using the P-384 curve with SHA-256 hash, or |
| | 2840 | </li> |
| | 2841 | <li><code>CUPS_CREDTYPE_ECDSA_P521_SHA256</code>: ECDSA using the P-521 curve with SHA-256 hash.</li> |
| | 2842 | </ul> |
| | 2843 | <p class="discussion">The "usage" argument specifies the usage(s) for the credentials as a bitwise |
| | 2844 | OR of the following constants: |
| | 2845 | |
| | 2846 | </p><ul> |
| | 2847 | <li><code>CUPS_CREDUSAGE_DIGITAL_SIGNATURE</code>: digital signatures, |
| | 2848 | </li> |
| | 2849 | <li><code>CUPS_CREDUSAGE_NON_REPUDIATION</code>: non-repudiation/content commitment, |
| | 2850 | </li> |
| | 2851 | <li><code>CUPS_CREDUSAGE_KEY_ENCIPHERMENT</code>: key encipherment, |
| | 2852 | </li> |
| | 2853 | <li><code>CUPS_CREDUSAGE_DATA_ENCIPHERMENT</code>: data encipherment, |
| | 2854 | </li> |
| | 2855 | <li><code>CUPS_CREDUSAGE_KEY_AGREEMENT</code>: key agreement, |
| | 2856 | </li> |
| | 2857 | <li><code>CUPS_CREDUSAGE_KEY_CERT_SIGN</code>: key certicate signing, |
| | 2858 | </li> |
| | 2859 | <li><code>CUPS_CREDUSAGE_CRL_SIGN</code>: certificate revocation list signing, |
| | 2860 | </li> |
| | 2861 | <li><code>CUPS_CREDUSAGE_ENCIPHER_ONLY</code>: encipherment only, |
| | 2862 | </li> |
| | 2863 | <li><code>CUPS_CREDUSAGE_DECIPHER_ONLY</code>: decipherment only, |
| | 2864 | </li> |
| | 2865 | <li><code>CUPS_CREDUSAGE_DEFAULT_CA</code>: defaults for CA certificates, |
| | 2866 | </li> |
| | 2867 | <li><code>CUPS_CREDUSAGE_DEFAULT_TLS</code>: defaults for TLS certificates, and/or |
| | 2868 | </li> |
| | 2869 | <li><code>CUPS_CREDUSAGE_ALL</code>: all usages.</li> |
| | 2870 | </ul> |
| | 2871 | <p class="discussion">The "organization", "org_unit", "locality", "state_province", and "country" |
| | 2872 | arguments specify information about the identity and geolocation of the |
| | 2873 | issuer.<br> |
| | 2874 | <br> |
| | 2875 | The "common_name" argument specifies the common name and the "num_alt_names" |
| | 2876 | and "alt_names" arguments specify a list of DNS hostnames for the |
| | 2877 | certificate.</p> |
| | 2878 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsCreateDestJob">cupsCreateDestJob</a></h3> |
| | 2879 | <p class="description">Create a job on a destination.</p> |
| | 2880 | <p class="code"> |
| | 2881 | 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, <span class="reserved">int</span> *job_id, <span class="reserved">const</span> <span class="reserved">char</span> *title, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| | 2882 | <h4 class="parameters">Parameters</h4> |
| | 2883 | <table class="list"><tbody> |
| | 2884 | <tr><th>http</th> |
| | 2885 | <td class="description">Connection to destination</td></tr> |
| | 2886 | <tr><th>dest</th> |
| | 2887 | <td class="description">Destination</td></tr> |
| | 2888 | <tr><th>info</th> |
| | 2889 | <td class="description">Destination information</td></tr> |
| | 2890 | <tr><th>job_id</th> |
| | 2891 | <td class="description">Job ID or 0 on error</td></tr> |
| | 2892 | <tr><th>title</th> |
| | 2893 | <td class="description">Job name</td></tr> |
| | 2894 | <tr><th>num_options</th> |
| | 2895 | <td class="description">Number of job options</td></tr> |
| | 2896 | <tr><th>options</th> |
| | 2897 | <td class="description">Job options</td></tr> |
| | 2898 | </tbody></table> |
| | 2899 | <h4 class="returnvalue">Return Value</h4> |
| | 2900 | <p class="description">IPP status code</p> |
| | 2901 | <h4 class="discussion">Discussion</h4> |
| | 2902 | <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success, saving the job ID |
| | 2903 | in the variable pointed to by "job_id". |
| | 2904 | |
| | 2905 | </p> |
| | 2906 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsCreateTempFd">cupsCreateTempFd</a></h3> |
| | 2907 | <p class="description">Creates a temporary file descriptor.</p> |
| | 2908 | <p class="code"> |
| | 2909 | <span class="reserved">int</span> cupsCreateTempFd(<span class="reserved">const</span> <span class="reserved">char</span> *prefix, <span class="reserved">const</span> <span class="reserved">char</span> *suffix, <span class="reserved">char</span> *filename, size_t len);</p> |
| | 2910 | <h4 class="parameters">Parameters</h4> |
| | 2911 | <table class="list"><tbody> |
| | 2912 | <tr><th>prefix</th> |
| | 2913 | <td class="description">Filename prefix or <code>NULL</code> for none</td></tr> |
| | 2914 | <tr><th>suffix</th> |
| | 2915 | <td class="description">Filename suffix or <code>NULL</code> for none</td></tr> |
| | 2916 | <tr><th>filename</th> |
| | 2917 | <td class="description">Pointer to buffer</td></tr> |
| | 2918 | <tr><th>len</th> |
| | 2919 | <td class="description">Size of buffer</td></tr> |
| | 2920 | </tbody></table> |
| | 2921 | <h4 class="returnvalue">Return Value</h4> |
| | 2922 | <p class="description">New file descriptor or <code>-1</code> on error</p> |
| | 2923 | <h4 class="discussion">Discussion</h4> |
| | 2924 | <p class="discussion">This function creates a temporary file and associated descriptor. The unique |
| | 2925 | temporary filename uses the "prefix" and "suffix" arguments and is returned |
| | 2926 | in the "filename" buffer. The temporary file is opened for reading and |
| | 2927 | writing. |
| | 2928 | |
| | 2929 | </p> |
| | 2930 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsCreateTempFile">cupsCreateTempFile</a></h3> |
| | 2931 | <p class="description">Creates a temporary CUPS file.</p> |
| | 2932 | <p class="code"> |
| | 2933 | <a href="#cups_file_t">cups_file_t</a> *cupsCreateTempFile(<span class="reserved">const</span> <span class="reserved">char</span> *prefix, <span class="reserved">const</span> <span class="reserved">char</span> *suffix, <span class="reserved">char</span> *filename, size_t len);</p> |
| | 2934 | <h4 class="parameters">Parameters</h4> |
| | 2935 | <table class="list"><tbody> |
| | 2936 | <tr><th>prefix</th> |
| | 2937 | <td class="description">Filename prefix or <code>NULL</code> for none</td></tr> |
| | 2938 | <tr><th>suffix</th> |
| | 2939 | <td class="description">Filename suffix or <code>NULL</code> for none</td></tr> |
| | 2940 | <tr><th>filename</th> |
| | 2941 | <td class="description">Pointer to buffer</td></tr> |
| | 2942 | <tr><th>len</th> |
| | 2943 | <td class="description">Size of buffer</td></tr> |
| | 2944 | </tbody></table> |
| | 2945 | <h4 class="returnvalue">Return Value</h4> |
| | 2946 | <p class="description">CUPS file or <code>NULL</code> on error</p> |
| | 2947 | <h4 class="discussion">Discussion</h4> |
| | 2948 | <p class="discussion">This function creates a temporary file and returns a CUPS file for it. The |
| | 2949 | unique temporary filename uses the "prefix" and "suffix" arguments and is |
| | 2950 | returned in the "filename" buffer. The temporary file is opened for writing. |
| | 2951 | |
| | 2952 | </p> |
| | 2953 | <h3 class="function"><a id="cupsDNSSDAssembleFullName">cupsDNSSDAssembleFullName</a></h3> |
| | 2954 | <p class="description">Create a full service name from the instance |
| | 2955 | name, registration type, and domain.</p> |
| | 2956 | <p class="code"> |
| | 2957 | <span class="reserved">bool</span> cupsDNSSDAssembleFullName(<span class="reserved">char</span> *fullname, size_t fullsize, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *type, <span class="reserved">const</span> <span class="reserved">char</span> *domain);</p> |
| | 2958 | <h4 class="parameters">Parameters</h4> |
| | 2959 | <table class="list"><tbody> |
| | 2960 | <tr><th>fullname</th> |
| | 2961 | <td class="description">Buffer for full name</td></tr> |
| | 2962 | <tr><th>fullsize</th> |
| | 2963 | <td class="description">Size of buffer</td></tr> |
| | 2964 | <tr><th>name</th> |
| | 2965 | <td class="description">Service instance name</td></tr> |
| | 2966 | <tr><th>type</th> |
| | 2967 | <td class="description">Registration type</td></tr> |
| | 2968 | <tr><th>domain</th> |
| | 2969 | <td class="description">Domain</td></tr> |
| | 2970 | </tbody></table> |
| | 2971 | <h4 class="returnvalue">Return Value</h4> |
| | 2972 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 2973 | <h4 class="discussion">Discussion</h4> |
| | 2974 | <p class="discussion">This function combines an instance name ("Example Name"), registration type |
| | 2975 | ("_ipp._tcp"), and domain ("local.") to create a properly escaped full |
| | 2976 | service name ("Example032Name._ipp._tcp.local.").</p> |
| | 2977 | <h3 class="function"><a id="cupsDNSSDBrowseDelete">cupsDNSSDBrowseDelete</a></h3> |
| | 2978 | <p class="description">Cancel and delete a browse request.</p> |
| | 2979 | <p class="code"> |
| | 2980 | <span class="reserved">void</span> cupsDNSSDBrowseDelete(<a href="#cups_dnssd_browse_t">cups_dnssd_browse_t</a> *browse);</p> |
| | 2981 | <h4 class="parameters">Parameters</h4> |
| | 2982 | <table class="list"><tbody> |
| | 2983 | <tr><th>browse</th> |
| | 2984 | <td class="description">Browse request</td></tr> |
| | 2985 | </tbody></table> |
| | 2986 | <h3 class="function"><a id="cupsDNSSDBrowseGetContext">cupsDNSSDBrowseGetContext</a></h3> |
| | 2987 | <p class="description">Get the DNS-SD context for the browse request.</p> |
| | 2988 | <p class="code"> |
| | 2989 | <a href="#cups_dnssd_t">cups_dnssd_t</a> *cupsDNSSDBrowseGetContext(<a href="#cups_dnssd_browse_t">cups_dnssd_browse_t</a> *browse);</p> |
| | 2990 | <h4 class="parameters">Parameters</h4> |
| | 2991 | <table class="list"><tbody> |
| | 2992 | <tr><th>browse</th> |
| | 2993 | <td class="description">Browse request</td></tr> |
| | 2994 | </tbody></table> |
| | 2995 | <h4 class="returnvalue">Return Value</h4> |
| | 2996 | <p class="description">Context or <code>NULL</code></p> |
| | 2997 | <h3 class="function"><a id="cupsDNSSDBrowseNew">cupsDNSSDBrowseNew</a></h3> |
| | 2998 | <p class="description">Create a new DNS-SD browse request.</p> |
| | 2999 | <p class="code"> |
| | 3000 | <a href="#cups_dnssd_browse_t">cups_dnssd_browse_t</a> *cupsDNSSDBrowseNew(<a href="#cups_dnssd_t">cups_dnssd_t</a> *dnssd, uint32_t if_index, <span class="reserved">const</span> <span class="reserved">char</span> *types, <span class="reserved">const</span> <span class="reserved">char</span> *domain, <a href="#cups_dnssd_browse_cb_t">cups_dnssd_browse_cb_t</a> browse_cb, <span class="reserved">void</span> *cb_data);</p> |
| | 3001 | <h4 class="parameters">Parameters</h4> |
| | 3002 | <table class="list"><tbody> |
| | 3003 | <tr><th>dnssd</th> |
| | 3004 | <td class="description">DNS-SD context</td></tr> |
| | 3005 | <tr><th>if_index</th> |
| | 3006 | <td class="description">Interface index, <code>CUPS_DNSSD_IF_INDEX_ANY</code>, or <code>CUPS_DNSSD_IF_INDEX_LOCAL</code></td></tr> |
| | 3007 | <tr><th>types</th> |
| | 3008 | <td class="description">Service types</td></tr> |
| | 3009 | <tr><th>domain</th> |
| | 3010 | <td class="description">Domain name or <code>NULL</code> for default</td></tr> |
| | 3011 | <tr><th>browse_cb</th> |
| | 3012 | <td class="description">Browse callback function</td></tr> |
| | 3013 | <tr><th>cb_data</th> |
| | 3014 | <td class="description">Browse callback data</td></tr> |
| | 3015 | </tbody></table> |
| | 3016 | <h4 class="returnvalue">Return Value</h4> |
| | 3017 | <p class="description">Browse request or <code>NULL</code> on error</p> |
| | 3018 | <h4 class="discussion">Discussion</h4> |
| | 3019 | <p class="discussion">This function creates a new DNS-SD browse request for the specified service |
| | 3020 | types and optional domain and interface index. The "types" argument can be a |
| | 3021 | single service type ("_ipp._tcp") or a service type and comma-delimited list |
| | 3022 | of sub-types ("_ipp._tcp,_print,_universal").<br> |
| | 3023 | <br> |
| | 3024 | Newly discovered services are reported using the required browse callback |
| | 3025 | function, with the "flags" argument set to <code>CUPS_DNSSD_FLAGS_ADD</code> for newly |
| | 3026 | discovered services, <code>CUPS_DNSSD_FLAGS_NONE</code> for removed services, or |
| | 3027 | <code>CUPS_DNSSD_FLAGS_ERROR</code> on an error: |
| | 3028 | |
| | 3029 | <pre> |
| | 3030 | void |
| | 3031 | browse_cb( |
| | 3032 | cups_dnssd_browse_t *browse, |
| | 3033 | void *cb_data, |
| | 3034 | cups_dnssd_flags_t flags, |
| | 3035 | uint32_t if_index, |
| | 3036 | const char *name, |
| | 3037 | const char *regtype, |
| | 3038 | const char *domain) |
| | 3039 | { |
| | 3040 | // Process added/removed service |
| | 3041 | } |
| | 3042 | </pre> |
| | 3043 | </p> |
| | 3044 | <h3 class="function"><a id="cupsDNSSDCopyComputerName">cupsDNSSDCopyComputerName</a></h3> |
| | 3045 | <p class="description">Copy the current human-readable name for the system.</p> |
| | 3046 | <p class="code"> |
| | 3047 | <span class="reserved">char</span> *cupsDNSSDCopyComputerName(<a href="#cups_dnssd_t">cups_dnssd_t</a> *dnssd, <span class="reserved">char</span> *buffer, size_t bufsize);</p> |
| | 3048 | <h4 class="parameters">Parameters</h4> |
| | 3049 | <table class="list"><tbody> |
| | 3050 | <tr><th>dnssd</th> |
| | 3051 | <td class="description">DNS-SD context</td></tr> |
| | 3052 | <tr><th>buffer</th> |
| | 3053 | <td class="description">Computer name buffer</td></tr> |
| | 3054 | <tr><th>bufsize</th> |
| | 3055 | <td class="description">Size of computer name buffer (at least 128 bytes)</td></tr> |
| | 3056 | </tbody></table> |
| | 3057 | <h4 class="returnvalue">Return Value</h4> |
| | 3058 | <p class="description">Computer name or <code>NULL</code> on error</p> |
| | 3059 | <h4 class="discussion">Discussion</h4> |
| | 3060 | <p class="discussion">This function copies the current human-readable name ("My Computer") to the |
| | 3061 | provided buffer. The "dnssd" parameter is a DNS-SD context created with |
| | 3062 | <a href="#cupsDNSSDNew"><code>cupsDNSSDNew</code></a>. The "buffer" parameter points to a character array of |
| | 3063 | at least 128 bytes and the "bufsize" parameter specifies the actual size of |
| | 3064 | the array.</p> |
| | 3065 | <h3 class="function"><a id="cupsDNSSDCopyHostName">cupsDNSSDCopyHostName</a></h3> |
| | 3066 | <p class="description">Copy the current mDNS hostname for the system.</p> |
| | 3067 | <p class="code"> |
| | 3068 | <span class="reserved">char</span> *cupsDNSSDCopyHostName(<a href="#cups_dnssd_t">cups_dnssd_t</a> *dnssd, <span class="reserved">char</span> *buffer, size_t bufsize);</p> |
| | 3069 | <h4 class="parameters">Parameters</h4> |
| | 3070 | <table class="list"><tbody> |
| | 3071 | <tr><th>dnssd</th> |
| | 3072 | <td class="description">DNS-SD context</td></tr> |
| | 3073 | <tr><th>buffer</th> |
| | 3074 | <td class="description">Hostname buffer</td></tr> |
| | 3075 | <tr><th>bufsize</th> |
| | 3076 | <td class="description">Size of hostname buffer (at least 70 bytes)</td></tr> |
| | 3077 | </tbody></table> |
| | 3078 | <h4 class="returnvalue">Return Value</h4> |
| | 3079 | <p class="description">mDNS hostname or <code>NULL</code> on error</p> |
| | 3080 | <h4 class="discussion">Discussion</h4> |
| | 3081 | <p class="discussion">This function copies the current mDNS hostname ("hostname.local") to the |
| | 3082 | provided buffer. The "dnssd" parameter is a DNS-SD context created with |
| | 3083 | <a href="#cupsDNSSDNew"><code>cupsDNSSDNew</code></a>. The "buffer" parameter points to a character array of |
| | 3084 | at least 70 bytes and the "bufsize" parameter specifies the actual size of |
| | 3085 | the array.</p> |
| | 3086 | <h3 class="function"><a id="cupsDNSSDDecodeTXT">cupsDNSSDDecodeTXT</a></h3> |
| | 3087 | <p class="description">Decode a TXT record into key/value pairs.</p> |
| | 3088 | <p class="code"> |
| | 3089 | <span class="reserved">int</span> cupsDNSSDDecodeTXT(<span class="reserved">const</span> <span class="reserved">unsigned</span> <span class="reserved">char</span> *txtrec, uint16_t txtlen, <a href="#cups_option_t">cups_option_t</a> **txt);</p> |
| | 3090 | <h4 class="parameters">Parameters</h4> |
| | 3091 | <table class="list"><tbody> |
| | 3092 | <tr><th>txtrec</th> |
| | 3093 | <td class="description">TXT record data</td></tr> |
| | 3094 | <tr><th>txtlen</th> |
| | 3095 | <td class="description">TXT record length</td></tr> |
| | 3096 | <tr><th>txt</th> |
| | 3097 | <td class="description">Key/value pairs</td></tr> |
| | 3098 | </tbody></table> |
| | 3099 | <h4 class="returnvalue">Return Value</h4> |
| | 3100 | <p class="description">Number of key/value pairs</p> |
| | 3101 | <h4 class="discussion">Discussion</h4> |
| | 3102 | <p class="discussion">This function converts the DNS TXT record encoding of key/value pairs into |
| | 3103 | <code>cups_option_t</code> elements that can be accessed using the <a href="#cupsGetOption"><code>cupsGetOption</code></a> |
| | 3104 | function and freed using the <a href="#cupsFreeOptions"><code>cupsFreeOptions</code></a> function.</p> |
| | 3105 | <h3 class="function"><a id="cupsDNSSDDelete">cupsDNSSDDelete</a></h3> |
| | 3106 | <p class="description">Delete a DNS-SD context and all its requests.</p> |
| | 3107 | <p class="code"> |
| | 3108 | <span class="reserved">void</span> cupsDNSSDDelete(<a href="#cups_dnssd_t">cups_dnssd_t</a> *dnssd);</p> |
| | 3109 | <h4 class="parameters">Parameters</h4> |
| | 3110 | <table class="list"><tbody> |
| | 3111 | <tr><th>dnssd</th> |
| | 3112 | <td class="description">DNS-SD context</td></tr> |
| | 3113 | </tbody></table> |
| | 3114 | <h3 class="function"><a id="cupsDNSSDGetConfigChanges">cupsDNSSDGetConfigChanges</a></h3> |
| | 3115 | <p class="description">Get the number of host name/network |
| | 3116 | configuration changes seen.</p> |
| | 3117 | <p class="code"> |
| | 3118 | size_t cupsDNSSDGetConfigChanges(<a href="#cups_dnssd_t">cups_dnssd_t</a> *dnssd);</p> |
| | 3119 | <h4 class="parameters">Parameters</h4> |
| | 3120 | <table class="list"><tbody> |
| | 3121 | <tr><th>dnssd</th> |
| | 3122 | <td class="description">DNS-SD context</td></tr> |
| | 3123 | </tbody></table> |
| | 3124 | <h4 class="returnvalue">Return Value</h4> |
| | 3125 | <p class="description">Number of host name changes</p> |
| | 3126 | <h4 class="discussion">Discussion</h4> |
| | 3127 | <p class="discussion">This function returns the number of host name or network configuration |
| | 3128 | changes that have been seen since the context was created. The value can be |
| | 3129 | used to track when local services need to be updated. Registered services |
| | 3130 | will also get a callback with the <code>CUPS_DNSSD_FLAGS_HOST_CHANGE</code> bit set in |
| | 3131 | the "flags" argument for host name changes and/or |
| | 3132 | <code>CUPS_DNSSD_FLAGS_NETWORK_CHANGE</code> for network changes.</p> |
| | 3133 | <h3 class="function"><a id="cupsDNSSDNew">cupsDNSSDNew</a></h3> |
| | 3134 | <p class="description">Create a new DNS-SD context.</p> |
| | 3135 | <p class="code"> |
| | 3136 | <a href="#cups_dnssd_t">cups_dnssd_t</a> *cupsDNSSDNew(<a href="#cups_dnssd_error_cb_t">cups_dnssd_error_cb_t</a> error_cb, <span class="reserved">void</span> *cb_data);</p> |
| | 3137 | <h4 class="parameters">Parameters</h4> |
| | 3138 | <table class="list"><tbody> |
| | 3139 | <tr><th>error_cb</th> |
| | 3140 | <td class="description">Error callback function</td></tr> |
| | 3141 | <tr><th>cb_data</th> |
| | 3142 | <td class="description">Error callback data</td></tr> |
| | 3143 | </tbody></table> |
| | 3144 | <h4 class="returnvalue">Return Value</h4> |
| | 3145 | <p class="description">DNS-SD context</p> |
| | 3146 | <h4 class="discussion">Discussion</h4> |
| | 3147 | <p class="discussion">This function creates a new DNS-SD context for browsing, querying, resolving, |
| | 3148 | and/or registering services. Call <a href="#cupsDNSSDDelete"><code>cupsDNSSDDelete</code></a> to stop any pending |
| | 3149 | browses, queries, or resolves, unregister any services, and free the DNS-SD |
| | 3150 | context.</p> |
| | 3151 | <h3 class="function"><a id="cupsDNSSDQueryDelete">cupsDNSSDQueryDelete</a></h3> |
| | 3152 | <p class="description">Cancel and delete a query request.</p> |
| | 3153 | <p class="code"> |
| | 3154 | <span class="reserved">void</span> cupsDNSSDQueryDelete(<a href="#cups_dnssd_query_t">cups_dnssd_query_t</a> *query);</p> |
| | 3155 | <h4 class="parameters">Parameters</h4> |
| | 3156 | <table class="list"><tbody> |
| | 3157 | <tr><th>query</th> |
| | 3158 | <td class="description">Query request</td></tr> |
| | 3159 | </tbody></table> |
| | 3160 | <h3 class="function"><a id="cupsDNSSDQueryGetContext">cupsDNSSDQueryGetContext</a></h3> |
| | 3161 | <p class="description">Get the DNS-SD context for the query request.</p> |
| | 3162 | <p class="code"> |
| | 3163 | <a href="#cups_dnssd_t">cups_dnssd_t</a> *cupsDNSSDQueryGetContext(<a href="#cups_dnssd_query_t">cups_dnssd_query_t</a> *query);</p> |
| | 3164 | <h4 class="parameters">Parameters</h4> |
| | 3165 | <table class="list"><tbody> |
| | 3166 | <tr><th>query</th> |
| | 3167 | <td class="description">Query request</td></tr> |
| | 3168 | </tbody></table> |
| | 3169 | <h4 class="returnvalue">Return Value</h4> |
| | 3170 | <p class="description">DNS-SD context or <code>NULL</code></p> |
| | 3171 | <h3 class="function"><a id="cupsDNSSDQueryNew">cupsDNSSDQueryNew</a></h3> |
| | 3172 | <p class="description">Create a new query request.</p> |
| | 3173 | <p class="code"> |
| | 3174 | <a href="#cups_dnssd_query_t">cups_dnssd_query_t</a> *cupsDNSSDQueryNew(<a href="#cups_dnssd_t">cups_dnssd_t</a> *dnssd, uint32_t if_index, <span class="reserved">const</span> <span class="reserved">char</span> *fullname, uint16_t rrtype, <a href="#cups_dnssd_query_cb_t">cups_dnssd_query_cb_t</a> query_cb, <span class="reserved">void</span> *cb_data);</p> |
| | 3175 | <h4 class="parameters">Parameters</h4> |
| | 3176 | <table class="list"><tbody> |
| | 3177 | <tr><th>dnssd</th> |
| | 3178 | <td class="description">DNS-SD context</td></tr> |
| | 3179 | <tr><th>if_index</th> |
| | 3180 | <td class="description">Interface index or <code>CUPS_DNSSD_IF_INDEX_ANY</code> or <code>CUPS_DNSSD_IF_INDEX_LOCAL</code></td></tr> |
| | 3181 | <tr><th>fullname</th> |
| | 3182 | <td class="description">Full DNS name including types and domain</td></tr> |
| | 3183 | <tr><th>rrtype</th> |
| | 3184 | <td class="description">Record type to query (<code>CUPS_DNSSD_RRTYPE_TXT</code>, etc.)</td></tr> |
| | 3185 | <tr><th>query_cb</th> |
| | 3186 | <td class="description">Query callback function</td></tr> |
| | 3187 | <tr><th>cb_data</th> |
| | 3188 | <td class="description">Query callback data</td></tr> |
| | 3189 | </tbody></table> |
| | 3190 | <h4 class="returnvalue">Return Value</h4> |
| | 3191 | <p class="description">Query request or <code>NULL</code> on error</p> |
| | 3192 | <h4 class="discussion">Discussion</h4> |
| | 3193 | <p class="discussion">This function creates a new DNS-SD query request for the specified full |
| | 3194 | service name and DNS record type. The "fullname" parameter specifies the |
| | 3195 | full DNS name of the service (instance name, type, and domain) being queried. |
| | 3196 | Responses to the query are reported using the required query callback |
| | 3197 | function with the "flags" argument set to <code>CUPS_DNSSD_FLAGS_NONE</code> on success |
| | 3198 | or <code>CUPS_DNSSD_FLAGS_ERROR</code> on error: |
| | 3199 | |
| | 3200 | <pre> |
| | 3201 | void |
| | 3202 | query_cb( |
| | 3203 | cups_dnssd_query_t *query, |
| | 3204 | void *cb_data, |
| | 3205 | cups_dnssd_flags_t flags, |
| | 3206 | uint32_t if_index, |
| | 3207 | const char *fullname, |
| | 3208 | uint16_t rrtype, |
| | 3209 | const void *qdata, |
| | 3210 | uint16_t qlen) |
| | 3211 | { |
| | 3212 | // Process query record |
| | 3213 | } |
| | 3214 | </pre> |
| | 3215 | </p> |
| | 3216 | <h3 class="function"><a id="cupsDNSSDResolveDelete">cupsDNSSDResolveDelete</a></h3> |
| | 3217 | <p class="description">Cancel and free a resolve request.</p> |
| | 3218 | <p class="code"> |
| | 3219 | <span class="reserved">void</span> cupsDNSSDResolveDelete(<a href="#cups_dnssd_resolve_t">cups_dnssd_resolve_t</a> *res);</p> |
| | 3220 | <h4 class="parameters">Parameters</h4> |
| | 3221 | <table class="list"><tbody> |
| | 3222 | <tr><th>res</th> |
| | 3223 | <td class="description">Resolve request</td></tr> |
| | 3224 | </tbody></table> |
| | 3225 | <h3 class="function"><a id="cupsDNSSDResolveGetContext">cupsDNSSDResolveGetContext</a></h3> |
| | 3226 | <p class="description">Get the DNS-SD context for the resolve request.</p> |
| | 3227 | <p class="code"> |
| | 3228 | <a href="#cups_dnssd_t">cups_dnssd_t</a> *cupsDNSSDResolveGetContext(<a href="#cups_dnssd_resolve_t">cups_dnssd_resolve_t</a> *resolve);</p> |
| | 3229 | <h4 class="parameters">Parameters</h4> |
| | 3230 | <table class="list"><tbody> |
| | 3231 | <tr><th>resolve</th> |
| | 3232 | <td class="description">Resolve request</td></tr> |
| | 3233 | </tbody></table> |
| | 3234 | <h4 class="returnvalue">Return Value</h4> |
| | 3235 | <p class="description">DNS-SD context or <code>NULL</code></p> |
| | 3236 | <h3 class="function"><a id="cupsDNSSDResolveNew">cupsDNSSDResolveNew</a></h3> |
| | 3237 | <p class="description">Create a new DNS-SD resolve request.</p> |
| | 3238 | <p class="code"> |
| | 3239 | <a href="#cups_dnssd_resolve_t">cups_dnssd_resolve_t</a> *cupsDNSSDResolveNew(<a href="#cups_dnssd_t">cups_dnssd_t</a> *dnssd, uint32_t if_index, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *type, <span class="reserved">const</span> <span class="reserved">char</span> *domain, <a href="#cups_dnssd_resolve_cb_t">cups_dnssd_resolve_cb_t</a> resolve_cb, <span class="reserved">void</span> *cb_data);</p> |
| | 3240 | <h4 class="parameters">Parameters</h4> |
| | 3241 | <table class="list"><tbody> |
| | 3242 | <tr><th>dnssd</th> |
| | 3243 | <td class="description">DNS-SD context</td></tr> |
| | 3244 | <tr><th>if_index</th> |
| | 3245 | <td class="description">Interface index or <code>CUPS_DNSSD_IF_INDEX_ANY</code> or <code>CUPS_DNSSD_IF_INDEX_LOCAL</code></td></tr> |
| | 3246 | <tr><th>name</th> |
| | 3247 | <td class="description">Service name</td></tr> |
| | 3248 | <tr><th>type</th> |
| | 3249 | <td class="description">Service type</td></tr> |
| | 3250 | <tr><th>domain</th> |
| | 3251 | <td class="description">Domain name or <code>NULL</code> for default</td></tr> |
| | 3252 | <tr><th>resolve_cb</th> |
| | 3253 | <td class="description">Resolve callback function</td></tr> |
| | 3254 | <tr><th>cb_data</th> |
| | 3255 | <td class="description">Resolve callback data</td></tr> |
| | 3256 | </tbody></table> |
| | 3257 | <h4 class="returnvalue">Return Value</h4> |
| | 3258 | <p class="description">Resolve request or <code>NULL</code> on error</p> |
| | 3259 | <h4 class="discussion">Discussion</h4> |
| | 3260 | <p class="discussion">This function creates a new DNS-SD resolver for the specified instance name, |
| | 3261 | service type, and optional domain and interface index. Resikved services |
| | 3262 | are reported using the required resolve callback function, with the "flags" |
| | 3263 | argument set to <code>CUPS_DNSSD_FLAGS_NONE</code> on success or |
| | 3264 | <code>CUPS_DNSSD_FLAGS_ERROR</code> on error: |
| | 3265 | |
| | 3266 | <pre> |
| | 3267 | void |
| | 3268 | resolve_cb( |
| | 3269 | cups_dnssd_resolve_t *resolve, |
| | 3270 | void *cb_data, |
| | 3271 | cups_dnssd_flags_t flags, |
| | 3272 | uint32_t if_index, |
| | 3273 | const char *fullname, |
| | 3274 | const char *host, |
| | 3275 | uint16_t port, |
| | 3276 | int num_txt, |
| | 3277 | cups_option_t *txt) |
| | 3278 | { |
| | 3279 | // Process resolved service |
| | 3280 | } |
| | 3281 | </pre> |
| | 3282 | </p> |
| | 3283 | <h3 class="function"><a id="cupsDNSSDSeparateFullName">cupsDNSSDSeparateFullName</a></h3> |
| | 3284 | <p class="description">Separate a full service name into an instance |
| | 3285 | name, registration type, and domain.</p> |
| | 3286 | <p class="code"> |
| | 3287 | <span class="reserved">bool</span> cupsDNSSDSeparateFullName(<span class="reserved">const</span> <span class="reserved">char</span> *fullname, <span class="reserved">char</span> *name, size_t namesize, <span class="reserved">char</span> *type, size_t typesize, <span class="reserved">char</span> *domain, size_t domainsize);</p> |
| | 3288 | <h4 class="parameters">Parameters</h4> |
| | 3289 | <table class="list"><tbody> |
| | 3290 | <tr><th>fullname</th> |
| | 3291 | <td class="description">Full service name</td></tr> |
| | 3292 | <tr><th>name</th> |
| | 3293 | <td class="description">Instance name buffer</td></tr> |
| | 3294 | <tr><th>namesize</th> |
| | 3295 | <td class="description">Size of instance name buffer</td></tr> |
| | 3296 | <tr><th>type</th> |
| | 3297 | <td class="description">Registration type buffer</td></tr> |
| | 3298 | <tr><th>typesize</th> |
| | 3299 | <td class="description">Size of registration type buffer</td></tr> |
| | 3300 | <tr><th>domain</th> |
| | 3301 | <td class="description">Domain name buffer</td></tr> |
| | 3302 | <tr><th>domainsize</th> |
| | 3303 | <td class="description">Size of domain name buffer</td></tr> |
| | 3304 | </tbody></table> |
| | 3305 | <h4 class="returnvalue">Return Value</h4> |
| | 3306 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 3307 | <h4 class="discussion">Discussion</h4> |
| | 3308 | <p class="discussion">This function separates a full service name such as |
| | 3309 | "Example032Name._ipp._tcp.local.") into its instance name ("Example Name"), |
| | 3310 | registration type ("_ipp._tcp"), and domain ("local.").</p> |
| | 3311 | <h3 class="function"><a id="cupsDNSSDServiceAdd">cupsDNSSDServiceAdd</a></h3> |
| | 3312 | <p class="description">Add a service instance.</p> |
| | 3313 | <p class="code"> |
| | 3314 | <span class="reserved">bool</span> cupsDNSSDServiceAdd(<a href="#cups_dnssd_service_t">cups_dnssd_service_t</a> *service, <span class="reserved">const</span> <span class="reserved">char</span> *types, <span class="reserved">const</span> <span class="reserved">char</span> *domain, <span class="reserved">const</span> <span class="reserved">char</span> *host, uint16_t port, <span class="reserved">int</span> num_txt, <a href="#cups_option_t">cups_option_t</a> *txt);</p> |
| | 3315 | <h4 class="parameters">Parameters</h4> |
| | 3316 | <table class="list"><tbody> |
| | 3317 | <tr><th>service</th> |
| | 3318 | <td class="description">Service</td></tr> |
| | 3319 | <tr><th>types</th> |
| | 3320 | <td class="description">Service types</td></tr> |
| | 3321 | <tr><th>domain</th> |
| | 3322 | <td class="description">Domain name or <code>NULL</code> for default</td></tr> |
| | 3323 | <tr><th>host</th> |
| | 3324 | <td class="description">Host name or <code>NULL</code> for default</td></tr> |
| | 3325 | <tr><th>port</th> |
| | 3326 | <td class="description">Port number or <code>0</code> for none</td></tr> |
| | 3327 | <tr><th>num_txt</th> |
| | 3328 | <td class="description">Number of TXT record values</td></tr> |
| | 3329 | <tr><th>txt</th> |
| | 3330 | <td class="description">TXT record values</td></tr> |
| | 3331 | </tbody></table> |
| | 3332 | <h4 class="returnvalue">Return Value</h4> |
| | 3333 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 3334 | <h4 class="discussion">Discussion</h4> |
| | 3335 | <p class="discussion">This function adds a service instance for the specified service types, |
| | 3336 | domain, host, and port. The "types" argument can be a single service type |
| | 3337 | ("_ipp._tcp") or a service type and comma-delimited list of sub-types |
| | 3338 | ("_ipp._tcp,_print,_universal").<br> |
| | 3339 | <br> |
| | 3340 | Call the <a href="#cupsDNSSDServicePublish"><code>cupsDNSSDServicePublish</code></a> function after all service instances |
| | 3341 | have been added.</p> |
| | 3342 | <h3 class="function"><a id="cupsDNSSDServiceDelete">cupsDNSSDServiceDelete</a></h3> |
| | 3343 | <p class="description">Cancel and free a service registration.</p> |
| | 3344 | <p class="code"> |
| | 3345 | <span class="reserved">void</span> cupsDNSSDServiceDelete(<a href="#cups_dnssd_service_t">cups_dnssd_service_t</a> *service);</p> |
| | 3346 | <h4 class="parameters">Parameters</h4> |
| | 3347 | <table class="list"><tbody> |
| | 3348 | <tr><th>service</th> |
| | 3349 | <td class="description">Service</td></tr> |
| | 3350 | </tbody></table> |
| | 3351 | <h3 class="function"><a id="cupsDNSSDServiceGetContext">cupsDNSSDServiceGetContext</a></h3> |
| | 3352 | <p class="description">Get the DNS-SD context for the service |
| | 3353 | registration.</p> |
| | 3354 | <p class="code"> |
| | 3355 | <a href="#cups_dnssd_t">cups_dnssd_t</a> *cupsDNSSDServiceGetContext(<a href="#cups_dnssd_service_t">cups_dnssd_service_t</a> *service);</p> |
| | 3356 | <h4 class="parameters">Parameters</h4> |
| | 3357 | <table class="list"><tbody> |
| | 3358 | <tr><th>service</th> |
| | 3359 | <td class="description">Service registration</td></tr> |
| | 3360 | </tbody></table> |
| | 3361 | <h4 class="returnvalue">Return Value</h4> |
| | 3362 | <p class="description">DNS-SD context or <code>NULL</code></p> |
| | 3363 | <h3 class="function"><a id="cupsDNSSDServiceGetName">cupsDNSSDServiceGetName</a></h3> |
| | 3364 | <p class="description">Get the service instance name for the service registration.</p> |
| | 3365 | <p class="code"> |
| | 3366 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsDNSSDServiceGetName(<a href="#cups_dnssd_service_t">cups_dnssd_service_t</a> *service);</p> |
| | 3367 | <h4 class="parameters">Parameters</h4> |
| | 3368 | <table class="list"><tbody> |
| | 3369 | <tr><th>service</th> |
| | 3370 | <td class="description">Service registration</td></tr> |
| | 3371 | </tbody></table> |
| | 3372 | <h4 class="returnvalue">Return Value</h4> |
| | 3373 | <p class="description">Service instance name</p> |
| | 3374 | <h3 class="function"><a id="cupsDNSSDServiceNew">cupsDNSSDServiceNew</a></h3> |
| | 3375 | <p class="description">Create a new named service.</p> |
| | 3376 | <p class="code"> |
| | 3377 | <a href="#cups_dnssd_service_t">cups_dnssd_service_t</a> *cupsDNSSDServiceNew(<a href="#cups_dnssd_t">cups_dnssd_t</a> *dnssd, uint32_t if_index, <span class="reserved">const</span> <span class="reserved">char</span> *name, <a href="#cups_dnssd_service_cb_t">cups_dnssd_service_cb_t</a> cb, <span class="reserved">void</span> *cb_data);</p> |
| | 3378 | <h4 class="parameters">Parameters</h4> |
| | 3379 | <table class="list"><tbody> |
| | 3380 | <tr><th>dnssd</th> |
| | 3381 | <td class="description">DNS-SD context</td></tr> |
| | 3382 | <tr><th>if_index</th> |
| | 3383 | <td class="description">Interface index, <code>CUPS_DNSSD_IF_INDEX_ANY</code>, or <code>CUPS_DNSSD_IF_INDEX_LOCAL</code></td></tr> |
| | 3384 | <tr><th>name</th> |
| | 3385 | <td class="description">Name of service</td></tr> |
| | 3386 | <tr><th>cb</th> |
| | 3387 | <td class="description">Service registration callback function</td></tr> |
| | 3388 | <tr><th>cb_data</th> |
| | 3389 | <td class="description">Service registration callback data</td></tr> |
| | 3390 | </tbody></table> |
| | 3391 | <h4 class="returnvalue">Return Value</h4> |
| | 3392 | <p class="description">Service or <code>NULL</code> on error</p> |
| | 3393 | <h4 class="discussion">Discussion</h4> |
| | 3394 | <p class="discussion">This function creates a new DNS-SD service registration for the given service |
| | 3395 | instance name and interface. Specific services using the name are added |
| | 3396 | using the <a href="#cupsDNSSDServiceAdd"><code>cupsDNSSDServiceAdd</code></a> function.<br> |
| | 3397 | <br> |
| | 3398 | The required service callback is called for select events, with the "flags" |
| | 3399 | argument set to <code>CUPS_DNSSD_FLAGS_NONE</code> for a successful registration, |
| | 3400 | <code>CUPS_DNSSD_FLAGS_COLLISION</code> when there is a name collision, or |
| | 3401 | <code>CUPS_DNSSD_FLAGS_ERROR</code> when there is a problem completing the service |
| | 3402 | registration.</p> |
| | 3403 | <h3 class="function"><a id="cupsDNSSDServicePublish">cupsDNSSDServicePublish</a></h3> |
| | 3404 | <p class="description">Publish a service.</p> |
| | 3405 | <p class="code"> |
| | 3406 | <span class="reserved">bool</span> cupsDNSSDServicePublish(<a href="#cups_dnssd_service_t">cups_dnssd_service_t</a> *service);</p> |
| | 3407 | <h4 class="parameters">Parameters</h4> |
| | 3408 | <table class="list"><tbody> |
| | 3409 | <tr><th>service</th> |
| | 3410 | <td class="description">Service</td></tr> |
| | 3411 | </tbody></table> |
| | 3412 | <h4 class="returnvalue">Return Value</h4> |
| | 3413 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 3414 | <h4 class="discussion">Discussion</h4> |
| | 3415 | <p class="discussion">This function publishes the DNS-SD services added using the |
| | 3416 | <a href="#cupsDNSSDServiceAdd"><code>cupsDNSSDServiceAdd</code></a> function.</p> |
| | 3417 | <h3 class="function"><a id="cupsDNSSDServiceSetLocation">cupsDNSSDServiceSetLocation</a></h3> |
| | 3418 | <p class="description">Set the geolocation (LOC record) of a |
| | 3419 | service.</p> |
| | 3420 | <p class="code"> |
| | 3421 | <span class="reserved">bool</span> cupsDNSSDServiceSetLocation(<a href="#cups_dnssd_service_t">cups_dnssd_service_t</a> *service, <span class="reserved">const</span> <span class="reserved">char</span> *geo_uri);</p> |
| | 3422 | <h4 class="parameters">Parameters</h4> |
| | 3423 | <table class="list"><tbody> |
| | 3424 | <tr><th>service</th> |
| | 3425 | <td class="description">Service</td></tr> |
| | 3426 | <tr><th>geo_uri</th> |
| | 3427 | <td class="description">Geolocation as a 'geo:' URI</td></tr> |
| | 3428 | </tbody></table> |
| | 3429 | <h4 class="returnvalue">Return Value</h4> |
| | 3430 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 3431 | <h4 class="discussion">Discussion</h4> |
| | 3432 | <p class="discussion">This function sets the geolocation of a service using a 'geo:' URI (RFC 5870) |
| | 3433 | of the form |
| | 3434 | 'geo:LATITUDE,LONGITUDE[,ALTITUDE][;crs=CRSLABEL][;u=UNCERTAINTY]'. The |
| | 3435 | specified coordinates and uncertainty are converted into a DNS LOC record |
| | 3436 | for the service name label. Only the "wgs84" CRSLABEL string is supported.<br> |
| | 3437 | <br> |
| | 3438 | You must call this function prior to <a href="#cupsDNSSDServiceAdd"><code>cupsDNSSDServiceAdd</code></a>.</p> |
| | 3439 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsDirClose">cupsDirClose</a></h3> |
| | 3440 | <p class="description">Close a directory.</p> |
| | 3441 | <p class="code"> |
| | 3442 | <span class="reserved">void</span> cupsDirClose(<a href="#cups_dir_t">cups_dir_t</a> *dp);</p> |
| | 3443 | <h4 class="parameters">Parameters</h4> |
| | 3444 | <table class="list"><tbody> |
| | 3445 | <tr><th>dp</th> |
| | 3446 | <td class="description">Directory pointer</td></tr> |
| | 3447 | </tbody></table> |
| | 3448 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsDirOpen">cupsDirOpen</a></h3> |
| | 3449 | <p class="description">Open a directory.</p> |
| | 3450 | <p class="code"> |
| | 3451 | <a href="#cups_dir_t">cups_dir_t</a> *cupsDirOpen(<span class="reserved">const</span> <span class="reserved">char</span> *directory);</p> |
| | 3452 | <h4 class="parameters">Parameters</h4> |
| | 3453 | <table class="list"><tbody> |
| | 3454 | <tr><th>directory</th> |
| | 3455 | <td class="description">Directory name</td></tr> |
| | 3456 | </tbody></table> |
| | 3457 | <h4 class="returnvalue">Return Value</h4> |
| | 3458 | <p class="description">Directory pointer or <code>NULL</code> if the directory could not be opened.</p> |
| | 3459 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsDirRead">cupsDirRead</a></h3> |
| | 3460 | <p class="description">Read the next directory entry.</p> |
| | 3461 | <p class="code"> |
| | 3462 | <a href="#cups_dentry_t">cups_dentry_t</a> *cupsDirRead(<a href="#cups_dir_t">cups_dir_t</a> *dp);</p> |
| | 3463 | <h4 class="parameters">Parameters</h4> |
| | 3464 | <table class="list"><tbody> |
| | 3465 | <tr><th>dp</th> |
| | 3466 | <td class="description">Directory pointer</td></tr> |
| | 3467 | </tbody></table> |
| | 3468 | <h4 class="returnvalue">Return Value</h4> |
| | 3469 | <p class="description">Directory entry or <code>NULL</code> when there are no more</p> |
| | 3470 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsDirRewind">cupsDirRewind</a></h3> |
| | 3471 | <p class="description">Rewind to the start of the directory.</p> |
| | 3472 | <p class="code"> |
| | 3473 | <span class="reserved">void</span> cupsDirRewind(<a href="#cups_dir_t">cups_dir_t</a> *dp);</p> |
| | 3474 | <h4 class="parameters">Parameters</h4> |
| | 3475 | <table class="list"><tbody> |
| | 3476 | <tr><th>dp</th> |
| | 3477 | <td class="description">Directory pointer</td></tr> |
| | 3478 | </tbody></table> |
| | 3479 | <h3 class="function"><span class="info"> CUPS 1.1.20 </span><a id="cupsDoAuthentication">cupsDoAuthentication</a></h3> |
| | 3480 | <p class="description">Authenticate a request.</p> |
| | 3481 | <p class="code"> |
| | 3482 | <span class="reserved">int</span> cupsDoAuthentication(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *method, <span class="reserved">const</span> <span class="reserved">char</span> *resource);</p> |
| | 3483 | <h4 class="parameters">Parameters</h4> |
| | 3484 | <table class="list"><tbody> |
| | 3485 | <tr><th>http</th> |
| | 3486 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 3487 | <tr><th>method</th> |
| | 3488 | <td class="description">Request method ("GET", "POST", "PUT")</td></tr> |
| | 3489 | <tr><th>resource</th> |
| | 3490 | <td class="description">Resource path</td></tr> |
| | 3491 | </tbody></table> |
| | 3492 | <h4 class="returnvalue">Return Value</h4> |
| | 3493 | <p class="description">0 on success, -1 on error</p> |
| | 3494 | <h4 class="discussion">Discussion</h4> |
| | 3495 | <p class="discussion">This function should be called in response to a <code>HTTP_STATUS_UNAUTHORIZED</code> |
| | 3496 | status, prior to resubmitting your request. |
| | 3497 | |
| | 3498 | </p> |
| | 3499 | <h3 class="function"><a id="cupsDoFileRequest">cupsDoFileRequest</a></h3> |
| | 3500 | <p class="description">Do an IPP request with a file.</p> |
| | 3501 | <p class="code"> |
| | 3502 | <a href="#ipp_t">ipp_t</a> *cupsDoFileRequest(<a href="#http_t">http_t</a> *http, <a href="#ipp_t">ipp_t</a> *request, <span class="reserved">const</span> <span class="reserved">char</span> *resource, <span class="reserved">const</span> <span class="reserved">char</span> *filename);</p> |
| | 3503 | <h4 class="parameters">Parameters</h4> |
| | 3504 | <table class="list"><tbody> |
| | 3505 | <tr><th>http</th> |
| | 3506 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 3507 | <tr><th>request</th> |
| | 3508 | <td class="description">IPP request</td></tr> |
| | 3509 | <tr><th>resource</th> |
| | 3510 | <td class="description">HTTP resource for POST</td></tr> |
| | 3511 | <tr><th>filename</th> |
| | 3512 | <td class="description">File to send or <code>NULL</code> for none</td></tr> |
| | 3513 | </tbody></table> |
| | 3514 | <h4 class="returnvalue">Return Value</h4> |
| | 3515 | <p class="description">Response data</p> |
| | 3516 | <h4 class="discussion">Discussion</h4> |
| | 3517 | <p class="discussion">This function sends the IPP request and attached file to the specified |
| | 3518 | server, retrying and authenticating as necessary. The request is freed with |
| | 3519 | <a href="#ippDelete"><code>ippDelete</code></a>.</p> |
| | 3520 | <h3 class="function"><span class="info"> CUPS 1.3 </span><a id="cupsDoIORequest">cupsDoIORequest</a></h3> |
| | 3521 | <p class="description">Do an IPP request with file descriptors.</p> |
| | 3522 | <p class="code"> |
| | 3523 | <a href="#ipp_t">ipp_t</a> *cupsDoIORequest(<a href="#http_t">http_t</a> *http, <a href="#ipp_t">ipp_t</a> *request, <span class="reserved">const</span> <span class="reserved">char</span> *resource, <span class="reserved">int</span> infile, <span class="reserved">int</span> outfile);</p> |
| | 3524 | <h4 class="parameters">Parameters</h4> |
| | 3525 | <table class="list"><tbody> |
| | 3526 | <tr><th>http</th> |
| | 3527 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 3528 | <tr><th>request</th> |
| | 3529 | <td class="description">IPP request</td></tr> |
| | 3530 | <tr><th>resource</th> |
| | 3531 | <td class="description">HTTP resource for POST</td></tr> |
| | 3532 | <tr><th>infile</th> |
| | 3533 | <td class="description">File to read from or -1 for none</td></tr> |
| | 3534 | <tr><th>outfile</th> |
| | 3535 | <td class="description">File to write to or -1 for none</td></tr> |
| | 3536 | </tbody></table> |
| | 3537 | <h4 class="returnvalue">Return Value</h4> |
| | 3538 | <p class="description">Response data</p> |
| | 3539 | <h4 class="discussion">Discussion</h4> |
| | 3540 | <p class="discussion">This function sends the IPP request with the optional input file "infile" to |
| | 3541 | the specified server, retrying and authenticating as necessary. The request |
| | 3542 | is freed with <a href="#ippDelete"><code>ippDelete</code></a>.<br> |
| | 3543 | <br> |
| | 3544 | If "infile" is a valid file descriptor, <code>cupsDoIORequest</code> copies |
| | 3545 | all of the data from the file after the IPP request message.<br> |
| | 3546 | <br> |
| | 3547 | If "outfile" is a valid file descriptor, <code>cupsDoIORequest</code> copies |
| | 3548 | all of the data after the IPP response message to the file. |
| | 3549 | |
| | 3550 | </p> |
| | 3551 | <h3 class="function"><a id="cupsDoRequest">cupsDoRequest</a></h3> |
| | 3552 | <p class="description">Do an IPP request.</p> |
| | 3553 | <p class="code"> |
| | 3554 | <a href="#ipp_t">ipp_t</a> *cupsDoRequest(<a href="#http_t">http_t</a> *http, <a href="#ipp_t">ipp_t</a> *request, <span class="reserved">const</span> <span class="reserved">char</span> *resource);</p> |
| | 3555 | <h4 class="parameters">Parameters</h4> |
| | 3556 | <table class="list"><tbody> |
| | 3557 | <tr><th>http</th> |
| | 3558 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 3559 | <tr><th>request</th> |
| | 3560 | <td class="description">IPP request</td></tr> |
| | 3561 | <tr><th>resource</th> |
| | 3562 | <td class="description">HTTP resource for POST</td></tr> |
| | 3563 | </tbody></table> |
| | 3564 | <h4 class="returnvalue">Return Value</h4> |
| | 3565 | <p class="description">Response data</p> |
| | 3566 | <h4 class="discussion">Discussion</h4> |
| | 3567 | <p class="discussion">This function sends the IPP request to the specified server, retrying |
| | 3568 | and authenticating as necessary. The request is freed with <a href="#ippDelete"><code>ippDelete</code></a>.</p> |
| | 3569 | <h3 class="function"><span class="info"> CUPS 2.3 </span><a id="cupsEncodeOption">cupsEncodeOption</a></h3> |
| | 3570 | <p class="description">Encode a single option into an IPP attribute.</p> |
| | 3571 | <p class="code"> |
| | 3572 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsEncodeOption(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group_tag, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 3573 | <h4 class="parameters">Parameters</h4> |
| | 3574 | <table class="list"><tbody> |
| | 3575 | <tr><th>ipp</th> |
| | 3576 | <td class="description">IPP request/response</td></tr> |
| | 3577 | <tr><th>group_tag</th> |
| | 3578 | <td class="description">Attribute group</td></tr> |
| | 3579 | <tr><th>name</th> |
| | 3580 | <td class="description">Option name</td></tr> |
| | 3581 | <tr><th>value</th> |
| | 3582 | <td class="description">Option string value</td></tr> |
| | 3583 | </tbody></table> |
| | 3584 | <h4 class="returnvalue">Return Value</h4> |
| | 3585 | <p class="description">New attribute or <code>NULL</code> on error</p> |
| | 3586 | <h3 class="function"><a id="cupsEncodeOptions">cupsEncodeOptions</a></h3> |
| | 3587 | <p class="description">Encode printer options into IPP attributes.</p> |
| | 3588 | <p class="code"> |
| | 3589 | <span class="reserved">void</span> cupsEncodeOptions(<a href="#ipp_t">ipp_t</a> *ipp, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| | 3590 | <h4 class="parameters">Parameters</h4> |
| | 3591 | <table class="list"><tbody> |
| | 3592 | <tr><th>ipp</th> |
| | 3593 | <td class="description">IPP request/response</td></tr> |
| | 3594 | <tr><th>num_options</th> |
| | 3595 | <td class="description">Number of options</td></tr> |
| | 3596 | <tr><th>options</th> |
| | 3597 | <td class="description">Options</td></tr> |
| | 3598 | </tbody></table> |
| | 3599 | <h4 class="discussion">Discussion</h4> |
| | 3600 | <p class="discussion">This function adds operation, job, and then subscription attributes, |
| | 3601 | in that order. Use the <a href="#cupsEncodeOptions2"><code>cupsEncodeOptions2</code></a> function to add attributes |
| | 3602 | for a single group.</p> |
| | 3603 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsEncodeOptions2">cupsEncodeOptions2</a></h3> |
| | 3604 | <p class="description">Encode printer options into IPP attributes for a group.</p> |
| | 3605 | <p class="code"> |
| | 3606 | <span class="reserved">void</span> cupsEncodeOptions2(<a href="#ipp_t">ipp_t</a> *ipp, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> *options, ipp_tag_t group_tag);</p> |
| | 3607 | <h4 class="parameters">Parameters</h4> |
| | 3608 | <table class="list"><tbody> |
| | 3609 | <tr><th>ipp</th> |
| | 3610 | <td class="description">IPP request/response</td></tr> |
| | 3611 | <tr><th>num_options</th> |
| | 3612 | <td class="description">Number of options</td></tr> |
| | 3613 | <tr><th>options</th> |
| | 3614 | <td class="description">Options</td></tr> |
| | 3615 | <tr><th>group_tag</th> |
| | 3616 | <td class="description">Group to encode</td></tr> |
| | 3617 | </tbody></table> |
| | 3618 | <h4 class="discussion">Discussion</h4> |
| | 3619 | <p class="discussion">This function only adds attributes for a single group. Call this |
| | 3620 | function multiple times for each group, or use <a href="#cupsEncodeOptions"><code>cupsEncodeOptions</code></a> |
| | 3621 | to add the standard groups. |
| | 3622 | |
| | 3623 | </p> |
| | 3624 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsEncryption">cupsEncryption</a></h3> |
| | 3625 | <p class="description">Get the current encryption settings.</p> |
| | 3626 | <p class="code"> |
| | 3627 | <a href="#http_encryption_t">http_encryption_t</a> cupsEncryption(<span class="reserved">void</span>);</p> |
| | 3628 | <h4 class="returnvalue">Return Value</h4> |
| | 3629 | <p class="description">Encryption settings</p> |
| | 3630 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsEnumDests">cupsEnumDests</a></h3> |
| | 3631 | <p class="description">Enumerate available destinations with a callback function.</p> |
| | 3632 | <p class="code"> |
| | 3633 | <span class="reserved">int</span> cupsEnumDests(<span class="reserved">unsigned</span> flags, <span class="reserved">int</span> msec, <span class="reserved">int</span> *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, <span class="reserved">void</span> *user_data);</p> |
| | 3634 | <h4 class="parameters">Parameters</h4> |
| | 3635 | <table class="list"><tbody> |
| | 3636 | <tr><th>flags</th> |
| | 3637 | <td class="description">Enumeration flags</td></tr> |
| | 3638 | <tr><th>msec</th> |
| | 3639 | <td class="description">Timeout in milliseconds, -1 for indefinite</td></tr> |
| | 3640 | <tr><th>cancel</th> |
| | 3641 | <td class="description">Pointer to "cancel" variable</td></tr> |
| | 3642 | <tr><th>type</th> |
| | 3643 | <td class="description">Printer type bits</td></tr> |
| | 3644 | <tr><th>mask</th> |
| | 3645 | <td class="description">Mask for printer type bits</td></tr> |
| | 3646 | <tr><th>cb</th> |
| | 3647 | <td class="description">Callback function</td></tr> |
| | 3648 | <tr><th>user_data</th> |
| | 3649 | <td class="description">User data</td></tr> |
| | 3650 | </tbody></table> |
| | 3651 | <h4 class="returnvalue">Return Value</h4> |
| | 3652 | <p class="description">1 on success, 0 on failure</p> |
| | 3653 | <h4 class="discussion">Discussion</h4> |
| | 3654 | <p class="discussion">Destinations are enumerated from one or more sources. The callback function |
| | 3655 | receives the <code>user_data</code> pointer and the destination pointer which can |
| | 3656 | be used as input to the <a href="#cupsCopyDest"><code>cupsCopyDest</code></a> function. The function must |
| | 3657 | return 1 to continue enumeration or 0 to stop.<br> |
| | 3658 | <br> |
| | 3659 | The <code>type</code> and <code>mask</code> arguments allow the caller to filter the |
| | 3660 | destinations that are enumerated. Passing 0 for both will enumerate all |
| | 3661 | printers. The constant <code>CUPS_PTYPE_DISCOVERED</code> is used to filter on |
| | 3662 | destinations that are available but have not yet been added locally.<br> |
| | 3663 | <br> |
| | 3664 | Enumeration happens on the current thread and does not return until all |
| | 3665 | destinations have been enumerated or the callback function returns 0.<br> |
| | 3666 | <br> |
| | 3667 | Note: The callback function will likely receive multiple updates for the same |
| | 3668 | destinations - it is up to the caller to suppress any duplicate destinations. |
| | 3669 | |
| | 3670 | </p> |
| | 3671 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileClose">cupsFileClose</a></h3> |
| | 3672 | <p class="description">Close a CUPS file.</p> |
| | 3673 | <p class="code"> |
| | 3674 | <span class="reserved">int</span> cupsFileClose(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 3675 | <h4 class="parameters">Parameters</h4> |
| | 3676 | <table class="list"><tbody> |
| | 3677 | <tr><th>fp</th> |
| | 3678 | <td class="description">CUPS file</td></tr> |
| | 3679 | </tbody></table> |
| | 3680 | <h4 class="returnvalue">Return Value</h4> |
| | 3681 | <p class="description">0 on success, -1 on error</p> |
| | 3682 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileEOF">cupsFileEOF</a></h3> |
| | 3683 | <p class="description">Return the end-of-file status.</p> |
| | 3684 | <p class="code"> |
| | 3685 | <span class="reserved">int</span> cupsFileEOF(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 3686 | <h4 class="parameters">Parameters</h4> |
| | 3687 | <table class="list"><tbody> |
| | 3688 | <tr><th>fp</th> |
| | 3689 | <td class="description">CUPS file</td></tr> |
| | 3690 | </tbody></table> |
| | 3691 | <h4 class="returnvalue">Return Value</h4> |
| | 3692 | <p class="description">1 on end of file, 0 otherwise</p> |
| | 3693 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileFind">cupsFileFind</a></h3> |
| | 3694 | <p class="description">Find a file using the specified path.</p> |
| | 3695 | <p class="code"> |
| | 3696 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsFileFind(<span class="reserved">const</span> <span class="reserved">char</span> *filename, <span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">int</span> executable, <span class="reserved">char</span> *buffer, <span class="reserved">int</span> bufsize);</p> |
| | 3697 | <h4 class="parameters">Parameters</h4> |
| | 3698 | <table class="list"><tbody> |
| | 3699 | <tr><th>filename</th> |
| | 3700 | <td class="description">File to find</td></tr> |
| | 3701 | <tr><th>path</th> |
| | 3702 | <td class="description">Colon/semicolon-separated path</td></tr> |
| | 3703 | <tr><th>executable</th> |
| | 3704 | <td class="description">1 = executable files, 0 = any file/dir</td></tr> |
| | 3705 | <tr><th>buffer</th> |
| | 3706 | <td class="description">Filename buffer</td></tr> |
| | 3707 | <tr><th>bufsize</th> |
| | 3708 | <td class="description">Size of filename buffer</td></tr> |
| | 3709 | </tbody></table> |
| | 3710 | <h4 class="returnvalue">Return Value</h4> |
| | 3711 | <p class="description">Full path to file or <code>NULL</code> if not found</p> |
| | 3712 | <h4 class="discussion">Discussion</h4> |
| | 3713 | <p class="discussion">This function allows the paths in the path string to be separated by |
| | 3714 | colons (UNIX standard) or semicolons (Windows standard) and stores the |
| | 3715 | result in the buffer supplied. If the file cannot be found in any of |
| | 3716 | the supplied paths, <code>NULL</code> is returned. A <code>NULL</code> path only |
| | 3717 | matches the current directory. |
| | 3718 | |
| | 3719 | </p> |
| | 3720 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileFlush">cupsFileFlush</a></h3> |
| | 3721 | <p class="description">Flush pending output.</p> |
| | 3722 | <p class="code"> |
| | 3723 | <span class="reserved">int</span> cupsFileFlush(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 3724 | <h4 class="parameters">Parameters</h4> |
| | 3725 | <table class="list"><tbody> |
| | 3726 | <tr><th>fp</th> |
| | 3727 | <td class="description">CUPS file</td></tr> |
| | 3728 | </tbody></table> |
| | 3729 | <h4 class="returnvalue">Return Value</h4> |
| | 3730 | <p class="description">0 on success, -1 on error</p> |
| | 3731 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileGetChar">cupsFileGetChar</a></h3> |
| | 3732 | <p class="description">Get a single character from a file.</p> |
| | 3733 | <p class="code"> |
| | 3734 | <span class="reserved">int</span> cupsFileGetChar(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 3735 | <h4 class="parameters">Parameters</h4> |
| | 3736 | <table class="list"><tbody> |
| | 3737 | <tr><th>fp</th> |
| | 3738 | <td class="description">CUPS file</td></tr> |
| | 3739 | </tbody></table> |
| | 3740 | <h4 class="returnvalue">Return Value</h4> |
| | 3741 | <p class="description">Character or -1 on end of file</p> |
| | 3742 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileGetConf">cupsFileGetConf</a></h3> |
| | 3743 | <p class="description">Get a line from a configuration file.</p> |
| | 3744 | <p class="code"> |
| | 3745 | <span class="reserved">char</span> *cupsFileGetConf(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">char</span> *buf, size_t buflen, <span class="reserved">char</span> **value, <span class="reserved">int</span> *linenum);</p> |
| | 3746 | <h4 class="parameters">Parameters</h4> |
| | 3747 | <table class="list"><tbody> |
| | 3748 | <tr><th>fp</th> |
| | 3749 | <td class="description">CUPS file</td></tr> |
| | 3750 | <tr><th>buf</th> |
| | 3751 | <td class="description">String buffer</td></tr> |
| | 3752 | <tr><th>buflen</th> |
| | 3753 | <td class="description">Size of string buffer</td></tr> |
| | 3754 | <tr><th>value</th> |
| | 3755 | <td class="description">Pointer to value</td></tr> |
| | 3756 | <tr><th>linenum</th> |
| | 3757 | <td class="description">Current line number</td></tr> |
| | 3758 | </tbody></table> |
| | 3759 | <h4 class="returnvalue">Return Value</h4> |
| | 3760 | <p class="description">Line read or <code>NULL</code> on end of file or error</p> |
| | 3761 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileGetLine">cupsFileGetLine</a></h3> |
| | 3762 | <p class="description">Get a CR and/or LF-terminated line that may |
| | 3763 | contain binary data.</p> |
| | 3764 | <p class="code"> |
| | 3765 | size_t cupsFileGetLine(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">char</span> *buf, size_t buflen);</p> |
| | 3766 | <h4 class="parameters">Parameters</h4> |
| | 3767 | <table class="list"><tbody> |
| | 3768 | <tr><th>fp</th> |
| | 3769 | <td class="description">File to read from</td></tr> |
| | 3770 | <tr><th>buf</th> |
| | 3771 | <td class="description">Buffer</td></tr> |
| | 3772 | <tr><th>buflen</th> |
| | 3773 | <td class="description">Size of buffer</td></tr> |
| | 3774 | </tbody></table> |
| | 3775 | <h4 class="returnvalue">Return Value</h4> |
| | 3776 | <p class="description">Number of bytes on line or 0 on end of file</p> |
| | 3777 | <h4 class="discussion">Discussion</h4> |
| | 3778 | <p class="discussion">This function differs from <a href="#cupsFileGets"><code>cupsFileGets</code></a> in that the trailing CR |
| | 3779 | and LF are preserved, as is any binary data on the line. The buffer is |
| | 3780 | nul-terminated, however you should use the returned length to determine |
| | 3781 | the number of bytes on the line. |
| | 3782 | |
| | 3783 | </p> |
| | 3784 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileGets">cupsFileGets</a></h3> |
| | 3785 | <p class="description">Get a CR and/or LF-terminated line.</p> |
| | 3786 | <p class="code"> |
| | 3787 | <span class="reserved">char</span> *cupsFileGets(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">char</span> *buf, size_t buflen);</p> |
| | 3788 | <h4 class="parameters">Parameters</h4> |
| | 3789 | <table class="list"><tbody> |
| | 3790 | <tr><th>fp</th> |
| | 3791 | <td class="description">CUPS file</td></tr> |
| | 3792 | <tr><th>buf</th> |
| | 3793 | <td class="description">String buffer</td></tr> |
| | 3794 | <tr><th>buflen</th> |
| | 3795 | <td class="description">Size of string buffer</td></tr> |
| | 3796 | </tbody></table> |
| | 3797 | <h4 class="returnvalue">Return Value</h4> |
| | 3798 | <p class="description">Line read or <code>NULL</code> on end of file or error</p> |
| | 3799 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsFileIsCompressed">cupsFileIsCompressed</a></h3> |
| | 3800 | <p class="description">Return whether a file is compressed.</p> |
| | 3801 | <p class="code"> |
| | 3802 | <span class="reserved">bool</span> cupsFileIsCompressed(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 3803 | <h4 class="parameters">Parameters</h4> |
| | 3804 | <table class="list"><tbody> |
| | 3805 | <tr><th>fp</th> |
| | 3806 | <td class="description">CUPS file</td></tr> |
| | 3807 | </tbody></table> |
| | 3808 | <h4 class="returnvalue">Return Value</h4> |
| | 3809 | <p class="description"><code>true</code> if file is compressed, <code>false</code> otherwise</p> |
| | 3810 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileLock">cupsFileLock</a></h3> |
| | 3811 | <p class="description">Temporarily lock access to a file.</p> |
| | 3812 | <p class="code"> |
| | 3813 | <span class="reserved">int</span> cupsFileLock(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">int</span> block);</p> |
| | 3814 | <h4 class="parameters">Parameters</h4> |
| | 3815 | <table class="list"><tbody> |
| | 3816 | <tr><th>fp</th> |
| | 3817 | <td class="description">CUPS file</td></tr> |
| | 3818 | <tr><th>block</th> |
| | 3819 | <td class="description">1 to wait for the lock, 0 to fail right away</td></tr> |
| | 3820 | </tbody></table> |
| | 3821 | <h4 class="returnvalue">Return Value</h4> |
| | 3822 | <p class="description">0 on success, -1 on error</p> |
| | 3823 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileNumber">cupsFileNumber</a></h3> |
| | 3824 | <p class="description">Return the file descriptor associated with a CUPS file.</p> |
| | 3825 | <p class="code"> |
| | 3826 | <span class="reserved">int</span> cupsFileNumber(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 3827 | <h4 class="parameters">Parameters</h4> |
| | 3828 | <table class="list"><tbody> |
| | 3829 | <tr><th>fp</th> |
| | 3830 | <td class="description">CUPS file</td></tr> |
| | 3831 | </tbody></table> |
| | 3832 | <h4 class="returnvalue">Return Value</h4> |
| | 3833 | <p class="description">File descriptor</p> |
| | 3834 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileOpen">cupsFileOpen</a></h3> |
| | 3835 | <p class="description">Open a CUPS file.</p> |
| | 3836 | <p class="code"> |
| | 3837 | <a href="#cups_file_t">cups_file_t</a> *cupsFileOpen(<span class="reserved">const</span> <span class="reserved">char</span> *filename, <span class="reserved">const</span> <span class="reserved">char</span> *mode);</p> |
| | 3838 | <h4 class="parameters">Parameters</h4> |
| | 3839 | <table class="list"><tbody> |
| | 3840 | <tr><th>filename</th> |
| | 3841 | <td class="description">Name of file</td></tr> |
| | 3842 | <tr><th>mode</th> |
| | 3843 | <td class="description">Open mode</td></tr> |
| | 3844 | </tbody></table> |
| | 3845 | <h4 class="returnvalue">Return Value</h4> |
| | 3846 | <p class="description">CUPS file or <code>NULL</code> if the file or socket cannot be opened</p> |
| | 3847 | <h4 class="discussion">Discussion</h4> |
| | 3848 | <p class="discussion">The "mode" parameter can be "r" to read, "w" to write, overwriting any |
| | 3849 | existing file, "a" to append to an existing file or create a new file, |
| | 3850 | or "s" to open a socket connection.<br> |
| | 3851 | <br> |
| | 3852 | When opening for writing ("w"), an optional number from 1 to 9 can be |
| | 3853 | supplied which enables Flate compression of the file. Compression is |
| | 3854 | not supported for the "a" (append) mode.<br> |
| | 3855 | <br> |
| | 3856 | When opening for writing ("w") or append ("a"), an optional 'm###' suffix |
| | 3857 | can be used to set the permissions of the opened file.<br> |
| | 3858 | <br> |
| | 3859 | When opening a socket connection, the filename is a string of the form |
| | 3860 | "address:port" or "hostname:port". The socket will make an IPv4 or IPv6 |
| | 3861 | connection as needed, generally preferring IPv6 connections when there is |
| | 3862 | a choice. |
| | 3863 | |
| | 3864 | </p> |
| | 3865 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileOpenFd">cupsFileOpenFd</a></h3> |
| | 3866 | <p class="description">Open a CUPS file using a file descriptor.</p> |
| | 3867 | <p class="code"> |
| | 3868 | <a href="#cups_file_t">cups_file_t</a> *cupsFileOpenFd(<span class="reserved">int</span> fd, <span class="reserved">const</span> <span class="reserved">char</span> *mode);</p> |
| | 3869 | <h4 class="parameters">Parameters</h4> |
| | 3870 | <table class="list"><tbody> |
| | 3871 | <tr><th>fd</th> |
| | 3872 | <td class="description">File descriptor</td></tr> |
| | 3873 | <tr><th>mode</th> |
| | 3874 | <td class="description">Open mode</td></tr> |
| | 3875 | </tbody></table> |
| | 3876 | <h4 class="returnvalue">Return Value</h4> |
| | 3877 | <p class="description">CUPS file or <code>NULL</code> if the file could not be opened</p> |
| | 3878 | <h4 class="discussion">Discussion</h4> |
| | 3879 | <p class="discussion">The "mode" parameter can be "r" to read, "w" to write, "a" to append, |
| | 3880 | or "s" to treat the file descriptor as a bidirectional socket connection.<br> |
| | 3881 | <br> |
| | 3882 | When opening for writing ("w"), an optional number from 1 to 9 can be |
| | 3883 | supplied which enables Flate compression of the file. Compression is |
| | 3884 | not supported for the "a" (append) mode. |
| | 3885 | |
| | 3886 | </p> |
| | 3887 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFilePeekChar">cupsFilePeekChar</a></h3> |
| | 3888 | <p class="description">Peek at the next character from a file.</p> |
| | 3889 | <p class="code"> |
| | 3890 | <span class="reserved">int</span> cupsFilePeekChar(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 3891 | <h4 class="parameters">Parameters</h4> |
| | 3892 | <table class="list"><tbody> |
| | 3893 | <tr><th>fp</th> |
| | 3894 | <td class="description">CUPS file</td></tr> |
| | 3895 | </tbody></table> |
| | 3896 | <h4 class="returnvalue">Return Value</h4> |
| | 3897 | <p class="description">Character or -1 on end of file</p> |
| | 3898 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFilePrintf">cupsFilePrintf</a></h3> |
| | 3899 | <p class="description">Write a formatted string.</p> |
| | 3900 | <p class="code"> |
| | 3901 | <span class="reserved">int</span> cupsFilePrintf(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">const</span> <span class="reserved">char</span> *format, ...);</p> |
| | 3902 | <h4 class="parameters">Parameters</h4> |
| | 3903 | <table class="list"><tbody> |
| | 3904 | <tr><th>fp</th> |
| | 3905 | <td class="description">CUPS file</td></tr> |
| | 3906 | <tr><th>format</th> |
| | 3907 | <td class="description">Printf-style format string</td></tr> |
| | 3908 | <tr><th>...</th> |
| | 3909 | <td class="description">Additional args as necessary</td></tr> |
| | 3910 | </tbody></table> |
| | 3911 | <h4 class="returnvalue">Return Value</h4> |
| | 3912 | <p class="description">Number of bytes written or -1 on error</p> |
| | 3913 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFilePutChar">cupsFilePutChar</a></h3> |
| | 3914 | <p class="description">Write a character.</p> |
| | 3915 | <p class="code"> |
| | 3916 | <span class="reserved">int</span> cupsFilePutChar(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">int</span> c);</p> |
| | 3917 | <h4 class="parameters">Parameters</h4> |
| | 3918 | <table class="list"><tbody> |
| | 3919 | <tr><th>fp</th> |
| | 3920 | <td class="description">CUPS file</td></tr> |
| | 3921 | <tr><th>c</th> |
| | 3922 | <td class="description">Character to write</td></tr> |
| | 3923 | </tbody></table> |
| | 3924 | <h4 class="returnvalue">Return Value</h4> |
| | 3925 | <p class="description">0 on success, -1 on error</p> |
| | 3926 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="cupsFilePutConf">cupsFilePutConf</a></h3> |
| | 3927 | <p class="description">Write a configuration line.</p> |
| | 3928 | <p class="code"> |
| | 3929 | ssize_t cupsFilePutConf(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">const</span> <span class="reserved">char</span> *directive, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 3930 | <h4 class="parameters">Parameters</h4> |
| | 3931 | <table class="list"><tbody> |
| | 3932 | <tr><th>fp</th> |
| | 3933 | <td class="description">CUPS file</td></tr> |
| | 3934 | <tr><th>directive</th> |
| | 3935 | <td class="description">Directive</td></tr> |
| | 3936 | <tr><th>value</th> |
| | 3937 | <td class="description">Value</td></tr> |
| | 3938 | </tbody></table> |
| | 3939 | <h4 class="returnvalue">Return Value</h4> |
| | 3940 | <p class="description">Number of bytes written or -1 on error</p> |
| | 3941 | <h4 class="discussion">Discussion</h4> |
| | 3942 | <p class="discussion">This function handles any comment escaping of the value. |
| | 3943 | |
| | 3944 | </p> |
| | 3945 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFilePuts">cupsFilePuts</a></h3> |
| | 3946 | <p class="description">Write a string.</p> |
| | 3947 | <p class="code"> |
| | 3948 | <span class="reserved">int</span> cupsFilePuts(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">const</span> <span class="reserved">char</span> *s);</p> |
| | 3949 | <h4 class="parameters">Parameters</h4> |
| | 3950 | <table class="list"><tbody> |
| | 3951 | <tr><th>fp</th> |
| | 3952 | <td class="description">CUPS file</td></tr> |
| | 3953 | <tr><th>s</th> |
| | 3954 | <td class="description">String to write</td></tr> |
| | 3955 | </tbody></table> |
| | 3956 | <h4 class="returnvalue">Return Value</h4> |
| | 3957 | <p class="description">Number of bytes written or -1 on error</p> |
| | 3958 | <h4 class="discussion">Discussion</h4> |
| | 3959 | <p class="discussion">Like the <code>fputs</code> function, no newline is appended to the string. |
| | 3960 | |
| | 3961 | </p> |
| | 3962 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileRead">cupsFileRead</a></h3> |
| | 3963 | <p class="description">Read from a file.</p> |
| | 3964 | <p class="code"> |
| | 3965 | ssize_t cupsFileRead(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">char</span> *buf, size_t bytes);</p> |
| | 3966 | <h4 class="parameters">Parameters</h4> |
| | 3967 | <table class="list"><tbody> |
| | 3968 | <tr><th>fp</th> |
| | 3969 | <td class="description">CUPS file</td></tr> |
| | 3970 | <tr><th>buf</th> |
| | 3971 | <td class="description">Buffer</td></tr> |
| | 3972 | <tr><th>bytes</th> |
| | 3973 | <td class="description">Number of bytes to read</td></tr> |
| | 3974 | </tbody></table> |
| | 3975 | <h4 class="returnvalue">Return Value</h4> |
| | 3976 | <p class="description">Number of bytes read or -1 on error</p> |
| | 3977 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileRewind">cupsFileRewind</a></h3> |
| | 3978 | <p class="description">Set the current file position to the beginning of the |
| | 3979 | file.</p> |
| | 3980 | <p class="code"> |
| | 3981 | off_t cupsFileRewind(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 3982 | <h4 class="parameters">Parameters</h4> |
| | 3983 | <table class="list"><tbody> |
| | 3984 | <tr><th>fp</th> |
| | 3985 | <td class="description">CUPS file</td></tr> |
| | 3986 | </tbody></table> |
| | 3987 | <h4 class="returnvalue">Return Value</h4> |
| | 3988 | <p class="description">New file position or -1 on error</p> |
| | 3989 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileSeek">cupsFileSeek</a></h3> |
| | 3990 | <p class="description">Seek in a file.</p> |
| | 3991 | <p class="code"> |
| | 3992 | off_t cupsFileSeek(<a href="#cups_file_t">cups_file_t</a> *fp, off_t pos);</p> |
| | 3993 | <h4 class="parameters">Parameters</h4> |
| | 3994 | <table class="list"><tbody> |
| | 3995 | <tr><th>fp</th> |
| | 3996 | <td class="description">CUPS file</td></tr> |
| | 3997 | <tr><th>pos</th> |
| | 3998 | <td class="description">Position in file</td></tr> |
| | 3999 | </tbody></table> |
| | 4000 | <h4 class="returnvalue">Return Value</h4> |
| | 4001 | <p class="description">New file position or -1 on error</p> |
| | 4002 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileStderr">cupsFileStderr</a></h3> |
| | 4003 | <p class="description">Return a CUPS file associated with stderr.</p> |
| | 4004 | <p class="code"> |
| | 4005 | <a href="#cups_file_t">cups_file_t</a> *cupsFileStderr(<span class="reserved">void</span>);</p> |
| | 4006 | <h4 class="returnvalue">Return Value</h4> |
| | 4007 | <p class="description">CUPS file</p> |
| | 4008 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileStdin">cupsFileStdin</a></h3> |
| | 4009 | <p class="description">Return a CUPS file associated with stdin.</p> |
| | 4010 | <p class="code"> |
| | 4011 | <a href="#cups_file_t">cups_file_t</a> *cupsFileStdin(<span class="reserved">void</span>);</p> |
| | 4012 | <h4 class="returnvalue">Return Value</h4> |
| | 4013 | <p class="description">CUPS file</p> |
| | 4014 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileStdout">cupsFileStdout</a></h3> |
| | 4015 | <p class="description">Return a CUPS file associated with stdout.</p> |
| | 4016 | <p class="code"> |
| | 4017 | <a href="#cups_file_t">cups_file_t</a> *cupsFileStdout(<span class="reserved">void</span>);</p> |
| | 4018 | <h4 class="returnvalue">Return Value</h4> |
| | 4019 | <p class="description">CUPS file</p> |
| | 4020 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileTell">cupsFileTell</a></h3> |
| | 4021 | <p class="description">Return the current file position.</p> |
| | 4022 | <p class="code"> |
| | 4023 | off_t cupsFileTell(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 4024 | <h4 class="parameters">Parameters</h4> |
| | 4025 | <table class="list"><tbody> |
| | 4026 | <tr><th>fp</th> |
| | 4027 | <td class="description">CUPS file</td></tr> |
| | 4028 | </tbody></table> |
| | 4029 | <h4 class="returnvalue">Return Value</h4> |
| | 4030 | <p class="description">File position</p> |
| | 4031 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileUnlock">cupsFileUnlock</a></h3> |
| | 4032 | <p class="description">Unlock access to a file.</p> |
| | 4033 | <p class="code"> |
| | 4034 | <span class="reserved">int</span> cupsFileUnlock(<a href="#cups_file_t">cups_file_t</a> *fp);</p> |
| | 4035 | <h4 class="parameters">Parameters</h4> |
| | 4036 | <table class="list"><tbody> |
| | 4037 | <tr><th>fp</th> |
| | 4038 | <td class="description">CUPS file</td></tr> |
| | 4039 | </tbody></table> |
| | 4040 | <h4 class="returnvalue">Return Value</h4> |
| | 4041 | <p class="description">0 on success, -1 on error</p> |
| | 4042 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsFileWrite">cupsFileWrite</a></h3> |
| | 4043 | <p class="description">Write to a file.</p> |
| | 4044 | <p class="code"> |
| | 4045 | ssize_t cupsFileWrite(<a href="#cups_file_t">cups_file_t</a> *fp, <span class="reserved">const</span> <span class="reserved">char</span> *buf, size_t bytes);</p> |
| | 4046 | <h4 class="parameters">Parameters</h4> |
| | 4047 | <table class="list"><tbody> |
| | 4048 | <tr><th>fp</th> |
| | 4049 | <td class="description">CUPS file</td></tr> |
| | 4050 | <tr><th>buf</th> |
| | 4051 | <td class="description">Buffer</td></tr> |
| | 4052 | <tr><th>bytes</th> |
| | 4053 | <td class="description">Number of bytes to write</td></tr> |
| | 4054 | </tbody></table> |
| | 4055 | <h4 class="returnvalue">Return Value</h4> |
| | 4056 | <p class="description">Number of bytes written or -1 on error</p> |
| | 4057 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="cupsFindDestDefault">cupsFindDestDefault</a></h3> |
| | 4058 | <p class="description">Find the default value(s) for the given option.</p> |
| | 4059 | <p class="code"> |
| | 4060 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *option);</p> |
| | 4061 | <h4 class="parameters">Parameters</h4> |
| | 4062 | <table class="list"><tbody> |
| | 4063 | <tr><th>http</th> |
| | 4064 | <td class="description">Connection to destination</td></tr> |
| | 4065 | <tr><th>dest</th> |
| | 4066 | <td class="description">Destination</td></tr> |
| | 4067 | <tr><th>dinfo</th> |
| | 4068 | <td class="description">Destination information</td></tr> |
| | 4069 | <tr><th>option</th> |
| | 4070 | <td class="description">Option/attribute name</td></tr> |
| | 4071 | </tbody></table> |
| | 4072 | <h4 class="returnvalue">Return Value</h4> |
| | 4073 | <p class="description">Default attribute or <code>NULL</code> for none</p> |
| | 4074 | <h4 class="discussion">Discussion</h4> |
| | 4075 | <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, |
| | 4076 | <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, |
| | 4077 | <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, |
| | 4078 | <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> |
| | 4079 | functions to inspect the default value(s) as needed. |
| | 4080 | |
| | 4081 | </p> |
| | 4082 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="cupsFindDestReady">cupsFindDestReady</a></h3> |
| | 4083 | <p class="description">Find the default value(s) for the given option.</p> |
| | 4084 | <p class="code"> |
| | 4085 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *option);</p> |
| | 4086 | <h4 class="parameters">Parameters</h4> |
| | 4087 | <table class="list"><tbody> |
| | 4088 | <tr><th>http</th> |
| | 4089 | <td class="description">Connection to destination</td></tr> |
| | 4090 | <tr><th>dest</th> |
| | 4091 | <td class="description">Destination</td></tr> |
| | 4092 | <tr><th>dinfo</th> |
| | 4093 | <td class="description">Destination information</td></tr> |
| | 4094 | <tr><th>option</th> |
| | 4095 | <td class="description">Option/attribute name</td></tr> |
| | 4096 | </tbody></table> |
| | 4097 | <h4 class="returnvalue">Return Value</h4> |
| | 4098 | <p class="description">Default attribute or <code>NULL</code> for none</p> |
| | 4099 | <h4 class="discussion">Discussion</h4> |
| | 4100 | <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, |
| | 4101 | <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, |
| | 4102 | <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, |
| | 4103 | <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> |
| | 4104 | functions to inspect the default value(s) as needed. |
| | 4105 | |
| | 4106 | </p> |
| | 4107 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="cupsFindDestSupported">cupsFindDestSupported</a></h3> |
| | 4108 | <p class="description">Find the default value(s) for the given option.</p> |
| | 4109 | <p class="code"> |
| | 4110 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *option);</p> |
| | 4111 | <h4 class="parameters">Parameters</h4> |
| | 4112 | <table class="list"><tbody> |
| | 4113 | <tr><th>http</th> |
| | 4114 | <td class="description">Connection to destination</td></tr> |
| | 4115 | <tr><th>dest</th> |
| | 4116 | <td class="description">Destination</td></tr> |
| | 4117 | <tr><th>dinfo</th> |
| | 4118 | <td class="description">Destination information</td></tr> |
| | 4119 | <tr><th>option</th> |
| | 4120 | <td class="description">Option/attribute name</td></tr> |
| | 4121 | </tbody></table> |
| | 4122 | <h4 class="returnvalue">Return Value</h4> |
| | 4123 | <p class="description">Default attribute or <code>NULL</code> for none</p> |
| | 4124 | <h4 class="discussion">Discussion</h4> |
| | 4125 | <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, |
| | 4126 | <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, |
| | 4127 | <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, |
| | 4128 | <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> |
| | 4129 | functions to inspect the default value(s) as needed. |
| | 4130 | |
| | 4131 | </p> |
| | 4132 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsFinishDestDocument">cupsFinishDestDocument</a></h3> |
| | 4133 | <p class="description">Finish the current document.</p> |
| | 4134 | <p class="code"> |
| | 4135 | 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> |
| | 4136 | <h4 class="parameters">Parameters</h4> |
| | 4137 | <table class="list"><tbody> |
| | 4138 | <tr><th>http</th> |
| | 4139 | <td class="description">Connection to destination</td></tr> |
| | 4140 | <tr><th>dest</th> |
| | 4141 | <td class="description">Destination</td></tr> |
| | 4142 | <tr><th>info</th> |
| | 4143 | <td class="description">Destination information</td></tr> |
| | 4144 | </tbody></table> |
| | 4145 | <h4 class="returnvalue">Return Value</h4> |
| | 4146 | <p class="description">Status of document submission</p> |
| | 4147 | <h4 class="discussion">Discussion</h4> |
| | 4148 | <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success. |
| | 4149 | |
| | 4150 | </p> |
| | 4151 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsFormDecode">cupsFormDecode</a></h3> |
| | 4152 | <p class="description">Decode URL-encoded form data.</p> |
| | 4153 | <p class="code"> |
| | 4154 | <span class="reserved">int</span> cupsFormDecode(<span class="reserved">const</span> <span class="reserved">char</span> *data, <a href="#cups_option_t">cups_option_t</a> **vars);</p> |
| | 4155 | <h4 class="parameters">Parameters</h4> |
| | 4156 | <table class="list"><tbody> |
| | 4157 | <tr><th>data</th> |
| | 4158 | <td class="description">URL-encoded form data</td></tr> |
| | 4159 | <tr><th>vars</th> |
| | 4160 | <td class="description">Array of variables</td></tr> |
| | 4161 | </tbody></table> |
| | 4162 | <h4 class="returnvalue">Return Value</h4> |
| | 4163 | <p class="description">Number of variables</p> |
| | 4164 | <h4 class="discussion">Discussion</h4> |
| | 4165 | <p class="discussion">This function decodes URL-encoded form data, returning the number of |
| | 4166 | variables and a pointer to a <a href="#cups_option_t"><code>cups_option_t</code></a> array of the variables.<br> |
| | 4167 | <br> |
| | 4168 | Use the <a href="#cupsFreeOptions"><code>cupsFreeOptions</code></a> function to return the memory used when you |
| | 4169 | are done with the form variables. |
| | 4170 | |
| | 4171 | </p> |
| | 4172 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsFormEncode">cupsFormEncode</a></h3> |
| | 4173 | <p class="description">Encode options as URL-encoded form data.</p> |
| | 4174 | <p class="code"> |
| | 4175 | <span class="reserved">char</span> *cupsFormEncode(<span class="reserved">const</span> <span class="reserved">char</span> *url, <span class="reserved">int</span> num_vars, <a href="#cups_option_t">cups_option_t</a> *vars);</p> |
| | 4176 | <h4 class="parameters">Parameters</h4> |
| | 4177 | <table class="list"><tbody> |
| | 4178 | <tr><th>url</th> |
| | 4179 | <td class="description">URL or <code>NULL</code> for none</td></tr> |
| | 4180 | <tr><th>num_vars</th> |
| | 4181 | <td class="description">Number of variables</td></tr> |
| | 4182 | <tr><th>vars</th> |
| | 4183 | <td class="description">Variables</td></tr> |
| | 4184 | </tbody></table> |
| | 4185 | <h4 class="returnvalue">Return Value</h4> |
| | 4186 | <p class="description">URL-encoded form data</p> |
| | 4187 | <h4 class="discussion">Discussion</h4> |
| | 4188 | <p class="discussion">This function encodes a CUPS options array as URL-encoded form data with an |
| | 4189 | optional URL prefix, returning an allocated string.<br> |
| | 4190 | <br> |
| | 4191 | Use <code>free</code> to return the memory used for the string. |
| | 4192 | |
| | 4193 | </p> |
| | 4194 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsFormatString">cupsFormatString</a></h3> |
| | 4195 | <p class="description">Format a UTF-8 string into a fixed size buffer.</p> |
| | 4196 | <p class="code"> |
| | 4197 | ssize_t cupsFormatString(<span class="reserved">char</span> *buffer, size_t bufsize, <span class="reserved">const</span> <span class="reserved">char</span> *format, ...);</p> |
| | 4198 | <h4 class="parameters">Parameters</h4> |
| | 4199 | <table class="list"><tbody> |
| | 4200 | <tr><th>buffer</th> |
| | 4201 | <td class="description">Output buffer</td></tr> |
| | 4202 | <tr><th>bufsize</th> |
| | 4203 | <td class="description">Size of output buffer</td></tr> |
| | 4204 | <tr><th>format</th> |
| | 4205 | <td class="description"><code>printf</code>-style format string</td></tr> |
| | 4206 | <tr><th>...</th> |
| | 4207 | <td class="description">Additional arguments</td></tr> |
| | 4208 | </tbody></table> |
| | 4209 | <h4 class="returnvalue">Return Value</h4> |
| | 4210 | <p class="description">Number of bytes formatted</p> |
| | 4211 | <h4 class="discussion">Discussion</h4> |
| | 4212 | <p class="discussion">This function formats a UTF-8 string into a fixed size buffer, escaping |
| | 4213 | special/control characters as needed so they can be safely displayed or |
| | 4214 | logged. |
| | 4215 | |
| | 4216 | </p> |
| | 4217 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsFormatStringv">cupsFormatStringv</a></h3> |
| | 4218 | <p class="description">Format a UTF-8 string into a fixed size buffer (<code>va_list</code> version).</p> |
| | 4219 | <p class="code"> |
| | 4220 | ssize_t cupsFormatStringv(<span class="reserved">char</span> *buffer, size_t bufsize, <span class="reserved">const</span> <span class="reserved">char</span> *format, va_list ap);</p> |
| | 4221 | <h4 class="parameters">Parameters</h4> |
| | 4222 | <table class="list"><tbody> |
| | 4223 | <tr><th>buffer</th> |
| | 4224 | <td class="description">Output buffer</td></tr> |
| | 4225 | <tr><th>bufsize</th> |
| | 4226 | <td class="description">Size of output buffer</td></tr> |
| | 4227 | <tr><th>format</th> |
| | 4228 | <td class="description">printf-style format string</td></tr> |
| | 4229 | <tr><th>ap</th> |
| | 4230 | <td class="description">Pointer to additional arguments</td></tr> |
| | 4231 | </tbody></table> |
| | 4232 | <h4 class="returnvalue">Return Value</h4> |
| | 4233 | <p class="description">Number of bytes formatted</p> |
| | 4234 | <h4 class="discussion">Discussion</h4> |
| | 4235 | <p class="discussion">This function formats a UTF-8 string into a fixed size buffer using a |
| | 4236 | variable argument pointer, escaping special/control characters as needed so |
| | 4237 | they can be safely displayed or logged. |
| | 4238 | |
| | 4239 | </p> |
| | 4240 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsFreeDestInfo">cupsFreeDestInfo</a></h3> |
| | 4241 | <p class="description">Free destination information obtained using |
| | 4242 | <a href="#cupsCopyDestInfo"><code>cupsCopyDestInfo</code></a>.</p> |
| | 4243 | <p class="code"> |
| | 4244 | <span class="reserved">void</span> cupsFreeDestInfo(<a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo);</p> |
| | 4245 | <h4 class="parameters">Parameters</h4> |
| | 4246 | <table class="list"><tbody> |
| | 4247 | <tr><th>dinfo</th> |
| | 4248 | <td class="description">Destination information</td></tr> |
| | 4249 | </tbody></table> |
| | 4250 | <h3 class="function"><a id="cupsFreeDests">cupsFreeDests</a></h3> |
| | 4251 | <p class="description">Free the memory used by the list of destinations.</p> |
| | 4252 | <p class="code"> |
| | 4253 | <span class="reserved">void</span> cupsFreeDests(<span class="reserved">int</span> num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
| | 4254 | <h4 class="parameters">Parameters</h4> |
| | 4255 | <table class="list"><tbody> |
| | 4256 | <tr><th>num_dests</th> |
| | 4257 | <td class="description">Number of destinations</td></tr> |
| | 4258 | <tr><th>dests</th> |
| | 4259 | <td class="description">Destinations</td></tr> |
| | 4260 | </tbody></table> |
| | 4261 | <h3 class="function"><a id="cupsFreeJobs">cupsFreeJobs</a></h3> |
| | 4262 | <p class="description">Free memory used by job data.</p> |
| | 4263 | <p class="code"> |
| | 4264 | <span class="reserved">void</span> cupsFreeJobs(<span class="reserved">int</span> num_jobs, <a href="#cups_job_t">cups_job_t</a> *jobs);</p> |
| | 4265 | <h4 class="parameters">Parameters</h4> |
| | 4266 | <table class="list"><tbody> |
| | 4267 | <tr><th>num_jobs</th> |
| | 4268 | <td class="description">Number of jobs</td></tr> |
| | 4269 | <tr><th>jobs</th> |
| | 4270 | <td class="description">Jobs</td></tr> |
| | 4271 | </tbody></table> |
| | 4272 | <h3 class="function"><a id="cupsFreeOptions">cupsFreeOptions</a></h3> |
| | 4273 | <p class="description">Free all memory used by options.</p> |
| | 4274 | <p class="code"> |
| | 4275 | <span class="reserved">void</span> cupsFreeOptions(<span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| | 4276 | <h4 class="parameters">Parameters</h4> |
| | 4277 | <table class="list"><tbody> |
| | 4278 | <tr><th>num_options</th> |
| | 4279 | <td class="description">Number of options</td></tr> |
| | 4280 | <tr><th>options</th> |
| | 4281 | <td class="description">Pointer to options</td></tr> |
| | 4282 | </tbody></table> |
| | 4283 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetClock">cupsGetClock</a></h3> |
| | 4284 | <p class="description">Get a monotonic clock value in seconds.</p> |
| | 4285 | <p class="code"> |
| | 4286 | <span class="reserved">double</span> cupsGetClock(<span class="reserved">void</span>);</p> |
| | 4287 | <h4 class="returnvalue">Return Value</h4> |
| | 4288 | <p class="description">Elapsed seconds</p> |
| | 4289 | <h4 class="discussion">Discussion</h4> |
| | 4290 | <p class="discussion">This function returns a monotonically increasing clock value in seconds. The |
| | 4291 | first call will always return 0.0. Subsequent calls will return the number |
| | 4292 | of seconds that have elapsed since the first call, regardless of system time |
| | 4293 | changes, sleep, etc. The sub-second accuracy varies based on the operating |
| | 4294 | system and hardware but is typically 10ms or better. |
| | 4295 | |
| | 4296 | </p> |
| | 4297 | <h3 class="function"><a id="cupsGetCredentialsExpiration">cupsGetCredentialsExpiration</a></h3> |
| | 4298 | <p class="description">Return the expiration date of the credentials.</p> |
| | 4299 | <p class="code"> |
| | 4300 | time_t cupsGetCredentialsExpiration(<span class="reserved">const</span> <span class="reserved">char</span> *credentials);</p> |
| | 4301 | <h4 class="parameters">Parameters</h4> |
| | 4302 | <table class="list"><tbody> |
| | 4303 | <tr><th>credentials</th> |
| | 4304 | <td class="description">Credentials</td></tr> |
| | 4305 | </tbody></table> |
| | 4306 | <h4 class="returnvalue">Return Value</h4> |
| | 4307 | <p class="description">Expiration date of credentials</p> |
| | 4308 | <h3 class="function"><a id="cupsGetCredentialsInfo">cupsGetCredentialsInfo</a></h3> |
| | 4309 | <p class="description">Return a string describing the credentials.</p> |
| | 4310 | <p class="code"> |
| | 4311 | <span class="reserved">char</span> *cupsGetCredentialsInfo(<span class="reserved">const</span> <span class="reserved">char</span> *credentials, <span class="reserved">char</span> *buffer, size_t bufsize);</p> |
| | 4312 | <h4 class="parameters">Parameters</h4> |
| | 4313 | <table class="list"><tbody> |
| | 4314 | <tr><th>credentials</th> |
| | 4315 | <td class="description">Credentials</td></tr> |
| | 4316 | <tr><th>buffer</th> |
| | 4317 | <td class="description">Buffer</td></tr> |
| | 4318 | <tr><th>bufsize</th> |
| | 4319 | <td class="description">Size of buffer</td></tr> |
| | 4320 | </tbody></table> |
| | 4321 | <h4 class="returnvalue">Return Value</h4> |
| | 4322 | <p class="description">Credentials description or <code>NULL</code> on error</p> |
| | 4323 | <h3 class="function"><a id="cupsGetCredentialsTrust">cupsGetCredentialsTrust</a></h3> |
| | 4324 | <p class="description">Return the trust of credentials.</p> |
| | 4325 | <p class="code"> |
| | 4326 | <a href="#http_trust_t">http_trust_t</a> cupsGetCredentialsTrust(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">const</span> <span class="reserved">char</span> *common_name, <span class="reserved">const</span> <span class="reserved">char</span> *credentials, <span class="reserved">bool</span> require_ca);</p> |
| | 4327 | <h4 class="parameters">Parameters</h4> |
| | 4328 | <table class="list"><tbody> |
| | 4329 | <tr><th>path</th> |
| | 4330 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 4331 | <tr><th>common_name</th> |
| | 4332 | <td class="description">Common name for trust lookup</td></tr> |
| | 4333 | <tr><th>credentials</th> |
| | 4334 | <td class="description">Credentials</td></tr> |
| | 4335 | <tr><th>require_ca</th> |
| | 4336 | <td class="description">Require a CA-signed certificate?</td></tr> |
| | 4337 | </tbody></table> |
| | 4338 | <h4 class="returnvalue">Return Value</h4> |
| | 4339 | <p class="description">Level of trust</p> |
| | 4340 | <h4 class="discussion">Discussion</h4> |
| | 4341 | <p class="discussion">This function determines the level of trust for the supplied credentials. |
| | 4342 | The "path" parameter specifies the certificate/key store for known |
| | 4343 | credentials and certificate authorities. The "common_name" parameter |
| | 4344 | specifies the FQDN of the service being accessed such as |
| | 4345 | "printer.example.com". The "credentials" parameter provides the credentials |
| | 4346 | being evaluated, which are usually obtained with the |
| | 4347 | <a href="#httpCopyPeerCredentials"><code>httpCopyPeerCredentials</code></a> function. The "require_ca" parameter |
| | 4348 | specifies whether a CA-signed certificate is required for trust.<br> |
| | 4349 | <br> |
| | 4350 | The <code>AllowAnyRoot</code>, <code>AllowExpiredCerts</code>, <code>TrustOnFirstUse</code>, and |
| | 4351 | <code>ValidateCerts</code> options in the "client.conf" file (or corresponding |
| | 4352 | preferences file on macOS) control the trust policy, which defaults to |
| | 4353 | AllowAnyRoot=Yes, AllowExpiredCerts=No, TrustOnFirstUse=Yes, and |
| | 4354 | ValidateCerts=No. When the "require_ca" parameter is <code>true</code> the AllowAnyRoot |
| | 4355 | and TrustOnFirstUse policies are turned off ("No").<br> |
| | 4356 | <br> |
| | 4357 | The returned trust value can be one of the following: |
| | 4358 | |
| | 4359 | </p><ul> |
| | 4360 | <li><code>HTTP_TRUST_OK</code>: Credentials are OK/trusted |
| | 4361 | </li> |
| | 4362 | <li><code>HTTP_TRUST_INVALID</code>: Credentials are invalid |
| | 4363 | </li> |
| | 4364 | <li><code>HTTP_TRUST_EXPIRED</code>: Credentials are expired |
| | 4365 | </li> |
| | 4366 | <li><code>HTTP_TRUST_RENEWED</code>: Credentials have been renewed |
| | 4367 | </li> |
| | 4368 | <li><code>HTTP_TRUST_UNKNOWN</code>: Credentials are unknown/new</li> |
| | 4369 | </ul> |
| | 4370 | <h3 class="function"><a id="cupsGetDest">cupsGetDest</a></h3> |
| | 4371 | <p class="description">Get the named destination from the list.</p> |
| | 4372 | <p class="code"> |
| | 4373 | <a href="#cups_dest_t">cups_dest_t</a> *cupsGetDest(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *instance, <span class="reserved">int</span> num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
| | 4374 | <h4 class="parameters">Parameters</h4> |
| | 4375 | <table class="list"><tbody> |
| | 4376 | <tr><th>name</th> |
| | 4377 | <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr> |
| | 4378 | <tr><th>instance</th> |
| | 4379 | <td class="description">Instance name or <code>NULL</code></td></tr> |
| | 4380 | <tr><th>num_dests</th> |
| | 4381 | <td class="description">Number of destinations</td></tr> |
| | 4382 | <tr><th>dests</th> |
| | 4383 | <td class="description">Destinations</td></tr> |
| | 4384 | </tbody></table> |
| | 4385 | <h4 class="returnvalue">Return Value</h4> |
| | 4386 | <p class="description">Destination pointer or <code>NULL</code></p> |
| | 4387 | <h4 class="discussion">Discussion</h4> |
| | 4388 | <p class="discussion">Use the <a href="#cupsEnumDests"><code>cupsEnumDests</code></a> or <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> functions to get a |
| | 4389 | list of supported destinations for the current user.</p> |
| | 4390 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></h3> |
| | 4391 | <p class="description">Get a media name, dimension, and margins for a |
| | 4392 | specific size.</p> |
| | 4393 | <p class="code"> |
| | 4394 | <span class="reserved">int</span> 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, <span class="reserved">int</span> n, <span class="reserved">unsigned</span> flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| | 4395 | <h4 class="parameters">Parameters</h4> |
| | 4396 | <table class="list"><tbody> |
| | 4397 | <tr><th>http</th> |
| | 4398 | <td class="description">Connection to destination</td></tr> |
| | 4399 | <tr><th>dest</th> |
| | 4400 | <td class="description">Destination</td></tr> |
| | 4401 | <tr><th>dinfo</th> |
| | 4402 | <td class="description">Destination information</td></tr> |
| | 4403 | <tr><th>n</th> |
| | 4404 | <td class="description">Media size number (0-based)</td></tr> |
| | 4405 | <tr><th>flags</th> |
| | 4406 | <td class="description">Media flags</td></tr> |
| | 4407 | <tr><th>size</th> |
| | 4408 | <td class="description">Media size information</td></tr> |
| | 4409 | </tbody></table> |
| | 4410 | <h4 class="returnvalue">Return Value</h4> |
| | 4411 | <p class="description">1 on success, 0 on failure</p> |
| | 4412 | <h4 class="discussion">Discussion</h4> |
| | 4413 | <p class="discussion">The <code>flags</code> parameter determines which set of media are indexed. For |
| | 4414 | example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will get the Nth |
| | 4415 | borderless size supported by the printer. |
| | 4416 | |
| | 4417 | </p> |
| | 4418 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetDestMediaByIndex2">cupsGetDestMediaByIndex2</a></h3> |
| | 4419 | <p class="description">Get specific media information.</p> |
| | 4420 | <p class="code"> |
| | 4421 | <span class="reserved">bool</span> cupsGetDestMediaByIndex2(<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, size_t n, <span class="reserved">unsigned</span> flags, <a href="#cups_media_t">cups_media_t</a> *media);</p> |
| | 4422 | <h4 class="parameters">Parameters</h4> |
| | 4423 | <table class="list"><tbody> |
| | 4424 | <tr><th>http</th> |
| | 4425 | <td class="description">Connection to destination</td></tr> |
| | 4426 | <tr><th>dest</th> |
| | 4427 | <td class="description">Destination</td></tr> |
| | 4428 | <tr><th>dinfo</th> |
| | 4429 | <td class="description">Destination information</td></tr> |
| | 4430 | <tr><th>n</th> |
| | 4431 | <td class="description">Media number (0-based)</td></tr> |
| | 4432 | <tr><th>flags</th> |
| | 4433 | <td class="description">Media flags</td></tr> |
| | 4434 | <tr><th>media</th> |
| | 4435 | <td class="description">Media information</td></tr> |
| | 4436 | </tbody></table> |
| | 4437 | <h4 class="returnvalue">Return Value</h4> |
| | 4438 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 4439 | <h4 class="discussion">Discussion</h4> |
| | 4440 | <p class="discussion">The <code>flags</code> parameter determines which set of media are indexed. For |
| | 4441 | example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will get the Nth |
| | 4442 | borderless size supported by the printer. |
| | 4443 | |
| | 4444 | </p> |
| | 4445 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsGetDestMediaByName">cupsGetDestMediaByName</a></h3> |
| | 4446 | <p class="description">Get media names, dimensions, and margins.</p> |
| | 4447 | <p class="code"> |
| | 4448 | <span class="reserved">int</span> 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, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">unsigned</span> flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| | 4449 | <h4 class="parameters">Parameters</h4> |
| | 4450 | <table class="list"><tbody> |
| | 4451 | <tr><th>http</th> |
| | 4452 | <td class="description">Connection to destination</td></tr> |
| | 4453 | <tr><th>dest</th> |
| | 4454 | <td class="description">Destination</td></tr> |
| | 4455 | <tr><th>dinfo</th> |
| | 4456 | <td class="description">Destination information</td></tr> |
| | 4457 | <tr><th>name</th> |
| | 4458 | <td class="description">Media name</td></tr> |
| | 4459 | <tr><th>flags</th> |
| | 4460 | <td class="description">Media matching flags</td></tr> |
| | 4461 | <tr><th>size</th> |
| | 4462 | <td class="description">Media size information</td></tr> |
| | 4463 | </tbody></table> |
| | 4464 | <h4 class="returnvalue">Return Value</h4> |
| | 4465 | <p class="description">1 on match, 0 on failure</p> |
| | 4466 | <h4 class="discussion">Discussion</h4> |
| | 4467 | <p class="discussion">The "media" string is a PWG media name. "Flags" provides some matching |
| | 4468 | guidance (multiple flags can be combined):<br> |
| | 4469 | <br> |
| | 4470 | CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, |
| | 4471 | CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, |
| | 4472 | CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, |
| | 4473 | CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and |
| | 4474 | CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the |
| | 4475 | size amongst the "ready" media.<br> |
| | 4476 | <br> |
| | 4477 | The matching result (if any) is returned in the "cups_size_t" structure.<br> |
| | 4478 | <br> |
| | 4479 | Returns 1 when there is a match and 0 if there is not a match. |
| | 4480 | |
| | 4481 | </p> |
| | 4482 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsGetDestMediaByName2">cupsGetDestMediaByName2</a></h3> |
| | 4483 | <p class="description">Get media names, dimensions, and margins.</p> |
| | 4484 | <p class="code"> |
| | 4485 | <span class="reserved">bool</span> cupsGetDestMediaByName2(<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, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">unsigned</span> flags, <a href="#cups_media_t">cups_media_t</a> *media);</p> |
| | 4486 | <h4 class="parameters">Parameters</h4> |
| | 4487 | <table class="list"><tbody> |
| | 4488 | <tr><th>http</th> |
| | 4489 | <td class="description">Connection to destination</td></tr> |
| | 4490 | <tr><th>dest</th> |
| | 4491 | <td class="description">Destination</td></tr> |
| | 4492 | <tr><th>dinfo</th> |
| | 4493 | <td class="description">Destination information</td></tr> |
| | 4494 | <tr><th>name</th> |
| | 4495 | <td class="description">Media name</td></tr> |
| | 4496 | <tr><th>flags</th> |
| | 4497 | <td class="description">Media matching flags</td></tr> |
| | 4498 | <tr><th>media</th> |
| | 4499 | <td class="description">Media information</td></tr> |
| | 4500 | </tbody></table> |
| | 4501 | <h4 class="returnvalue">Return Value</h4> |
| | 4502 | <p class="description"><code>true</code> on match, <code>false</code> on failure</p> |
| | 4503 | <h4 class="discussion">Discussion</h4> |
| | 4504 | <p class="discussion">The "media" string is a PWG media name. "Flags" provides some matching |
| | 4505 | guidance (multiple flags can be combined):<br> |
| | 4506 | <br> |
| | 4507 | CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, |
| | 4508 | CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, |
| | 4509 | CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, |
| | 4510 | CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and |
| | 4511 | CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the |
| | 4512 | size amongst the "ready" media.<br> |
| | 4513 | <br> |
| | 4514 | The matching result (if any) is returned in the "cups_size_t" structure.<br> |
| | 4515 | <br> |
| | 4516 | Returns <code>true</code> when there is a match and <code>false</code> if there is not a match. |
| | 4517 | |
| | 4518 | </p> |
| | 4519 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></h3> |
| | 4520 | <p class="description">Get media names, dimensions, and margins.</p> |
| | 4521 | <p class="code"> |
| | 4522 | <span class="reserved">int</span> 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, <span class="reserved">int</span> width, <span class="reserved">int</span> length, <span class="reserved">unsigned</span> flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| | 4523 | <h4 class="parameters">Parameters</h4> |
| | 4524 | <table class="list"><tbody> |
| | 4525 | <tr><th>http</th> |
| | 4526 | <td class="description">Connection to destination</td></tr> |
| | 4527 | <tr><th>dest</th> |
| | 4528 | <td class="description">Destination</td></tr> |
| | 4529 | <tr><th>dinfo</th> |
| | 4530 | <td class="description">Destination information</td></tr> |
| | 4531 | <tr><th>width</th> |
| | 4532 | <td class="description">Media width in hundredths of |
| | 4533 | of millimeters</td></tr> |
| | 4534 | <tr><th>length</th> |
| | 4535 | <td class="description">Media length in hundredths of |
| | 4536 | of millimeters</td></tr> |
| | 4537 | <tr><th>flags</th> |
| | 4538 | <td class="description">Media matching flags</td></tr> |
| | 4539 | <tr><th>size</th> |
| | 4540 | <td class="description">Media size information</td></tr> |
| | 4541 | </tbody></table> |
| | 4542 | <h4 class="returnvalue">Return Value</h4> |
| | 4543 | <p class="description">1 on match, 0 on failure</p> |
| | 4544 | <h4 class="discussion">Discussion</h4> |
| | 4545 | <p class="discussion">"Width" and "length" are the dimensions in hundredths of millimeters. |
| | 4546 | "Flags" provides some matching guidance (multiple flags can be combined):<br> |
| | 4547 | <br> |
| | 4548 | CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, |
| | 4549 | CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, |
| | 4550 | CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, |
| | 4551 | CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and |
| | 4552 | CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the |
| | 4553 | size amongst the "ready" media.<br> |
| | 4554 | <br> |
| | 4555 | The matching result (if any) is returned in the "cups_size_t" structure.<br> |
| | 4556 | <br> |
| | 4557 | Returns 1 when there is a match and 0 if there is not a match. |
| | 4558 | |
| | 4559 | </p> |
| | 4560 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetDestMediaBySize2">cupsGetDestMediaBySize2</a></h3> |
| | 4561 | <p class="description">Get media names, dimensions, and margins.</p> |
| | 4562 | <p class="code"> |
| | 4563 | <span class="reserved">bool</span> cupsGetDestMediaBySize2(<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, <span class="reserved">int</span> width, <span class="reserved">int</span> length, <span class="reserved">unsigned</span> flags, <a href="#cups_media_t">cups_media_t</a> *media);</p> |
| | 4564 | <h4 class="parameters">Parameters</h4> |
| | 4565 | <table class="list"><tbody> |
| | 4566 | <tr><th>http</th> |
| | 4567 | <td class="description">Connection to destination</td></tr> |
| | 4568 | <tr><th>dest</th> |
| | 4569 | <td class="description">Destination</td></tr> |
| | 4570 | <tr><th>dinfo</th> |
| | 4571 | <td class="description">Destination information</td></tr> |
| | 4572 | <tr><th>width</th> |
| | 4573 | <td class="description">Media width in hundredths of millimeters</td></tr> |
| | 4574 | <tr><th>length</th> |
| | 4575 | <td class="description">Media length in hundredths of millimeters</td></tr> |
| | 4576 | <tr><th>flags</th> |
| | 4577 | <td class="description">Media matching flags</td></tr> |
| | 4578 | <tr><th>media</th> |
| | 4579 | <td class="description">Media information</td></tr> |
| | 4580 | </tbody></table> |
| | 4581 | <h4 class="returnvalue">Return Value</h4> |
| | 4582 | <p class="description"><code>true</code> on match, <code>false</code> on failure</p> |
| | 4583 | <h4 class="discussion">Discussion</h4> |
| | 4584 | <p class="discussion">"Width" and "length" are the dimensions in hundredths of millimeters. |
| | 4585 | "Flags" provides some matching guidance (multiple flags can be combined):<br> |
| | 4586 | <br> |
| | 4587 | CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, |
| | 4588 | CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, |
| | 4589 | CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, |
| | 4590 | CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and |
| | 4591 | CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the |
| | 4592 | size amongst the "ready" media.<br> |
| | 4593 | <br> |
| | 4594 | The matching result (if any) is returned in the "cups_size_t" structure.<br> |
| | 4595 | <br> |
| | 4596 | Returns <code>true</code> when there is a match and <code>false</code> if there is not a match. |
| | 4597 | |
| | 4598 | </p> |
| | 4599 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="cupsGetDestMediaCount">cupsGetDestMediaCount</a></h3> |
| | 4600 | <p class="description">Get the number of sizes supported by a |
| | 4601 | destination.</p> |
| | 4602 | <p class="code"> |
| | 4603 | <span class="reserved">int</span> 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, <span class="reserved">unsigned</span> flags);</p> |
| | 4604 | <h4 class="parameters">Parameters</h4> |
| | 4605 | <table class="list"><tbody> |
| | 4606 | <tr><th>http</th> |
| | 4607 | <td class="description">Connection to destination</td></tr> |
| | 4608 | <tr><th>dest</th> |
| | 4609 | <td class="description">Destination</td></tr> |
| | 4610 | <tr><th>dinfo</th> |
| | 4611 | <td class="description">Destination information</td></tr> |
| | 4612 | <tr><th>flags</th> |
| | 4613 | <td class="description">Media flags</td></tr> |
| | 4614 | </tbody></table> |
| | 4615 | <h4 class="returnvalue">Return Value</h4> |
| | 4616 | <p class="description">Number of sizes</p> |
| | 4617 | <h4 class="discussion">Discussion</h4> |
| | 4618 | <p class="discussion">The <code>flags</code> parameter determines the set of media sizes that are |
| | 4619 | counted. For example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return |
| | 4620 | the number of borderless sizes. |
| | 4621 | |
| | 4622 | </p> |
| | 4623 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></h3> |
| | 4624 | <p class="description">Get the default size for a destination.</p> |
| | 4625 | <p class="code"> |
| | 4626 | <span class="reserved">int</span> 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, <span class="reserved">unsigned</span> flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| | 4627 | <h4 class="parameters">Parameters</h4> |
| | 4628 | <table class="list"><tbody> |
| | 4629 | <tr><th>http</th> |
| | 4630 | <td class="description">Connection to destination</td></tr> |
| | 4631 | <tr><th>dest</th> |
| | 4632 | <td class="description">Destination</td></tr> |
| | 4633 | <tr><th>dinfo</th> |
| | 4634 | <td class="description">Destination information</td></tr> |
| | 4635 | <tr><th>flags</th> |
| | 4636 | <td class="description">Media flags</td></tr> |
| | 4637 | <tr><th>size</th> |
| | 4638 | <td class="description">Media size information</td></tr> |
| | 4639 | </tbody></table> |
| | 4640 | <h4 class="returnvalue">Return Value</h4> |
| | 4641 | <p class="description">1 on success, 0 on failure</p> |
| | 4642 | <h4 class="discussion">Discussion</h4> |
| | 4643 | <p class="discussion">The <code>flags</code> parameter determines which default size is returned. For |
| | 4644 | example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return the default |
| | 4645 | borderless size, typically US Letter or A4, but sometimes 4x6 photo media. |
| | 4646 | |
| | 4647 | </p> |
| | 4648 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetDestMediaDefault2">cupsGetDestMediaDefault2</a></h3> |
| | 4649 | <p class="description">Get the default size for a destination.</p> |
| | 4650 | <p class="code"> |
| | 4651 | <span class="reserved">bool</span> cupsGetDestMediaDefault2(<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, <span class="reserved">unsigned</span> flags, <a href="#cups_media_t">cups_media_t</a> *media);</p> |
| | 4652 | <h4 class="parameters">Parameters</h4> |
| | 4653 | <table class="list"><tbody> |
| | 4654 | <tr><th>http</th> |
| | 4655 | <td class="description">Connection to destination</td></tr> |
| | 4656 | <tr><th>dest</th> |
| | 4657 | <td class="description">Destination</td></tr> |
| | 4658 | <tr><th>dinfo</th> |
| | 4659 | <td class="description">Destination information</td></tr> |
| | 4660 | <tr><th>flags</th> |
| | 4661 | <td class="description">Media flags</td></tr> |
| | 4662 | <tr><th>media</th> |
| | 4663 | <td class="description">Media information</td></tr> |
| | 4664 | </tbody></table> |
| | 4665 | <h4 class="returnvalue">Return Value</h4> |
| | 4666 | <p class="description"><code>true</code> on match, <code>false</code> on failure</p> |
| | 4667 | <h4 class="discussion">Discussion</h4> |
| | 4668 | <p class="discussion">The <code>flags</code> parameter determines which default size is returned. For |
| | 4669 | example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return the default |
| | 4670 | borderless size, typically US Letter or A4, but sometimes 4x6 photo media. |
| | 4671 | |
| | 4672 | </p> |
| | 4673 | <h3 class="function"><span class="info"> CUPS 2.0 </span><a id="cupsGetDestWithURI">cupsGetDestWithURI</a></h3> |
| | 4674 | <p class="description">Get a destination associated with a URI.</p> |
| | 4675 | <p class="code"> |
| | 4676 | <a href="#cups_dest_t">cups_dest_t</a> *cupsGetDestWithURI(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *uri);</p> |
| | 4677 | <h4 class="parameters">Parameters</h4> |
| | 4678 | <table class="list"><tbody> |
| | 4679 | <tr><th>name</th> |
| | 4680 | <td class="description">Desired printer name or <code>NULL</code></td></tr> |
| | 4681 | <tr><th>uri</th> |
| | 4682 | <td class="description">URI for the printer</td></tr> |
| | 4683 | </tbody></table> |
| | 4684 | <h4 class="returnvalue">Return Value</h4> |
| | 4685 | <p class="description">Destination or <code>NULL</code></p> |
| | 4686 | <h4 class="discussion">Discussion</h4> |
| | 4687 | <p class="discussion">"name" is the desired name for the printer. If <code>NULL</code>, a name will be |
| | 4688 | created using the URI.<br> |
| | 4689 | <br> |
| | 4690 | "uri" is the "ipp" or "ipps" URI for the printer. |
| | 4691 | |
| | 4692 | </p> |
| | 4693 | <h3 class="function"><span class="info"> CUPS 1.1.21 </span><a id="cupsGetDests2">cupsGetDests2</a></h3> |
| | 4694 | <p class="description">Get the list of destinations from the specified server.</p> |
| | 4695 | <p class="code"> |
| | 4696 | <span class="reserved">int</span> cupsGetDests2(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
| | 4697 | <h4 class="parameters">Parameters</h4> |
| | 4698 | <table class="list"><tbody> |
| | 4699 | <tr><th>http</th> |
| | 4700 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 4701 | <tr><th>dests</th> |
| | 4702 | <td class="description">Destinations</td></tr> |
| | 4703 | </tbody></table> |
| | 4704 | <h4 class="returnvalue">Return Value</h4> |
| | 4705 | <p class="description">Number of destinations</p> |
| | 4706 | <h4 class="discussion">Discussion</h4> |
| | 4707 | <p class="discussion">Starting with CUPS 1.2, the returned list of destinations include the |
| | 4708 | "printer-info", "printer-is-accepting-jobs", "printer-is-shared", |
| | 4709 | "printer-make-and-model", "printer-state", "printer-state-change-time", |
| | 4710 | "printer-state-reasons", "printer-type", and "printer-uri-supported" |
| | 4711 | attributes as options.<br> |
| | 4712 | <br> |
| | 4713 | CUPS 1.4 adds the "marker-change-time", "marker-colors", |
| | 4714 | "marker-high-levels", "marker-levels", "marker-low-levels", "marker-message", |
| | 4715 | "marker-names", "marker-types", and "printer-commands" attributes as options.<br> |
| | 4716 | <br> |
| | 4717 | CUPS 2.2 adds accessible IPP printers to the list of destinations that can |
| | 4718 | be used. The "printer-uri-supported" option will be present for those IPP |
| | 4719 | printers that have been recently used.<br> |
| | 4720 | <br> |
| | 4721 | Use the <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> function to free the destination list and |
| | 4722 | the <a href="#cupsGetDest"><code>cupsGetDest</code></a> function to find a particular destination. |
| | 4723 | |
| | 4724 | </p> |
| | 4725 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetEncryption">cupsGetEncryption</a></h3> |
| | 4726 | <p class="description">Get the current encryption settings.</p> |
| | 4727 | <p class="code"> |
| | 4728 | <a href="#http_encryption_t">http_encryption_t</a> cupsGetEncryption(<span class="reserved">void</span>);</p> |
| | 4729 | <h4 class="returnvalue">Return Value</h4> |
| | 4730 | <p class="description">Encryption settings</p> |
| | 4731 | <h4 class="discussion">Discussion</h4> |
| | 4732 | <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION |
| | 4733 | environment variable, then the ~/.cups/client.conf file, and finally the |
| | 4734 | /etc/cups/client.conf file. If not set, the default is |
| | 4735 | <code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> |
| | 4736 | <br> |
| | 4737 | Note: The current encryption setting is tracked separately for each thread |
| | 4738 | in a program. Multi-threaded programs that override the setting via the |
| | 4739 | <a href="#cupsSetEncryption"><code>cupsSetEncryption</code></a> function need to do so in each thread for the same |
| | 4740 | setting to be used. |
| | 4741 | |
| | 4742 | </p> |
| | 4743 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetError">cupsGetError</a></h3> |
| | 4744 | <p class="description">Return the last IPP status code received on the current thread.</p> |
| | 4745 | <p class="code"> |
| | 4746 | ipp_status_t cupsGetError(<span class="reserved">void</span>);</p> |
| | 4747 | <h4 class="returnvalue">Return Value</h4> |
| | 4748 | <p class="description">IPP status code from last request</p> |
| | 4749 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetErrorString">cupsGetErrorString</a></h3> |
| | 4750 | <p class="description">Return the last IPP status-message received on the current thread.</p> |
| | 4751 | <p class="code"> |
| | 4752 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsGetErrorString(<span class="reserved">void</span>);</p> |
| | 4753 | <h4 class="returnvalue">Return Value</h4> |
| | 4754 | <p class="description">status-message text from last request</p> |
| | 4755 | <h3 class="function"><span class="info"> CUPS 1.1.20 </span><a id="cupsGetFd">cupsGetFd</a></h3> |
| | 4756 | <p class="description">Get a file from the server.</p> |
| | 4757 | <p class="code"> |
| | 4758 | http_status_t cupsGetFd(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *resource, <span class="reserved">int</span> fd);</p> |
| | 4759 | <h4 class="parameters">Parameters</h4> |
| | 4760 | <table class="list"><tbody> |
| | 4761 | <tr><th>http</th> |
| | 4762 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 4763 | <tr><th>resource</th> |
| | 4764 | <td class="description">Resource name</td></tr> |
| | 4765 | <tr><th>fd</th> |
| | 4766 | <td class="description">File descriptor</td></tr> |
| | 4767 | </tbody></table> |
| | 4768 | <h4 class="returnvalue">Return Value</h4> |
| | 4769 | <p class="description">HTTP status</p> |
| | 4770 | <h4 class="discussion">Discussion</h4> |
| | 4771 | <p class="discussion">This function returns <code>HTTP_STATUS_OK</code> when the file is successfully retrieved. |
| | 4772 | |
| | 4773 | </p> |
| | 4774 | <h3 class="function"><span class="info"> CUPS 1.1.20 </span><a id="cupsGetFile">cupsGetFile</a></h3> |
| | 4775 | <p class="description">Get a file from the server.</p> |
| | 4776 | <p class="code"> |
| | 4777 | http_status_t cupsGetFile(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *resource, <span class="reserved">const</span> <span class="reserved">char</span> *filename);</p> |
| | 4778 | <h4 class="parameters">Parameters</h4> |
| | 4779 | <table class="list"><tbody> |
| | 4780 | <tr><th>http</th> |
| | 4781 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 4782 | <tr><th>resource</th> |
| | 4783 | <td class="description">Resource name</td></tr> |
| | 4784 | <tr><th>filename</th> |
| | 4785 | <td class="description">Filename</td></tr> |
| | 4786 | </tbody></table> |
| | 4787 | <h4 class="returnvalue">Return Value</h4> |
| | 4788 | <p class="description">HTTP status</p> |
| | 4789 | <h4 class="discussion">Discussion</h4> |
| | 4790 | <p class="discussion">This function returns <code>HTTP_STATUS_OK</code> when the file is successfully retrieved. |
| | 4791 | |
| | 4792 | </p> |
| | 4793 | <h3 class="function"><span class="info"> CUPS 2.2.4 </span><a id="cupsGetIntegerOption">cupsGetIntegerOption</a></h3> |
| | 4794 | <p class="description">Get an integer option value.</p> |
| | 4795 | <p class="code"> |
| | 4796 | <span class="reserved">int</span> cupsGetIntegerOption(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| | 4797 | <h4 class="parameters">Parameters</h4> |
| | 4798 | <table class="list"><tbody> |
| | 4799 | <tr><th>name</th> |
| | 4800 | <td class="description">Name of option</td></tr> |
| | 4801 | <tr><th>num_options</th> |
| | 4802 | <td class="description">Number of options</td></tr> |
| | 4803 | <tr><th>options</th> |
| | 4804 | <td class="description">Options</td></tr> |
| | 4805 | </tbody></table> |
| | 4806 | <h4 class="returnvalue">Return Value</h4> |
| | 4807 | <p class="description">Option value or <code>INT_MIN</code></p> |
| | 4808 | <h4 class="discussion">Discussion</h4> |
| | 4809 | <p class="discussion">INT_MIN is returned when the option does not exist, is not an integer, or |
| | 4810 | exceeds the range of values for the "int" type. |
| | 4811 | |
| | 4812 | </p> |
| | 4813 | <h3 class="function"><span class="info"> CUPS 1.1.21 </span><a id="cupsGetJobs2">cupsGetJobs2</a></h3> |
| | 4814 | <p class="description">Get the jobs from the specified server.</p> |
| | 4815 | <p class="code"> |
| | 4816 | <span class="reserved">int</span> cupsGetJobs2(<a href="#http_t">http_t</a> *http, <a href="#cups_job_t">cups_job_t</a> **jobs, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> myjobs, <span class="reserved">int</span> whichjobs);</p> |
| | 4817 | <h4 class="parameters">Parameters</h4> |
| | 4818 | <table class="list"><tbody> |
| | 4819 | <tr><th>http</th> |
| | 4820 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 4821 | <tr><th>jobs</th> |
| | 4822 | <td class="description">Job data</td></tr> |
| | 4823 | <tr><th>name</th> |
| | 4824 | <td class="description"><code>NULL</code> = all destinations, otherwise show jobs for named destination</td></tr> |
| | 4825 | <tr><th>myjobs</th> |
| | 4826 | <td class="description">0 = all users, 1 = mine</td></tr> |
| | 4827 | <tr><th>whichjobs</th> |
| | 4828 | <td class="description"><code>CUPS_WHICHJOBS_ALL</code>, <code>CUPS_WHICHJOBS_ACTIVE</code>, or <code>CUPS_WHICHJOBS_COMPLETED</code></td></tr> |
| | 4829 | </tbody></table> |
| | 4830 | <h4 class="returnvalue">Return Value</h4> |
| | 4831 | <p class="description">Number of jobs</p> |
| | 4832 | <h4 class="discussion">Discussion</h4> |
| | 4833 | <p class="discussion">A "whichjobs" value of <code>CUPS_WHICHJOBS_ALL</code> returns all jobs regardless |
| | 4834 | of state, while <code>CUPS_WHICHJOBS_ACTIVE</code> returns jobs that are |
| | 4835 | pending, processing, or held and <code>CUPS_WHICHJOBS_COMPLETED</code> returns |
| | 4836 | jobs that are stopped, canceled, aborted, or completed. |
| | 4837 | |
| | 4838 | </p> |
| | 4839 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="cupsGetNamedDest">cupsGetNamedDest</a></h3> |
| | 4840 | <p class="description">Get options for the named destination.</p> |
| | 4841 | <p class="code"> |
| | 4842 | <a href="#cups_dest_t">cups_dest_t</a> *cupsGetNamedDest(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *instance);</p> |
| | 4843 | <h4 class="parameters">Parameters</h4> |
| | 4844 | <table class="list"><tbody> |
| | 4845 | <tr><th>http</th> |
| | 4846 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 4847 | <tr><th>name</th> |
| | 4848 | <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr> |
| | 4849 | <tr><th>instance</th> |
| | 4850 | <td class="description">Instance name or <code>NULL</code></td></tr> |
| | 4851 | </tbody></table> |
| | 4852 | <h4 class="returnvalue">Return Value</h4> |
| | 4853 | <p class="description">Destination or <code>NULL</code></p> |
| | 4854 | <h4 class="discussion">Discussion</h4> |
| | 4855 | <p class="discussion">This function is optimized for retrieving a single destination and should |
| | 4856 | be used instead of <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> and <a href="#cupsGetDest"><code>cupsGetDest</code></a> when you |
| | 4857 | either know the name of the destination or want to print to the default |
| | 4858 | destination. If <code>NULL</code> is returned, the destination does not exist or |
| | 4859 | there is no default destination.<br> |
| | 4860 | <br> |
| | 4861 | If "http" is <code>CUPS_HTTP_DEFAULT</code>, the connection to the default print |
| | 4862 | server will be used.<br> |
| | 4863 | <br> |
| | 4864 | If "name" is <code>NULL</code>, the default printer for the current user will be |
| | 4865 | returned.<br> |
| | 4866 | <br> |
| | 4867 | The returned destination must be freed using <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> with a |
| | 4868 | "num_dests" value of 1. |
| | 4869 | |
| | 4870 | </p> |
| | 4871 | <h3 class="function"><a id="cupsGetOption">cupsGetOption</a></h3> |
| | 4872 | <p class="description">Get an option value.</p> |
| | 4873 | <p class="code"> |
| | 4874 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsGetOption(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
| | 4875 | <h4 class="parameters">Parameters</h4> |
| | 4876 | <table class="list"><tbody> |
| | 4877 | <tr><th>name</th> |
| | 4878 | <td class="description">Name of option</td></tr> |
| | 4879 | <tr><th>num_options</th> |
| | 4880 | <td class="description">Number of options</td></tr> |
| | 4881 | <tr><th>options</th> |
| | 4882 | <td class="description">Options</td></tr> |
| | 4883 | </tbody></table> |
| | 4884 | <h4 class="returnvalue">Return Value</h4> |
| | 4885 | <p class="description">Option value or <code>NULL</code></p> |
| | 4886 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="cupsGetPassword2">cupsGetPassword2</a></h3> |
| | 4887 | <p class="description">Get a password from the user using the current |
| | 4888 | password callback.</p> |
| | 4889 | <p class="code"> |
| | 4890 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsGetPassword2(<span class="reserved">const</span> <span class="reserved">char</span> *prompt, <a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *method, <span class="reserved">const</span> <span class="reserved">char</span> *resource);</p> |
| | 4891 | <h4 class="parameters">Parameters</h4> |
| | 4892 | <table class="list"><tbody> |
| | 4893 | <tr><th>prompt</th> |
| | 4894 | <td class="description">Prompt string</td></tr> |
| | 4895 | <tr><th>http</th> |
| | 4896 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 4897 | <tr><th>method</th> |
| | 4898 | <td class="description">Request method ("GET", "POST", "PUT")</td></tr> |
| | 4899 | <tr><th>resource</th> |
| | 4900 | <td class="description">Resource path</td></tr> |
| | 4901 | </tbody></table> |
| | 4902 | <h4 class="returnvalue">Return Value</h4> |
| | 4903 | <p class="description">Password</p> |
| | 4904 | <h4 class="discussion">Discussion</h4> |
| | 4905 | <p class="discussion">Uses the current password callback function. Returns <code>NULL</code> if the |
| | 4906 | user does not provide a password.<br> |
| | 4907 | <br> |
| | 4908 | Note: The current password callback function is tracked separately for each |
| | 4909 | thread in a program. Multi-threaded programs that override the setting via |
| | 4910 | the <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> function need to do so in each thread for the |
| | 4911 | same function to be used. |
| | 4912 | |
| | 4913 | </p> |
| | 4914 | <h3 class="function"><a id="cupsGetRand">cupsGetRand</a></h3> |
| | 4915 | <p class="description">Return a 32-bit pseudo-random number.</p> |
| | 4916 | <p class="code"> |
| | 4917 | <span class="reserved">unsigned</span> cupsGetRand(<span class="reserved">void</span>);</p> |
| | 4918 | <h4 class="returnvalue">Return Value</h4> |
| | 4919 | <p class="description">Random number</p> |
| | 4920 | <h4 class="discussion">Discussion</h4> |
| | 4921 | <p class="discussion">This function returns a 32-bit pseudo-random number suitable for use as |
| | 4922 | one-time identifiers or nonces. The random numbers are generated/seeded |
| | 4923 | using system entropy.</p> |
| | 4924 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="cupsGetResponse">cupsGetResponse</a></h3> |
| | 4925 | <p class="description">Get a response to an IPP request.</p> |
| | 4926 | <p class="code"> |
| | 4927 | <a href="#ipp_t">ipp_t</a> *cupsGetResponse(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *resource);</p> |
| | 4928 | <h4 class="parameters">Parameters</h4> |
| | 4929 | <table class="list"><tbody> |
| | 4930 | <tr><th>http</th> |
| | 4931 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 4932 | <tr><th>resource</th> |
| | 4933 | <td class="description">HTTP resource for POST</td></tr> |
| | 4934 | </tbody></table> |
| | 4935 | <h4 class="returnvalue">Return Value</h4> |
| | 4936 | <p class="description">Response or <code>NULL</code> on HTTP error</p> |
| | 4937 | <h4 class="discussion">Discussion</h4> |
| | 4938 | <p class="discussion">Use this function to get the response for an IPP request sent using |
| | 4939 | <a href="#cupsSendRequest"><code>cupsSendRequest</code></a>. For requests that return additional data, use |
| | 4940 | <a href="#cupsReadResponseData"><code>cupsReadResponseData</code></a> after getting a successful response, |
| | 4941 | otherwise call <a href="#httpFlush"><code>httpFlush</code></a> to complete the response processing. |
| | 4942 | |
| | 4943 | </p> |
| | 4944 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetServer">cupsGetServer</a></h3> |
| | 4945 | <p class="description">Return the hostname/address of the current server.</p> |
| | 4946 | <p class="code"> |
| | 4947 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsGetServer(<span class="reserved">void</span>);</p> |
| | 4948 | <h4 class="returnvalue">Return Value</h4> |
| | 4949 | <p class="description">Server name</p> |
| | 4950 | <h4 class="discussion">Discussion</h4> |
| | 4951 | <p class="discussion">The default server comes from the CUPS_SERVER environment variable, then the |
| | 4952 | ~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not |
| | 4953 | set, the default is the local system - either "localhost" or a domain socket |
| | 4954 | path.<br> |
| | 4955 | <br> |
| | 4956 | The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6 |
| | 4957 | address, or a domain socket pathname.<br> |
| | 4958 | <br> |
| | 4959 | Note: The current server is tracked separately for each thread in a program. |
| | 4960 | Multi-threaded programs that override the server via the |
| | 4961 | <a href="#cupsSetServer"><code>cupsSetServer</code></a> function need to do so in each thread for the same |
| | 4962 | server to be used. |
| | 4963 | |
| | 4964 | </p> |
| | 4965 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetUser">cupsGetUser</a></h3> |
| | 4966 | <p class="description">Return the current user's name.</p> |
| | 4967 | <p class="code"> |
| | 4968 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsGetUser(<span class="reserved">void</span>);</p> |
| | 4969 | <h4 class="returnvalue">Return Value</h4> |
| | 4970 | <p class="description">User name</p> |
| | 4971 | <h4 class="discussion">Discussion</h4> |
| | 4972 | <p class="discussion">Note: The current user name is tracked separately for each thread in a |
| | 4973 | program. Multi-threaded programs that override the user name with the |
| | 4974 | <a href="#cupsSetUser"><code>cupsSetUser</code></a> function need to do so in each thread for the same user |
| | 4975 | name to be used. |
| | 4976 | |
| | 4977 | </p> |
| | 4978 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsGetUserAgent">cupsGetUserAgent</a></h3> |
| | 4979 | <p class="description">Return the default HTTP User-Agent string.</p> |
| | 4980 | <p class="code"> |
| | 4981 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsGetUserAgent(<span class="reserved">void</span>);</p> |
| | 4982 | <h4 class="returnvalue">Return Value</h4> |
| | 4983 | <p class="description">User-Agent string</p> |
| | 4984 | <h3 class="function"><a id="cupsHMACData">cupsHMACData</a></h3> |
| | 4985 | <p class="description">Perform a HMAC function on the given data.</p> |
| | 4986 | <p class="code"> |
| | 4987 | ssize_t cupsHMACData(<span class="reserved">const</span> <span class="reserved">char</span> *algorithm, <span class="reserved">const</span> <span class="reserved">unsigned</span> <span class="reserved">char</span> *key, size_t keylen, <span class="reserved">const</span> <span class="reserved">void</span> *data, size_t datalen, <span class="reserved">unsigned</span> <span class="reserved">char</span> *hmac, size_t hmacsize);</p> |
| | 4988 | <h4 class="parameters">Parameters</h4> |
| | 4989 | <table class="list"><tbody> |
| | 4990 | <tr><th>algorithm</th> |
| | 4991 | <td class="description">Hash algorithm</td></tr> |
| | 4992 | <tr><th>key</th> |
| | 4993 | <td class="description">Key</td></tr> |
| | 4994 | <tr><th>keylen</th> |
| | 4995 | <td class="description">Length of key</td></tr> |
| | 4996 | <tr><th>data</th> |
| | 4997 | <td class="description">Data to hash</td></tr> |
| | 4998 | <tr><th>datalen</th> |
| | 4999 | <td class="description">Length of data to hash</td></tr> |
| | 5000 | <tr><th>hmac</th> |
| | 5001 | <td class="description">HMAC buffer</td></tr> |
| | 5002 | <tr><th>hmacsize</th> |
| | 5003 | <td class="description">Size of HMAC buffer</td></tr> |
| | 5004 | </tbody></table> |
| | 5005 | <h4 class="returnvalue">Return Value</h4> |
| | 5006 | <p class="description">The length of the HMAC or <code>-1</code> on error</p> |
| | 5007 | <h4 class="discussion">Discussion</h4> |
| | 5008 | <p class="discussion">This function performs a HMAC function on the given data with the given key. |
| | 5009 | The "algorithm" argument can be any of the registered, non-deprecated IPP |
| | 5010 | hash algorithms for the "job-password-encryption" attribute, including |
| | 5011 | "sha" for SHA-1, "sha2-256" for SHA2-256, etc.<br> |
| | 5012 | <br> |
| | 5013 | The "hmac" argument points to a buffer of "hmacsize" bytes and should be at |
| | 5014 | least 64 bytes in length for all of the supported algorithms.<br> |
| | 5015 | <br> |
| | 5016 | The returned HMAC is binary data.</p> |
| | 5017 | <h3 class="function"><a id="cupsHashData">cupsHashData</a></h3> |
| | 5018 | <p class="description">Perform a hash function on the given data.</p> |
| | 5019 | <p class="code"> |
| | 5020 | ssize_t cupsHashData(<span class="reserved">const</span> <span class="reserved">char</span> *algorithm, <span class="reserved">const</span> <span class="reserved">void</span> *data, size_t datalen, <span class="reserved">unsigned</span> <span class="reserved">char</span> *hash, size_t hashsize);</p> |
| | 5021 | <h4 class="parameters">Parameters</h4> |
| | 5022 | <table class="list"><tbody> |
| | 5023 | <tr><th>algorithm</th> |
| | 5024 | <td class="description">Algorithm name</td></tr> |
| | 5025 | <tr><th>data</th> |
| | 5026 | <td class="description">Data to hash</td></tr> |
| | 5027 | <tr><th>datalen</th> |
| | 5028 | <td class="description">Length of data to hash</td></tr> |
| | 5029 | <tr><th>hash</th> |
| | 5030 | <td class="description">Hash buffer</td></tr> |
| | 5031 | <tr><th>hashsize</th> |
| | 5032 | <td class="description">Size of hash buffer</td></tr> |
| | 5033 | </tbody></table> |
| | 5034 | <h4 class="returnvalue">Return Value</h4> |
| | 5035 | <p class="description">Size of hash or -1 on error</p> |
| | 5036 | <h4 class="discussion">Discussion</h4> |
| | 5037 | <p class="discussion">This function performs a hash function on the given data. The "algorithm" |
| | 5038 | argument can be any of the registered, non-deprecated IPP hash algorithms for |
| | 5039 | the "job-password-encryption" attribute, including "sha" for SHA-1, |
| | 5040 | "sha2-256" for SHA2-256, etc.<br> |
| | 5041 | <br> |
| | 5042 | The "hash" argument points to a buffer of "hashsize" bytes and should be at |
| | 5043 | least 64 bytes in length for all of the supported algorithms.<br> |
| | 5044 | <br> |
| | 5045 | The returned hash is binary data.</p> |
| | 5046 | <h3 class="function"><a id="cupsHashString">cupsHashString</a></h3> |
| | 5047 | <p class="description">Format a hash value as a hexadecimal string.</p> |
| | 5048 | <p class="code"> |
| | 5049 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsHashString(<span class="reserved">const</span> <span class="reserved">unsigned</span> <span class="reserved">char</span> *hash, size_t hashsize, <span class="reserved">char</span> *buffer, size_t bufsize);</p> |
| | 5050 | <h4 class="parameters">Parameters</h4> |
| | 5051 | <table class="list"><tbody> |
| | 5052 | <tr><th>hash</th> |
| | 5053 | <td class="description">Hash</td></tr> |
| | 5054 | <tr><th>hashsize</th> |
| | 5055 | <td class="description">Size of hash</td></tr> |
| | 5056 | <tr><th>buffer</th> |
| | 5057 | <td class="description">String buffer</td></tr> |
| | 5058 | <tr><th>bufsize</th> |
| | 5059 | <td class="description">Size of string buffer</td></tr> |
| | 5060 | </tbody></table> |
| | 5061 | <h4 class="returnvalue">Return Value</h4> |
| | 5062 | <p class="description">Formatted string</p> |
| | 5063 | <h4 class="discussion">Discussion</h4> |
| | 5064 | <p class="discussion">The passed buffer must be at least 2 * hashsize + 1 characters in length.</p> |
| | 5065 | <h3 class="function"><a id="cupsJSONAdd">cupsJSONAdd</a></h3> |
| | 5066 | <p class="description">Add a node to a JSON node.</p> |
| | 5067 | <p class="code"> |
| | 5068 | <span class="reserved">void</span> cupsJSONAdd(<a href="#cups_json_t">cups_json_t</a> *parent, <a href="#cups_json_t">cups_json_t</a> *after, <a href="#cups_json_t">cups_json_t</a> *node);</p> |
| | 5069 | <h4 class="parameters">Parameters</h4> |
| | 5070 | <table class="list"><tbody> |
| | 5071 | <tr><th>parent</th> |
| | 5072 | <td class="description">Parent JSON node</td></tr> |
| | 5073 | <tr><th>after</th> |
| | 5074 | <td class="description">Previous sibling node or <code>NULL</code> to append to the end</td></tr> |
| | 5075 | <tr><th>node</th> |
| | 5076 | <td class="description">JSON node to add</td></tr> |
| | 5077 | </tbody></table> |
| | 5078 | <h4 class="discussion">Discussion</h4> |
| | 5079 | <p class="discussion">This function adds an existing JSON node as a child of other JSON node. |
| | 5080 | The "parent" argument specifies the node to add to. The "after" argument |
| | 5081 | specifies a child of the parent node or <code>NULL</code> to append to the end of the |
| | 5082 | children.<br> |
| | 5083 | <br> |
| | 5084 | Note: The node being added must not already be the child of another parent.</p> |
| | 5085 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONDelete">cupsJSONDelete</a></h3> |
| | 5086 | <p class="description">Delete a JSON node and all of its children.</p> |
| | 5087 | <p class="code"> |
| | 5088 | <span class="reserved">void</span> cupsJSONDelete(<a href="#cups_json_t">cups_json_t</a> *json);</p> |
| | 5089 | <h4 class="parameters">Parameters</h4> |
| | 5090 | <table class="list"><tbody> |
| | 5091 | <tr><th>json</th> |
| | 5092 | <td class="description">JSON node</td></tr> |
| | 5093 | </tbody></table> |
| | 5094 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONExportFile">cupsJSONExportFile</a></h3> |
| | 5095 | <p class="description">Save a JSON node tree to a file.</p> |
| | 5096 | <p class="code"> |
| | 5097 | <span class="reserved">bool</span> cupsJSONExportFile(<a href="#cups_json_t">cups_json_t</a> *json, <span class="reserved">const</span> <span class="reserved">char</span> *filename);</p> |
| | 5098 | <h4 class="parameters">Parameters</h4> |
| | 5099 | <table class="list"><tbody> |
| | 5100 | <tr><th>json</th> |
| | 5101 | <td class="description">JSON root node</td></tr> |
| | 5102 | <tr><th>filename</th> |
| | 5103 | <td class="description">JSON filename</td></tr> |
| | 5104 | </tbody></table> |
| | 5105 | <h4 class="returnvalue">Return Value</h4> |
| | 5106 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 5107 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONExportString">cupsJSONExportString</a></h3> |
| | 5108 | <p class="description">Save a JSON node tree to a string.</p> |
| | 5109 | <p class="code"> |
| | 5110 | <span class="reserved">char</span> *cupsJSONExportString(<a href="#cups_json_t">cups_json_t</a> *json);</p> |
| | 5111 | <h4 class="parameters">Parameters</h4> |
| | 5112 | <table class="list"><tbody> |
| | 5113 | <tr><th>json</th> |
| | 5114 | <td class="description">JSON root node</td></tr> |
| | 5115 | </tbody></table> |
| | 5116 | <h4 class="returnvalue">Return Value</h4> |
| | 5117 | <p class="description">JSON string or <code>NULL</code> on error</p> |
| | 5118 | <h4 class="discussion">Discussion</h4> |
| | 5119 | <p class="discussion">This function saves a JSON node tree to an allocated string. The resulting |
| | 5120 | string must be freed using the <code>free</code> function. |
| | 5121 | |
| | 5122 | </p> |
| | 5123 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONFind">cupsJSONFind</a></h3> |
| | 5124 | <p class="description">Find the value(s) associated with a given key.</p> |
| | 5125 | <p class="code"> |
| | 5126 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONFind(<a href="#cups_json_t">cups_json_t</a> *json, <span class="reserved">const</span> <span class="reserved">char</span> *key);</p> |
| | 5127 | <h4 class="parameters">Parameters</h4> |
| | 5128 | <table class="list"><tbody> |
| | 5129 | <tr><th>json</th> |
| | 5130 | <td class="description">JSON object node</td></tr> |
| | 5131 | <tr><th>key</th> |
| | 5132 | <td class="description">Object key</td></tr> |
| | 5133 | </tbody></table> |
| | 5134 | <h4 class="returnvalue">Return Value</h4> |
| | 5135 | <p class="description">JSON value or <code>NULL</code></p> |
| | 5136 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONGetChild">cupsJSONGetChild</a></h3> |
| | 5137 | <p class="description">Get the first child node of an array or object node.</p> |
| | 5138 | <p class="code"> |
| | 5139 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONGetChild(<a href="#cups_json_t">cups_json_t</a> *json, size_t n);</p> |
| | 5140 | <h4 class="parameters">Parameters</h4> |
| | 5141 | <table class="list"><tbody> |
| | 5142 | <tr><th>json</th> |
| | 5143 | <td class="description">JSON array or object node</td></tr> |
| | 5144 | <tr><th>n</th> |
| | 5145 | <td class="description">Child node number (starting at <code>0</code>)</td></tr> |
| | 5146 | </tbody></table> |
| | 5147 | <h4 class="returnvalue">Return Value</h4> |
| | 5148 | <p class="description">First child node or <code>NULL</code></p> |
| | 5149 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONGetCount">cupsJSONGetCount</a></h3> |
| | 5150 | <p class="description">Get the number of child nodes.</p> |
| | 5151 | <p class="code"> |
| | 5152 | size_t cupsJSONGetCount(<a href="#cups_json_t">cups_json_t</a> *json);</p> |
| | 5153 | <h4 class="parameters">Parameters</h4> |
| | 5154 | <table class="list"><tbody> |
| | 5155 | <tr><th>json</th> |
| | 5156 | <td class="description">JSON array or object node</td></tr> |
| | 5157 | </tbody></table> |
| | 5158 | <h4 class="returnvalue">Return Value</h4> |
| | 5159 | <p class="description">Number of child nodes</p> |
| | 5160 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONGetKey">cupsJSONGetKey</a></h3> |
| | 5161 | <p class="description">Get the key string, if any.</p> |
| | 5162 | <p class="code"> |
| | 5163 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsJSONGetKey(<a href="#cups_json_t">cups_json_t</a> *json);</p> |
| | 5164 | <h4 class="parameters">Parameters</h4> |
| | 5165 | <table class="list"><tbody> |
| | 5166 | <tr><th>json</th> |
| | 5167 | <td class="description">JSON string node</td></tr> |
| | 5168 | </tbody></table> |
| | 5169 | <h4 class="returnvalue">Return Value</h4> |
| | 5170 | <p class="description">String value</p> |
| | 5171 | <h4 class="discussion">Discussion</h4> |
| | 5172 | <p class="discussion">This function returns the key string for a JSON key node or <code>NULL</code> if |
| | 5173 | the node is not a key. |
| | 5174 | |
| | 5175 | </p> |
| | 5176 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONGetNumber">cupsJSONGetNumber</a></h3> |
| | 5177 | <p class="description">Get the number value, if any.</p> |
| | 5178 | <p class="code"> |
| | 5179 | <span class="reserved">double</span> cupsJSONGetNumber(<a href="#cups_json_t">cups_json_t</a> *json);</p> |
| | 5180 | <h4 class="parameters">Parameters</h4> |
| | 5181 | <table class="list"><tbody> |
| | 5182 | <tr><th>json</th> |
| | 5183 | <td class="description">JSON number node</td></tr> |
| | 5184 | </tbody></table> |
| | 5185 | <h4 class="returnvalue">Return Value</h4> |
| | 5186 | <p class="description">Number value</p> |
| | 5187 | <h4 class="discussion">Discussion</h4> |
| | 5188 | <p class="discussion">This function returns the number value for a JSON number node or <code>0.0</code> if |
| | 5189 | the node is not a number. |
| | 5190 | |
| | 5191 | </p> |
| | 5192 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONGetParent">cupsJSONGetParent</a></h3> |
| | 5193 | <p class="description">Get the parent node, if any.</p> |
| | 5194 | <p class="code"> |
| | 5195 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONGetParent(<a href="#cups_json_t">cups_json_t</a> *json);</p> |
| | 5196 | <h4 class="parameters">Parameters</h4> |
| | 5197 | <table class="list"><tbody> |
| | 5198 | <tr><th>json</th> |
| | 5199 | <td class="description">JSON node</td></tr> |
| | 5200 | </tbody></table> |
| | 5201 | <h4 class="returnvalue">Return Value</h4> |
| | 5202 | <p class="description">Parent node or <code>NULL</code> if none</p> |
| | 5203 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONGetSibling">cupsJSONGetSibling</a></h3> |
| | 5204 | <p class="description">Get the next sibling node, if any.</p> |
| | 5205 | <p class="code"> |
| | 5206 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONGetSibling(<a href="#cups_json_t">cups_json_t</a> *json);</p> |
| | 5207 | <h4 class="parameters">Parameters</h4> |
| | 5208 | <table class="list"><tbody> |
| | 5209 | <tr><th>json</th> |
| | 5210 | <td class="description">JSON node</td></tr> |
| | 5211 | </tbody></table> |
| | 5212 | <h4 class="returnvalue">Return Value</h4> |
| | 5213 | <p class="description">Sibling node or <code>NULL</code> if none</p> |
| | 5214 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONGetString">cupsJSONGetString</a></h3> |
| | 5215 | <p class="description">Get the string value, if any.</p> |
| | 5216 | <p class="code"> |
| | 5217 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsJSONGetString(<a href="#cups_json_t">cups_json_t</a> *json);</p> |
| | 5218 | <h4 class="parameters">Parameters</h4> |
| | 5219 | <table class="list"><tbody> |
| | 5220 | <tr><th>json</th> |
| | 5221 | <td class="description">JSON string node</td></tr> |
| | 5222 | </tbody></table> |
| | 5223 | <h4 class="returnvalue">Return Value</h4> |
| | 5224 | <p class="description">String value</p> |
| | 5225 | <h4 class="discussion">Discussion</h4> |
| | 5226 | <p class="discussion">This function returns the string value for a JSON string node or <code>NULL</code> if |
| | 5227 | the node is not a string. |
| | 5228 | |
| | 5229 | </p> |
| | 5230 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONGetType">cupsJSONGetType</a></h3> |
| | 5231 | <p class="description">Get the type of a JSON node.</p> |
| | 5232 | <p class="code"> |
| | 5233 | <a href="#cups_jtype_t">cups_jtype_t</a> cupsJSONGetType(<a href="#cups_json_t">cups_json_t</a> *json);</p> |
| | 5234 | <h4 class="parameters">Parameters</h4> |
| | 5235 | <table class="list"><tbody> |
| | 5236 | <tr><th>json</th> |
| | 5237 | <td class="description">JSON node</td></tr> |
| | 5238 | </tbody></table> |
| | 5239 | <h4 class="returnvalue">Return Value</h4> |
| | 5240 | <p class="description">JSON node type</p> |
| | 5241 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONImportFile">cupsJSONImportFile</a></h3> |
| | 5242 | <p class="description">Load a JSON object file.</p> |
| | 5243 | <p class="code"> |
| | 5244 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONImportFile(<span class="reserved">const</span> <span class="reserved">char</span> *filename);</p> |
| | 5245 | <h4 class="parameters">Parameters</h4> |
| | 5246 | <table class="list"><tbody> |
| | 5247 | <tr><th>filename</th> |
| | 5248 | <td class="description">JSON filename</td></tr> |
| | 5249 | </tbody></table> |
| | 5250 | <h4 class="returnvalue">Return Value</h4> |
| | 5251 | <p class="description">Root JSON object node</p> |
| | 5252 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONImportString">cupsJSONImportString</a></h3> |
| | 5253 | <p class="description">Load a JSON object from a string.</p> |
| | 5254 | <p class="code"> |
| | 5255 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONImportString(<span class="reserved">const</span> <span class="reserved">char</span> *s);</p> |
| | 5256 | <h4 class="parameters">Parameters</h4> |
| | 5257 | <table class="list"><tbody> |
| | 5258 | <tr><th>s</th> |
| | 5259 | <td class="description">JSON string</td></tr> |
| | 5260 | </tbody></table> |
| | 5261 | <h4 class="returnvalue">Return Value</h4> |
| | 5262 | <p class="description">Root JSON object node</p> |
| | 5263 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONImportURL">cupsJSONImportURL</a></h3> |
| | 5264 | <p class="description">Load a JSON object from a URL.</p> |
| | 5265 | <p class="code"> |
| | 5266 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONImportURL(<span class="reserved">const</span> <span class="reserved">char</span> *url, time_t *last_modified);</p> |
| | 5267 | <h4 class="parameters">Parameters</h4> |
| | 5268 | <table class="list"><tbody> |
| | 5269 | <tr><th>url</th> |
| | 5270 | <td class="description">URL</td></tr> |
| | 5271 | <tr><th>last_modified</th> |
| | 5272 | <td class="description">Last modified date/time or <code>NULL</code></td></tr> |
| | 5273 | </tbody></table> |
| | 5274 | <h4 class="returnvalue">Return Value</h4> |
| | 5275 | <p class="description">Root JSON object node</p> |
| | 5276 | <h4 class="discussion">Discussion</h4> |
| | 5277 | <p class="discussion">This function loads a JSON object from a URL. The "url" can be a "http:" or |
| | 5278 | "https:" URL. The "last_modified" argument provides a pointer to a <code>time_t</code> |
| | 5279 | variable with the last modified date and time from a previous load. If |
| | 5280 | <code>NULL</code> or the variable has a value of 0, the JSON is loaded unconditionally |
| | 5281 | from the URL.<br> |
| | 5282 | <br> |
| | 5283 | On success, a pointer to the root JSON object node is returned and the |
| | 5284 | "last_modified" variable, if not <code>NULL</code>, is updated to the Last-Modified |
| | 5285 | date and time returned by the server. Otherwise, <code>NULL</code> is returned with |
| | 5286 | the <a href="#cupsGetError"><code>cupsGetError</code></a> value set to <code>IPP_STATUS_OK_EVENTS_COMPLETE</code> if |
| | 5287 | the JSON data has not been updated since the "last_modified" date and time |
| | 5288 | or a suitable <code>IPP_STATUS_ERROR_</code> value if an error occurred. |
| | 5289 | |
| | 5290 | </p> |
| | 5291 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONNew">cupsJSONNew</a></h3> |
| | 5292 | <p class="description">Create a new JSON node.</p> |
| | 5293 | <p class="code"> |
| | 5294 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONNew(<a href="#cups_json_t">cups_json_t</a> *parent, <a href="#cups_json_t">cups_json_t</a> *after, <a href="#cups_jtype_t">cups_jtype_t</a> type);</p> |
| | 5295 | <h4 class="parameters">Parameters</h4> |
| | 5296 | <table class="list"><tbody> |
| | 5297 | <tr><th>parent</th> |
| | 5298 | <td class="description">Parent JSON node or <code>NULL</code> for a root node</td></tr> |
| | 5299 | <tr><th>after</th> |
| | 5300 | <td class="description">Previous sibling node or <code>NULL</code> to append to the end</td></tr> |
| | 5301 | <tr><th>type</th> |
| | 5302 | <td class="description">JSON node type</td></tr> |
| | 5303 | </tbody></table> |
| | 5304 | <h4 class="returnvalue">Return Value</h4> |
| | 5305 | <p class="description">JSON node</p> |
| | 5306 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONNewKey">cupsJSONNewKey</a></h3> |
| | 5307 | <p class="description">Create a new JSON key node.</p> |
| | 5308 | <p class="code"> |
| | 5309 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONNewKey(<a href="#cups_json_t">cups_json_t</a> *parent, <a href="#cups_json_t">cups_json_t</a> *after, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 5310 | <h4 class="parameters">Parameters</h4> |
| | 5311 | <table class="list"><tbody> |
| | 5312 | <tr><th>parent</th> |
| | 5313 | <td class="description">Parent JSON node or <code>NULL</code> for a root node</td></tr> |
| | 5314 | <tr><th>after</th> |
| | 5315 | <td class="description">Previous sibling node or <code>NULL</code> to append to the end</td></tr> |
| | 5316 | <tr><th>value</th> |
| | 5317 | <td class="description">Key string</td></tr> |
| | 5318 | </tbody></table> |
| | 5319 | <h4 class="returnvalue">Return Value</h4> |
| | 5320 | <p class="description">JSON node</p> |
| | 5321 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONNewNumber">cupsJSONNewNumber</a></h3> |
| | 5322 | <p class="description">Create a new JSON number node.</p> |
| | 5323 | <p class="code"> |
| | 5324 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONNewNumber(<a href="#cups_json_t">cups_json_t</a> *parent, <a href="#cups_json_t">cups_json_t</a> *after, <span class="reserved">double</span> value);</p> |
| | 5325 | <h4 class="parameters">Parameters</h4> |
| | 5326 | <table class="list"><tbody> |
| | 5327 | <tr><th>parent</th> |
| | 5328 | <td class="description">Parent JSON node or <code>NULL</code> for a root node</td></tr> |
| | 5329 | <tr><th>after</th> |
| | 5330 | <td class="description">Previous sibling node or <code>NULL</code> to append to the end</td></tr> |
| | 5331 | <tr><th>value</th> |
| | 5332 | <td class="description">Number value</td></tr> |
| | 5333 | </tbody></table> |
| | 5334 | <h4 class="returnvalue">Return Value</h4> |
| | 5335 | <p class="description">JSON node</p> |
| | 5336 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJSONNewString">cupsJSONNewString</a></h3> |
| | 5337 | <p class="description">Create a new JSON string node.</p> |
| | 5338 | <p class="code"> |
| | 5339 | <a href="#cups_json_t">cups_json_t</a> *cupsJSONNewString(<a href="#cups_json_t">cups_json_t</a> *parent, <a href="#cups_json_t">cups_json_t</a> *after, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 5340 | <h4 class="parameters">Parameters</h4> |
| | 5341 | <table class="list"><tbody> |
| | 5342 | <tr><th>parent</th> |
| | 5343 | <td class="description">Parent JSON node or <code>NULL</code> for a root node</td></tr> |
| | 5344 | <tr><th>after</th> |
| | 5345 | <td class="description">Previous sibling node or <code>NULL</code> to append to the end</td></tr> |
| | 5346 | <tr><th>value</th> |
| | 5347 | <td class="description">String value</td></tr> |
| | 5348 | </tbody></table> |
| | 5349 | <h4 class="returnvalue">Return Value</h4> |
| | 5350 | <p class="description">JSON node</p> |
| | 5351 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTDelete">cupsJWTDelete</a></h3> |
| | 5352 | <p class="description">Free the memory used for a JSON Web Token.</p> |
| | 5353 | <p class="code"> |
| | 5354 | <span class="reserved">void</span> cupsJWTDelete(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt);</p> |
| | 5355 | <h4 class="parameters">Parameters</h4> |
| | 5356 | <table class="list"><tbody> |
| | 5357 | <tr><th>jwt</th> |
| | 5358 | <td class="description">JWT object</td></tr> |
| | 5359 | </tbody></table> |
| | 5360 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTExportString">cupsJWTExportString</a></h3> |
| | 5361 | <p class="description">Export a JWT with the JWS Compact or JWS JSON (Flattened) Serialization format.</p> |
| | 5362 | <p class="code"> |
| | 5363 | <span class="reserved">char</span> *cupsJWTExportString(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <a href="#cups_jws_format_t">cups_jws_format_t</a> format);</p> |
| | 5364 | <h4 class="parameters">Parameters</h4> |
| | 5365 | <table class="list"><tbody> |
| | 5366 | <tr><th>jwt</th> |
| | 5367 | <td class="description">JWT object</td></tr> |
| | 5368 | <tr><th>format</th> |
| | 5369 | <td class="description">JWS serialization format</td></tr> |
| | 5370 | </tbody></table> |
| | 5371 | <h4 class="returnvalue">Return Value</h4> |
| | 5372 | <p class="description">JWT/JWS Serialization string</p> |
| | 5373 | <h4 class="discussion">Discussion</h4> |
| | 5374 | <p class="discussion">This function exports a JWT to a JWS Compact or JWS JSON Serialization |
| | 5375 | string. The JSON output is always the "flattened" format since the JWT |
| | 5376 | only contains a single signature.<br> |
| | 5377 | <br> |
| | 5378 | The return value must be freed using the <code>free</code> function. |
| | 5379 | |
| | 5380 | </p> |
| | 5381 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetAlgorithm">cupsJWTGetAlgorithm</a></h3> |
| | 5382 | <p class="description">Get the signature algorithm used by a JSON Web Token.</p> |
| | 5383 | <p class="code"> |
| | 5384 | <a href="#cups_jwa_t">cups_jwa_t</a> cupsJWTGetAlgorithm(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt);</p> |
| | 5385 | <h4 class="parameters">Parameters</h4> |
| | 5386 | <table class="list"><tbody> |
| | 5387 | <tr><th>jwt</th> |
| | 5388 | <td class="description">JWT object</td></tr> |
| | 5389 | </tbody></table> |
| | 5390 | <h4 class="returnvalue">Return Value</h4> |
| | 5391 | <p class="description">Signature algorithm</p> |
| | 5392 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetClaimNumber">cupsJWTGetClaimNumber</a></h3> |
| | 5393 | <p class="description">Get the number value of a claim.</p> |
| | 5394 | <p class="code"> |
| | 5395 | <span class="reserved">double</span> cupsJWTGetClaimNumber(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *claim);</p> |
| | 5396 | <h4 class="parameters">Parameters</h4> |
| | 5397 | <table class="list"><tbody> |
| | 5398 | <tr><th>jwt</th> |
| | 5399 | <td class="description">JWT object</td></tr> |
| | 5400 | <tr><th>claim</th> |
| | 5401 | <td class="description">Claim name</td></tr> |
| | 5402 | </tbody></table> |
| | 5403 | <h4 class="returnvalue">Return Value</h4> |
| | 5404 | <p class="description">Number value</p> |
| | 5405 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetClaimString">cupsJWTGetClaimString</a></h3> |
| | 5406 | <p class="description">Get the string value of a claim.</p> |
| | 5407 | <p class="code"> |
| | 5408 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsJWTGetClaimString(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *claim);</p> |
| | 5409 | <h4 class="parameters">Parameters</h4> |
| | 5410 | <table class="list"><tbody> |
| | 5411 | <tr><th>jwt</th> |
| | 5412 | <td class="description">JWT object</td></tr> |
| | 5413 | <tr><th>claim</th> |
| | 5414 | <td class="description">Claim name</td></tr> |
| | 5415 | </tbody></table> |
| | 5416 | <h4 class="returnvalue">Return Value</h4> |
| | 5417 | <p class="description">String value</p> |
| | 5418 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetClaimType">cupsJWTGetClaimType</a></h3> |
| | 5419 | <p class="description">Get the value type of a claim.</p> |
| | 5420 | <p class="code"> |
| | 5421 | <a href="#cups_jtype_t">cups_jtype_t</a> cupsJWTGetClaimType(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *claim);</p> |
| | 5422 | <h4 class="parameters">Parameters</h4> |
| | 5423 | <table class="list"><tbody> |
| | 5424 | <tr><th>jwt</th> |
| | 5425 | <td class="description">JWT object</td></tr> |
| | 5426 | <tr><th>claim</th> |
| | 5427 | <td class="description">Claim name</td></tr> |
| | 5428 | </tbody></table> |
| | 5429 | <h4 class="returnvalue">Return Value</h4> |
| | 5430 | <p class="description">JSON value type</p> |
| | 5431 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetClaimValue">cupsJWTGetClaimValue</a></h3> |
| | 5432 | <p class="description">Get the value node of a claim.</p> |
| | 5433 | <p class="code"> |
| | 5434 | <a href="#cups_json_t">cups_json_t</a> *cupsJWTGetClaimValue(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *claim);</p> |
| | 5435 | <h4 class="parameters">Parameters</h4> |
| | 5436 | <table class="list"><tbody> |
| | 5437 | <tr><th>jwt</th> |
| | 5438 | <td class="description">JWT object</td></tr> |
| | 5439 | <tr><th>claim</th> |
| | 5440 | <td class="description">Claim name</td></tr> |
| | 5441 | </tbody></table> |
| | 5442 | <h4 class="returnvalue">Return Value</h4> |
| | 5443 | <p class="description">JSON value node</p> |
| | 5444 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetClaims">cupsJWTGetClaims</a></h3> |
| | 5445 | <p class="description">Get the JWT claims as a JSON object.</p> |
| | 5446 | <p class="code"> |
| | 5447 | <a href="#cups_json_t">cups_json_t</a> *cupsJWTGetClaims(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt);</p> |
| | 5448 | <h4 class="parameters">Parameters</h4> |
| | 5449 | <table class="list"><tbody> |
| | 5450 | <tr><th>jwt</th> |
| | 5451 | <td class="description">JWT object</td></tr> |
| | 5452 | </tbody></table> |
| | 5453 | <h4 class="returnvalue">Return Value</h4> |
| | 5454 | <p class="description">JSON object</p> |
| | 5455 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetHeaderNumber">cupsJWTGetHeaderNumber</a></h3> |
| | 5456 | <p class="description">Get the number value of a protected header.</p> |
| | 5457 | <p class="code"> |
| | 5458 | <span class="reserved">double</span> cupsJWTGetHeaderNumber(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *header);</p> |
| | 5459 | <h4 class="parameters">Parameters</h4> |
| | 5460 | <table class="list"><tbody> |
| | 5461 | <tr><th>jwt</th> |
| | 5462 | <td class="description">JWT object</td></tr> |
| | 5463 | <tr><th>header</th> |
| | 5464 | <td class="description">Header name</td></tr> |
| | 5465 | </tbody></table> |
| | 5466 | <h4 class="returnvalue">Return Value</h4> |
| | 5467 | <p class="description">Number value</p> |
| | 5468 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetHeaderString">cupsJWTGetHeaderString</a></h3> |
| | 5469 | <p class="description">Get the string value of a protected header.</p> |
| | 5470 | <p class="code"> |
| | 5471 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsJWTGetHeaderString(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *header);</p> |
| | 5472 | <h4 class="parameters">Parameters</h4> |
| | 5473 | <table class="list"><tbody> |
| | 5474 | <tr><th>jwt</th> |
| | 5475 | <td class="description">JWT object</td></tr> |
| | 5476 | <tr><th>header</th> |
| | 5477 | <td class="description">Header name</td></tr> |
| | 5478 | </tbody></table> |
| | 5479 | <h4 class="returnvalue">Return Value</h4> |
| | 5480 | <p class="description">String value</p> |
| | 5481 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetHeaderType">cupsJWTGetHeaderType</a></h3> |
| | 5482 | <p class="description">Get the value type of a protected header.</p> |
| | 5483 | <p class="code"> |
| | 5484 | <a href="#cups_jtype_t">cups_jtype_t</a> cupsJWTGetHeaderType(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *header);</p> |
| | 5485 | <h4 class="parameters">Parameters</h4> |
| | 5486 | <table class="list"><tbody> |
| | 5487 | <tr><th>jwt</th> |
| | 5488 | <td class="description">JWT object</td></tr> |
| | 5489 | <tr><th>header</th> |
| | 5490 | <td class="description">Header name</td></tr> |
| | 5491 | </tbody></table> |
| | 5492 | <h4 class="returnvalue">Return Value</h4> |
| | 5493 | <p class="description">JSON value type</p> |
| | 5494 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetHeaderValue">cupsJWTGetHeaderValue</a></h3> |
| | 5495 | <p class="description">Get the value node of a protected header.</p> |
| | 5496 | <p class="code"> |
| | 5497 | <a href="#cups_json_t">cups_json_t</a> *cupsJWTGetHeaderValue(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *header);</p> |
| | 5498 | <h4 class="parameters">Parameters</h4> |
| | 5499 | <table class="list"><tbody> |
| | 5500 | <tr><th>jwt</th> |
| | 5501 | <td class="description">JWT object</td></tr> |
| | 5502 | <tr><th>header</th> |
| | 5503 | <td class="description">Header name</td></tr> |
| | 5504 | </tbody></table> |
| | 5505 | <h4 class="returnvalue">Return Value</h4> |
| | 5506 | <p class="description">JSON value node</p> |
| | 5507 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTGetHeaders">cupsJWTGetHeaders</a></h3> |
| | 5508 | <p class="description">Get the JWT protected headers as a JSON object.</p> |
| | 5509 | <p class="code"> |
| | 5510 | <a href="#cups_json_t">cups_json_t</a> *cupsJWTGetHeaders(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt);</p> |
| | 5511 | <h4 class="parameters">Parameters</h4> |
| | 5512 | <table class="list"><tbody> |
| | 5513 | <tr><th>jwt</th> |
| | 5514 | <td class="description">JWT object</td></tr> |
| | 5515 | </tbody></table> |
| | 5516 | <h4 class="returnvalue">Return Value</h4> |
| | 5517 | <p class="description">JSON object</p> |
| | 5518 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTHasValidSignature">cupsJWTHasValidSignature</a></h3> |
| | 5519 | <p class="description">Determine whether the JWT has a valid signature.</p> |
| | 5520 | <p class="code"> |
| | 5521 | <span class="reserved">bool</span> cupsJWTHasValidSignature(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <a href="#cups_json_t">cups_json_t</a> *jwk);</p> |
| | 5522 | <h4 class="parameters">Parameters</h4> |
| | 5523 | <table class="list"><tbody> |
| | 5524 | <tr><th>jwt</th> |
| | 5525 | <td class="description">JWT object</td></tr> |
| | 5526 | <tr><th>jwk</th> |
| | 5527 | <td class="description">JWK key set</td></tr> |
| | 5528 | </tbody></table> |
| | 5529 | <h4 class="returnvalue">Return Value</h4> |
| | 5530 | <p class="description"><code>true</code> if value, <code>false</code> otherwise</p> |
| | 5531 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTImportString">cupsJWTImportString</a></h3> |
| | 5532 | <p class="description">Import a JSON Web Token or JSON Web Signature.</p> |
| | 5533 | <p class="code"> |
| | 5534 | <a href="#cups_jwt_t">cups_jwt_t</a> *cupsJWTImportString(<span class="reserved">const</span> <span class="reserved">char</span> *s, <a href="#cups_jws_format_t">cups_jws_format_t</a> format);</p> |
| | 5535 | <h4 class="parameters">Parameters</h4> |
| | 5536 | <table class="list"><tbody> |
| | 5537 | <tr><th>s</th> |
| | 5538 | <td class="description">JWS string</td></tr> |
| | 5539 | <tr><th>format</th> |
| | 5540 | <td class="description">JWS serialization format</td></tr> |
| | 5541 | </tbody></table> |
| | 5542 | <h4 class="returnvalue">Return Value</h4> |
| | 5543 | <p class="description">JWT object</p> |
| | 5544 | <h3 class="function"><a id="cupsJWTLoadCredentials">cupsJWTLoadCredentials</a></h3> |
| | 5545 | <p class="description">Load X.509 credentials and private key into a JSON Web Key for signing.</p> |
| | 5546 | <p class="code"> |
| | 5547 | <a href="#cups_json_t">cups_json_t</a> *cupsJWTLoadCredentials(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">const</span> <span class="reserved">char</span> *common_name);</p> |
| | 5548 | <h4 class="parameters">Parameters</h4> |
| | 5549 | <table class="list"><tbody> |
| | 5550 | <tr><th>path</th> |
| | 5551 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 5552 | <tr><th>common_name</th> |
| | 5553 | <td class="description">Common name</td></tr> |
| | 5554 | </tbody></table> |
| | 5555 | <h4 class="returnvalue">Return Value</h4> |
| | 5556 | <p class="description">JSON Web Key of <code>NULL</code> on error</p> |
| | 5557 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTMakePrivateKey">cupsJWTMakePrivateKey</a></h3> |
| | 5558 | <p class="description">Make a JSON Web Key for encryption and signing.</p> |
| | 5559 | <p class="code"> |
| | 5560 | <a href="#cups_json_t">cups_json_t</a> *cupsJWTMakePrivateKey(<a href="#cups_jwa_t">cups_jwa_t</a> alg);</p> |
| | 5561 | <h4 class="parameters">Parameters</h4> |
| | 5562 | <table class="list"><tbody> |
| | 5563 | <tr><th>alg</th> |
| | 5564 | <td class="description">Signing/encryption algorithm</td></tr> |
| | 5565 | </tbody></table> |
| | 5566 | <h4 class="returnvalue">Return Value</h4> |
| | 5567 | <p class="description">Private JSON Web Key or <code>NULL</code> on error</p> |
| | 5568 | <h4 class="discussion">Discussion</h4> |
| | 5569 | <p class="discussion">This function makes a JSON Web Key (JWK) for the specified JWS/JWE algorithm |
| | 5570 | for use when signing or encrypting JSON Web Tokens. The resulting JWK |
| | 5571 | <em>must not</em> be provided to clients - instead, call <a href="#cupsJWTMakePublicKey"><code>cupsJWTMakePublicKey</code></a> |
| | 5572 | to produce a public key subset suitable for verification and decryption. |
| | 5573 | |
| | 5574 | </p> |
| | 5575 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTMakePublicKey">cupsJWTMakePublicKey</a></h3> |
| | 5576 | <p class="description">Make a JSON Web Key for decryption and verification.</p> |
| | 5577 | <p class="code"> |
| | 5578 | <a href="#cups_json_t">cups_json_t</a> *cupsJWTMakePublicKey(<a href="#cups_json_t">cups_json_t</a> *jwk);</p> |
| | 5579 | <h4 class="parameters">Parameters</h4> |
| | 5580 | <table class="list"><tbody> |
| | 5581 | <tr><th>jwk</th> |
| | 5582 | <td class="description">Private JSON Web Key</td></tr> |
| | 5583 | </tbody></table> |
| | 5584 | <h4 class="returnvalue">Return Value</h4> |
| | 5585 | <p class="description">Public JSON Web Key or <code>NULL</code> on error</p> |
| | 5586 | <h4 class="discussion">Discussion</h4> |
| | 5587 | <p class="discussion">This function makes a public JSON Web Key (JWK) from the specified private |
| | 5588 | JWK suitable for use when decrypting or verifying a JWE/JWS message. |
| | 5589 | |
| | 5590 | </p> |
| | 5591 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTNew">cupsJWTNew</a></h3> |
| | 5592 | <p class="description">Create a new, empty JSON Web Token.</p> |
| | 5593 | <p class="code"> |
| | 5594 | <a href="#cups_jwt_t">cups_jwt_t</a> *cupsJWTNew(<span class="reserved">const</span> <span class="reserved">char</span> *type, <a href="#cups_json_t">cups_json_t</a> *claims);</p> |
| | 5595 | <h4 class="parameters">Parameters</h4> |
| | 5596 | <table class="list"><tbody> |
| | 5597 | <tr><th>type</th> |
| | 5598 | <td class="description">JWT type or <code>NULL</code> for default ("JWT")</td></tr> |
| | 5599 | <tr><th>claims</th> |
| | 5600 | <td class="description">JSON claims or <code>NULL</code> for empty</td></tr> |
| | 5601 | </tbody></table> |
| | 5602 | <h4 class="returnvalue">Return Value</h4> |
| | 5603 | <p class="description">JWT object</p> |
| | 5604 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTSetClaimNumber">cupsJWTSetClaimNumber</a></h3> |
| | 5605 | <p class="description">Set a claim number.</p> |
| | 5606 | <p class="code"> |
| | 5607 | <span class="reserved">void</span> cupsJWTSetClaimNumber(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *claim, <span class="reserved">double</span> value);</p> |
| | 5608 | <h4 class="parameters">Parameters</h4> |
| | 5609 | <table class="list"><tbody> |
| | 5610 | <tr><th>jwt</th> |
| | 5611 | <td class="description">JWT object</td></tr> |
| | 5612 | <tr><th>claim</th> |
| | 5613 | <td class="description">Claim name</td></tr> |
| | 5614 | <tr><th>value</th> |
| | 5615 | <td class="description">Number value</td></tr> |
| | 5616 | </tbody></table> |
| | 5617 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTSetClaimString">cupsJWTSetClaimString</a></h3> |
| | 5618 | <p class="description">Set a claim string.</p> |
| | 5619 | <p class="code"> |
| | 5620 | <span class="reserved">void</span> cupsJWTSetClaimString(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *claim, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 5621 | <h4 class="parameters">Parameters</h4> |
| | 5622 | <table class="list"><tbody> |
| | 5623 | <tr><th>jwt</th> |
| | 5624 | <td class="description">JWT object</td></tr> |
| | 5625 | <tr><th>claim</th> |
| | 5626 | <td class="description">Claim name</td></tr> |
| | 5627 | <tr><th>value</th> |
| | 5628 | <td class="description">String value</td></tr> |
| | 5629 | </tbody></table> |
| | 5630 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTSetClaimValue">cupsJWTSetClaimValue</a></h3> |
| | 5631 | <p class="description">Set a claim value.</p> |
| | 5632 | <p class="code"> |
| | 5633 | <span class="reserved">void</span> cupsJWTSetClaimValue(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *claim, <a href="#cups_json_t">cups_json_t</a> *value);</p> |
| | 5634 | <h4 class="parameters">Parameters</h4> |
| | 5635 | <table class="list"><tbody> |
| | 5636 | <tr><th>jwt</th> |
| | 5637 | <td class="description">JWT object</td></tr> |
| | 5638 | <tr><th>claim</th> |
| | 5639 | <td class="description">Claim name</td></tr> |
| | 5640 | <tr><th>value</th> |
| | 5641 | <td class="description">JSON value node</td></tr> |
| | 5642 | </tbody></table> |
| | 5643 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTSetHeaderNumber">cupsJWTSetHeaderNumber</a></h3> |
| | 5644 | <p class="description">Set a protected header number.</p> |
| | 5645 | <p class="code"> |
| | 5646 | <span class="reserved">void</span> cupsJWTSetHeaderNumber(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *header, <span class="reserved">double</span> value);</p> |
| | 5647 | <h4 class="parameters">Parameters</h4> |
| | 5648 | <table class="list"><tbody> |
| | 5649 | <tr><th>jwt</th> |
| | 5650 | <td class="description">JWT object</td></tr> |
| | 5651 | <tr><th>header</th> |
| | 5652 | <td class="description">Header name</td></tr> |
| | 5653 | <tr><th>value</th> |
| | 5654 | <td class="description">Number value</td></tr> |
| | 5655 | </tbody></table> |
| | 5656 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTSetHeaderString">cupsJWTSetHeaderString</a></h3> |
| | 5657 | <p class="description">Set a protected header string.</p> |
| | 5658 | <p class="code"> |
| | 5659 | <span class="reserved">void</span> cupsJWTSetHeaderString(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *header, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 5660 | <h4 class="parameters">Parameters</h4> |
| | 5661 | <table class="list"><tbody> |
| | 5662 | <tr><th>jwt</th> |
| | 5663 | <td class="description">JWT object</td></tr> |
| | 5664 | <tr><th>header</th> |
| | 5665 | <td class="description">Header name</td></tr> |
| | 5666 | <tr><th>value</th> |
| | 5667 | <td class="description">String value</td></tr> |
| | 5668 | </tbody></table> |
| | 5669 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTSetHeaderValue">cupsJWTSetHeaderValue</a></h3> |
| | 5670 | <p class="description">Set a protected header value.</p> |
| | 5671 | <p class="code"> |
| | 5672 | <span class="reserved">void</span> cupsJWTSetHeaderValue(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <span class="reserved">const</span> <span class="reserved">char</span> *header, <a href="#cups_json_t">cups_json_t</a> *value);</p> |
| | 5673 | <h4 class="parameters">Parameters</h4> |
| | 5674 | <table class="list"><tbody> |
| | 5675 | <tr><th>jwt</th> |
| | 5676 | <td class="description">JWT object</td></tr> |
| | 5677 | <tr><th>header</th> |
| | 5678 | <td class="description">Header name</td></tr> |
| | 5679 | <tr><th>value</th> |
| | 5680 | <td class="description">JSON value node</td></tr> |
| | 5681 | </tbody></table> |
| | 5682 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsJWTSign">cupsJWTSign</a></h3> |
| | 5683 | <p class="description">Sign a JSON Web Token, creating a JSON Web Signature.</p> |
| | 5684 | <p class="code"> |
| | 5685 | <span class="reserved">bool</span> cupsJWTSign(<a href="#cups_jwt_t">cups_jwt_t</a> *jwt, <a href="#cups_jwa_t">cups_jwa_t</a> alg, <a href="#cups_json_t">cups_json_t</a> *jwk);</p> |
| | 5686 | <h4 class="parameters">Parameters</h4> |
| | 5687 | <table class="list"><tbody> |
| | 5688 | <tr><th>jwt</th> |
| | 5689 | <td class="description">JWT object</td></tr> |
| | 5690 | <tr><th>alg</th> |
| | 5691 | <td class="description">Signing algorithm</td></tr> |
| | 5692 | <tr><th>jwk</th> |
| | 5693 | <td class="description">JWK key set</td></tr> |
| | 5694 | </tbody></table> |
| | 5695 | <h4 class="returnvalue">Return Value</h4> |
| | 5696 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 5697 | <h3 class="function"><a id="cupsLangDefault">cupsLangDefault</a></h3> |
| | 5698 | <p class="description">Return the default language.</p> |
| | 5699 | <p class="code"> |
| | 5700 | <a href="#cups_lang_t">cups_lang_t</a> *cupsLangDefault(<span class="reserved">void</span>);</p> |
| | 5701 | <h4 class="returnvalue">Return Value</h4> |
| | 5702 | <p class="description">Language data</p> |
| | 5703 | <h3 class="function"><a id="cupsLangEncoding">cupsLangEncoding</a></h3> |
| | 5704 | <p class="description">Return the character encoding (us-ascii, etc.) |
| | 5705 | for the given language.</p> |
| | 5706 | <p class="code"> |
| | 5707 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsLangEncoding(<a href="#cups_lang_t">cups_lang_t</a> *lang);</p> |
| | 5708 | <h4 class="parameters">Parameters</h4> |
| | 5709 | <table class="list"><tbody> |
| | 5710 | <tr><th>lang</th> |
| | 5711 | <td class="description">Language data</td></tr> |
| | 5712 | </tbody></table> |
| | 5713 | <h4 class="returnvalue">Return Value</h4> |
| | 5714 | <p class="description">Character encoding</p> |
| | 5715 | <h3 class="function"><a id="cupsLangFlush">cupsLangFlush</a></h3> |
| | 5716 | <p class="description">Flush all language data out of the cache.</p> |
| | 5717 | <p class="code"> |
| | 5718 | <span class="reserved">void</span> cupsLangFlush(<span class="reserved">void</span>);</p> |
| | 5719 | <h3 class="function"><a id="cupsLangFree">cupsLangFree</a></h3> |
| | 5720 | <p class="description">Free language data.</p> |
| | 5721 | <p class="code"> |
| | 5722 | <span class="reserved">void</span> cupsLangFree(<a href="#cups_lang_t">cups_lang_t</a> *lang);</p> |
| | 5723 | <h4 class="parameters">Parameters</h4> |
| | 5724 | <table class="list"><tbody> |
| | 5725 | <tr><th>lang</th> |
| | 5726 | <td class="description">Language to free</td></tr> |
| | 5727 | </tbody></table> |
| | 5728 | <h4 class="discussion">Discussion</h4> |
| | 5729 | <p class="discussion">This does not actually free anything; use <a href="#cupsLangFlush"><code>cupsLangFlush</code></a> for that.</p> |
| | 5730 | <h3 class="function"><a id="cupsLangGet">cupsLangGet</a></h3> |
| | 5731 | <p class="description">Get a language.</p> |
| | 5732 | <p class="code"> |
| | 5733 | <a href="#cups_lang_t">cups_lang_t</a> *cupsLangGet(<span class="reserved">const</span> <span class="reserved">char</span> *language);</p> |
| | 5734 | <h4 class="parameters">Parameters</h4> |
| | 5735 | <table class="list"><tbody> |
| | 5736 | <tr><th>language</th> |
| | 5737 | <td class="description">Language or locale</td></tr> |
| | 5738 | </tbody></table> |
| | 5739 | <h4 class="returnvalue">Return Value</h4> |
| | 5740 | <p class="description">Language data</p> |
| | 5741 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsLastError">cupsLastError</a></h3> |
| | 5742 | <p class="description">Return the last IPP status code received on the current thread.</p> |
| | 5743 | <p class="code"> |
| | 5744 | ipp_status_t cupsLastError(<span class="reserved">void</span>);</p> |
| | 5745 | <h4 class="returnvalue">Return Value</h4> |
| | 5746 | <p class="description">IPP status code from last request</p> |
| | 5747 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsLastErrorString">cupsLastErrorString</a></h3> |
| | 5748 | <p class="description">Return the last IPP status-message received on the current thread.</p> |
| | 5749 | <p class="code"> |
| | 5750 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsLastErrorString(<span class="reserved">void</span>);</p> |
| | 5751 | <h4 class="returnvalue">Return Value</h4> |
| | 5752 | <p class="description">status-message text from last request</p> |
| | 5753 | <h3 class="function"><span class="info"> CUPS 2.0 </span><a id="cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></h3> |
| | 5754 | <p class="description">Get the localized string for a destination media |
| | 5755 | size.</p> |
| | 5756 | <p class="code"> |
| | 5757 | <span class="reserved">const</span> <span class="reserved">char</span> *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, <span class="reserved">unsigned</span> flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
| | 5758 | <h4 class="parameters">Parameters</h4> |
| | 5759 | <table class="list"><tbody> |
| | 5760 | <tr><th>http</th> |
| | 5761 | <td class="description">Connection to destination</td></tr> |
| | 5762 | <tr><th>dest</th> |
| | 5763 | <td class="description">Destination</td></tr> |
| | 5764 | <tr><th>dinfo</th> |
| | 5765 | <td class="description">Destination information</td></tr> |
| | 5766 | <tr><th>flags</th> |
| | 5767 | <td class="description">Media flags</td></tr> |
| | 5768 | <tr><th>size</th> |
| | 5769 | <td class="description">Media size</td></tr> |
| | 5770 | </tbody></table> |
| | 5771 | <h4 class="returnvalue">Return Value</h4> |
| | 5772 | <p class="description">Localized string</p> |
| | 5773 | <h4 class="discussion">Discussion</h4> |
| | 5774 | <p class="discussion">This function returns the localized string for the specified media size |
| | 5775 | information.<br> |
| | 5776 | <br> |
| | 5777 | The returned string is stored in the destination information and will become |
| | 5778 | invalid if the destination information is deleted. |
| | 5779 | |
| | 5780 | </p> |
| | 5781 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsLocalizeDestMedia2">cupsLocalizeDestMedia2</a></h3> |
| | 5782 | <p class="description">Get the localized string for a destination media.</p> |
| | 5783 | <p class="code"> |
| | 5784 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsLocalizeDestMedia2(<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, <span class="reserved">unsigned</span> flags, <a href="#cups_media_t">cups_media_t</a> *media);</p> |
| | 5785 | <h4 class="parameters">Parameters</h4> |
| | 5786 | <table class="list"><tbody> |
| | 5787 | <tr><th>http</th> |
| | 5788 | <td class="description">Connection to destination</td></tr> |
| | 5789 | <tr><th>dest</th> |
| | 5790 | <td class="description">Destination</td></tr> |
| | 5791 | <tr><th>dinfo</th> |
| | 5792 | <td class="description">Destination information</td></tr> |
| | 5793 | <tr><th>flags</th> |
| | 5794 | <td class="description">Media flags</td></tr> |
| | 5795 | <tr><th>media</th> |
| | 5796 | <td class="description">Media</td></tr> |
| | 5797 | </tbody></table> |
| | 5798 | <h4 class="returnvalue">Return Value</h4> |
| | 5799 | <p class="description">Localized string</p> |
| | 5800 | <h4 class="discussion">Discussion</h4> |
| | 5801 | <p class="discussion">This function returns the localized string for the specified media |
| | 5802 | information.<br> |
| | 5803 | <br> |
| | 5804 | The returned string is stored in the destination information and will become |
| | 5805 | invalid if the destination information is deleted. |
| | 5806 | |
| | 5807 | </p> |
| | 5808 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsLocalizeDestOption">cupsLocalizeDestOption</a></h3> |
| | 5809 | <p class="description">Get the localized string for a destination |
| | 5810 | option.</p> |
| | 5811 | <p class="code"> |
| | 5812 | <span class="reserved">const</span> <span class="reserved">char</span> *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, <span class="reserved">const</span> <span class="reserved">char</span> *option);</p> |
| | 5813 | <h4 class="parameters">Parameters</h4> |
| | 5814 | <table class="list"><tbody> |
| | 5815 | <tr><th>http</th> |
| | 5816 | <td class="description">Connection to destination</td></tr> |
| | 5817 | <tr><th>dest</th> |
| | 5818 | <td class="description">Destination</td></tr> |
| | 5819 | <tr><th>dinfo</th> |
| | 5820 | <td class="description">Destination information</td></tr> |
| | 5821 | <tr><th>option</th> |
| | 5822 | <td class="description">Option to localize</td></tr> |
| | 5823 | </tbody></table> |
| | 5824 | <h4 class="returnvalue">Return Value</h4> |
| | 5825 | <p class="description">Localized string</p> |
| | 5826 | <h4 class="discussion">Discussion</h4> |
| | 5827 | <p class="discussion">The returned string is stored in the destination information and will become |
| | 5828 | invalid if the destination information is deleted. |
| | 5829 | |
| | 5830 | </p> |
| | 5831 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsLocalizeDestValue">cupsLocalizeDestValue</a></h3> |
| | 5832 | <p class="description">Get the localized string for a destination |
| | 5833 | option+value pair.</p> |
| | 5834 | <p class="code"> |
| | 5835 | <span class="reserved">const</span> <span class="reserved">char</span> *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, <span class="reserved">const</span> <span class="reserved">char</span> *option, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 5836 | <h4 class="parameters">Parameters</h4> |
| | 5837 | <table class="list"><tbody> |
| | 5838 | <tr><th>http</th> |
| | 5839 | <td class="description">Connection to destination</td></tr> |
| | 5840 | <tr><th>dest</th> |
| | 5841 | <td class="description">Destination</td></tr> |
| | 5842 | <tr><th>dinfo</th> |
| | 5843 | <td class="description">Destination information</td></tr> |
| | 5844 | <tr><th>option</th> |
| | 5845 | <td class="description">Option to localize</td></tr> |
| | 5846 | <tr><th>value</th> |
| | 5847 | <td class="description">Value to localize</td></tr> |
| | 5848 | </tbody></table> |
| | 5849 | <h4 class="returnvalue">Return Value</h4> |
| | 5850 | <p class="description">Localized string</p> |
| | 5851 | <h4 class="discussion">Discussion</h4> |
| | 5852 | <p class="discussion">The returned string is stored in the destination information and will become |
| | 5853 | invalid if the destination information is deleted. |
| | 5854 | |
| | 5855 | </p> |
| | 5856 | <h3 class="function"><a id="cupsMutexDestroy">cupsMutexDestroy</a></h3> |
| | 5857 | <p class="description">Destroy a mutex.</p> |
| | 5858 | <p class="code"> |
| | 5859 | <span class="reserved">void</span> cupsMutexDestroy(<a href="#cups_mutex_t">cups_mutex_t</a> *mutex);</p> |
| | 5860 | <h4 class="parameters">Parameters</h4> |
| | 5861 | <table class="list"><tbody> |
| | 5862 | <tr><th>mutex</th> |
| | 5863 | <td class="description">Mutex</td></tr> |
| | 5864 | </tbody></table> |
| | 5865 | <h3 class="function"><a id="cupsMutexInit">cupsMutexInit</a></h3> |
| | 5866 | <p class="description">Initialize a mutex.</p> |
| | 5867 | <p class="code"> |
| | 5868 | <span class="reserved">void</span> cupsMutexInit(<a href="#cups_mutex_t">cups_mutex_t</a> *mutex);</p> |
| | 5869 | <h4 class="parameters">Parameters</h4> |
| | 5870 | <table class="list"><tbody> |
| | 5871 | <tr><th>mutex</th> |
| | 5872 | <td class="description">Mutex</td></tr> |
| | 5873 | </tbody></table> |
| | 5874 | <h3 class="function"><a id="cupsMutexLock">cupsMutexLock</a></h3> |
| | 5875 | <p class="description">Lock a mutex.</p> |
| | 5876 | <p class="code"> |
| | 5877 | <span class="reserved">void</span> cupsMutexLock(<a href="#cups_mutex_t">cups_mutex_t</a> *mutex);</p> |
| | 5878 | <h4 class="parameters">Parameters</h4> |
| | 5879 | <table class="list"><tbody> |
| | 5880 | <tr><th>mutex</th> |
| | 5881 | <td class="description">Mutex</td></tr> |
| | 5882 | </tbody></table> |
| | 5883 | <h3 class="function"><a id="cupsMutexUnlock">cupsMutexUnlock</a></h3> |
| | 5884 | <p class="description">Unlock a mutex.</p> |
| | 5885 | <p class="code"> |
| | 5886 | <span class="reserved">void</span> cupsMutexUnlock(<a href="#cups_mutex_t">cups_mutex_t</a> *mutex);</p> |
| | 5887 | <h4 class="parameters">Parameters</h4> |
| | 5888 | <table class="list"><tbody> |
| | 5889 | <tr><th>mutex</th> |
| | 5890 | <td class="description">Mutex</td></tr> |
| | 5891 | </tbody></table> |
| | 5892 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsNotifySubject">cupsNotifySubject</a></h3> |
| | 5893 | <p class="description">Return the subject for the given notification message.</p> |
| | 5894 | <p class="code"> |
| | 5895 | <span class="reserved">char</span> *cupsNotifySubject(<a href="#cups_lang_t">cups_lang_t</a> *lang, <a href="#ipp_t">ipp_t</a> *event);</p> |
| | 5896 | <h4 class="parameters">Parameters</h4> |
| | 5897 | <table class="list"><tbody> |
| | 5898 | <tr><th>lang</th> |
| | 5899 | <td class="description">Language data</td></tr> |
| | 5900 | <tr><th>event</th> |
| | 5901 | <td class="description">Event data</td></tr> |
| | 5902 | </tbody></table> |
| | 5903 | <h4 class="returnvalue">Return Value</h4> |
| | 5904 | <p class="description">Subject string or <code>NULL</code></p> |
| | 5905 | <h4 class="discussion">Discussion</h4> |
| | 5906 | <p class="discussion">The returned string must be freed by the caller using <code>free</code>. |
| | 5907 | |
| | 5908 | </p> |
| | 5909 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsNotifyText">cupsNotifyText</a></h3> |
| | 5910 | <p class="description">Return the text for the given notification message.</p> |
| | 5911 | <p class="code"> |
| | 5912 | <span class="reserved">char</span> *cupsNotifyText(<a href="#cups_lang_t">cups_lang_t</a> *lang, <a href="#ipp_t">ipp_t</a> *event);</p> |
| | 5913 | <h4 class="parameters">Parameters</h4> |
| | 5914 | <table class="list"><tbody> |
| | 5915 | <tr><th>lang</th> |
| | 5916 | <td class="description">Language data</td></tr> |
| | 5917 | <tr><th>event</th> |
| | 5918 | <td class="description">Event data</td></tr> |
| | 5919 | </tbody></table> |
| | 5920 | <h4 class="returnvalue">Return Value</h4> |
| | 5921 | <p class="description">Message text or <code>NULL</code></p> |
| | 5922 | <h4 class="discussion">Discussion</h4> |
| | 5923 | <p class="discussion">The returned string must be freed by the caller using <code>free</code>. |
| | 5924 | |
| | 5925 | </p> |
| | 5926 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthClearTokens">cupsOAuthClearTokens</a></h3> |
| | 5927 | <p class="description">Clear any cached authorization information.</p> |
| | 5928 | <p class="code"> |
| | 5929 | <span class="reserved">void</span> cupsOAuthClearTokens(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <span class="reserved">const</span> <span class="reserved">char</span> *resource_uri);</p> |
| | 5930 | <h4 class="parameters">Parameters</h4> |
| | 5931 | <table class="list"><tbody> |
| | 5932 | <tr><th>auth_uri</th> |
| | 5933 | <td class="description">Authorization server URI</td></tr> |
| | 5934 | <tr><th>resource_uri</th> |
| | 5935 | <td class="description">Resource server URI</td></tr> |
| | 5936 | </tbody></table> |
| | 5937 | <h4 class="discussion">Discussion</h4> |
| | 5938 | <p class="discussion">This function clears cached authorization information for the given |
| | 5939 | Authorization Server "auth_uri" and Resource "resource_uri" combination. |
| | 5940 | |
| | 5941 | </p> |
| | 5942 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthCopyAccessToken">cupsOAuthCopyAccessToken</a></h3> |
| | 5943 | <p class="description">Get a cached access token.</p> |
| | 5944 | <p class="code"> |
| | 5945 | <span class="reserved">char</span> *cupsOAuthCopyAccessToken(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <span class="reserved">const</span> <span class="reserved">char</span> *resource_uri, time_t *access_expires);</p> |
| | 5946 | <h4 class="parameters">Parameters</h4> |
| | 5947 | <table class="list"><tbody> |
| | 5948 | <tr><th>auth_uri</th> |
| | 5949 | <td class="description">Authorization Server URI</td></tr> |
| | 5950 | <tr><th>resource_uri</th> |
| | 5951 | <td class="description">Resource URI</td></tr> |
| | 5952 | <tr><th>access_expires</th> |
| | 5953 | <td class="description">Access expiration time or <code>NULL</code> for don't care</td></tr> |
| | 5954 | </tbody></table> |
| | 5955 | <h4 class="returnvalue">Return Value</h4> |
| | 5956 | <p class="description">Access token</p> |
| | 5957 | <h4 class="discussion">Discussion</h4> |
| | 5958 | <p class="discussion">This function makes a copy of a cached access token and any |
| | 5959 | associated expiration time for the given Authorization Server "auth_uri" and |
| | 5960 | Resource "resource_uri" combination. The returned access token must be freed |
| | 5961 | using the <code>free</code> function.<br> |
| | 5962 | <br> |
| | 5963 | <code>NULL</code> is returned if no token is cached. |
| | 5964 | |
| | 5965 | </p> |
| | 5966 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthCopyClientId">cupsOAuthCopyClientId</a></h3> |
| | 5967 | <p class="description">Get the cached <code>client_id</code> value.</p> |
| | 5968 | <p class="code"> |
| | 5969 | <span class="reserved">char</span> *cupsOAuthCopyClientId(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <span class="reserved">const</span> <span class="reserved">char</span> *redirect_uri);</p> |
| | 5970 | <h4 class="parameters">Parameters</h4> |
| | 5971 | <table class="list"><tbody> |
| | 5972 | <tr><th>auth_uri</th> |
| | 5973 | <td class="description">Authorization Server URI</td></tr> |
| | 5974 | <tr><th>redirect_uri</th> |
| | 5975 | <td class="description">Redirection URI</td></tr> |
| | 5976 | </tbody></table> |
| | 5977 | <h4 class="returnvalue">Return Value</h4> |
| | 5978 | <p class="description"><code>client_id</code> value</p> |
| | 5979 | <h4 class="discussion">Discussion</h4> |
| | 5980 | <p class="discussion">This function makes a copy of the cached <code>client_id</code> value for a given |
| | 5981 | Authorization Server "auth_uri" and Redirection URI "resource_uri". The |
| | 5982 | returned value must be freed using the <code>free</code> function.<br> |
| | 5983 | <br> |
| | 5984 | <code>NULL</code> is returned if no <code>client_id</code> is cached. |
| | 5985 | |
| | 5986 | </p> |
| | 5987 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthCopyRefreshToken">cupsOAuthCopyRefreshToken</a></h3> |
| | 5988 | <p class="description">Get a cached refresh token.</p> |
| | 5989 | <p class="code"> |
| | 5990 | <span class="reserved">char</span> *cupsOAuthCopyRefreshToken(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <span class="reserved">const</span> <span class="reserved">char</span> *resource_uri);</p> |
| | 5991 | <h4 class="parameters">Parameters</h4> |
| | 5992 | <table class="list"><tbody> |
| | 5993 | <tr><th>auth_uri</th> |
| | 5994 | <td class="description">Authorization Server URI</td></tr> |
| | 5995 | <tr><th>resource_uri</th> |
| | 5996 | <td class="description">Resource URI</td></tr> |
| | 5997 | </tbody></table> |
| | 5998 | <h4 class="returnvalue">Return Value</h4> |
| | 5999 | <p class="description">Refresh token</p> |
| | 6000 | <h4 class="discussion">Discussion</h4> |
| | 6001 | <p class="discussion">This function makes a copy of a cached refresh token for the given |
| | 6002 | given Authorization Server "auth_uri" and Resource "resource_uri" |
| | 6003 | combination. The returned refresh token must be freed using the <code>free</code> |
| | 6004 | function.<br> |
| | 6005 | <br> |
| | 6006 | <code>NULL</code> is returned if no refresh token is cached. |
| | 6007 | |
| | 6008 | </p> |
| | 6009 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthCopyUserId">cupsOAuthCopyUserId</a></h3> |
| | 6010 | <p class="description">Get cached user identification information.</p> |
| | 6011 | <p class="code"> |
| | 6012 | <a href="#cups_jwt_t">cups_jwt_t</a> *cupsOAuthCopyUserId(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <span class="reserved">const</span> <span class="reserved">char</span> *resource_uri);</p> |
| | 6013 | <h4 class="parameters">Parameters</h4> |
| | 6014 | <table class="list"><tbody> |
| | 6015 | <tr><th>auth_uri</th> |
| | 6016 | <td class="description">Authorization Server URI</td></tr> |
| | 6017 | <tr><th>resource_uri</th> |
| | 6018 | <td class="description">Resource URI</td></tr> |
| | 6019 | </tbody></table> |
| | 6020 | <h4 class="returnvalue">Return Value</h4> |
| | 6021 | <p class="description">Identification information</p> |
| | 6022 | <h4 class="discussion">Discussion</h4> |
| | 6023 | <p class="discussion">This function makes a copy of cached user identification information for the |
| | 6024 | given Authorization Server "auth_uri" and Resource "resource_uri" |
| | 6025 | combination. The returned user information must be freed using the |
| | 6026 | <a href="#cupsJWTDelete"><code>cupsJWTDelete</code></a> function.<br> |
| | 6027 | <br> |
| | 6028 | <code>NULL</code> is returned if no identification information is cached. |
| | 6029 | |
| | 6030 | </p> |
| | 6031 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthGetAuthorizationCode">cupsOAuthGetAuthorizationCode</a></h3> |
| | 6032 | <p class="description">Authorize access using a web browser.</p> |
| | 6033 | <p class="code"> |
| | 6034 | <span class="reserved">char</span> *cupsOAuthGetAuthorizationCode(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <a href="#cups_json_t">cups_json_t</a> *metadata, <span class="reserved">const</span> <span class="reserved">char</span> *resource_uri, <span class="reserved">const</span> <span class="reserved">char</span> *scopes, <span class="reserved">const</span> <span class="reserved">char</span> *redirect_uri);</p> |
| | 6035 | <h4 class="parameters">Parameters</h4> |
| | 6036 | <table class="list"><tbody> |
| | 6037 | <tr><th>auth_uri</th> |
| | 6038 | <td class="description">Authorization Server URI</td></tr> |
| | 6039 | <tr><th>metadata</th> |
| | 6040 | <td class="description">Authorization Server metadata</td></tr> |
| | 6041 | <tr><th>resource_uri</th> |
| | 6042 | <td class="description">Resource URI</td></tr> |
| | 6043 | <tr><th>scopes</th> |
| | 6044 | <td class="description">Space-delimited scopes</td></tr> |
| | 6045 | <tr><th>redirect_uri</th> |
| | 6046 | <td class="description">Redirect URI or <code>NULL</code> for default</td></tr> |
| | 6047 | </tbody></table> |
| | 6048 | <h4 class="returnvalue">Return Value</h4> |
| | 6049 | <p class="description">Authorization code or <code>NULL</code> on error</p> |
| | 6050 | <h4 class="discussion">Discussion</h4> |
| | 6051 | <p class="discussion">This function performs a local/"native" OAuth authorization flow to obtain an |
| | 6052 | authorization code for use with the <a href="#cupsOAuthGetTokens"><code>cupsOAuthGetTokens</code></a> function.<br> |
| | 6053 | <br> |
| | 6054 | The "auth_uri" parameter specifies the URI for the OAuth Authorization |
| | 6055 | Server. The "metadata" parameter specifies the Authorization Server metadata |
| | 6056 | as obtained using <a href="#cupsOAuthCopyMetadata"><code>cupsOAuthCopyMetadata</code></a> and/or |
| | 6057 | <a href="#cupsOAuthGetMetadata"><code>cupsOAuthGetMetadata</code></a>.<br> |
| | 6058 | <br> |
| | 6059 | The "resource_uri" parameter specifies the URI for a resource (printer, web |
| | 6060 | file, etc.) that you which to access.<br> |
| | 6061 | <br> |
| | 6062 | The "scopes" parameter specifies zero or more whitespace-delimited scope |
| | 6063 | names to request during authorization. The list of supported scope names are |
| | 6064 | available from the Authorization Server metadata, for example: |
| | 6065 | |
| | 6066 | <pre> |
| | 6067 | cups_json_t *metadata = cupsOAuthGetMetadata(auth_uri); |
| | 6068 | cups_json_t *scopes_supported = cupsJSONFind(metadata, "scopes_supported"); |
| | 6069 | </pre> |
| | 6070 | |
| | 6071 | The "redirect_uri" parameter specifies a 'http:' URL with a listen address, |
| | 6072 | port, and path to use. If <code>NULL</code>, 127.0.0.1 on a random port is used with a |
| | 6073 | path of "/".<br> |
| | 6074 | <br> |
| | 6075 | The returned authorization code must be freed using the <code>free</code> function. |
| | 6076 | |
| | 6077 | </p> |
| | 6078 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthGetClientId">cupsOAuthGetClientId</a></h3> |
| | 6079 | <p class="description">Register a client application and get its ID.</p> |
| | 6080 | <p class="code"> |
| | 6081 | <span class="reserved">char</span> *cupsOAuthGetClientId(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <a href="#cups_json_t">cups_json_t</a> *metadata, <span class="reserved">const</span> <span class="reserved">char</span> *redirect_uri, <span class="reserved">const</span> <span class="reserved">char</span> *logo_uri, <span class="reserved">const</span> <span class="reserved">char</span> *tos_uri);</p> |
| | 6082 | <h4 class="parameters">Parameters</h4> |
| | 6083 | <table class="list"><tbody> |
| | 6084 | <tr><th>auth_uri</th> |
| | 6085 | <td class="description">Authorization Server URI</td></tr> |
| | 6086 | <tr><th>metadata</th> |
| | 6087 | <td class="description">Authorization Server metadata</td></tr> |
| | 6088 | <tr><th>redirect_uri</th> |
| | 6089 | <td class="description">Redirection URL</td></tr> |
| | 6090 | <tr><th>logo_uri</th> |
| | 6091 | <td class="description">Logo URL or <code>NULL</code> for none</td></tr> |
| | 6092 | <tr><th>tos_uri</th> |
| | 6093 | <td class="description">Terms-of-service URL or <code>NULL</code> for none</td></tr> |
| | 6094 | </tbody></table> |
| | 6095 | <h4 class="returnvalue">Return Value</h4> |
| | 6096 | <p class="description"><code>client_id</code> string or <code>NULL</code> on error</p> |
| | 6097 | <h4 class="discussion">Discussion</h4> |
| | 6098 | <p class="discussion">This function registers a client application with the specified OAuth |
| | 6099 | Authorization Server.<br> |
| | 6100 | <br> |
| | 6101 | The "auth_uri" parameter specifies the URI for the OAuth Authorization |
| | 6102 | Server. The "metadata" parameter specifies the Authorization Server metadata |
| | 6103 | as obtained using <a href="#cupsOAuthCopyMetadata"><code>cupsOAuthCopyMetadata</code></a> and/or |
| | 6104 | <a href="#cupsOAuthGetMetadata"><code>cupsOAuthGetMetadata</code></a>.<br> |
| | 6105 | <br> |
| | 6106 | The "redirect_uri" argument specifies the URL to use for providing |
| | 6107 | authorization results to a WWW application.<br> |
| | 6108 | <br> |
| | 6109 | The "logo_uri" argument specifies a public URL for the logo of your |
| | 6110 | application, while the "tos_uri" specifies a public URL for the terms of |
| | 6111 | service for your application.<br> |
| | 6112 | <br> |
| | 6113 | The returned "client_id" string must be freed using the <code>free</code> function.<br> |
| | 6114 | <br> |
| | 6115 | <em>Note</em>: This function should only be used to register WWW applications. The |
| | 6116 | <a href="#cupsOAuthGetAuthorizationCode"><code>cupsOAuthGetAuthorizationCode</code></a> function handles registration of |
| | 6117 | local/"native" applications for you. |
| | 6118 | |
| | 6119 | </p> |
| | 6120 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthGetJWKS">cupsOAuthGetJWKS</a></h3> |
| | 6121 | <p class="description">Get the JWT key set for an Authorization Server.</p> |
| | 6122 | <p class="code"> |
| | 6123 | <a href="#cups_json_t">cups_json_t</a> *cupsOAuthGetJWKS(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <a href="#cups_json_t">cups_json_t</a> *metadata);</p> |
| | 6124 | <h4 class="parameters">Parameters</h4> |
| | 6125 | <table class="list"><tbody> |
| | 6126 | <tr><th>auth_uri</th> |
| | 6127 | <td class="description">Authorization server URI</td></tr> |
| | 6128 | <tr><th>metadata</th> |
| | 6129 | <td class="description">Server metadata</td></tr> |
| | 6130 | </tbody></table> |
| | 6131 | <h4 class="returnvalue">Return Value</h4> |
| | 6132 | <p class="description">JWKS or <code>NULL</code> on error</p> |
| | 6133 | <h4 class="discussion">Discussion</h4> |
| | 6134 | <p class="discussion">This function gets the JWT key set for the specified Authorization Server |
| | 6135 | "auth_uri". The "metadata" value is obtained using the |
| | 6136 | <a href="#cupsOAuthGetMetadata"><code>cupsOAuthGetMetadata</code></a> function. The returned key set is cached |
| | 6137 | per-user for better performance and must be freed using the |
| | 6138 | <a href="#cupsJSONDelete"><code>cupsJSONDelete</code></a> function.<br> |
| | 6139 | <br> |
| | 6140 | The key set is typically used to validate JWT bearer tokens using the |
| | 6141 | <a href="#cupsJWTHasValidSignature"><code>cupsJWTHasValidSignature</code></a> function. |
| | 6142 | |
| | 6143 | </p> |
| | 6144 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthGetMetadata">cupsOAuthGetMetadata</a></h3> |
| | 6145 | <p class="description">Get the metadata for an Authorization Server.</p> |
| | 6146 | <p class="code"> |
| | 6147 | <a href="#cups_json_t">cups_json_t</a> *cupsOAuthGetMetadata(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri);</p> |
| | 6148 | <h4 class="parameters">Parameters</h4> |
| | 6149 | <table class="list"><tbody> |
| | 6150 | <tr><th>auth_uri</th> |
| | 6151 | <td class="description">Authorization Server URI</td></tr> |
| | 6152 | </tbody></table> |
| | 6153 | <h4 class="returnvalue">Return Value</h4> |
| | 6154 | <p class="description">JSON metadata or <code>NULL</code> on error</p> |
| | 6155 | <h4 class="discussion">Discussion</h4> |
| | 6156 | <p class="discussion">This function gets the RFC 8414 or Open ID Connect metadata for the specified |
| | 6157 | OAuth Authorization Server URI "auth_uri".<br> |
| | 6158 | <br> |
| | 6159 | The returned metadata is cached per-user for better performance and must be |
| | 6160 | freed using the <a href="#cupsJSONDelete"><code>cupsJSONDelete</code></a> function. |
| | 6161 | |
| | 6162 | </p> |
| | 6163 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthGetTokens">cupsOAuthGetTokens</a></h3> |
| | 6164 | <p class="description">Obtain access and refresh tokens.</p> |
| | 6165 | <p class="code"> |
| | 6166 | <span class="reserved">char</span> *cupsOAuthGetTokens(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <a href="#cups_json_t">cups_json_t</a> *metadata, <span class="reserved">const</span> <span class="reserved">char</span> *resource_uri, <span class="reserved">const</span> <span class="reserved">char</span> *grant_code, <a href="#cups_ogrant_t">cups_ogrant_t</a> grant_type, <span class="reserved">const</span> <span class="reserved">char</span> *redirect_uri, time_t *access_expires);</p> |
| | 6167 | <h4 class="parameters">Parameters</h4> |
| | 6168 | <table class="list"><tbody> |
| | 6169 | <tr><th>auth_uri</th> |
| | 6170 | <td class="description">Authorization Server URI</td></tr> |
| | 6171 | <tr><th>metadata</th> |
| | 6172 | <td class="description">Authorization Server metadata</td></tr> |
| | 6173 | <tr><th>resource_uri</th> |
| | 6174 | <td class="description">Resource URI</td></tr> |
| | 6175 | <tr><th>grant_code</th> |
| | 6176 | <td class="description">Authorization code or refresh token</td></tr> |
| | 6177 | <tr><th>grant_type</th> |
| | 6178 | <td class="description">Grant code type</td></tr> |
| | 6179 | <tr><th>redirect_uri</th> |
| | 6180 | <td class="description">Redirect URI</td></tr> |
| | 6181 | <tr><th>access_expires</th> |
| | 6182 | <td class="description">Expiration time for access token</td></tr> |
| | 6183 | </tbody></table> |
| | 6184 | <h4 class="returnvalue">Return Value</h4> |
| | 6185 | <p class="description">Access token or <code>NULL</code> on error</p> |
| | 6186 | <h4 class="discussion">Discussion</h4> |
| | 6187 | <p class="discussion">This function obtains a access and refresh tokens from an OAuth Authorization |
| | 6188 | Server. OpenID Authorization Servers also provide user identification |
| | 6189 | information.<br> |
| | 6190 | <br> |
| | 6191 | The "auth_uri" parameter specifies the URI for the OAuth Authorization |
| | 6192 | Server. The "metadata" parameter specifies the Authorization Server metadata |
| | 6193 | as obtained using <a href="#cupsOAuthCopyMetadata"><code>cupsOAuthCopyMetadata</code></a> and/or |
| | 6194 | <a href="#cupsOAuthGetMetadata"><code>cupsOAuthGetMetadata</code></a>.<br> |
| | 6195 | <br> |
| | 6196 | The "resource_uri" parameter specifies the URI for a resource (printer, web |
| | 6197 | file, etc.) that you which to access.<br> |
| | 6198 | <br> |
| | 6199 | The "grant_code" parameter specifies the code or token to use while the |
| | 6200 | "grant_type" parameter specifies the type of code: |
| | 6201 | |
| | 6202 | </p><ul> |
| | 6203 | <li><code>CUPS_OGRANT_AUTHORIZATION_CODE</code>: A user authorization grant code. |
| | 6204 | </li> |
| | 6205 | <li><code>CUPS_OGRANT_DEVICE_CODE</code>: A device authorization grant code. |
| | 6206 | </li> |
| | 6207 | <li><code>CUPS_OGRANT_REFRESH_TOKEN</code>: A refresh token.</li> |
| | 6208 | </ul> |
| | 6209 | <p class="discussion">The "redirect_uri" specifies the redirection URI used to obtain the code. The |
| | 6210 | constant <code>CUPS_OAUTH_REDIRECT_URI</code> should be used for codes obtained using |
| | 6211 | the <a href="#cupsOAuthGetAuthorizationCode"><code>cupsOAuthGetAuthorizationCode</code></a> function.<br> |
| | 6212 | <br> |
| | 6213 | When successful, the access token and expiration time are returned. The |
| | 6214 | access token must be freed using the <code>free</code> function. The new refresh token |
| | 6215 | and any user ID information can be obtained using the |
| | 6216 | <a href="#cupsOAuthCopyRefreshToken"><code>cupsOAuthCopyRefreshToken</code></a> and <a href="#cupsOAuthCopyUserId"><code>cupsOAuthCopyUserId</code></a> functions |
| | 6217 | respectively. |
| | 6218 | |
| | 6219 | </p> |
| | 6220 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthGetUserId">cupsOAuthGetUserId</a></h3> |
| | 6221 | <p class="description">Get the user ID token associated with the given access token.</p> |
| | 6222 | <p class="code"> |
| | 6223 | <a href="#cups_jwt_t">cups_jwt_t</a> *cupsOAuthGetUserId(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <a href="#cups_json_t">cups_json_t</a> *metadata, <span class="reserved">const</span> <span class="reserved">char</span> *access_token);</p> |
| | 6224 | <h4 class="parameters">Parameters</h4> |
| | 6225 | <table class="list"><tbody> |
| | 6226 | <tr><th>auth_uri</th> |
| | 6227 | <td class="description">Authorization Server URL</td></tr> |
| | 6228 | <tr><th>metadata</th> |
| | 6229 | <td class="description">Authorization Server metadata</td></tr> |
| | 6230 | <tr><th>access_token</th> |
| | 6231 | <td class="description">Access (Bearer) token</td></tr> |
| | 6232 | </tbody></table> |
| | 6233 | <h4 class="returnvalue">Return Value</h4> |
| | 6234 | <p class="description">Identification information or <code>NULL</code> if none</p> |
| | 6235 | <h4 class="discussion">Discussion</h4> |
| | 6236 | <p class="discussion">This function retrieves the user ID token associated with a given access |
| | 6237 | token. The user ID information is cached until the token expires to minimize |
| | 6238 | the overhead of communicating with the Authorization Server. |
| | 6239 | |
| | 6240 | </p> |
| | 6241 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthMakeAuthorizationURL">cupsOAuthMakeAuthorizationURL</a></h3> |
| | 6242 | <p class="description">Make an authorization URL.</p> |
| | 6243 | <p class="code"> |
| | 6244 | <span class="reserved">char</span> *cupsOAuthMakeAuthorizationURL(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <a href="#cups_json_t">cups_json_t</a> *metadata, <span class="reserved">const</span> <span class="reserved">char</span> *resource_uri, <span class="reserved">const</span> <span class="reserved">char</span> *scopes, <span class="reserved">const</span> <span class="reserved">char</span> *client_id, <span class="reserved">const</span> <span class="reserved">char</span> *code_verifier, <span class="reserved">const</span> <span class="reserved">char</span> *nonce, <span class="reserved">const</span> <span class="reserved">char</span> *redirect_uri, <span class="reserved">const</span> <span class="reserved">char</span> *state);</p> |
| | 6245 | <h4 class="parameters">Parameters</h4> |
| | 6246 | <table class="list"><tbody> |
| | 6247 | <tr><th>auth_uri</th> |
| | 6248 | <td class="description">Authorization Server URI</td></tr> |
| | 6249 | <tr><th>metadata</th> |
| | 6250 | <td class="description">Authorization Server metadata</td></tr> |
| | 6251 | <tr><th>resource_uri</th> |
| | 6252 | <td class="description">Resource URI</td></tr> |
| | 6253 | <tr><th>scopes</th> |
| | 6254 | <td class="description">Space-delimited scope(s)</td></tr> |
| | 6255 | <tr><th>client_id</th> |
| | 6256 | <td class="description">Client ID</td></tr> |
| | 6257 | <tr><th>code_verifier</th> |
| | 6258 | <td class="description">Code verifier string</td></tr> |
| | 6259 | <tr><th>nonce</th> |
| | 6260 | <td class="description">Nonce</td></tr> |
| | 6261 | <tr><th>redirect_uri</th> |
| | 6262 | <td class="description">Redirection URI</td></tr> |
| | 6263 | <tr><th>state</th> |
| | 6264 | <td class="description">State</td></tr> |
| | 6265 | </tbody></table> |
| | 6266 | <h4 class="returnvalue">Return Value</h4> |
| | 6267 | <p class="description">Authorization URL</p> |
| | 6268 | <h4 class="discussion">Discussion</h4> |
| | 6269 | <p class="discussion">This function makes an authorization URL for the specified authorization |
| | 6270 | server and resource.<br> |
| | 6271 | <br> |
| | 6272 | The "auth_uri" parameter specifies the URI for the OAuth Authorization |
| | 6273 | Server. The "metadata" parameter specifies the Authorization Server metadata |
| | 6274 | as obtained using <a href="#cupsOAuthCopyMetadata"><code>cupsOAuthCopyMetadata</code></a> and/or |
| | 6275 | <a href="#cupsOAuthGetMetadata"><code>cupsOAuthGetMetadata</code></a>.<br> |
| | 6276 | <br> |
| | 6277 | The "resource_uri" parameter specifies the URI for a resource (printer, web |
| | 6278 | file, etc.) that you which to access.<br> |
| | 6279 | <br> |
| | 6280 | The "scopes" parameter specifies zero or more whitespace-delimited scope |
| | 6281 | names to request during authorization. The list of supported scope names are |
| | 6282 | available from the Authorization Server metadata, for example: |
| | 6283 | |
| | 6284 | <pre> |
| | 6285 | cups_json_t *metadata = cupsOAuthGetMetadata(auth_uri); |
| | 6286 | cups_json_t *scopes_supported = cupsJSONFind(metadata, "scopes_supported"); |
| | 6287 | </pre> |
| | 6288 | |
| | 6289 | The "client_id" parameter specifies the client identifier obtained using |
| | 6290 | <a href="#cupsOAuthCopyClientId"><code>cupsOAuthCopyClientId</code></a> and/or <a href="#cupsOAuthGetClientId"><code>cupsOAuthGetClientId</code></a>.<br> |
| | 6291 | <br> |
| | 6292 | The "client_id" parameter is the string returned by |
| | 6293 | <a href="#cupsOAuthCopyClientId"><code>cupsOAuthCopyClientId</code></a> or <a href="#cupsOAuthGetClientId"><code>cupsOAuthGetClientId</code></a>.<br> |
| | 6294 | <br> |
| | 6295 | The "code_verifier" parameter specifies a random Base64URL-encoded string |
| | 6296 | that is used by the Proof Key for Code Exchange [RFC7636] extension to help |
| | 6297 | secure the authorization flow. The <a href="#cupsOAuthMakeBase64Random"><code>cupsOAuthMakeBase64Random</code></a> function |
| | 6298 | can be used to generate this string.<br> |
| | 6299 | <br> |
| | 6300 | The "nonce" parameter specifies a random Base64URL-encoded string that is |
| | 6301 | used by OpenID to validate the ID token. The <a href="#cupsOAuthMakeBase64Random"><code>cupsOAuthMakeBase64Random</code></a> |
| | 6302 | function can be used to generate this string.<br> |
| | 6303 | <br> |
| | 6304 | The "redirect_uri" parameter specifies the URI that will receive the |
| | 6305 | authorization grant code.<br> |
| | 6306 | <br> |
| | 6307 | The "state" parameter is a unique (random) identifier for the authorization |
| | 6308 | request. It is provided to the redirection URI as a form parameter. |
| | 6309 | |
| | 6310 | </p> |
| | 6311 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthMakeBase64Random">cupsOAuthMakeBase64Random</a></h3> |
| | 6312 | <p class="description">Make a random data string.</p> |
| | 6313 | <p class="code"> |
| | 6314 | <span class="reserved">char</span> *cupsOAuthMakeBase64Random(size_t len);</p> |
| | 6315 | <h4 class="parameters">Parameters</h4> |
| | 6316 | <table class="list"><tbody> |
| | 6317 | <tr><th>len</th> |
| | 6318 | <td class="description">Number of bytes</td></tr> |
| | 6319 | </tbody></table> |
| | 6320 | <h4 class="returnvalue">Return Value</h4> |
| | 6321 | <p class="description">Random string</p> |
| | 6322 | <h4 class="discussion">Discussion</h4> |
| | 6323 | <p class="discussion">This function creates a string containing random data that has been Base64URL |
| | 6324 | encoded. "len" specifies the number of random bytes to include in the string. |
| | 6325 | The returned string must be freed using the <code>free</code> function. |
| | 6326 | |
| | 6327 | </p> |
| | 6328 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthSaveClientData">cupsOAuthSaveClientData</a></h3> |
| | 6329 | <p class="description">Save client_id and client_secret values.</p> |
| | 6330 | <p class="code"> |
| | 6331 | <span class="reserved">void</span> cupsOAuthSaveClientData(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <span class="reserved">const</span> <span class="reserved">char</span> *redirect_uri, <span class="reserved">const</span> <span class="reserved">char</span> *client_id, <span class="reserved">const</span> <span class="reserved">char</span> *client_secret);</p> |
| | 6332 | <h4 class="parameters">Parameters</h4> |
| | 6333 | <table class="list"><tbody> |
| | 6334 | <tr><th>auth_uri</th> |
| | 6335 | <td class="description">Authorization Server URI</td></tr> |
| | 6336 | <tr><th>redirect_uri</th> |
| | 6337 | <td class="description">Redirection URI</td></tr> |
| | 6338 | <tr><th>client_id</th> |
| | 6339 | <td class="description">client_id or <code>NULL</code> to delete</td></tr> |
| | 6340 | <tr><th>client_secret</th> |
| | 6341 | <td class="description">client_secret value or <code>NULL</code> for none</td></tr> |
| | 6342 | </tbody></table> |
| | 6343 | <h4 class="discussion">Discussion</h4> |
| | 6344 | <p class="discussion">This function saves the "client_id" and "client_secret" values for the given |
| | 6345 | Authorization Server "auth_uri" and redirection URI "redirect_uri". If the |
| | 6346 | "client_id" is <code>NULL</code> then any saved values are deleted from the per-user |
| | 6347 | store. |
| | 6348 | |
| | 6349 | </p> |
| | 6350 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsOAuthSaveTokens">cupsOAuthSaveTokens</a></h3> |
| | 6351 | <p class="description">Save authorization and refresh tokens.</p> |
| | 6352 | <p class="code"> |
| | 6353 | <span class="reserved">void</span> cupsOAuthSaveTokens(<span class="reserved">const</span> <span class="reserved">char</span> *auth_uri, <span class="reserved">const</span> <span class="reserved">char</span> *resource_uri, <span class="reserved">const</span> <span class="reserved">char</span> *access_token, time_t access_expires, <span class="reserved">const</span> <span class="reserved">char</span> *user_id, <span class="reserved">const</span> <span class="reserved">char</span> *refresh_token);</p> |
| | 6354 | <h4 class="parameters">Parameters</h4> |
| | 6355 | <table class="list"><tbody> |
| | 6356 | <tr><th>auth_uri</th> |
| | 6357 | <td class="description">Authorization Server URI</td></tr> |
| | 6358 | <tr><th>resource_uri</th> |
| | 6359 | <td class="description">Resource URI</td></tr> |
| | 6360 | <tr><th>access_token</th> |
| | 6361 | <td class="description">Access token or <code>NULL</code> to delete</td></tr> |
| | 6362 | <tr><th>access_expires</th> |
| | 6363 | <td class="description">Access expiration time</td></tr> |
| | 6364 | <tr><th>user_id</th> |
| | 6365 | <td class="description">User ID or <code>NULL</code> to delete</td></tr> |
| | 6366 | <tr><th>refresh_token</th> |
| | 6367 | <td class="description">Refresh token or <code>NULL</code> to delete</td></tr> |
| | 6368 | </tbody></table> |
| | 6369 | <h4 class="discussion">Discussion</h4> |
| | 6370 | <p class="discussion">This function saves the access token "access_token", user ID "user_id", and |
| | 6371 | refresh token "refresh_token" values for the given Authorization Server |
| | 6372 | "auth_uri" and resource "resource_uri". Specifying <code>NULL</code> for any of the |
| | 6373 | values will delete the corresponding saved values from the per-user store. |
| | 6374 | |
| | 6375 | </p> |
| | 6376 | <h3 class="function"><a id="cupsParseOptions">cupsParseOptions</a></h3> |
| | 6377 | <p class="description">Parse options from a command-line argument.</p> |
| | 6378 | <p class="code"> |
| | 6379 | <span class="reserved">int</span> cupsParseOptions(<span class="reserved">const</span> <span class="reserved">char</span> *arg, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| | 6380 | <h4 class="parameters">Parameters</h4> |
| | 6381 | <table class="list"><tbody> |
| | 6382 | <tr><th>arg</th> |
| | 6383 | <td class="description">Argument to parse</td></tr> |
| | 6384 | <tr><th>num_options</th> |
| | 6385 | <td class="description">Number of options</td></tr> |
| | 6386 | <tr><th>options</th> |
| | 6387 | <td class="description">Options found</td></tr> |
| | 6388 | </tbody></table> |
| | 6389 | <h4 class="returnvalue">Return Value</h4> |
| | 6390 | <p class="description">Number of options found</p> |
| | 6391 | <h4 class="discussion">Discussion</h4> |
| | 6392 | <p class="discussion">This function converts space-delimited name/value pairs according |
| | 6393 | to the PAPI text option ABNF specification. Collection values |
| | 6394 | ("name={a=... b=... c=...}") are stored with the curley brackets |
| | 6395 | intact - use <code>cupsParseOptions</code> on the value to extract the |
| | 6396 | collection attributes.</p> |
| | 6397 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsParseOptions2">cupsParseOptions2</a></h3> |
| | 6398 | <p class="description">Parse options from a command-line argument.</p> |
| | 6399 | <p class="code"> |
| | 6400 | <span class="reserved">int</span> cupsParseOptions2(<span class="reserved">const</span> <span class="reserved">char</span> *arg, <span class="reserved">const</span> <span class="reserved">char</span> **end, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| | 6401 | <h4 class="parameters">Parameters</h4> |
| | 6402 | <table class="list"><tbody> |
| | 6403 | <tr><th>arg</th> |
| | 6404 | <td class="description">Argument to parse</td></tr> |
| | 6405 | <tr><th>end</th> |
| | 6406 | <td class="description">Pointer to end of options or <code>NULL</code> for "don't care"</td></tr> |
| | 6407 | <tr><th>num_options</th> |
| | 6408 | <td class="description">Number of options</td></tr> |
| | 6409 | <tr><th>options</th> |
| | 6410 | <td class="description">Options found</td></tr> |
| | 6411 | </tbody></table> |
| | 6412 | <h4 class="returnvalue">Return Value</h4> |
| | 6413 | <p class="description">Number of options found</p> |
| | 6414 | <h4 class="discussion">Discussion</h4> |
| | 6415 | <p class="discussion">This function converts space-delimited name/value pairs according |
| | 6416 | to the PAPI text option ABNF specification. Collection values |
| | 6417 | ("name={a=... b=... c=...}") are stored with the curley brackets |
| | 6418 | intact - use <code>cupsParseOptions</code> on the value to extract the |
| | 6419 | collection attributes.<br> |
| | 6420 | <br> |
| | 6421 | The "end" argument, if not <code>NULL</code>, receives a pointer to the end of the |
| | 6422 | options. |
| | 6423 | |
| | 6424 | </p> |
| | 6425 | <h3 class="function"><span class="info"> CUPS 1.1.20 </span><a id="cupsPutFd">cupsPutFd</a></h3> |
| | 6426 | <p class="description">Put a file on the server.</p> |
| | 6427 | <p class="code"> |
| | 6428 | http_status_t cupsPutFd(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *resource, <span class="reserved">int</span> fd);</p> |
| | 6429 | <h4 class="parameters">Parameters</h4> |
| | 6430 | <table class="list"><tbody> |
| | 6431 | <tr><th>http</th> |
| | 6432 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 6433 | <tr><th>resource</th> |
| | 6434 | <td class="description">Resource name</td></tr> |
| | 6435 | <tr><th>fd</th> |
| | 6436 | <td class="description">File descriptor</td></tr> |
| | 6437 | </tbody></table> |
| | 6438 | <h4 class="returnvalue">Return Value</h4> |
| | 6439 | <p class="description">HTTP status</p> |
| | 6440 | <h4 class="discussion">Discussion</h4> |
| | 6441 | <p class="discussion">This function returns <code>HTTP_STATUS_CREATED</code> when the file is stored |
| | 6442 | successfully. |
| | 6443 | |
| | 6444 | </p> |
| | 6445 | <h3 class="function"><span class="info"> CUPS 1.1.20 </span><a id="cupsPutFile">cupsPutFile</a></h3> |
| | 6446 | <p class="description">Put a file on the server.</p> |
| | 6447 | <p class="code"> |
| | 6448 | http_status_t cupsPutFile(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *resource, <span class="reserved">const</span> <span class="reserved">char</span> *filename);</p> |
| | 6449 | <h4 class="parameters">Parameters</h4> |
| | 6450 | <table class="list"><tbody> |
| | 6451 | <tr><th>http</th> |
| | 6452 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 6453 | <tr><th>resource</th> |
| | 6454 | <td class="description">Resource name</td></tr> |
| | 6455 | <tr><th>filename</th> |
| | 6456 | <td class="description">Filename</td></tr> |
| | 6457 | </tbody></table> |
| | 6458 | <h4 class="returnvalue">Return Value</h4> |
| | 6459 | <p class="description">HTTP status</p> |
| | 6460 | <h4 class="discussion">Discussion</h4> |
| | 6461 | <p class="discussion">This function returns <code>HTTP_CREATED</code> when the file is stored |
| | 6462 | successfully. |
| | 6463 | |
| | 6464 | </p> |
| | 6465 | <h3 class="function"><a id="cupsRWDestroy">cupsRWDestroy</a></h3> |
| | 6466 | <p class="description">Destroy a reader/writer lock.</p> |
| | 6467 | <p class="code"> |
| | 6468 | <span class="reserved">void</span> cupsRWDestroy(<a href="#cups_rwlock_t">cups_rwlock_t</a> *rwlock);</p> |
| | 6469 | <h4 class="parameters">Parameters</h4> |
| | 6470 | <table class="list"><tbody> |
| | 6471 | <tr><th>rwlock</th> |
| | 6472 | <td class="description">Reader/writer lock</td></tr> |
| | 6473 | </tbody></table> |
| | 6474 | <h3 class="function"><a id="cupsRWInit">cupsRWInit</a></h3> |
| | 6475 | <p class="description">Initialize a reader/writer lock.</p> |
| | 6476 | <p class="code"> |
| | 6477 | <span class="reserved">void</span> cupsRWInit(<a href="#cups_rwlock_t">cups_rwlock_t</a> *rwlock);</p> |
| | 6478 | <h4 class="parameters">Parameters</h4> |
| | 6479 | <table class="list"><tbody> |
| | 6480 | <tr><th>rwlock</th> |
| | 6481 | <td class="description">Reader/writer lock</td></tr> |
| | 6482 | </tbody></table> |
| | 6483 | <h3 class="function"><a id="cupsRWLockRead">cupsRWLockRead</a></h3> |
| | 6484 | <p class="description">Acquire a reader/writer lock for reading.</p> |
| | 6485 | <p class="code"> |
| | 6486 | <span class="reserved">void</span> cupsRWLockRead(<a href="#cups_rwlock_t">cups_rwlock_t</a> *rwlock);</p> |
| | 6487 | <h4 class="parameters">Parameters</h4> |
| | 6488 | <table class="list"><tbody> |
| | 6489 | <tr><th>rwlock</th> |
| | 6490 | <td class="description">Reader/writer lock</td></tr> |
| | 6491 | </tbody></table> |
| | 6492 | <h3 class="function"><a id="cupsRWLockWrite">cupsRWLockWrite</a></h3> |
| | 6493 | <p class="description">Acquire a reader/writer lock for writing.</p> |
| | 6494 | <p class="code"> |
| | 6495 | <span class="reserved">void</span> cupsRWLockWrite(<a href="#cups_rwlock_t">cups_rwlock_t</a> *rwlock);</p> |
| | 6496 | <h4 class="parameters">Parameters</h4> |
| | 6497 | <table class="list"><tbody> |
| | 6498 | <tr><th>rwlock</th> |
| | 6499 | <td class="description">Reader/writer lock</td></tr> |
| | 6500 | </tbody></table> |
| | 6501 | <h3 class="function"><a id="cupsRWUnlock">cupsRWUnlock</a></h3> |
| | 6502 | <p class="description">Release a reader/writer lock.</p> |
| | 6503 | <p class="code"> |
| | 6504 | <span class="reserved">void</span> cupsRWUnlock(<a href="#cups_rwlock_t">cups_rwlock_t</a> *rwlock);</p> |
| | 6505 | <h4 class="parameters">Parameters</h4> |
| | 6506 | <table class="list"><tbody> |
| | 6507 | <tr><th>rwlock</th> |
| | 6508 | <td class="description">Reader/writer lock</td></tr> |
| | 6509 | </tbody></table> |
| | 6510 | <h3 class="function"><a id="cupsRasterClose">cupsRasterClose</a></h3> |
| | 6511 | <p class="description">Close a raster stream.</p> |
| | 6512 | <p class="code"> |
| | 6513 | <span class="reserved">void</span> cupsRasterClose(<a href="#cups_raster_t">cups_raster_t</a> *r);</p> |
| | 6514 | <h4 class="parameters">Parameters</h4> |
| | 6515 | <table class="list"><tbody> |
| | 6516 | <tr><th>r</th> |
| | 6517 | <td class="description">Stream to close</td></tr> |
| | 6518 | </tbody></table> |
| | 6519 | <h4 class="discussion">Discussion</h4> |
| | 6520 | <p class="discussion">The file descriptor associated with the raster stream must be closed |
| | 6521 | separately as needed.</p> |
| | 6522 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsRasterGetErrorString">cupsRasterGetErrorString</a></h3> |
| | 6523 | <p class="description">Return the last error from a raster function.</p> |
| | 6524 | <p class="code"> |
| | 6525 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsRasterGetErrorString(<span class="reserved">void</span>);</p> |
| | 6526 | <h4 class="returnvalue">Return Value</h4> |
| | 6527 | <p class="description">Last error</p> |
| | 6528 | <h4 class="discussion">Discussion</h4> |
| | 6529 | <p class="discussion">If there are no recent errors, NULL is returned. |
| | 6530 | |
| | 6531 | </p> |
| | 6532 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsRasterInitHeader">cupsRasterInitHeader</a></h3> |
| | 6533 | <p class="description">Initialize a page header for PWG Raster output.</p> |
| | 6534 | <p class="code"> |
| | 6535 | <span class="reserved">bool</span> cupsRasterInitHeader(<a href="#cups_page_header2_t">cups_page_header2_t</a> *h, <a href="#cups_media_t">cups_media_t</a> *media, <span class="reserved">const</span> <span class="reserved">char</span> *optimize, <a href="#ipp_quality_t">ipp_quality_t</a> quality, <span class="reserved">const</span> <span class="reserved">char</span> *intent, <a href="#ipp_orient_t">ipp_orient_t</a> orientation, <span class="reserved">const</span> <span class="reserved">char</span> *sides, <span class="reserved">const</span> <span class="reserved">char</span> *type, <span class="reserved">int</span> xdpi, <span class="reserved">int</span> ydpi, <span class="reserved">const</span> <span class="reserved">char</span> *sheet_back);</p> |
| | 6536 | <h4 class="parameters">Parameters</h4> |
| | 6537 | <table class="list"><tbody> |
| | 6538 | <tr><th>h</th> |
| | 6539 | <td class="description">Page header</td></tr> |
| | 6540 | <tr><th>media</th> |
| | 6541 | <td class="description">Media information</td></tr> |
| | 6542 | <tr><th>optimize</th> |
| | 6543 | <td class="description">IPP "print-content-optimize" value</td></tr> |
| | 6544 | <tr><th>quality</th> |
| | 6545 | <td class="description">IPP "print-quality" value</td></tr> |
| | 6546 | <tr><th>intent</th> |
| | 6547 | <td class="description">IPP "print-rendering-intent" value</td></tr> |
| | 6548 | <tr><th>orientation</th> |
| | 6549 | <td class="description">IPP "orientation-requested" value</td></tr> |
| | 6550 | <tr><th>sides</th> |
| | 6551 | <td class="description">IPP "sides" value</td></tr> |
| | 6552 | <tr><th>type</th> |
| | 6553 | <td class="description">PWG raster type string</td></tr> |
| | 6554 | <tr><th>xdpi</th> |
| | 6555 | <td class="description">Cross-feed direction (horizontal) resolution</td></tr> |
| | 6556 | <tr><th>ydpi</th> |
| | 6557 | <td class="description">Feed direction (vertical) resolution</td></tr> |
| | 6558 | <tr><th>sheet_back</th> |
| | 6559 | <td class="description">Transform for back side or <code>NULL</code> for none</td></tr> |
| | 6560 | </tbody></table> |
| | 6561 | <h4 class="returnvalue">Return Value</h4> |
| | 6562 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 6563 | <h4 class="discussion">Discussion</h4> |
| | 6564 | <p class="discussion">The "media" argument specifies the media to use. The "optimize", "quality", |
| | 6565 | "intent", "orientation", and "sides" arguments specify additional IPP Job |
| | 6566 | Template attribute values that are reflected in the raster header.<br> |
| | 6567 | <br> |
| | 6568 | The "type" argument specifies a "pwg-raster-document-type-supported" value |
| | 6569 | that controls the color space and bit depth of the raster data. Supported |
| | 6570 | values include: |
| | 6571 | |
| | 6572 | </p><ul> |
| | 6573 | <li>"adobe-rgb_8": 8-bit per component (24-bit) AdobeRGB |
| | 6574 | </li> |
| | 6575 | <li>"adobe-rgb_16": 16-bit per component (48-bit) AdobeRGB |
| | 6576 | </li> |
| | 6577 | <li>"black_1": 1-bit black (K) |
| | 6578 | </li> |
| | 6579 | <li>"black_8": 8-bit black (K) |
| | 6580 | </li> |
| | 6581 | <li>"black_16": 16-bit black (K) |
| | 6582 | </li> |
| | 6583 | <li>"cmyk_8": 8-bit per component (32-bit) CMYK |
| | 6584 | </li> |
| | 6585 | <li>"cmyk_16": 16-bit per component (64-bit) CMYK |
| | 6586 | </li> |
| | 6587 | <li>"device1_8" to "device15_8": 8-bit per component DeviceN |
| | 6588 | </li> |
| | 6589 | <li>"device1_16" to "device15_16": 16-bit per component DeviceN |
| | 6590 | </li> |
| | 6591 | <li>"rgb_8": 8-bit per component (24-bit) DeviceRGB |
| | 6592 | </li> |
| | 6593 | <li>"rgb_16": 16-bit per component (32-bit) DeviceRGB |
| | 6594 | </li> |
| | 6595 | <li>"sgray_1": 1-bit sGray |
| | 6596 | </li> |
| | 6597 | <li>"sgray_8": 8-bit sGray |
| | 6598 | </li> |
| | 6599 | <li>"sgray_16": 16-bit sGray |
| | 6600 | </li> |
| | 6601 | <li>"srgb_8": 8-bit per component (24-bit) sRGB |
| | 6602 | </li> |
| | 6603 | <li>"srgb_16": 16-bit per component (48-bit) sRGB</li> |
| | 6604 | </ul> |
| | 6605 | <p class="discussion">The "xres" and "yres" arguments specify the raster resolution in dots per |
| | 6606 | inch.<br> |
| | 6607 | <br> |
| | 6608 | The "sheet_back" argument specifies a "pwg-raster-document-sheet-back" value |
| | 6609 | to apply for the back side of a page. Pass <code>NULL</code> for the front side. |
| | 6610 | |
| | 6611 | </p> |
| | 6612 | <h3 class="function"><a id="cupsRasterOpen">cupsRasterOpen</a></h3> |
| | 6613 | <p class="description">Open a raster stream using a file descriptor.</p> |
| | 6614 | <p class="code"> |
| | 6615 | <a href="#cups_raster_t">cups_raster_t</a> *cupsRasterOpen(<span class="reserved">int</span> fd, cups_mode_t mode);</p> |
| | 6616 | <h4 class="parameters">Parameters</h4> |
| | 6617 | <table class="list"><tbody> |
| | 6618 | <tr><th>fd</th> |
| | 6619 | <td class="description">File descriptor</td></tr> |
| | 6620 | <tr><th>mode</th> |
| | 6621 | <td class="description">Mode - <code>CUPS_RASTER_READ</code>, |
| | 6622 | <code>CUPS_RASTER_WRITE</code>, |
| | 6623 | <code>CUPS_RASTER_WRITE_COMPRESSED</code>, |
| | 6624 | or <code>CUPS_RASTER_WRITE_PWG</code></td></tr> |
| | 6625 | </tbody></table> |
| | 6626 | <h4 class="returnvalue">Return Value</h4> |
| | 6627 | <p class="description">New stream</p> |
| | 6628 | <h4 class="discussion">Discussion</h4> |
| | 6629 | <p class="discussion">This function associates a raster stream with the given file descriptor. |
| | 6630 | For most printer driver filters, "fd" will be 0 (stdin). For most raster |
| | 6631 | image processor (RIP) filters that generate raster data, "fd" will be 1 |
| | 6632 | (stdout).<br> |
| | 6633 | <br> |
| | 6634 | When writing raster data, the <code>CUPS_RASTER_WRITE</code>, |
| | 6635 | <code>CUPS_RASTER_WRITE_COMPRESS</code>, or <code>CUPS_RASTER_WRITE_PWG</code> mode can |
| | 6636 | be used - compressed and PWG output is generally 25-50% smaller but adds a |
| | 6637 | 100-300% execution time overhead.</p> |
| | 6638 | <h3 class="function"><a id="cupsRasterOpenIO">cupsRasterOpenIO</a></h3> |
| | 6639 | <p class="description">Open a raster stream using a callback function.</p> |
| | 6640 | <p class="code"> |
| | 6641 | <a href="#cups_raster_t">cups_raster_t</a> *cupsRasterOpenIO(<a href="#cups_raster_cb_t">cups_raster_cb_t</a> iocb, <span class="reserved">void</span> *ctx, <a href="#cups_raster_mode_t">cups_raster_mode_t</a> mode);</p> |
| | 6642 | <h4 class="parameters">Parameters</h4> |
| | 6643 | <table class="list"><tbody> |
| | 6644 | <tr><th>iocb</th> |
| | 6645 | <td class="description">Read/write callback</td></tr> |
| | 6646 | <tr><th>ctx</th> |
| | 6647 | <td class="description">Context pointer for callback</td></tr> |
| | 6648 | <tr><th>mode</th> |
| | 6649 | <td class="description">Mode - <code>CUPS_RASTER_READ</code>, |
| | 6650 | <code>CUPS_RASTER_WRITE</code>, |
| | 6651 | <code>CUPS_RASTER_WRITE_COMPRESSED</code>, |
| | 6652 | or <code>CUPS_RASTER_WRITE_PWG</code></td></tr> |
| | 6653 | </tbody></table> |
| | 6654 | <h4 class="returnvalue">Return Value</h4> |
| | 6655 | <p class="description">New stream</p> |
| | 6656 | <h4 class="discussion">Discussion</h4> |
| | 6657 | <p class="discussion">This function associates a raster stream with the given callback function and |
| | 6658 | context pointer.<br> |
| | 6659 | <br> |
| | 6660 | When writing raster data, the <code>CUPS_RASTER_WRITE</code>, |
| | 6661 | <code>CUPS_RASTER_WRITE_COMPRESS</code>, or <code>CUPS_RASTER_WRITE_PWG</code> mode can |
| | 6662 | be used - compressed and PWG output is generally 25-50% smaller but adds a |
| | 6663 | 100-300% execution time overhead.</p> |
| | 6664 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsRasterReadHeader">cupsRasterReadHeader</a></h3> |
| | 6665 | <p class="description">Read a raster page header and store it in a |
| | 6666 | version 1 page header structure.</p> |
| | 6667 | <p class="code"> |
| | 6668 | <span class="reserved">unsigned</span> cupsRasterReadHeader(<a href="#cups_raster_t">cups_raster_t</a> *r, <a href="#cups_page_header_t">cups_page_header_t</a> *h);</p> |
| | 6669 | <h4 class="parameters">Parameters</h4> |
| | 6670 | <table class="list"><tbody> |
| | 6671 | <tr><th>r</th> |
| | 6672 | <td class="description">Raster stream</td></tr> |
| | 6673 | <tr><th>h</th> |
| | 6674 | <td class="description">Pointer to header data</td></tr> |
| | 6675 | </tbody></table> |
| | 6676 | <h4 class="returnvalue">Return Value</h4> |
| | 6677 | <p class="description">1 on success, 0 on failure/end-of-file</p> |
| | 6678 | <h4 class="discussion">Discussion</h4> |
| | 6679 | <p class="discussion">This function is deprecated. Use <a href="#cupsRasterReadHeader2"><code>cupsRasterReadHeader2</code></a> instead.<br> |
| | 6680 | <br> |
| | 6681 | Version 1 page headers were used in CUPS 1.0 and 1.1 and contain a subset |
| | 6682 | of the version 2 page header data. This function handles reading version 2 |
| | 6683 | page headers and copying only the version 1 data into the provided buffer. |
| | 6684 | |
| | 6685 | </p> |
| | 6686 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsRasterReadHeader2">cupsRasterReadHeader2</a></h3> |
| | 6687 | <p class="description">Read a raster page header and store it in a |
| | 6688 | version 2 page header structure.</p> |
| | 6689 | <p class="code"> |
| | 6690 | <span class="reserved">unsigned</span> cupsRasterReadHeader2(<a href="#cups_raster_t">cups_raster_t</a> *r, <a href="#cups_page_header2_t">cups_page_header2_t</a> *h);</p> |
| | 6691 | <h4 class="parameters">Parameters</h4> |
| | 6692 | <table class="list"><tbody> |
| | 6693 | <tr><th>r</th> |
| | 6694 | <td class="description">Raster stream</td></tr> |
| | 6695 | <tr><th>h</th> |
| | 6696 | <td class="description">Pointer to header data</td></tr> |
| | 6697 | </tbody></table> |
| | 6698 | <h4 class="returnvalue">Return Value</h4> |
| | 6699 | <p class="description">1 on success, 0 on failure/end-of-file</p> |
| | 6700 | <h3 class="function"><a id="cupsRasterReadPixels">cupsRasterReadPixels</a></h3> |
| | 6701 | <p class="description">Read raster pixels.</p> |
| | 6702 | <p class="code"> |
| | 6703 | <span class="reserved">unsigned</span> cupsRasterReadPixels(<a href="#cups_raster_t">cups_raster_t</a> *r, <span class="reserved">unsigned</span> <span class="reserved">char</span> *p, <span class="reserved">unsigned</span> len);</p> |
| | 6704 | <h4 class="parameters">Parameters</h4> |
| | 6705 | <table class="list"><tbody> |
| | 6706 | <tr><th>r</th> |
| | 6707 | <td class="description">Raster stream</td></tr> |
| | 6708 | <tr><th>p</th> |
| | 6709 | <td class="description">Pointer to pixel buffer</td></tr> |
| | 6710 | <tr><th>len</th> |
| | 6711 | <td class="description">Number of bytes to read</td></tr> |
| | 6712 | </tbody></table> |
| | 6713 | <h4 class="returnvalue">Return Value</h4> |
| | 6714 | <p class="description">Number of bytes read</p> |
| | 6715 | <h4 class="discussion">Discussion</h4> |
| | 6716 | <p class="discussion">For best performance, filters should read one or more whole lines. |
| | 6717 | The "cupsBytesPerLine" value from the page header can be used to allocate |
| | 6718 | the line buffer and as the number of bytes to read.</p> |
| | 6719 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsRasterWriteHeader">cupsRasterWriteHeader</a></h3> |
| | 6720 | <p class="description">Write a raster page header from a version 1 page |
| | 6721 | header structure.</p> |
| | 6722 | <p class="code"> |
| | 6723 | <span class="reserved">unsigned</span> cupsRasterWriteHeader(<a href="#cups_raster_t">cups_raster_t</a> *r, <a href="#cups_page_header_t">cups_page_header_t</a> *h);</p> |
| | 6724 | <h4 class="parameters">Parameters</h4> |
| | 6725 | <table class="list"><tbody> |
| | 6726 | <tr><th>r</th> |
| | 6727 | <td class="description">Raster stream</td></tr> |
| | 6728 | <tr><th>h</th> |
| | 6729 | <td class="description">Raster page header</td></tr> |
| | 6730 | </tbody></table> |
| | 6731 | <h4 class="returnvalue">Return Value</h4> |
| | 6732 | <p class="description">1 on success, 0 on failure</p> |
| | 6733 | <h4 class="discussion">Discussion</h4> |
| | 6734 | <p class="discussion">This function is deprecated. Use <a href="#cupsRasterWriteHeader2"><code>cupsRasterWriteHeader2</code></a> instead. |
| | 6735 | |
| | 6736 | </p> |
| | 6737 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsRasterWriteHeader2">cupsRasterWriteHeader2</a></h3> |
| | 6738 | <p class="description">Write a raster page header from a version 2 |
| | 6739 | page header structure.</p> |
| | 6740 | <p class="code"> |
| | 6741 | <span class="reserved">unsigned</span> cupsRasterWriteHeader2(<a href="#cups_raster_t">cups_raster_t</a> *r, <a href="#cups_page_header2_t">cups_page_header2_t</a> *h);</p> |
| | 6742 | <h4 class="parameters">Parameters</h4> |
| | 6743 | <table class="list"><tbody> |
| | 6744 | <tr><th>r</th> |
| | 6745 | <td class="description">Raster stream</td></tr> |
| | 6746 | <tr><th>h</th> |
| | 6747 | <td class="description">Raster page header</td></tr> |
| | 6748 | </tbody></table> |
| | 6749 | <h4 class="returnvalue">Return Value</h4> |
| | 6750 | <p class="description">1 on success, 0 on failure</p> |
| | 6751 | <h4 class="discussion">Discussion</h4> |
| | 6752 | <p class="discussion">The page header can be initialized using <a href="#cupsRasterInitPWGHeader"><code>cupsRasterInitPWGHeader</code></a>. |
| | 6753 | |
| | 6754 | </p> |
| | 6755 | <h3 class="function"><a id="cupsRasterWritePixels">cupsRasterWritePixels</a></h3> |
| | 6756 | <p class="description">Write raster pixels.</p> |
| | 6757 | <p class="code"> |
| | 6758 | <span class="reserved">unsigned</span> cupsRasterWritePixels(<a href="#cups_raster_t">cups_raster_t</a> *r, <span class="reserved">unsigned</span> <span class="reserved">char</span> *p, <span class="reserved">unsigned</span> len);</p> |
| | 6759 | <h4 class="parameters">Parameters</h4> |
| | 6760 | <table class="list"><tbody> |
| | 6761 | <tr><th>r</th> |
| | 6762 | <td class="description">Raster stream</td></tr> |
| | 6763 | <tr><th>p</th> |
| | 6764 | <td class="description">Bytes to write</td></tr> |
| | 6765 | <tr><th>len</th> |
| | 6766 | <td class="description">Number of bytes to write</td></tr> |
| | 6767 | </tbody></table> |
| | 6768 | <h4 class="returnvalue">Return Value</h4> |
| | 6769 | <p class="description">Number of bytes written</p> |
| | 6770 | <h4 class="discussion">Discussion</h4> |
| | 6771 | <p class="discussion">For best performance, filters should write one or more whole lines. |
| | 6772 | The "cupsBytesPerLine" value from the page header can be used to allocate |
| | 6773 | the line buffer and as the number of bytes to write.</p> |
| | 6774 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="cupsReadResponseData">cupsReadResponseData</a></h3> |
| | 6775 | <p class="description">Read additional data after the IPP response.</p> |
| | 6776 | <p class="code"> |
| | 6777 | ssize_t cupsReadResponseData(<a href="#http_t">http_t</a> *http, <span class="reserved">char</span> *buffer, size_t length);</p> |
| | 6778 | <h4 class="parameters">Parameters</h4> |
| | 6779 | <table class="list"><tbody> |
| | 6780 | <tr><th>http</th> |
| | 6781 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 6782 | <tr><th>buffer</th> |
| | 6783 | <td class="description">Buffer to use</td></tr> |
| | 6784 | <tr><th>length</th> |
| | 6785 | <td class="description">Number of bytes to read</td></tr> |
| | 6786 | </tbody></table> |
| | 6787 | <h4 class="returnvalue">Return Value</h4> |
| | 6788 | <p class="description">Bytes read, 0 on EOF, -1 on error</p> |
| | 6789 | <h4 class="discussion">Discussion</h4> |
| | 6790 | <p class="discussion">This function is used after <a href="#cupsGetResponse"><code>cupsGetResponse</code></a> to read the PPD or document |
| | 6791 | files from <code>CUPS_GET_PPD</code> and <code>CUPS_GET_DOCUMENT</code> requests, |
| | 6792 | respectively. |
| | 6793 | |
| | 6794 | </p> |
| | 6795 | <h3 class="function"><span class="info"> CUPS 1.3 </span><a id="cupsRemoveDest">cupsRemoveDest</a></h3> |
| | 6796 | <p class="description">Remove a destination from the destination list.</p> |
| | 6797 | <p class="code"> |
| | 6798 | <span class="reserved">int</span> cupsRemoveDest(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *instance, <span class="reserved">int</span> num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
| | 6799 | <h4 class="parameters">Parameters</h4> |
| | 6800 | <table class="list"><tbody> |
| | 6801 | <tr><th>name</th> |
| | 6802 | <td class="description">Destination name</td></tr> |
| | 6803 | <tr><th>instance</th> |
| | 6804 | <td class="description">Instance name or <code>NULL</code></td></tr> |
| | 6805 | <tr><th>num_dests</th> |
| | 6806 | <td class="description">Number of destinations</td></tr> |
| | 6807 | <tr><th>dests</th> |
| | 6808 | <td class="description">Destinations</td></tr> |
| | 6809 | </tbody></table> |
| | 6810 | <h4 class="returnvalue">Return Value</h4> |
| | 6811 | <p class="description">New number of destinations</p> |
| | 6812 | <h4 class="discussion">Discussion</h4> |
| | 6813 | <p class="discussion">Removing a destination/instance does not delete the class or printer |
| | 6814 | queue, merely the lpoptions for that destination/instance. Use the |
| | 6815 | <a href="#cupsSetDests"><code>cupsSetDests</code></a> or <a href="#cupsSetDests2"><code>cupsSetDests2</code></a> functions to save the new |
| | 6816 | options for the user. |
| | 6817 | |
| | 6818 | </p> |
| | 6819 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="cupsRemoveOption">cupsRemoveOption</a></h3> |
| | 6820 | <p class="description">Remove an option from an option array.</p> |
| | 6821 | <p class="code"> |
| | 6822 | <span class="reserved">int</span> cupsRemoveOption(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
| | 6823 | <h4 class="parameters">Parameters</h4> |
| | 6824 | <table class="list"><tbody> |
| | 6825 | <tr><th>name</th> |
| | 6826 | <td class="description">Option name</td></tr> |
| | 6827 | <tr><th>num_options</th> |
| | 6828 | <td class="description">Current number of options</td></tr> |
| | 6829 | <tr><th>options</th> |
| | 6830 | <td class="description">Options</td></tr> |
| | 6831 | </tbody></table> |
| | 6832 | <h4 class="returnvalue">Return Value</h4> |
| | 6833 | <p class="description">New number of options</p> |
| | 6834 | <h3 class="function"><a id="cupsSaveCredentials">cupsSaveCredentials</a></h3> |
| | 6835 | <p class="description">Save the credentials associated with a printer/server.</p> |
| | 6836 | <p class="code"> |
| | 6837 | <span class="reserved">bool</span> cupsSaveCredentials(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">const</span> <span class="reserved">char</span> *common_name, <span class="reserved">const</span> <span class="reserved">char</span> *credentials, <span class="reserved">const</span> <span class="reserved">char</span> *key);</p> |
| | 6838 | <h4 class="parameters">Parameters</h4> |
| | 6839 | <table class="list"><tbody> |
| | 6840 | <tr><th>path</th> |
| | 6841 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 6842 | <tr><th>common_name</th> |
| | 6843 | <td class="description">Common name for certificate</td></tr> |
| | 6844 | <tr><th>credentials</th> |
| | 6845 | <td class="description">PEM-encoded certificate chain or <code>NULL</code> to remove</td></tr> |
| | 6846 | <tr><th>key</th> |
| | 6847 | <td class="description">PEM-encoded private key or <code>NULL</code> for none</td></tr> |
| | 6848 | </tbody></table> |
| | 6849 | <h4 class="returnvalue">Return Value</h4> |
| | 6850 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 6851 | <h4 class="discussion">Discussion</h4> |
| | 6852 | <p class="discussion">This function saves the the PEM-encoded X.509 certificate chain string and |
| | 6853 | private key (if not <code>NULL</code>) to the directory "path" or, if "path" is <code>NULL</code>, |
| | 6854 | in a per-user or system-wide (when running as root) certificate/key store.</p> |
| | 6855 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="cupsSendRequest">cupsSendRequest</a></h3> |
| | 6856 | <p class="description">Send an IPP request.</p> |
| | 6857 | <p class="code"> |
| | 6858 | http_status_t cupsSendRequest(<a href="#http_t">http_t</a> *http, <a href="#ipp_t">ipp_t</a> *request, <span class="reserved">const</span> <span class="reserved">char</span> *resource, size_t length);</p> |
| | 6859 | <h4 class="parameters">Parameters</h4> |
| | 6860 | <table class="list"><tbody> |
| | 6861 | <tr><th>http</th> |
| | 6862 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 6863 | <tr><th>request</th> |
| | 6864 | <td class="description">IPP request</td></tr> |
| | 6865 | <tr><th>resource</th> |
| | 6866 | <td class="description">Resource path</td></tr> |
| | 6867 | <tr><th>length</th> |
| | 6868 | <td class="description">Length of data to follow or <code>CUPS_LENGTH_VARIABLE</code></td></tr> |
| | 6869 | </tbody></table> |
| | 6870 | <h4 class="returnvalue">Return Value</h4> |
| | 6871 | <p class="description">Initial HTTP status</p> |
| | 6872 | <h4 class="discussion">Discussion</h4> |
| | 6873 | <p class="discussion">Use <a href="#cupsWriteRequestData"><code>cupsWriteRequestData</code></a> to write any additional data (document, PPD |
| | 6874 | file, etc.) for the request, <a href="#cupsGetResponse"><code>cupsGetResponse</code></a> to get the IPP response, |
| | 6875 | and <a href="#cupsReadResponseData"><code>cupsReadResponseData</code></a> to read any additional data following the |
| | 6876 | response. Only one request can be sent/queued at a time per <code>http_t</code> |
| | 6877 | connection.<br> |
| | 6878 | <br> |
| | 6879 | Returns the initial HTTP status code, which will be <code>HTTP_STATUS_CONTINUE</code> |
| | 6880 | on a successful send of the request.<br> |
| | 6881 | <br> |
| | 6882 | Note: Unlike <a href="#cupsDoFileRequest"><code>cupsDoFileRequest</code></a>, <a href="#cupsDoIORequest"><code>cupsDoIORequest</code></a>, and |
| | 6883 | <a href="#cupsDoRequest"><code>cupsDoRequest</code></a>, the request is NOT freed with <a href="#ippDelete"><code>ippDelete</code></a>. |
| | 6884 | |
| | 6885 | </p> |
| | 6886 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsServer">cupsServer</a></h3> |
| | 6887 | <p class="description">Return the hostname/address of the current server.</p> |
| | 6888 | <p class="code"> |
| | 6889 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsServer(<span class="reserved">void</span>);</p> |
| | 6890 | <h4 class="returnvalue">Return Value</h4> |
| | 6891 | <p class="description">Server name</p> |
| | 6892 | <h4 class="discussion">Discussion</h4> |
| | 6893 | <p class="discussion">The default server comes from the CUPS_SERVER environment variable, then the |
| | 6894 | ~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not |
| | 6895 | set, the default is the local system - either "localhost" or a domain socket |
| | 6896 | path.<br> |
| | 6897 | <br> |
| | 6898 | The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6 |
| | 6899 | address, or a domain socket pathname.<br> |
| | 6900 | <br> |
| | 6901 | Note: The current server is tracked separately for each thread in a program. |
| | 6902 | Multi-threaded programs that override the server via the |
| | 6903 | <a href="#cupsSetServer"><code>cupsSetServer</code></a> function need to do so in each thread for the same |
| | 6904 | server to be used. |
| | 6905 | |
| | 6906 | </p> |
| | 6907 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsSetClientCertCB">cupsSetClientCertCB</a></h3> |
| | 6908 | <p class="description">Set the client certificate callback.</p> |
| | 6909 | <p class="code"> |
| | 6910 | <span class="reserved">void</span> cupsSetClientCertCB(<a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a> cb, <span class="reserved">void</span> *user_data);</p> |
| | 6911 | <h4 class="parameters">Parameters</h4> |
| | 6912 | <table class="list"><tbody> |
| | 6913 | <tr><th>cb</th> |
| | 6914 | <td class="description">Callback function</td></tr> |
| | 6915 | <tr><th>user_data</th> |
| | 6916 | <td class="description">User data pointer</td></tr> |
| | 6917 | </tbody></table> |
| | 6918 | <h4 class="discussion">Discussion</h4> |
| | 6919 | <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> |
| | 6920 | <br> |
| | 6921 | Note: The current certificate callback is tracked separately for each thread |
| | 6922 | in a program. Multi-threaded programs that override the callback need to do |
| | 6923 | so in each thread for the same callback to be used. |
| | 6924 | |
| | 6925 | </p> |
| | 6926 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="cupsSetClientCredentials">cupsSetClientCredentials</a></h3> |
| | 6927 | <p class="description">Set the default credentials to be used for TLS connections.</p> |
| | 6928 | <p class="code"> |
| | 6929 | <span class="reserved">bool</span> cupsSetClientCredentials(<span class="reserved">const</span> <span class="reserved">char</span> *credentials, <span class="reserved">const</span> <span class="reserved">char</span> *key);</p> |
| | 6930 | <h4 class="parameters">Parameters</h4> |
| | 6931 | <table class="list"><tbody> |
| | 6932 | <tr><th>credentials</th> |
| | 6933 | <td class="description">PEM-encoded X.509 credentials string</td></tr> |
| | 6934 | <tr><th>key</th> |
| | 6935 | <td class="description">PEM-encoded private key</td></tr> |
| | 6936 | </tbody></table> |
| | 6937 | <h4 class="returnvalue">Return Value</h4> |
| | 6938 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 6939 | <h4 class="discussion">Discussion</h4> |
| | 6940 | <p class="discussion">Note: The default credentials are tracked separately for each thread in a |
| | 6941 | program. Multi-threaded programs that override the setting need to do so in |
| | 6942 | each thread for the same setting to be used. |
| | 6943 | |
| | 6944 | </p> |
| | 6945 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsSetCredentials">cupsSetCredentials</a></h3> |
| | 6946 | <p class="description">Set the default credentials to be used for SSL/TLS |
| | 6947 | connections.</p> |
| | 6948 | <p class="code"> |
| | 6949 | <span class="reserved">int</span> cupsSetCredentials(<a href="#cups_array_t">cups_array_t</a> *credentials);</p> |
| | 6950 | <h4 class="parameters">Parameters</h4> |
| | 6951 | <table class="list"><tbody> |
| | 6952 | <tr><th>credentials</th> |
| | 6953 | <td class="description">Array of credentials</td></tr> |
| | 6954 | </tbody></table> |
| | 6955 | <h4 class="returnvalue">Return Value</h4> |
| | 6956 | <p class="description">Status of call (0 = success)</p> |
| | 6957 | <h3 class="function"><span class="info"> CUPS 1.3 </span><a id="cupsSetDefaultDest">cupsSetDefaultDest</a></h3> |
| | 6958 | <p class="description">Set the default destination.</p> |
| | 6959 | <p class="code"> |
| | 6960 | <span class="reserved">void</span> cupsSetDefaultDest(<span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *instance, <span class="reserved">int</span> num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
| | 6961 | <h4 class="parameters">Parameters</h4> |
| | 6962 | <table class="list"><tbody> |
| | 6963 | <tr><th>name</th> |
| | 6964 | <td class="description">Destination name</td></tr> |
| | 6965 | <tr><th>instance</th> |
| | 6966 | <td class="description">Instance name or <code>NULL</code></td></tr> |
| | 6967 | <tr><th>num_dests</th> |
| | 6968 | <td class="description">Number of destinations</td></tr> |
| | 6969 | <tr><th>dests</th> |
| | 6970 | <td class="description">Destinations</td></tr> |
| | 6971 | </tbody></table> |
| | 6972 | <h3 class="function"><span class="info"> CUPS 1.1.21 </span><a id="cupsSetDests2">cupsSetDests2</a></h3> |
| | 6973 | <p class="description">Save the list of destinations for the specified server.</p> |
| | 6974 | <p class="code"> |
| | 6975 | <span class="reserved">int</span> cupsSetDests2(<a href="#http_t">http_t</a> *http, <span class="reserved">int</span> num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
| | 6976 | <h4 class="parameters">Parameters</h4> |
| | 6977 | <table class="list"><tbody> |
| | 6978 | <tr><th>http</th> |
| | 6979 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 6980 | <tr><th>num_dests</th> |
| | 6981 | <td class="description">Number of destinations</td></tr> |
| | 6982 | <tr><th>dests</th> |
| | 6983 | <td class="description">Destinations</td></tr> |
| | 6984 | </tbody></table> |
| | 6985 | <h4 class="returnvalue">Return Value</h4> |
| | 6986 | <p class="description">0 on success, -1 on error</p> |
| | 6987 | <h4 class="discussion">Discussion</h4> |
| | 6988 | <p class="discussion">This function saves the destinations to /etc/cups/lpoptions when run |
| | 6989 | as root and ~/.cups/lpoptions when run as a normal user. |
| | 6990 | |
| | 6991 | </p> |
| | 6992 | <h3 class="function"><a id="cupsSetEncryption">cupsSetEncryption</a></h3> |
| | 6993 | <p class="description">Set the encryption preference.</p> |
| | 6994 | <p class="code"> |
| | 6995 | <span class="reserved">void</span> cupsSetEncryption(<a href="#http_encryption_t">http_encryption_t</a> e);</p> |
| | 6996 | <h4 class="parameters">Parameters</h4> |
| | 6997 | <table class="list"><tbody> |
| | 6998 | <tr><th>e</th> |
| | 6999 | <td class="description">New encryption preference</td></tr> |
| | 7000 | </tbody></table> |
| | 7001 | <h4 class="discussion">Discussion</h4> |
| | 7002 | <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION |
| | 7003 | environment variable, then the ~/.cups/client.conf file, and finally the |
| | 7004 | /etc/cups/client.conf file. If not set, the default is |
| | 7005 | <code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> |
| | 7006 | <br> |
| | 7007 | Note: The current encryption setting is tracked separately for each thread |
| | 7008 | in a program. Multi-threaded programs that override the setting need to do |
| | 7009 | so in each thread for the same setting to be used.</p> |
| | 7010 | <h3 class="function"><span class="info"> CUPS 2.4 </span><a id="cupsSetOAuthCB">cupsSetOAuthCB</a></h3> |
| | 7011 | <p class="description">Set the OAuth 2.0 callback for CUPS.</p> |
| | 7012 | <p class="code"> |
| | 7013 | <span class="reserved">void</span> cupsSetOAuthCB(<a href="#cups_oauth_cb_t">cups_oauth_cb_t</a> cb, <span class="reserved">void</span> *user_data);</p> |
| | 7014 | <h4 class="parameters">Parameters</h4> |
| | 7015 | <table class="list"><tbody> |
| | 7016 | <tr><th>cb</th> |
| | 7017 | <td class="description">Callback function</td></tr> |
| | 7018 | <tr><th>user_data</th> |
| | 7019 | <td class="description">User data pointer</td></tr> |
| | 7020 | </tbody></table> |
| | 7021 | <h4 class="discussion">Discussion</h4> |
| | 7022 | <p class="discussion">This function sets the OAuth 2.0 callback for the various CUPS APIs that |
| | 7023 | send HTTP requests. Pass <code>NULL</code> to restore the default (console-based) |
| | 7024 | callback.<br> |
| | 7025 | <br> |
| | 7026 | The OAuth callback receives the HTTP connection, realm name, scope name (if |
| | 7027 | any), resource path, and the "user_data" pointer for each request that |
| | 7028 | requires an OAuth access token. The function then returns either the Bearer |
| | 7029 | token string or <code>NULL</code> if no authorization could be obtained.<br> |
| | 7030 | <br> |
| | 7031 | Beyond reusing the Bearer token for subsequent requests on the same HTTP |
| | 7032 | connection, no caching of the token is done by the CUPS library. The |
| | 7033 | callback can determine whether to refresh a cached token by examining any |
| | 7034 | existing token returned by the <a href="#httpGetAuthString"><code>httpGetAuthString</code></a> function.<br> |
| | 7035 | <br> |
| | 7036 | Note: The current OAuth callback is tracked separately for each thread in a |
| | 7037 | program. Multi-threaded programs that override the callback need to do so in |
| | 7038 | each thread for the same callback to be used. |
| | 7039 | |
| | 7040 | </p> |
| | 7041 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="cupsSetPasswordCB2">cupsSetPasswordCB2</a></h3> |
| | 7042 | <p class="description">Set the advanced password callback for CUPS.</p> |
| | 7043 | <p class="code"> |
| | 7044 | <span class="reserved">void</span> cupsSetPasswordCB2(<a href="#cups_password_cb2_t">cups_password_cb2_t</a> cb, <span class="reserved">void</span> *user_data);</p> |
| | 7045 | <h4 class="parameters">Parameters</h4> |
| | 7046 | <table class="list"><tbody> |
| | 7047 | <tr><th>cb</th> |
| | 7048 | <td class="description">Callback function</td></tr> |
| | 7049 | <tr><th>user_data</th> |
| | 7050 | <td class="description">User data pointer</td></tr> |
| | 7051 | </tbody></table> |
| | 7052 | <h4 class="discussion">Discussion</h4> |
| | 7053 | <p class="discussion">Pass <code>NULL</code> to restore the default (console) password callback, which |
| | 7054 | reads the password from the console. Programs should call either this |
| | 7055 | function or <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a>, as only one callback can be registered |
| | 7056 | by a program per thread.<br> |
| | 7057 | <br> |
| | 7058 | Note: The current password callback is tracked separately for each thread |
| | 7059 | in a program. Multi-threaded programs that override the callback need to do |
| | 7060 | so in each thread for the same callback to be used. |
| | 7061 | |
| | 7062 | </p> |
| | 7063 | <h3 class="function"><a id="cupsSetServer">cupsSetServer</a></h3> |
| | 7064 | <p class="description">Set the default server name and port.</p> |
| | 7065 | <p class="code"> |
| | 7066 | <span class="reserved">void</span> cupsSetServer(<span class="reserved">const</span> <span class="reserved">char</span> *server);</p> |
| | 7067 | <h4 class="parameters">Parameters</h4> |
| | 7068 | <table class="list"><tbody> |
| | 7069 | <tr><th>server</th> |
| | 7070 | <td class="description">Server name</td></tr> |
| | 7071 | </tbody></table> |
| | 7072 | <h4 class="discussion">Discussion</h4> |
| | 7073 | <p class="discussion">The "server" string can be a fully-qualified hostname, a numeric |
| | 7074 | IPv4 or IPv6 address, or a domain socket pathname. Hostnames and numeric IP |
| | 7075 | addresses can be optionally followed by a colon and port number to override |
| | 7076 | the default port 631, e.g. "hostname:8631". Pass <code>NULL</code> to restore the |
| | 7077 | default server name and port.<br> |
| | 7078 | <br> |
| | 7079 | Note: The current server is tracked separately for each thread in a program. |
| | 7080 | Multi-threaded programs that override the server need to do so in each |
| | 7081 | thread for the same server to be used.</p> |
| | 7082 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsSetServerCertCB">cupsSetServerCertCB</a></h3> |
| | 7083 | <p class="description">Set the server certificate callback.</p> |
| | 7084 | <p class="code"> |
| | 7085 | <span class="reserved">void</span> cupsSetServerCertCB(<a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a> cb, <span class="reserved">void</span> *user_data);</p> |
| | 7086 | <h4 class="parameters">Parameters</h4> |
| | 7087 | <table class="list"><tbody> |
| | 7088 | <tr><th>cb</th> |
| | 7089 | <td class="description">Callback function</td></tr> |
| | 7090 | <tr><th>user_data</th> |
| | 7091 | <td class="description">User data pointer</td></tr> |
| | 7092 | </tbody></table> |
| | 7093 | <h4 class="discussion">Discussion</h4> |
| | 7094 | <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> |
| | 7095 | <br> |
| | 7096 | Note: The current credentials callback is tracked separately for each thread |
| | 7097 | in a program. Multi-threaded programs that override the callback need to do |
| | 7098 | so in each thread for the same callback to be used. |
| | 7099 | |
| | 7100 | </p> |
| | 7101 | <h3 class="function"><a id="cupsSetServerCredentials">cupsSetServerCredentials</a></h3> |
| | 7102 | <p class="description">Set the default server credentials.</p> |
| | 7103 | <p class="code"> |
| | 7104 | <span class="reserved">int</span> cupsSetServerCredentials(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">const</span> <span class="reserved">char</span> *common_name, <span class="reserved">int</span> auto_create);</p> |
| | 7105 | <h4 class="parameters">Parameters</h4> |
| | 7106 | <table class="list"><tbody> |
| | 7107 | <tr><th>path</th> |
| | 7108 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 7109 | <tr><th>common_name</th> |
| | 7110 | <td class="description">Default common name for server</td></tr> |
| | 7111 | <tr><th>auto_create</th> |
| | 7112 | <td class="description"><code>true</code> = automatically create self-signed certificates</td></tr> |
| | 7113 | </tbody></table> |
| | 7114 | <h4 class="returnvalue">Return Value</h4> |
| | 7115 | <p class="description"><code>1</code> on success, <code>0</code> on failure</p> |
| | 7116 | <h4 class="discussion">Discussion</h4> |
| | 7117 | <p class="discussion">Note: The server credentials are used by all threads in the running process. |
| | 7118 | This function is threadsafe.</p> |
| | 7119 | <h3 class="function"><a id="cupsSetUser">cupsSetUser</a></h3> |
| | 7120 | <p class="description">Set the default user name.</p> |
| | 7121 | <p class="code"> |
| | 7122 | <span class="reserved">void</span> cupsSetUser(<span class="reserved">const</span> <span class="reserved">char</span> *user);</p> |
| | 7123 | <h4 class="parameters">Parameters</h4> |
| | 7124 | <table class="list"><tbody> |
| | 7125 | <tr><th>user</th> |
| | 7126 | <td class="description">User name</td></tr> |
| | 7127 | </tbody></table> |
| | 7128 | <h4 class="discussion">Discussion</h4> |
| | 7129 | <p class="discussion">Pass <code>NULL</code> to restore the default user name.<br> |
| | 7130 | <br> |
| | 7131 | Note: The current user name is tracked separately for each thread in a |
| | 7132 | program. Multi-threaded programs that override the user name need to do so |
| | 7133 | in each thread for the same user name to be used.</p> |
| | 7134 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="cupsSetUserAgent">cupsSetUserAgent</a></h3> |
| | 7135 | <p class="description">Set the default HTTP User-Agent string.</p> |
| | 7136 | <p class="code"> |
| | 7137 | <span class="reserved">void</span> cupsSetUserAgent(<span class="reserved">const</span> <span class="reserved">char</span> *user_agent);</p> |
| | 7138 | <h4 class="parameters">Parameters</h4> |
| | 7139 | <table class="list"><tbody> |
| | 7140 | <tr><th>user_agent</th> |
| | 7141 | <td class="description">User-Agent string or <code>NULL</code></td></tr> |
| | 7142 | </tbody></table> |
| | 7143 | <h4 class="discussion">Discussion</h4> |
| | 7144 | <p class="discussion">Setting the string to NULL forces the default value containing the CUPS |
| | 7145 | version, IPP version, and operating system version and architecture. |
| | 7146 | |
| | 7147 | </p> |
| | 7148 | <h3 class="function"><a id="cupsSignCredentialsRequest">cupsSignCredentialsRequest</a></h3> |
| | 7149 | <p class="description">Sign an X.509 certificate signing request to produce an X.509 certificate chain.</p> |
| | 7150 | <p class="code"> |
| | 7151 | <span class="reserved">bool</span> cupsSignCredentialsRequest(<span class="reserved">const</span> <span class="reserved">char</span> *path, <span class="reserved">const</span> <span class="reserved">char</span> *common_name, <span class="reserved">const</span> <span class="reserved">char</span> *request, <span class="reserved">const</span> <span class="reserved">char</span> *root_name, <a href="#cups_credpurpose_t">cups_credpurpose_t</a> allowed_purpose, <a href="#cups_credusage_t">cups_credusage_t</a> allowed_usage, <a href="#cups_cert_san_cb_t">cups_cert_san_cb_t</a> cb, <span class="reserved">void</span> *cb_data, time_t expiration_date);</p> |
| | 7152 | <h4 class="parameters">Parameters</h4> |
| | 7153 | <table class="list"><tbody> |
| | 7154 | <tr><th>path</th> |
| | 7155 | <td class="description">Directory path for certificate/key store or <code>NULL</code> for default</td></tr> |
| | 7156 | <tr><th>common_name</th> |
| | 7157 | <td class="description">Common name to use</td></tr> |
| | 7158 | <tr><th>request</th> |
| | 7159 | <td class="description">PEM-encoded CSR</td></tr> |
| | 7160 | <tr><th>root_name</th> |
| | 7161 | <td class="description">Root certificate</td></tr> |
| | 7162 | <tr><th>allowed_purpose</th> |
| | 7163 | <td class="description">Allowed credential purpose(s)</td></tr> |
| | 7164 | <tr><th>allowed_usage</th> |
| | 7165 | <td class="description">Allowed credential usage(s)</td></tr> |
| | 7166 | <tr><th>cb</th> |
| | 7167 | <td class="description">subjectAltName callback or <code>NULL</code> to allow just .local</td></tr> |
| | 7168 | <tr><th>cb_data</th> |
| | 7169 | <td class="description">Callback data</td></tr> |
| | 7170 | <tr><th>expiration_date</th> |
| | 7171 | <td class="description">Certificate expiration date</td></tr> |
| | 7172 | </tbody></table> |
| | 7173 | <h4 class="returnvalue">Return Value</h4> |
| | 7174 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 7175 | <h4 class="discussion">Discussion</h4> |
| | 7176 | <p class="discussion">This function creates an X.509 certificate from a signing request. The |
| | 7177 | certificate is stored in the directory "path" or, if "path" is <code>NULL</code>, in a |
| | 7178 | per-user or system-wide (when running as root) certificate/key store. The |
| | 7179 | generated certificate is signed by the named root certificate or, if |
| | 7180 | "root_name" is <code>NULL</code>, a site-wide default root certificate. When |
| | 7181 | "root_name" is <code>NULL</code> and there is no site-wide default root certificate, a |
| | 7182 | self-signed certificate is generated instead.<br> |
| | 7183 | <br> |
| | 7184 | The "allowed_purpose" argument specifies the allowed purpose(s) used for the |
| | 7185 | credentials as a bitwise OR of the following constants: |
| | 7186 | |
| | 7187 | </p><ul> |
| | 7188 | <li><code>CUPS_CREDPURPOSE_SERVER_AUTH</code> for validating TLS servers, |
| | 7189 | </li> |
| | 7190 | <li><code>CUPS_CREDPURPOSE_CLIENT_AUTH</code> for validating TLS clients, |
| | 7191 | </li> |
| | 7192 | <li><code>CUPS_CREDPURPOSE_CODE_SIGNING</code> for validating compiled code, |
| | 7193 | </li> |
| | 7194 | <li><code>CUPS_CREDPURPOSE_EMAIL_PROTECTION</code> for validating email messages, |
| | 7195 | </li> |
| | 7196 | <li><code>CUPS_CREDPURPOSE_TIME_STAMPING</code> for signing timestamps to objects, and/or |
| | 7197 | </li> |
| | 7198 | <li><code>CUPS_CREDPURPOSE_OCSP_SIGNING</code> for Online Certificate Status Protocol |
| | 7199 | message signing.</li> |
| | 7200 | </ul> |
| | 7201 | <p class="discussion">The "allowed_usage" argument specifies the allowed usage(s) for the |
| | 7202 | credentials as a bitwise OR of the following constants: |
| | 7203 | |
| | 7204 | </p><ul> |
| | 7205 | <li><code>CUPS_CREDUSAGE_DIGITAL_SIGNATURE</code>: digital signatures, |
| | 7206 | </li> |
| | 7207 | <li><code>CUPS_CREDUSAGE_NON_REPUDIATION</code>: non-repudiation/content commitment, |
| | 7208 | </li> |
| | 7209 | <li><code>CUPS_CREDUSAGE_KEY_ENCIPHERMENT</code>: key encipherment, |
| | 7210 | </li> |
| | 7211 | <li><code>CUPS_CREDUSAGE_DATA_ENCIPHERMENT</code>: data encipherment, |
| | 7212 | </li> |
| | 7213 | <li><code>CUPS_CREDUSAGE_KEY_AGREEMENT</code>: key agreement, |
| | 7214 | </li> |
| | 7215 | <li><code>CUPS_CREDUSAGE_KEY_CERT_SIGN</code>: key certicate signing, |
| | 7216 | </li> |
| | 7217 | <li><code>CUPS_CREDUSAGE_CRL_SIGN</code>: certificate revocation list signing, |
| | 7218 | </li> |
| | 7219 | <li><code>CUPS_CREDUSAGE_ENCIPHER_ONLY</code>: encipherment only, |
| | 7220 | </li> |
| | 7221 | <li><code>CUPS_CREDUSAGE_DECIPHER_ONLY</code>: decipherment only, |
| | 7222 | </li> |
| | 7223 | <li><code>CUPS_CREDUSAGE_DEFAULT_CA</code>: defaults for CA certificates, |
| | 7224 | </li> |
| | 7225 | <li><code>CUPS_CREDUSAGE_DEFAULT_TLS</code>: defaults for TLS certificates, and/or |
| | 7226 | </li> |
| | 7227 | <li><code>CUPS_CREDUSAGE_ALL</code>: all usages.</li> |
| | 7228 | </ul> |
| | 7229 | <p class="discussion">The "cb" and "cb_data" arguments specify a function and its data that are |
| | 7230 | used to validate any subjectAltName values in the signing request: |
| | 7231 | |
| | 7232 | <pre> |
| | 7233 | bool san_cb(const char *common_name, const char *alt_name, void *cb_data) { |
| | 7234 | ... return true if OK and false if not ... |
| | 7235 | } |
| | 7236 | </pre> |
| | 7237 | |
| | 7238 | If <code>NULL</code>, a default validation function is used that allows "localhost" and |
| | 7239 | variations of the common name.<br> |
| | 7240 | <br> |
| | 7241 | The "expiration_date" argument specifies the expiration date and time as a |
| | 7242 | Unix <code>time_t</code> value in seconds.</p> |
| | 7243 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="cupsStartDestDocument">cupsStartDestDocument</a></h3> |
| | 7244 | <p class="description">Start a new document.</p> |
| | 7245 | <p class="code"> |
| | 7246 | 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, <span class="reserved">int</span> job_id, <span class="reserved">const</span> <span class="reserved">char</span> *docname, <span class="reserved">const</span> <span class="reserved">char</span> *format, <span class="reserved">int</span> num_options, <a href="#cups_option_t">cups_option_t</a> *options, <span class="reserved">int</span> last_document);</p> |
| | 7247 | <h4 class="parameters">Parameters</h4> |
| | 7248 | <table class="list"><tbody> |
| | 7249 | <tr><th>http</th> |
| | 7250 | <td class="description">Connection to destination</td></tr> |
| | 7251 | <tr><th>dest</th> |
| | 7252 | <td class="description">Destination</td></tr> |
| | 7253 | <tr><th>info</th> |
| | 7254 | <td class="description">Destination information</td></tr> |
| | 7255 | <tr><th>job_id</th> |
| | 7256 | <td class="description">Job ID</td></tr> |
| | 7257 | <tr><th>docname</th> |
| | 7258 | <td class="description">Document name</td></tr> |
| | 7259 | <tr><th>format</th> |
| | 7260 | <td class="description">Document format</td></tr> |
| | 7261 | <tr><th>num_options</th> |
| | 7262 | <td class="description">Number of document options</td></tr> |
| | 7263 | <tr><th>options</th> |
| | 7264 | <td class="description">Document options</td></tr> |
| | 7265 | <tr><th>last_document</th> |
| | 7266 | <td class="description">1 if this is the last document</td></tr> |
| | 7267 | </tbody></table> |
| | 7268 | <h4 class="returnvalue">Return Value</h4> |
| | 7269 | <p class="description">Status of document creation</p> |
| | 7270 | <h4 class="discussion">Discussion</h4> |
| | 7271 | <p class="discussion">"job_id" is the job ID returned by cupsCreateDestJob. "docname" is the name |
| | 7272 | of the document/file being printed, "format" is the MIME media type for the |
| | 7273 | document (see CUPS_FORMAT_xxx constants), and "num_options" and "options" |
| | 7274 | are the options do be applied to the document. "last_document" should be 1 |
| | 7275 | if this is the last document to be submitted in the job. Returns |
| | 7276 | <code>HTTP_CONTINUE</code> on success. |
| | 7277 | |
| | 7278 | </p> |
| | 7279 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsTempFd">cupsTempFd</a></h3> |
| | 7280 | <p class="description">Create a temporary file descriptor.</p> |
| | 7281 | <p class="code"> |
| | 7282 | <span class="reserved">int</span> cupsTempFd(<span class="reserved">char</span> *filename, <span class="reserved">int</span> len);</p> |
| | 7283 | <h4 class="parameters">Parameters</h4> |
| | 7284 | <table class="list"><tbody> |
| | 7285 | <tr><th>filename</th> |
| | 7286 | <td class="description">Pointer to buffer</td></tr> |
| | 7287 | <tr><th>len</th> |
| | 7288 | <td class="description">Size of buffer</td></tr> |
| | 7289 | </tbody></table> |
| | 7290 | <h4 class="returnvalue">Return Value</h4> |
| | 7291 | <p class="description">New file descriptor or -1 on error</p> |
| | 7292 | <h4 class="discussion">Discussion</h4> |
| | 7293 | <p class="discussion">This function creates a temporary file descriptor and places the filename in |
| | 7294 | the "filename" buffer. The temporary file descriptor is opened for reading |
| | 7295 | and writing.<br> |
| | 7296 | <br> |
| | 7297 | </p><blockquote> |
| | 7298 | Note: This function is deprecated. Use the <a href="#cupsCreateTempFd"><code>cupsCreateTempFd</code></a> |
| | 7299 | function instead.</blockquote> |
| | 7300 | |
| | 7301 | </p> |
| | 7302 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsTempFile">cupsTempFile</a></h3> |
| | 7303 | <p class="description">Generate a temporary filename (deprecated).</p> |
| | 7304 | <p class="code"> |
| | 7305 | <span class="reserved">char</span> *cupsTempFile(<span class="reserved">char</span> *filename, <span class="reserved">int</span> len);</p> |
| | 7306 | <h4 class="parameters">Parameters</h4> |
| | 7307 | <table class="list"><tbody> |
| | 7308 | <tr><th>filename</th> |
| | 7309 | <td class="description">Pointer to buffer */</td></tr> |
| | 7310 | <tr><th>len</th> |
| | 7311 | <td class="description">Size of buffer</td></tr> |
| | 7312 | </tbody></table> |
| | 7313 | <h4 class="returnvalue">Return Value</h4> |
| | 7314 | <p class="description"><code>NULL</code> (error)</p> |
| | 7315 | <h4 class="discussion">Discussion</h4> |
| | 7316 | <p class="discussion">This function is deprecated and no longer generates a temporary filename. |
| | 7317 | Use <a href="#cupsCreateTempFd"><code>cupsCreateTempFd</code></a> or <a href="#cupsCreateTempFile2"><code>cupsCreateTempFile2</code></a> instead. |
| | 7318 | |
| | 7319 | </p> |
| | 7320 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsTempFile2">cupsTempFile2</a></h3> |
| | 7321 | <p class="description">Creates a temporary CUPS file.</p> |
| | 7322 | <p class="code"> |
| | 7323 | <a href="#cups_file_t">cups_file_t</a> *cupsTempFile2(<span class="reserved">char</span> *filename, <span class="reserved">int</span> len);</p> |
| | 7324 | <h4 class="parameters">Parameters</h4> |
| | 7325 | <table class="list"><tbody> |
| | 7326 | <tr><th>filename</th> |
| | 7327 | <td class="description">Pointer to buffer</td></tr> |
| | 7328 | <tr><th>len</th> |
| | 7329 | <td class="description">Size of buffer</td></tr> |
| | 7330 | </tbody></table> |
| | 7331 | <h4 class="returnvalue">Return Value</h4> |
| | 7332 | <p class="description">CUPS file or <code>NULL</code> on error</p> |
| | 7333 | <h4 class="discussion">Discussion</h4> |
| | 7334 | <p class="discussion">This function creates a temporary CUPS file and places the filename in the |
| | 7335 | "filename" buffer. The temporary file is opened for writing.<br> |
| | 7336 | <br> |
| | 7337 | </p><blockquote> |
| | 7338 | Note: This function is deprecated. Use the <a href="#cupsCreateTempFile"><code>cupsCreateTempFile</code></a> |
| | 7339 | function instead.</blockquote> |
| | 7340 | |
| | 7341 | </p> |
| | 7342 | <h3 class="function"><a id="cupsThreadCancel">cupsThreadCancel</a></h3> |
| | 7343 | <p class="description">Cancel (kill) a thread.</p> |
| | 7344 | <p class="code"> |
| | 7345 | <span class="reserved">void</span> cupsThreadCancel(<a href="#cups_thread_t">cups_thread_t</a> thread);</p> |
| | 7346 | <h4 class="parameters">Parameters</h4> |
| | 7347 | <table class="list"><tbody> |
| | 7348 | <tr><th>thread</th> |
| | 7349 | <td class="description">Thread ID</td></tr> |
| | 7350 | </tbody></table> |
| | 7351 | <h3 class="function"><a id="cupsThreadCreate">cupsThreadCreate</a></h3> |
| | 7352 | <p class="description">Create a thread.</p> |
| | 7353 | <p class="code"> |
| | 7354 | <a href="#cups_thread_t">cups_thread_t</a> cupsThreadCreate(<a href="#cups_thread_func_t">cups_thread_func_t</a> func, <span class="reserved">void</span> *arg);</p> |
| | 7355 | <h4 class="parameters">Parameters</h4> |
| | 7356 | <table class="list"><tbody> |
| | 7357 | <tr><th>func</th> |
| | 7358 | <td class="description">Entry point</td></tr> |
| | 7359 | <tr><th>arg</th> |
| | 7360 | <td class="description">Entry point context</td></tr> |
| | 7361 | </tbody></table> |
| | 7362 | <h4 class="returnvalue">Return Value</h4> |
| | 7363 | <p class="description">Thread ID or <code>CUPS_THREAD_INVALID</code> on failure</p> |
| | 7364 | <h3 class="function"><a id="cupsThreadDetach">cupsThreadDetach</a></h3> |
| | 7365 | <p class="description">Tell the OS that the thread is running independently.</p> |
| | 7366 | <p class="code"> |
| | 7367 | <span class="reserved">void</span> cupsThreadDetach(<a href="#cups_thread_t">cups_thread_t</a> thread);</p> |
| | 7368 | <h4 class="parameters">Parameters</h4> |
| | 7369 | <table class="list"><tbody> |
| | 7370 | <tr><th>thread</th> |
| | 7371 | <td class="description">Thread ID</td></tr> |
| | 7372 | </tbody></table> |
| | 7373 | <h3 class="function"><a id="cupsThreadWait">cupsThreadWait</a></h3> |
| | 7374 | <p class="description">Wait for a thread to exit.</p> |
| | 7375 | <p class="code"> |
| | 7376 | <span class="reserved">void</span> *cupsThreadWait(<a href="#cups_thread_t">cups_thread_t</a> thread);</p> |
| | 7377 | <h4 class="parameters">Parameters</h4> |
| | 7378 | <table class="list"><tbody> |
| | 7379 | <tr><th>thread</th> |
| | 7380 | <td class="description">Thread ID</td></tr> |
| | 7381 | </tbody></table> |
| | 7382 | <h4 class="returnvalue">Return Value</h4> |
| | 7383 | <p class="description">Return value</p> |
| | 7384 | <h3 class="function"><a id="cupsUTF32ToUTF8">cupsUTF32ToUTF8</a></h3> |
| | 7385 | <p class="description">Convert UTF-32 to UTF-8.</p> |
| | 7386 | <p class="code"> |
| | 7387 | <span class="reserved">int</span> cupsUTF32ToUTF8(<a href="#cups_utf8_t">cups_utf8_t</a> *dest, <span class="reserved">const</span> <a href="#cups_utf32_t">cups_utf32_t</a> *src, <span class="reserved">const</span> <span class="reserved">int</span> maxout);</p> |
| | 7388 | <h4 class="parameters">Parameters</h4> |
| | 7389 | <table class="list"><tbody> |
| | 7390 | <tr><th>dest</th> |
| | 7391 | <td class="description">Target string</td></tr> |
| | 7392 | <tr><th>src</th> |
| | 7393 | <td class="description">Source string</td></tr> |
| | 7394 | <tr><th>maxout</th> |
| | 7395 | <td class="description">Max output</td></tr> |
| | 7396 | </tbody></table> |
| | 7397 | <h4 class="returnvalue">Return Value</h4> |
| | 7398 | <p class="description">Count or -1 on error</p> |
| | 7399 | <h4 class="discussion">Discussion</h4> |
| | 7400 | <p class="discussion">32-bit UTF-32 (actually 21-bit) maps to UTF-8 as follows...<br> |
| | 7401 | <br> |
| | 7402 | UTF-32 char UTF-8 char(s) |
| | 7403 | -------------------------------------------------- |
| | 7404 | 0 to 127 = 0xxxxxxx (US-ASCII) |
| | 7405 | 128 to 2047 = 110xxxxx 10yyyyyy |
| | 7406 | 2048 to 65535 = 1110xxxx 10yyyyyy 10zzzzzz |
| | 7407 | > 65535 = 11110xxx 10yyyyyy 10zzzzzz 10xxxxxx<br> |
| | 7408 | <br> |
| | 7409 | UTF-32 prohibits chars beyond Plane 16 (> 0x10ffff) in UCS-4, |
| | 7410 | which would convert to five- or six-octet UTF-8 sequences...</p> |
| | 7411 | <h3 class="function"><a id="cupsUTF8ToCharset">cupsUTF8ToCharset</a></h3> |
| | 7412 | <p class="description">Convert UTF-8 to legacy character set.</p> |
| | 7413 | <p class="code"> |
| | 7414 | <span class="reserved">int</span> cupsUTF8ToCharset(<span class="reserved">char</span> *dest, <span class="reserved">const</span> <a href="#cups_utf8_t">cups_utf8_t</a> *src, <span class="reserved">const</span> <span class="reserved">int</span> maxout, <span class="reserved">const</span> <a href="#cups_encoding_t">cups_encoding_t</a> encoding);</p> |
| | 7415 | <h4 class="parameters">Parameters</h4> |
| | 7416 | <table class="list"><tbody> |
| | 7417 | <tr><th>dest</th> |
| | 7418 | <td class="description">Target string</td></tr> |
| | 7419 | <tr><th>src</th> |
| | 7420 | <td class="description">Source string</td></tr> |
| | 7421 | <tr><th>maxout</th> |
| | 7422 | <td class="description">Max output</td></tr> |
| | 7423 | <tr><th>encoding</th> |
| | 7424 | <td class="description">Encoding</td></tr> |
| | 7425 | </tbody></table> |
| | 7426 | <h4 class="returnvalue">Return Value</h4> |
| | 7427 | <p class="description">Count or -1 on error</p> |
| | 7428 | <h3 class="function"><a id="cupsUTF8ToUTF32">cupsUTF8ToUTF32</a></h3> |
| | 7429 | <p class="description">Convert UTF-8 to UTF-32.</p> |
| | 7430 | <p class="code"> |
| | 7431 | <span class="reserved">int</span> cupsUTF8ToUTF32(<a href="#cups_utf32_t">cups_utf32_t</a> *dest, <span class="reserved">const</span> <a href="#cups_utf8_t">cups_utf8_t</a> *src, <span class="reserved">const</span> <span class="reserved">int</span> maxout);</p> |
| | 7432 | <h4 class="parameters">Parameters</h4> |
| | 7433 | <table class="list"><tbody> |
| | 7434 | <tr><th>dest</th> |
| | 7435 | <td class="description">Target string</td></tr> |
| | 7436 | <tr><th>src</th> |
| | 7437 | <td class="description">Source string</td></tr> |
| | 7438 | <tr><th>maxout</th> |
| | 7439 | <td class="description">Max output</td></tr> |
| | 7440 | </tbody></table> |
| | 7441 | <h4 class="returnvalue">Return Value</h4> |
| | 7442 | <p class="description">Count or -1 on error</p> |
| | 7443 | <h4 class="discussion">Discussion</h4> |
| | 7444 | <p class="discussion">32-bit UTF-32 (actually 21-bit) maps to UTF-8 as follows...<br> |
| | 7445 | <br> |
| | 7446 | UTF-32 char UTF-8 char(s) |
| | 7447 | -------------------------------------------------- |
| | 7448 | 0 to 127 = 0xxxxxxx (US-ASCII) |
| | 7449 | 128 to 2047 = 110xxxxx 10yyyyyy |
| | 7450 | 2048 to 65535 = 1110xxxx 10yyyyyy 10zzzzzz |
| | 7451 | > 65535 = 11110xxx 10yyyyyy 10zzzzzz 10xxxxxx<br> |
| | 7452 | <br> |
| | 7453 | UTF-32 prohibits chars beyond Plane 16 (> 0x10ffff) in UCS-4, |
| | 7454 | which would convert to five- or six-octet UTF-8 sequences...</p> |
| | 7455 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsUser">cupsUser</a></h3> |
| | 7456 | <p class="description">Return the current user's name.</p> |
| | 7457 | <p class="code"> |
| | 7458 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsUser(<span class="reserved">void</span>);</p> |
| | 7459 | <h4 class="returnvalue">Return Value</h4> |
| | 7460 | <p class="description">User name</p> |
| | 7461 | <h4 class="discussion">Discussion</h4> |
| | 7462 | <p class="discussion">Note: The current user name is tracked separately for each thread in a |
| | 7463 | program. Multi-threaded programs that override the user name with the |
| | 7464 | <a href="#cupsSetUser"><code>cupsSetUser</code></a> function need to do so in each thread for the same user |
| | 7465 | name to be used. |
| | 7466 | |
| | 7467 | </p> |
| | 7468 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="cupsUserAgent">cupsUserAgent</a></h3> |
| | 7469 | <p class="description">Return the default HTTP User-Agent string.</p> |
| | 7470 | <p class="code"> |
| | 7471 | <span class="reserved">const</span> <span class="reserved">char</span> *cupsUserAgent(<span class="reserved">void</span>);</p> |
| | 7472 | <h4 class="returnvalue">Return Value</h4> |
| | 7473 | <p class="description">User-Agent string</p> |
| | 7474 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="cupsWriteRequestData">cupsWriteRequestData</a></h3> |
| | 7475 | <p class="description">Write additional data after an IPP request.</p> |
| | 7476 | <p class="code"> |
| | 7477 | http_status_t cupsWriteRequestData(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *buffer, size_t length);</p> |
| | 7478 | <h4 class="parameters">Parameters</h4> |
| | 7479 | <table class="list"><tbody> |
| | 7480 | <tr><th>http</th> |
| | 7481 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> |
| | 7482 | <tr><th>buffer</th> |
| | 7483 | <td class="description">Bytes to write</td></tr> |
| | 7484 | <tr><th>length</th> |
| | 7485 | <td class="description">Number of bytes to write</td></tr> |
| | 7486 | </tbody></table> |
| | 7487 | <h4 class="returnvalue">Return Value</h4> |
| | 7488 | <p class="description"><code>HTTP_STATUS_CONTINUE</code> if OK or HTTP status on error</p> |
| | 7489 | <h4 class="discussion">Discussion</h4> |
| | 7490 | <p class="discussion">This function is used after <a href="#cupsSendRequest"><code>cupsSendRequest</code></a> to provide a PPD and |
| | 7491 | after <a href="#cupsStartDocument"><code>cupsStartDocument</code></a> to provide a document file. |
| | 7492 | |
| | 7493 | </p> |
| | 7494 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpAcceptConnection">httpAcceptConnection</a></h3> |
| | 7495 | <p class="description">Accept a new HTTP client connection.</p> |
| | 7496 | <p class="code"> |
| | 7497 | <a href="#http_t">http_t</a> *httpAcceptConnection(<span class="reserved">int</span> fd, <span class="reserved">int</span> blocking);</p> |
| | 7498 | <h4 class="parameters">Parameters</h4> |
| | 7499 | <table class="list"><tbody> |
| | 7500 | <tr><th>fd</th> |
| | 7501 | <td class="description">Listen socket file descriptor</td></tr> |
| | 7502 | <tr><th>blocking</th> |
| | 7503 | <td class="description">1 if the connection should be blocking, 0 otherwise</td></tr> |
| | 7504 | </tbody></table> |
| | 7505 | <h4 class="returnvalue">Return Value</h4> |
| | 7506 | <p class="description">HTTP connection or <code>NULL</code></p> |
| | 7507 | <h4 class="discussion">Discussion</h4> |
| | 7508 | <p class="discussion">This function accepts a new HTTP client connection from the specified |
| | 7509 | listening socket "fd". The "blocking" argument specifies whether the new |
| | 7510 | HTTP connection is blocking. |
| | 7511 | |
| | 7512 | </p> |
| | 7513 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpAddrClose">httpAddrClose</a></h3> |
| | 7514 | <p class="description">Close a socket created by <a href="#httpAddrConnect"><code>httpAddrConnect</code></a> or |
| | 7515 | <a href="#httpAddrListen"><code>httpAddrListen</code></a>.</p> |
| | 7516 | <p class="code"> |
| | 7517 | <span class="reserved">int</span> httpAddrClose(<a href="#http_addr_t">http_addr_t</a> *addr, <span class="reserved">int</span> fd);</p> |
| | 7518 | <h4 class="parameters">Parameters</h4> |
| | 7519 | <table class="list"><tbody> |
| | 7520 | <tr><th>addr</th> |
| | 7521 | <td class="description">Listen address or <code>NULL</code></td></tr> |
| | 7522 | <tr><th>fd</th> |
| | 7523 | <td class="description">Socket file descriptor</td></tr> |
| | 7524 | </tbody></table> |
| | 7525 | <h4 class="returnvalue">Return Value</h4> |
| | 7526 | <p class="description">0 on success, -1 on failure</p> |
| | 7527 | <h4 class="discussion">Discussion</h4> |
| | 7528 | <p class="discussion">Pass <code>NULL</code> for sockets created with <a href="#httpAddrConnect2"><code>httpAddrConnect2</code></a> and the |
| | 7529 | listen address for sockets created with <a href="#httpAddrListen"><code>httpAddrListen</code></a>. This function |
| | 7530 | ensures that domain sockets are removed when closed. |
| | 7531 | |
| | 7532 | </p> |
| | 7533 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpAddrConnect2">httpAddrConnect2</a></h3> |
| | 7534 | <p class="description">Connect to any of the addresses in the list with a |
| | 7535 | timeout and optional cancel.</p> |
| | 7536 | <p class="code"> |
| | 7537 | <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrConnect2(<a href="#http_addrlist_t">http_addrlist_t</a> *addrlist, <span class="reserved">int</span> *sock, <span class="reserved">int</span> msec, <span class="reserved">int</span> *cancel);</p> |
| | 7538 | <h4 class="parameters">Parameters</h4> |
| | 7539 | <table class="list"><tbody> |
| | 7540 | <tr><th>addrlist</th> |
| | 7541 | <td class="description">List of potential addresses</td></tr> |
| | 7542 | <tr><th>sock</th> |
| | 7543 | <td class="description">Socket</td></tr> |
| | 7544 | <tr><th>msec</th> |
| | 7545 | <td class="description">Timeout in milliseconds</td></tr> |
| | 7546 | <tr><th>cancel</th> |
| | 7547 | <td class="description">Pointer to "cancel" variable</td></tr> |
| | 7548 | </tbody></table> |
| | 7549 | <h4 class="returnvalue">Return Value</h4> |
| | 7550 | <p class="description">Connected address or NULL on failure</p> |
| | 7551 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpAddrCopyList">httpAddrCopyList</a></h3> |
| | 7552 | <p class="description">Copy an address list.</p> |
| | 7553 | <p class="code"> |
| | 7554 | <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrCopyList(<a href="#http_addrlist_t">http_addrlist_t</a> *src);</p> |
| | 7555 | <h4 class="parameters">Parameters</h4> |
| | 7556 | <table class="list"><tbody> |
| | 7557 | <tr><th>src</th> |
| | 7558 | <td class="description">Source address list</td></tr> |
| | 7559 | </tbody></table> |
| | 7560 | <h4 class="returnvalue">Return Value</h4> |
| | 7561 | <p class="description">New address list or <code>NULL</code> on error</p> |
| | 7562 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpAddrFreeList">httpAddrFreeList</a></h3> |
| | 7563 | <p class="description">Free an address list.</p> |
| | 7564 | <p class="code"> |
| | 7565 | <span class="reserved">void</span> httpAddrFreeList(<a href="#http_addrlist_t">http_addrlist_t</a> *addrlist);</p> |
| | 7566 | <h4 class="parameters">Parameters</h4> |
| | 7567 | <table class="list"><tbody> |
| | 7568 | <tr><th>addrlist</th> |
| | 7569 | <td class="description">Address list to free</td></tr> |
| | 7570 | </tbody></table> |
| | 7571 | <h3 class="function"><a id="httpAddrGetFamily">httpAddrGetFamily</a></h3> |
| | 7572 | <p class="description">Get the address family of an address.</p> |
| | 7573 | <p class="code"> |
| | 7574 | <span class="reserved">int</span> httpAddrGetFamily(<a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| | 7575 | <h4 class="parameters">Parameters</h4> |
| | 7576 | <table class="list"><tbody> |
| | 7577 | <tr><th>addr</th> |
| | 7578 | <td class="description">Address</td></tr> |
| | 7579 | </tbody></table> |
| | 7580 | <h4 class="returnvalue">Return Value</h4> |
| | 7581 | <p class="description">Address family</p> |
| | 7582 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpAddrGetLength">httpAddrGetLength</a></h3> |
| | 7583 | <p class="description">Return the length of the address in bytes.</p> |
| | 7584 | <p class="code"> |
| | 7585 | size_t httpAddrGetLength(<span class="reserved">const</span> <a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| | 7586 | <h4 class="parameters">Parameters</h4> |
| | 7587 | <table class="list"><tbody> |
| | 7588 | <tr><th>addr</th> |
| | 7589 | <td class="description">Address</td></tr> |
| | 7590 | </tbody></table> |
| | 7591 | <h4 class="returnvalue">Return Value</h4> |
| | 7592 | <p class="description">Length in bytes</p> |
| | 7593 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpAddrGetList">httpAddrGetList</a></h3> |
| | 7594 | <p class="description">Get a list of addresses for a hostname.</p> |
| | 7595 | <p class="code"> |
| | 7596 | <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrGetList(<span class="reserved">const</span> <span class="reserved">char</span> *hostname, <span class="reserved">int</span> family, <span class="reserved">const</span> <span class="reserved">char</span> *service);</p> |
| | 7597 | <h4 class="parameters">Parameters</h4> |
| | 7598 | <table class="list"><tbody> |
| | 7599 | <tr><th>hostname</th> |
| | 7600 | <td class="description">Hostname, IP address, or NULL for passive listen address</td></tr> |
| | 7601 | <tr><th>family</th> |
| | 7602 | <td class="description">Address family or AF_UNSPEC</td></tr> |
| | 7603 | <tr><th>service</th> |
| | 7604 | <td class="description">Service name or port number</td></tr> |
| | 7605 | </tbody></table> |
| | 7606 | <h4 class="returnvalue">Return Value</h4> |
| | 7607 | <p class="description">List of addresses or NULL</p> |
| | 7608 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpAddrGetPort">httpAddrGetPort</a></h3> |
| | 7609 | <p class="description">Get the port number associated with an address.</p> |
| | 7610 | <p class="code"> |
| | 7611 | <span class="reserved">int</span> httpAddrGetPort(<a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| | 7612 | <h4 class="parameters">Parameters</h4> |
| | 7613 | <table class="list"><tbody> |
| | 7614 | <tr><th>addr</th> |
| | 7615 | <td class="description">Address</td></tr> |
| | 7616 | </tbody></table> |
| | 7617 | <h4 class="returnvalue">Return Value</h4> |
| | 7618 | <p class="description">Port number</p> |
| | 7619 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpAddrGetString">httpAddrGetString</a></h3> |
| | 7620 | <p class="description">Convert an address to a numeric string.</p> |
| | 7621 | <p class="code"> |
| | 7622 | <span class="reserved">char</span> *httpAddrGetString(<span class="reserved">const</span> <a href="#http_addr_t">http_addr_t</a> *addr, <span class="reserved">char</span> *s, size_t slen);</p> |
| | 7623 | <h4 class="parameters">Parameters</h4> |
| | 7624 | <table class="list"><tbody> |
| | 7625 | <tr><th>addr</th> |
| | 7626 | <td class="description">Address to convert</td></tr> |
| | 7627 | <tr><th>s</th> |
| | 7628 | <td class="description">String buffer</td></tr> |
| | 7629 | <tr><th>slen</th> |
| | 7630 | <td class="description">Length of string</td></tr> |
| | 7631 | </tbody></table> |
| | 7632 | <h4 class="returnvalue">Return Value</h4> |
| | 7633 | <p class="description">Numeric address string</p> |
| | 7634 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpAddrIsAny">httpAddrIsAny</a></h3> |
| | 7635 | <p class="description">Check for the "any" address.</p> |
| | 7636 | <p class="code"> |
| | 7637 | <span class="reserved">bool</span> httpAddrIsAny(<span class="reserved">const</span> <a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| | 7638 | <h4 class="parameters">Parameters</h4> |
| | 7639 | <table class="list"><tbody> |
| | 7640 | <tr><th>addr</th> |
| | 7641 | <td class="description">Address to check</td></tr> |
| | 7642 | </tbody></table> |
| | 7643 | <h4 class="returnvalue">Return Value</h4> |
| | 7644 | <p class="description"><code>true</code> if "any" address, <code>false</code> otherwise</p> |
| | 7645 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpAddrIsEqual">httpAddrIsEqual</a></h3> |
| | 7646 | <p class="description">Compare two addresses.</p> |
| | 7647 | <p class="code"> |
| | 7648 | <span class="reserved">bool</span> httpAddrIsEqual(<span class="reserved">const</span> <a href="#http_addr_t">http_addr_t</a> *addr1, <span class="reserved">const</span> <a href="#http_addr_t">http_addr_t</a> *addr2);</p> |
| | 7649 | <h4 class="parameters">Parameters</h4> |
| | 7650 | <table class="list"><tbody> |
| | 7651 | <tr><th>addr1</th> |
| | 7652 | <td class="description">First address</td></tr> |
| | 7653 | <tr><th>addr2</th> |
| | 7654 | <td class="description">Second address</td></tr> |
| | 7655 | </tbody></table> |
| | 7656 | <h4 class="returnvalue">Return Value</h4> |
| | 7657 | <p class="description"><code>true</code> if equal, <code>false</code> if not</p> |
| | 7658 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpAddrIsLocalhost">httpAddrIsLocalhost</a></h3> |
| | 7659 | <p class="description">Check for the local loopback address.</p> |
| | 7660 | <p class="code"> |
| | 7661 | <span class="reserved">bool</span> httpAddrIsLocalhost(<span class="reserved">const</span> <a href="#http_addr_t">http_addr_t</a> *addr);</p> |
| | 7662 | <h4 class="parameters">Parameters</h4> |
| | 7663 | <table class="list"><tbody> |
| | 7664 | <tr><th>addr</th> |
| | 7665 | <td class="description">Address to check</td></tr> |
| | 7666 | </tbody></table> |
| | 7667 | <h4 class="returnvalue">Return Value</h4> |
| | 7668 | <p class="description"><code>true</code> if local host, <code>false</code> otherwise</p> |
| | 7669 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpAddrListen">httpAddrListen</a></h3> |
| | 7670 | <p class="description">Create a listening socket bound to the specified |
| | 7671 | address and port.</p> |
| | 7672 | <p class="code"> |
| | 7673 | <span class="reserved">int</span> httpAddrListen(<a href="#http_addr_t">http_addr_t</a> *addr, <span class="reserved">int</span> port);</p> |
| | 7674 | <h4 class="parameters">Parameters</h4> |
| | 7675 | <table class="list"><tbody> |
| | 7676 | <tr><th>addr</th> |
| | 7677 | <td class="description">Address to bind to</td></tr> |
| | 7678 | <tr><th>port</th> |
| | 7679 | <td class="description">Port number to bind to</td></tr> |
| | 7680 | </tbody></table> |
| | 7681 | <h4 class="returnvalue">Return Value</h4> |
| | 7682 | <p class="description">Socket or -1 on error</p> |
| | 7683 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpAddrLookup">httpAddrLookup</a></h3> |
| | 7684 | <p class="description">Lookup the hostname associated with the address.</p> |
| | 7685 | <p class="code"> |
| | 7686 | <span class="reserved">char</span> *httpAddrLookup(<span class="reserved">const</span> <a href="#http_addr_t">http_addr_t</a> *addr, <span class="reserved">char</span> *name, <span class="reserved">int</span> namelen);</p> |
| | 7687 | <h4 class="parameters">Parameters</h4> |
| | 7688 | <table class="list"><tbody> |
| | 7689 | <tr><th>addr</th> |
| | 7690 | <td class="description">Address to lookup</td></tr> |
| | 7691 | <tr><th>name</th> |
| | 7692 | <td class="description">Host name buffer</td></tr> |
| | 7693 | <tr><th>namelen</th> |
| | 7694 | <td class="description">Size of name buffer</td></tr> |
| | 7695 | </tbody></table> |
| | 7696 | <h4 class="returnvalue">Return Value</h4> |
| | 7697 | <p class="description">Host name</p> |
| | 7698 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpAddrSetPort">httpAddrSetPort</a></h3> |
| | 7699 | <p class="description">Set the port number associated with an address.</p> |
| | 7700 | <p class="code"> |
| | 7701 | <span class="reserved">void</span> httpAddrSetPort(<a href="#http_addr_t">http_addr_t</a> *addr, <span class="reserved">int</span> port);</p> |
| | 7702 | <h4 class="parameters">Parameters</h4> |
| | 7703 | <table class="list"><tbody> |
| | 7704 | <tr><th>addr</th> |
| | 7705 | <td class="description">Address</td></tr> |
| | 7706 | <tr><th>port</th> |
| | 7707 | <td class="description">Port</td></tr> |
| | 7708 | </tbody></table> |
| | 7709 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpAssembleURI">httpAssembleURI</a></h3> |
| | 7710 | <p class="description">Assemble a uniform resource identifier from its |
| | 7711 | components.</p> |
| | 7712 | <p class="code"> |
| | 7713 | <a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURI(<a href="#http_uri_coding_t">http_uri_coding_t</a> encoding, <span class="reserved">char</span> *uri, <span class="reserved">int</span> urilen, <span class="reserved">const</span> <span class="reserved">char</span> *scheme, <span class="reserved">const</span> <span class="reserved">char</span> *username, <span class="reserved">const</span> <span class="reserved">char</span> *host, <span class="reserved">int</span> port, <span class="reserved">const</span> <span class="reserved">char</span> *resource);</p> |
| | 7714 | <h4 class="parameters">Parameters</h4> |
| | 7715 | <table class="list"><tbody> |
| | 7716 | <tr><th>encoding</th> |
| | 7717 | <td class="description">Encoding flags</td></tr> |
| | 7718 | <tr><th>uri</th> |
| | 7719 | <td class="description">URI buffer</td></tr> |
| | 7720 | <tr><th>urilen</th> |
| | 7721 | <td class="description">Size of URI buffer</td></tr> |
| | 7722 | <tr><th>scheme</th> |
| | 7723 | <td class="description">Scheme name</td></tr> |
| | 7724 | <tr><th>username</th> |
| | 7725 | <td class="description">Username</td></tr> |
| | 7726 | <tr><th>host</th> |
| | 7727 | <td class="description">Hostname or address</td></tr> |
| | 7728 | <tr><th>port</th> |
| | 7729 | <td class="description">Port number</td></tr> |
| | 7730 | <tr><th>resource</th> |
| | 7731 | <td class="description">Resource</td></tr> |
| | 7732 | </tbody></table> |
| | 7733 | <h4 class="returnvalue">Return Value</h4> |
| | 7734 | <p class="description">URI status</p> |
| | 7735 | <h4 class="discussion">Discussion</h4> |
| | 7736 | <p class="discussion">This function escapes reserved characters in the URI depending on the |
| | 7737 | value of the "encoding" argument. You should use this function in |
| | 7738 | place of traditional string functions whenever you need to create a |
| | 7739 | URI string. |
| | 7740 | |
| | 7741 | </p> |
| | 7742 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpAssembleURIf">httpAssembleURIf</a></h3> |
| | 7743 | <p class="description">Assemble a uniform resource identifier from its components with a formatted resource.</p> |
| | 7744 | <p class="code"> |
| | 7745 | <a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURIf(<a href="#http_uri_coding_t">http_uri_coding_t</a> encoding, <span class="reserved">char</span> *uri, <span class="reserved">int</span> urilen, <span class="reserved">const</span> <span class="reserved">char</span> *scheme, <span class="reserved">const</span> <span class="reserved">char</span> *username, <span class="reserved">const</span> <span class="reserved">char</span> *host, <span class="reserved">int</span> port, <span class="reserved">const</span> <span class="reserved">char</span> *resourcef, ...);</p> |
| | 7746 | <h4 class="parameters">Parameters</h4> |
| | 7747 | <table class="list"><tbody> |
| | 7748 | <tr><th>encoding</th> |
| | 7749 | <td class="description">Encoding flags</td></tr> |
| | 7750 | <tr><th>uri</th> |
| | 7751 | <td class="description">URI buffer</td></tr> |
| | 7752 | <tr><th>urilen</th> |
| | 7753 | <td class="description">Size of URI buffer</td></tr> |
| | 7754 | <tr><th>scheme</th> |
| | 7755 | <td class="description">Scheme name</td></tr> |
| | 7756 | <tr><th>username</th> |
| | 7757 | <td class="description">Username</td></tr> |
| | 7758 | <tr><th>host</th> |
| | 7759 | <td class="description">Hostname or address</td></tr> |
| | 7760 | <tr><th>port</th> |
| | 7761 | <td class="description">Port number</td></tr> |
| | 7762 | <tr><th>resourcef</th> |
| | 7763 | <td class="description">Printf-style resource</td></tr> |
| | 7764 | <tr><th>...</th> |
| | 7765 | <td class="description">Additional arguments as needed</td></tr> |
| | 7766 | </tbody></table> |
| | 7767 | <h4 class="returnvalue">Return Value</h4> |
| | 7768 | <p class="description">URI status</p> |
| | 7769 | <h4 class="discussion">Discussion</h4> |
| | 7770 | <p class="discussion">This function creates a formatted version of the resource string |
| | 7771 | argument "resourcef" and escapes reserved characters in the URI |
| | 7772 | depending on the value of the "encoding" argument. You should use |
| | 7773 | this function in place of traditional string functions whenever |
| | 7774 | you need to create a URI string. |
| | 7775 | |
| | 7776 | </p> |
| | 7777 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpAssembleUUID">httpAssembleUUID</a></h3> |
| | 7778 | <p class="description">Assemble a name-based UUID URN conforming to RFC 4122.</p> |
| | 7779 | <p class="code"> |
| | 7780 | <span class="reserved">char</span> *httpAssembleUUID(<span class="reserved">const</span> <span class="reserved">char</span> *server, <span class="reserved">int</span> port, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> number, <span class="reserved">char</span> *buffer, size_t bufsize);</p> |
| | 7781 | <h4 class="parameters">Parameters</h4> |
| | 7782 | <table class="list"><tbody> |
| | 7783 | <tr><th>server</th> |
| | 7784 | <td class="description">Server name</td></tr> |
| | 7785 | <tr><th>port</th> |
| | 7786 | <td class="description">Port number</td></tr> |
| | 7787 | <tr><th>name</th> |
| | 7788 | <td class="description">Object name or NULL</td></tr> |
| | 7789 | <tr><th>number</th> |
| | 7790 | <td class="description">Object number or 0</td></tr> |
| | 7791 | <tr><th>buffer</th> |
| | 7792 | <td class="description">String buffer</td></tr> |
| | 7793 | <tr><th>bufsize</th> |
| | 7794 | <td class="description">Size of buffer</td></tr> |
| | 7795 | </tbody></table> |
| | 7796 | <h4 class="returnvalue">Return Value</h4> |
| | 7797 | <p class="description">UUID string</p> |
| | 7798 | <h4 class="discussion">Discussion</h4> |
| | 7799 | <p class="discussion">This function creates a unique 128-bit identifying number using the server |
| | 7800 | name, port number, random data, and optionally an object name and/or object |
| | 7801 | number. The result is formatted as a UUID URN as defined in RFC 4122.<br> |
| | 7802 | <br> |
| | 7803 | The buffer needs to be at least 46 bytes in size. |
| | 7804 | |
| | 7805 | </p> |
| | 7806 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="httpBlocking">httpBlocking</a></h3> |
| | 7807 | <p class="description">Set blocking/non-blocking behavior on a connection.</p> |
| | 7808 | <p class="code"> |
| | 7809 | <span class="reserved">void</span> httpBlocking(<a href="#http_t">http_t</a> *http, <span class="reserved">int</span> b);</p> |
| | 7810 | <h4 class="parameters">Parameters</h4> |
| | 7811 | <table class="list"><tbody> |
| | 7812 | <tr><th>http</th> |
| | 7813 | <td class="description">HTTP connection</td></tr> |
| | 7814 | <tr><th>b</th> |
| | 7815 | <td class="description">1 = blocking, 0 = non-blocking</td></tr> |
| | 7816 | </tbody></table> |
| | 7817 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="httpCheck">httpCheck</a></h3> |
| | 7818 | <p class="description">Check to see if there is a pending response from the server.</p> |
| | 7819 | <p class="code"> |
| | 7820 | <span class="reserved">int</span> httpCheck(<a href="#http_t">http_t</a> *http);</p> |
| | 7821 | <h4 class="parameters">Parameters</h4> |
| | 7822 | <table class="list"><tbody> |
| | 7823 | <tr><th>http</th> |
| | 7824 | <td class="description">HTTP connection</td></tr> |
| | 7825 | </tbody></table> |
| | 7826 | <h4 class="returnvalue">Return Value</h4> |
| | 7827 | <p class="description">0 = no data, 1 = data available</p> |
| | 7828 | <h3 class="function"><span class="info"> CUPS 1.1.19 </span><a id="httpClearCookie">httpClearCookie</a></h3> |
| | 7829 | <p class="description">Clear the cookie value(s).</p> |
| | 7830 | <p class="code"> |
| | 7831 | <span class="reserved">void</span> httpClearCookie(<a href="#http_t">http_t</a> *http);</p> |
| | 7832 | <h4 class="parameters">Parameters</h4> |
| | 7833 | <table class="list"><tbody> |
| | 7834 | <tr><th>http</th> |
| | 7835 | <td class="description">HTTP connection</td></tr> |
| | 7836 | </tbody></table> |
| | 7837 | <h3 class="function"><a id="httpClearFields">httpClearFields</a></h3> |
| | 7838 | <p class="description">Clear HTTP request/response fields.</p> |
| | 7839 | <p class="code"> |
| | 7840 | <span class="reserved">void</span> httpClearFields(<a href="#http_t">http_t</a> *http);</p> |
| | 7841 | <h4 class="parameters">Parameters</h4> |
| | 7842 | <table class="list"><tbody> |
| | 7843 | <tr><th>http</th> |
| | 7844 | <td class="description">HTTP connection</td></tr> |
| | 7845 | </tbody></table> |
| | 7846 | <h3 class="function"><a id="httpClose">httpClose</a></h3> |
| | 7847 | <p class="description">Close a HTTP connection.</p> |
| | 7848 | <p class="code"> |
| | 7849 | <span class="reserved">void</span> httpClose(<a href="#http_t">http_t</a> *http);</p> |
| | 7850 | <h4 class="parameters">Parameters</h4> |
| | 7851 | <table class="list"><tbody> |
| | 7852 | <tr><th>http</th> |
| | 7853 | <td class="description">HTTP connection</td></tr> |
| | 7854 | </tbody></table> |
| | 7855 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpConnect2">httpConnect2</a></h3> |
| | 7856 | <p class="description">Connect to a HTTP server.</p> |
| | 7857 | <p class="code"> |
| | 7858 | <a href="#http_t">http_t</a> *httpConnect2(<span class="reserved">const</span> <span class="reserved">char</span> *host, <span class="reserved">int</span> port, <a href="#http_addrlist_t">http_addrlist_t</a> *addrlist, <span class="reserved">int</span> family, <a href="#http_encryption_t">http_encryption_t</a> encryption, <span class="reserved">int</span> blocking, <span class="reserved">int</span> msec, <span class="reserved">int</span> *cancel);</p> |
| | 7859 | <h4 class="parameters">Parameters</h4> |
| | 7860 | <table class="list"><tbody> |
| | 7861 | <tr><th>host</th> |
| | 7862 | <td class="description">Host to connect to</td></tr> |
| | 7863 | <tr><th>port</th> |
| | 7864 | <td class="description">Port number</td></tr> |
| | 7865 | <tr><th>addrlist</th> |
| | 7866 | <td class="description">List of addresses or <code>NULL</code> to lookup</td></tr> |
| | 7867 | <tr><th>family</th> |
| | 7868 | <td class="description">Address family to use or <code>AF_UNSPEC</code> for any</td></tr> |
| | 7869 | <tr><th>encryption</th> |
| | 7870 | <td class="description">Type of encryption to use</td></tr> |
| | 7871 | <tr><th>blocking</th> |
| | 7872 | <td class="description">1 for blocking connection, 0 for non-blocking</td></tr> |
| | 7873 | <tr><th>msec</th> |
| | 7874 | <td class="description">Connection timeout in milliseconds, 0 means don't connect</td></tr> |
| | 7875 | <tr><th>cancel</th> |
| | 7876 | <td class="description">Pointer to "cancel" variable</td></tr> |
| | 7877 | </tbody></table> |
| | 7878 | <h4 class="returnvalue">Return Value</h4> |
| | 7879 | <p class="description">New HTTP connection</p> |
| | 7880 | <h4 class="discussion">Discussion</h4> |
| | 7881 | <p class="discussion">This function creates a connection to a HTTP server. The "host" and "port" |
| | 7882 | arguments specify a hostname or IP address and port number to use while the |
| | 7883 | "addrlist" argument specifies a list of addresses to use or <code>NULL</code> to do a |
| | 7884 | fresh lookup. The "family" argument specifies the address family to use - |
| | 7885 | <code>AF_UNSPEC</code> to try both IPv4 and IPv6, <code>AF_INET</code> for IPv4, or <code>AF_INET6</code> for |
| | 7886 | IPv6.<br> |
| | 7887 | <br> |
| | 7888 | The "encryption" argument specifies whether to encrypt the connection and the |
| | 7889 | "blocking" argument specifies whether to use blocking behavior when reading |
| | 7890 | or writing data.<br> |
| | 7891 | <br> |
| | 7892 | The "msec" argument specifies how long to try to connect to the server or <code>0</code> |
| | 7893 | to just create an unconnected <code>http_t</code> object. The "cancel" argument |
| | 7894 | specifies an integer variable that can be set to a non-zero value to cancel |
| | 7895 | the connection process. |
| | 7896 | |
| | 7897 | </p> |
| | 7898 | <h3 class="function"><a id="httpConnectAgain">httpConnectAgain</a></h3> |
| | 7899 | <p class="description">Reconnect to a HTTP server with timeout and optional cancel variable.</p> |
| | 7900 | <p class="code"> |
| | 7901 | <span class="reserved">bool</span> httpConnectAgain(<a href="#http_t">http_t</a> *http, <span class="reserved">int</span> msec, <span class="reserved">int</span> *cancel);</p> |
| | 7902 | <h4 class="parameters">Parameters</h4> |
| | 7903 | <table class="list"><tbody> |
| | 7904 | <tr><th>http</th> |
| | 7905 | <td class="description">HTTP connection</td></tr> |
| | 7906 | <tr><th>msec</th> |
| | 7907 | <td class="description">Timeout in milliseconds</td></tr> |
| | 7908 | <tr><th>cancel</th> |
| | 7909 | <td class="description">Pointer to "cancel" variable</td></tr> |
| | 7910 | </tbody></table> |
| | 7911 | <h4 class="returnvalue">Return Value</h4> |
| | 7912 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 7913 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpConnectURI">httpConnectURI</a></h3> |
| | 7914 | <p class="description">Connect to a HTTP service using a URI.</p> |
| | 7915 | <p class="code"> |
| | 7916 | <a href="#http_t">http_t</a> *httpConnectURI(<span class="reserved">const</span> <span class="reserved">char</span> *uri, <span class="reserved">char</span> *host, size_t hsize, <span class="reserved">int</span> *port, <span class="reserved">char</span> *resource, size_t rsize, <span class="reserved">bool</span> blocking, <span class="reserved">int</span> msec, <span class="reserved">int</span> *cancel, <span class="reserved">bool</span> require_ca);</p> |
| | 7917 | <h4 class="parameters">Parameters</h4> |
| | 7918 | <table class="list"><tbody> |
| | 7919 | <tr><th>uri</th> |
| | 7920 | <td class="description">Service to connect to</td></tr> |
| | 7921 | <tr><th>host</th> |
| | 7922 | <td class="description">Host name buffer (<code>NULL</code> for don't care)</td></tr> |
| | 7923 | <tr><th>hsize</th> |
| | 7924 | <td class="description">Size of host name buffer</td></tr> |
| | 7925 | <tr><th>port</th> |
| | 7926 | <td class="description">Port number (<code>NULL</code> for don't care)</td></tr> |
| | 7927 | <tr><th>resource</th> |
| | 7928 | <td class="description">Resource path buffer (<code>NULL</code> for don't care)</td></tr> |
| | 7929 | <tr><th>rsize</th> |
| | 7930 | <td class="description">Size of resource path buffer</td></tr> |
| | 7931 | <tr><th>blocking</th> |
| | 7932 | <td class="description"><code>true</code> for blocking connection, <code>false</code> for non-blocking</td></tr> |
| | 7933 | <tr><th>msec</th> |
| | 7934 | <td class="description">Connection timeout in milliseconds, <code>0</code> means don't connect</td></tr> |
| | 7935 | <tr><th>cancel</th> |
| | 7936 | <td class="description">Pointer to "cancel" variable or <code>NULL</code> for none</td></tr> |
| | 7937 | <tr><th>require_ca</th> |
| | 7938 | <td class="description"><code>true</code> to require a CA-signed X.509 certificate</td></tr> |
| | 7939 | </tbody></table> |
| | 7940 | <h4 class="returnvalue">Return Value</h4> |
| | 7941 | <p class="description">New HTTP connection</p> |
| | 7942 | <h4 class="discussion">Discussion</h4> |
| | 7943 | <p class="discussion">This function creates a connection to a HTTP server. The "uri" argument |
| | 7944 | specifies a "http", "https", "ipp", or "ipps" URI for the service.<br> |
| | 7945 | <br> |
| | 7946 | The resource path for the service is returned in the buffer pointed to by |
| | 7947 | the "resource" argument of size "rsize".<br> |
| | 7948 | <br> |
| | 7949 | The "msec" argument specifies how long to try to connect to the server or <code>0</code> |
| | 7950 | to just create an unconnected <code>http_t</code> object. The "cancel" argument |
| | 7951 | specifies an integer variable that can be set to a non-zero value to cancel |
| | 7952 | the connection process.<br> |
| | 7953 | <br> |
| | 7954 | The "require_ca" argument specifies whether to verify that the service |
| | 7955 | connection is using a CA-signed X.509 certificate. |
| | 7956 | |
| | 7957 | </p> |
| | 7958 | <h3 class="function"><a id="httpCopyPeerCredentials">httpCopyPeerCredentials</a></h3> |
| | 7959 | <p class="description">Copy the credentials associated with the peer in an encrypted connection.</p> |
| | 7960 | <p class="code"> |
| | 7961 | <span class="reserved">char</span> *httpCopyPeerCredentials(<a href="#http_t">http_t</a> *http);</p> |
| | 7962 | <h4 class="parameters">Parameters</h4> |
| | 7963 | <table class="list"><tbody> |
| | 7964 | <tr><th>http</th> |
| | 7965 | <td class="description">Connection to server</td></tr> |
| | 7966 | </tbody></table> |
| | 7967 | <h4 class="returnvalue">Return Value</h4> |
| | 7968 | <p class="description">PEM-encoded X.509 certificate chain or <code>NULL</code></p> |
| | 7969 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpDecode64_3">httpDecode64_3</a></h3> |
| | 7970 | <p class="description">Base64-decode a string.</p> |
| | 7971 | <p class="code"> |
| | 7972 | <span class="reserved">char</span> *httpDecode64_3(<span class="reserved">char</span> *out, size_t *outlen, <span class="reserved">const</span> <span class="reserved">char</span> *in, <span class="reserved">const</span> <span class="reserved">char</span> **end);</p> |
| | 7973 | <h4 class="parameters">Parameters</h4> |
| | 7974 | <table class="list"><tbody> |
| | 7975 | <tr><th>out</th> |
| | 7976 | <td class="description">String to write to</td></tr> |
| | 7977 | <tr><th>outlen</th> |
| | 7978 | <td class="description">Size of output string</td></tr> |
| | 7979 | <tr><th>in</th> |
| | 7980 | <td class="description">String to read from</td></tr> |
| | 7981 | <tr><th>end</th> |
| | 7982 | <td class="description">Pointer to end of Base64 data (<code>NULL</code> if don't care)</td></tr> |
| | 7983 | </tbody></table> |
| | 7984 | <h4 class="returnvalue">Return Value</h4> |
| | 7985 | <p class="description">Decoded string or <code>NULL</code> on error</p> |
| | 7986 | <h4 class="discussion">Discussion</h4> |
| | 7987 | <p class="discussion">This function decodes a Base64 string as defined by RFC 4648. The caller |
| | 7988 | must initialize "outlen" to the maximum size of the decoded string. On |
| | 7989 | return "outlen" contains the decoded length of the string and "end" (if not |
| | 7990 | <code>NULL</code>) points to the end of the Base64 data that has been decoded.<br> |
| | 7991 | <br> |
| | 7992 | This function always reserves one byte in the output buffer for a nul |
| | 7993 | terminating character, even if the result is not a regular string. Callers |
| | 7994 | should ensure that the output buffer is at least one byte larger than the |
| | 7995 | expected size, for example 33 bytes for a SHA-256 hash which is 32 bytes in |
| | 7996 | length.<br> |
| | 7997 | <br> |
| | 7998 | This function supports both Base64 and Base64url strings. |
| | 7999 | |
| | 8000 | </p> |
| | 8001 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpEncode64_3">httpEncode64_3</a></h3> |
| | 8002 | <p class="description">Base64-encode a string.</p> |
| | 8003 | <p class="code"> |
| | 8004 | <span class="reserved">char</span> *httpEncode64_3(<span class="reserved">char</span> *out, size_t outlen, <span class="reserved">const</span> <span class="reserved">char</span> *in, size_t inlen, <span class="reserved">bool</span> url);</p> |
| | 8005 | <h4 class="parameters">Parameters</h4> |
| | 8006 | <table class="list"><tbody> |
| | 8007 | <tr><th>out</th> |
| | 8008 | <td class="description">String to write to</td></tr> |
| | 8009 | <tr><th>outlen</th> |
| | 8010 | <td class="description">Maximum size of output string</td></tr> |
| | 8011 | <tr><th>in</th> |
| | 8012 | <td class="description">String to read from</td></tr> |
| | 8013 | <tr><th>inlen</th> |
| | 8014 | <td class="description">Size of input string</td></tr> |
| | 8015 | <tr><th>url</th> |
| | 8016 | <td class="description"><code>true</code> for Base64url, <code>false</code> for Base64</td></tr> |
| | 8017 | </tbody></table> |
| | 8018 | <h4 class="returnvalue">Return Value</h4> |
| | 8019 | <p class="description">Encoded string</p> |
| | 8020 | <h4 class="discussion">Discussion</h4> |
| | 8021 | <p class="discussion">This function encodes a Base64 string as defined by RFC 4648. The "url" |
| | 8022 | parameter controls whether the original Base64 ("url" = <code>false</code>) or the |
| | 8023 | Base64url ("url" = <code>true</code>) alphabet is used. |
| | 8024 | |
| | 8025 | </p> |
| | 8026 | <h3 class="function"><a id="httpFieldValue">httpFieldValue</a></h3> |
| | 8027 | <p class="description">Return the HTTP field enumeration value for a field name.</p> |
| | 8028 | <p class="code"> |
| | 8029 | <a href="#http_field_t">http_field_t</a> httpFieldValue(<span class="reserved">const</span> <span class="reserved">char</span> *name);</p> |
| | 8030 | <h4 class="parameters">Parameters</h4> |
| | 8031 | <table class="list"><tbody> |
| | 8032 | <tr><th>name</th> |
| | 8033 | <td class="description">String name</td></tr> |
| | 8034 | </tbody></table> |
| | 8035 | <h4 class="returnvalue">Return Value</h4> |
| | 8036 | <p class="description">Field index</p> |
| | 8037 | <h3 class="function"><a id="httpFlush">httpFlush</a></h3> |
| | 8038 | <p class="description">Flush data read from a HTTP connection.</p> |
| | 8039 | <p class="code"> |
| | 8040 | <span class="reserved">void</span> httpFlush(<a href="#http_t">http_t</a> *http);</p> |
| | 8041 | <h4 class="parameters">Parameters</h4> |
| | 8042 | <table class="list"><tbody> |
| | 8043 | <tr><th>http</th> |
| | 8044 | <td class="description">HTTP connection</td></tr> |
| | 8045 | </tbody></table> |
| | 8046 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpFlushWrite">httpFlushWrite</a></h3> |
| | 8047 | <p class="description">Flush data written to a HTTP connection.</p> |
| | 8048 | <p class="code"> |
| | 8049 | <span class="reserved">int</span> httpFlushWrite(<a href="#http_t">http_t</a> *http);</p> |
| | 8050 | <h4 class="parameters">Parameters</h4> |
| | 8051 | <table class="list"><tbody> |
| | 8052 | <tr><th>http</th> |
| | 8053 | <td class="description">HTTP connection</td></tr> |
| | 8054 | </tbody></table> |
| | 8055 | <h4 class="returnvalue">Return Value</h4> |
| | 8056 | <p class="description">Bytes written or -1 on error</p> |
| | 8057 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetActivity">httpGetActivity</a></h3> |
| | 8058 | <p class="description">Get the most recent activity for a connection.</p> |
| | 8059 | <p class="code"> |
| | 8060 | time_t httpGetActivity(<a href="#http_t">http_t</a> *http);</p> |
| | 8061 | <h4 class="parameters">Parameters</h4> |
| | 8062 | <table class="list"><tbody> |
| | 8063 | <tr><th>http</th> |
| | 8064 | <td class="description">HTTP connection</td></tr> |
| | 8065 | </tbody></table> |
| | 8066 | <h4 class="returnvalue">Return Value</h4> |
| | 8067 | <p class="description">Time of last read or write</p> |
| | 8068 | <h4 class="discussion">Discussion</h4> |
| | 8069 | <p class="discussion">The return value is the time in seconds of the last read or write. |
| | 8070 | |
| | 8071 | </p> |
| | 8072 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetAddress">httpGetAddress</a></h3> |
| | 8073 | <p class="description">Get the address of the connected peer of a connection.</p> |
| | 8074 | <p class="code"> |
| | 8075 | <a href="#http_addr_t">http_addr_t</a> *httpGetAddress(<a href="#http_t">http_t</a> *http);</p> |
| | 8076 | <h4 class="parameters">Parameters</h4> |
| | 8077 | <table class="list"><tbody> |
| | 8078 | <tr><th>http</th> |
| | 8079 | <td class="description">HTTP connection</td></tr> |
| | 8080 | </tbody></table> |
| | 8081 | <h4 class="returnvalue">Return Value</h4> |
| | 8082 | <p class="description">Connected address or <code>NULL</code></p> |
| | 8083 | <h4 class="discussion">Discussion</h4> |
| | 8084 | <p class="discussion">For connections created with <a href="#httpConnect2"><code>httpConnect2</code></a>, the address is for the |
| | 8085 | server. For connections created with <a href="#httpAccept"><code>httpAccept</code></a>, the address is for |
| | 8086 | the client.<br> |
| | 8087 | <br> |
| | 8088 | Returns <code>NULL</code> if the socket is currently unconnected. |
| | 8089 | |
| | 8090 | </p> |
| | 8091 | <h3 class="function"><span class="info"> CUPS 1.3 </span><a id="httpGetAuthString">httpGetAuthString</a></h3> |
| | 8092 | <p class="description">Get the current authorization string.</p> |
| | 8093 | <p class="code"> |
| | 8094 | <span class="reserved">char</span> *httpGetAuthString(<a href="#http_t">http_t</a> *http);</p> |
| | 8095 | <h4 class="parameters">Parameters</h4> |
| | 8096 | <table class="list"><tbody> |
| | 8097 | <tr><th>http</th> |
| | 8098 | <td class="description">HTTP connection</td></tr> |
| | 8099 | </tbody></table> |
| | 8100 | <h4 class="returnvalue">Return Value</h4> |
| | 8101 | <p class="description">Authorization string</p> |
| | 8102 | <h4 class="discussion">Discussion</h4> |
| | 8103 | <p class="discussion">The authorization string is set by <a href="#cupsDoAuthentication"><code>cupsDoAuthentication</code></a> and |
| | 8104 | <a href="#httpSetAuthString"><code>httpSetAuthString</code></a>. Use <a href="#httpGetAuthString"><code>httpGetAuthString</code></a> to retrieve the |
| | 8105 | string to use with <a href="#httpSetField"><code>httpSetField</code></a> for the |
| | 8106 | <code>HTTP_FIELD_AUTHORIZATION</code> value. |
| | 8107 | |
| | 8108 | </p> |
| | 8109 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpGetBlocking">httpGetBlocking</a></h3> |
| | 8110 | <p class="description">Get the blocking/non-blocking state of a connection.</p> |
| | 8111 | <p class="code"> |
| | 8112 | <span class="reserved">int</span> httpGetBlocking(<a href="#http_t">http_t</a> *http);</p> |
| | 8113 | <h4 class="parameters">Parameters</h4> |
| | 8114 | <table class="list"><tbody> |
| | 8115 | <tr><th>http</th> |
| | 8116 | <td class="description">HTTP connection</td></tr> |
| | 8117 | </tbody></table> |
| | 8118 | <h4 class="returnvalue">Return Value</h4> |
| | 8119 | <p class="description">1 if blocking, 0 if non-blocking</p> |
| | 8120 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpGetContentEncoding">httpGetContentEncoding</a></h3> |
| | 8121 | <p class="description">Get a common content encoding, if any, between |
| | 8122 | the client and server.</p> |
| | 8123 | <p class="code"> |
| | 8124 | <span class="reserved">const</span> <span class="reserved">char</span> *httpGetContentEncoding(<a href="#http_t">http_t</a> *http);</p> |
| | 8125 | <h4 class="parameters">Parameters</h4> |
| | 8126 | <table class="list"><tbody> |
| | 8127 | <tr><th>http</th> |
| | 8128 | <td class="description">HTTP connection</td></tr> |
| | 8129 | </tbody></table> |
| | 8130 | <h4 class="returnvalue">Return Value</h4> |
| | 8131 | <p class="description">Content-Coding value or <code>NULL</code> for the identity coding.</p> |
| | 8132 | <h4 class="discussion">Discussion</h4> |
| | 8133 | <p class="discussion">This function uses the value of the Accepts-Encoding HTTP header and must be |
| | 8134 | called after receiving a response from the server or a request from the |
| | 8135 | client. The value returned can be use in subsequent requests (for clients) |
| | 8136 | or in the response (for servers) in order to compress the content stream. |
| | 8137 | |
| | 8138 | </p> |
| | 8139 | <h3 class="function"><span class="info"> CUPS 1.1.19 </span><a id="httpGetCookie">httpGetCookie</a></h3> |
| | 8140 | <p class="description">Get cookie data from the HTTP connection.</p> |
| | 8141 | <p class="code"> |
| | 8142 | <span class="reserved">const</span> <span class="reserved">char</span> *httpGetCookie(<a href="#http_t">http_t</a> *http);</p> |
| | 8143 | <h4 class="parameters">Parameters</h4> |
| | 8144 | <table class="list"><tbody> |
| | 8145 | <tr><th>http</th> |
| | 8146 | <td class="description">HTTP connection</td></tr> |
| | 8147 | </tbody></table> |
| | 8148 | <h4 class="returnvalue">Return Value</h4> |
| | 8149 | <p class="description">Cookie data or <code>NULL</code></p> |
| | 8150 | <h4 class="discussion">Discussion</h4> |
| | 8151 | <p class="discussion">This function returns any HTTP "Set-Cookie:" or "Cookie:" header data for the |
| | 8152 | given HTTP connection as described in RFC 6265. Use the |
| | 8153 | <a href="#httpGetCookieValue"><code>httpGetCookieValue</code></a> to get the value of a named "Cookie:" value. |
| | 8154 | |
| | 8155 | </p> |
| | 8156 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpGetCookieValue">httpGetCookieValue</a></h3> |
| | 8157 | <p class="description">Get the value of a named cookie from the HTTP connection.</p> |
| | 8158 | <p class="code"> |
| | 8159 | <span class="reserved">char</span> *httpGetCookieValue(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">char</span> *buffer, size_t bufsize);</p> |
| | 8160 | <h4 class="parameters">Parameters</h4> |
| | 8161 | <table class="list"><tbody> |
| | 8162 | <tr><th>http</th> |
| | 8163 | <td class="description">HTTP connection</td></tr> |
| | 8164 | <tr><th>name</th> |
| | 8165 | <td class="description">Cookie name</td></tr> |
| | 8166 | <tr><th>buffer</th> |
| | 8167 | <td class="description">Value buffer</td></tr> |
| | 8168 | <tr><th>bufsize</th> |
| | 8169 | <td class="description">Size of value buffer</td></tr> |
| | 8170 | </tbody></table> |
| | 8171 | <h4 class="returnvalue">Return Value</h4> |
| | 8172 | <p class="description">Cookie value or <code>NULL</code> if not present</p> |
| | 8173 | <h4 class="discussion">Discussion</h4> |
| | 8174 | <p class="discussion">This function copies the value of a named cookie in the HTTP "Cookie:" header |
| | 8175 | for the given HTTP connection as described in RFC 6265. Use the |
| | 8176 | <a href="#httpGetCookie"><code>httpGetCookie</code></a> function to get the original "Cookie:" string. |
| | 8177 | |
| | 8178 | </p> |
| | 8179 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpGetDateString2">httpGetDateString2</a></h3> |
| | 8180 | <p class="description">Get a formatted date/time string from a time value.</p> |
| | 8181 | <p class="code"> |
| | 8182 | <span class="reserved">const</span> <span class="reserved">char</span> *httpGetDateString2(time_t t, <span class="reserved">char</span> *s, <span class="reserved">int</span> slen);</p> |
| | 8183 | <h4 class="parameters">Parameters</h4> |
| | 8184 | <table class="list"><tbody> |
| | 8185 | <tr><th>t</th> |
| | 8186 | <td class="description">Time in seconds</td></tr> |
| | 8187 | <tr><th>s</th> |
| | 8188 | <td class="description">String buffer</td></tr> |
| | 8189 | <tr><th>slen</th> |
| | 8190 | <td class="description">Size of string buffer</td></tr> |
| | 8191 | </tbody></table> |
| | 8192 | <h4 class="returnvalue">Return Value</h4> |
| | 8193 | <p class="description">Date/time string</p> |
| | 8194 | <h3 class="function"><a id="httpGetDateTime">httpGetDateTime</a></h3> |
| | 8195 | <p class="description">Get a time value from a formatted date/time string.</p> |
| | 8196 | <p class="code"> |
| | 8197 | time_t httpGetDateTime(<span class="reserved">const</span> <span class="reserved">char</span> *s);</p> |
| | 8198 | <h4 class="parameters">Parameters</h4> |
| | 8199 | <table class="list"><tbody> |
| | 8200 | <tr><th>s</th> |
| | 8201 | <td class="description">Date/time string</td></tr> |
| | 8202 | </tbody></table> |
| | 8203 | <h4 class="returnvalue">Return Value</h4> |
| | 8204 | <p class="description">Time in seconds</p> |
| | 8205 | <h3 class="function"><span class="info"> CUPS 2.0 </span><a id="httpGetEncryption">httpGetEncryption</a></h3> |
| | 8206 | <p class="description">Get the current encryption mode of a connection.</p> |
| | 8207 | <p class="code"> |
| | 8208 | <a href="#http_encryption_t">http_encryption_t</a> httpGetEncryption(<a href="#http_t">http_t</a> *http);</p> |
| | 8209 | <h4 class="parameters">Parameters</h4> |
| | 8210 | <table class="list"><tbody> |
| | 8211 | <tr><th>http</th> |
| | 8212 | <td class="description">HTTP connection</td></tr> |
| | 8213 | </tbody></table> |
| | 8214 | <h4 class="returnvalue">Return Value</h4> |
| | 8215 | <p class="description">Current encryption mode</p> |
| | 8216 | <h4 class="discussion">Discussion</h4> |
| | 8217 | <p class="discussion">This function returns the encryption mode for the connection. Use the |
| | 8218 | <a href="#httpIsEncrypted"><code>httpIsEncrypted</code></a> function to determine whether a TLS session has |
| | 8219 | been established. |
| | 8220 | |
| | 8221 | </p> |
| | 8222 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpGetError">httpGetError</a></h3> |
| | 8223 | <p class="description">Get the last error on a connection.</p> |
| | 8224 | <p class="code"> |
| | 8225 | <span class="reserved">int</span> httpGetError(<a href="#http_t">http_t</a> *http);</p> |
| | 8226 | <h4 class="parameters">Parameters</h4> |
| | 8227 | <table class="list"><tbody> |
| | 8228 | <tr><th>http</th> |
| | 8229 | <td class="description">HTTP connection</td></tr> |
| | 8230 | </tbody></table> |
| | 8231 | <h4 class="returnvalue">Return Value</h4> |
| | 8232 | <p class="description">Error code (errno) value</p> |
| | 8233 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpGetExpect">httpGetExpect</a></h3> |
| | 8234 | <p class="description">Get the value of the Expect header, if any.</p> |
| | 8235 | <p class="code"> |
| | 8236 | http_status_t httpGetExpect(<a href="#http_t">http_t</a> *http);</p> |
| | 8237 | <h4 class="parameters">Parameters</h4> |
| | 8238 | <table class="list"><tbody> |
| | 8239 | <tr><th>http</th> |
| | 8240 | <td class="description">HTTP connection</td></tr> |
| | 8241 | </tbody></table> |
| | 8242 | <h4 class="returnvalue">Return Value</h4> |
| | 8243 | <p class="description">Expect: status, if any</p> |
| | 8244 | <h4 class="discussion">Discussion</h4> |
| | 8245 | <p class="discussion">Returns <code>HTTP_STATUS_NONE</code> if there is no Expect header, otherwise |
| | 8246 | returns the expected HTTP status code, typically <code>HTTP_STATUS_CONTINUE</code>. |
| | 8247 | |
| | 8248 | </p> |
| | 8249 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpGetFd">httpGetFd</a></h3> |
| | 8250 | <p class="description">Get the file descriptor associated with a connection.</p> |
| | 8251 | <p class="code"> |
| | 8252 | <span class="reserved">int</span> httpGetFd(<a href="#http_t">http_t</a> *http);</p> |
| | 8253 | <h4 class="parameters">Parameters</h4> |
| | 8254 | <table class="list"><tbody> |
| | 8255 | <tr><th>http</th> |
| | 8256 | <td class="description">HTTP connection</td></tr> |
| | 8257 | </tbody></table> |
| | 8258 | <h4 class="returnvalue">Return Value</h4> |
| | 8259 | <p class="description">File descriptor or -1 if none</p> |
| | 8260 | <h3 class="function"><a id="httpGetField">httpGetField</a></h3> |
| | 8261 | <p class="description">Get a field value from a request/response.</p> |
| | 8262 | <p class="code"> |
| | 8263 | <span class="reserved">const</span> <span class="reserved">char</span> *httpGetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field);</p> |
| | 8264 | <h4 class="parameters">Parameters</h4> |
| | 8265 | <table class="list"><tbody> |
| | 8266 | <tr><th>http</th> |
| | 8267 | <td class="description">HTTP connection</td></tr> |
| | 8268 | <tr><th>field</th> |
| | 8269 | <td class="description">Field to get</td></tr> |
| | 8270 | </tbody></table> |
| | 8271 | <h4 class="returnvalue">Return Value</h4> |
| | 8272 | <p class="description">Field value</p> |
| | 8273 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpGetHostname">httpGetHostname</a></h3> |
| | 8274 | <p class="description">Get the FQDN for the connection or local system.</p> |
| | 8275 | <p class="code"> |
| | 8276 | <span class="reserved">const</span> <span class="reserved">char</span> *httpGetHostname(<a href="#http_t">http_t</a> *http, <span class="reserved">char</span> *s, <span class="reserved">int</span> slen);</p> |
| | 8277 | <h4 class="parameters">Parameters</h4> |
| | 8278 | <table class="list"><tbody> |
| | 8279 | <tr><th>http</th> |
| | 8280 | <td class="description">HTTP connection or NULL</td></tr> |
| | 8281 | <tr><th>s</th> |
| | 8282 | <td class="description">String buffer for name</td></tr> |
| | 8283 | <tr><th>slen</th> |
| | 8284 | <td class="description">Size of buffer</td></tr> |
| | 8285 | </tbody></table> |
| | 8286 | <h4 class="returnvalue">Return Value</h4> |
| | 8287 | <p class="description">FQDN for connection or system</p> |
| | 8288 | <h4 class="discussion">Discussion</h4> |
| | 8289 | <p class="discussion">When "http" points to a connected socket, return the hostname or |
| | 8290 | address that was used in the call to httpConnect() or httpConnectEncrypt(), |
| | 8291 | or the address of the client for the connection from httpAcceptConnection(). |
| | 8292 | Otherwise, return the FQDN for the local system using both gethostname() |
| | 8293 | and gethostbyname() to get the local hostname with domain. |
| | 8294 | |
| | 8295 | </p> |
| | 8296 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetKeepAlive">httpGetKeepAlive</a></h3> |
| | 8297 | <p class="description">Get the current Keep-Alive state of the connection.</p> |
| | 8298 | <p class="code"> |
| | 8299 | <a href="#http_keepalive_t">http_keepalive_t</a> httpGetKeepAlive(<a href="#http_t">http_t</a> *http);</p> |
| | 8300 | <h4 class="parameters">Parameters</h4> |
| | 8301 | <table class="list"><tbody> |
| | 8302 | <tr><th>http</th> |
| | 8303 | <td class="description">HTTP connection</td></tr> |
| | 8304 | </tbody></table> |
| | 8305 | <h4 class="returnvalue">Return Value</h4> |
| | 8306 | <p class="description">Keep-Alive state</p> |
| | 8307 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpGetLength2">httpGetLength2</a></h3> |
| | 8308 | <p class="description">Get the amount of data remaining from the Content-Length or Transfer-Encoding fields.</p> |
| | 8309 | <p class="code"> |
| | 8310 | off_t httpGetLength2(<a href="#http_t">http_t</a> *http);</p> |
| | 8311 | <h4 class="parameters">Parameters</h4> |
| | 8312 | <table class="list"><tbody> |
| | 8313 | <tr><th>http</th> |
| | 8314 | <td class="description">HTTP connection</td></tr> |
| | 8315 | </tbody></table> |
| | 8316 | <h4 class="returnvalue">Return Value</h4> |
| | 8317 | <p class="description">Content length</p> |
| | 8318 | <h4 class="discussion">Discussion</h4> |
| | 8319 | <p class="discussion">This function returns the complete content length, even for |
| | 8320 | content larger than 2^31 - 1. |
| | 8321 | |
| | 8322 | </p> |
| | 8323 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetPending">httpGetPending</a></h3> |
| | 8324 | <p class="description">Get the number of bytes that are buffered for writing.</p> |
| | 8325 | <p class="code"> |
| | 8326 | size_t httpGetPending(<a href="#http_t">http_t</a> *http);</p> |
| | 8327 | <h4 class="parameters">Parameters</h4> |
| | 8328 | <table class="list"><tbody> |
| | 8329 | <tr><th>http</th> |
| | 8330 | <td class="description">HTTP connection</td></tr> |
| | 8331 | </tbody></table> |
| | 8332 | <h4 class="returnvalue">Return Value</h4> |
| | 8333 | <p class="description">Number of bytes buffered</p> |
| | 8334 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetReady">httpGetReady</a></h3> |
| | 8335 | <p class="description">Get the number of bytes that can be read without blocking.</p> |
| | 8336 | <p class="code"> |
| | 8337 | size_t httpGetReady(<a href="#http_t">http_t</a> *http);</p> |
| | 8338 | <h4 class="parameters">Parameters</h4> |
| | 8339 | <table class="list"><tbody> |
| | 8340 | <tr><th>http</th> |
| | 8341 | <td class="description">HTTP connection</td></tr> |
| | 8342 | </tbody></table> |
| | 8343 | <h4 class="returnvalue">Return Value</h4> |
| | 8344 | <p class="description">Number of bytes available</p> |
| | 8345 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetRemaining">httpGetRemaining</a></h3> |
| | 8346 | <p class="description">Get the number of remaining bytes in the message body or current chunk.</p> |
| | 8347 | <p class="code"> |
| | 8348 | size_t httpGetRemaining(<a href="#http_t">http_t</a> *http);</p> |
| | 8349 | <h4 class="parameters">Parameters</h4> |
| | 8350 | <table class="list"><tbody> |
| | 8351 | <tr><th>http</th> |
| | 8352 | <td class="description">HTTP connection</td></tr> |
| | 8353 | </tbody></table> |
| | 8354 | <h4 class="returnvalue">Return Value</h4> |
| | 8355 | <p class="description">Remaining bytes</p> |
| | 8356 | <h4 class="discussion">Discussion</h4> |
| | 8357 | <p class="discussion">The <a href="#httpIsChunked"><code>httpIsChunked</code></a> function can be used to determine whether the |
| | 8358 | message body is chunked or fixed-length. |
| | 8359 | |
| | 8360 | </p> |
| | 8361 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpGetSecurity">httpGetSecurity</a></h3> |
| | 8362 | <p class="description">Get the TLS version and cipher suite used by a connection.</p> |
| | 8363 | <p class="code"> |
| | 8364 | <span class="reserved">const</span> <span class="reserved">char</span> *httpGetSecurity(<a href="#http_t">http_t</a> *http, <span class="reserved">char</span> *buffer, size_t bufsize);</p> |
| | 8365 | <h4 class="parameters">Parameters</h4> |
| | 8366 | <table class="list"><tbody> |
| | 8367 | <tr><th>http</th> |
| | 8368 | <td class="description">HTTP connection</td></tr> |
| | 8369 | <tr><th>buffer</th> |
| | 8370 | <td class="description">String buffer</td></tr> |
| | 8371 | <tr><th>bufsize</th> |
| | 8372 | <td class="description">Size of buffer</td></tr> |
| | 8373 | </tbody></table> |
| | 8374 | <h4 class="returnvalue">Return Value</h4> |
| | 8375 | <p class="description">Security information or <code>NULL</code> if not encrypted</p> |
| | 8376 | <h4 class="discussion">Discussion</h4> |
| | 8377 | <p class="discussion">This function gets the TLS version and cipher suite being used by a |
| | 8378 | connection, if any. The string is copied to "buffer" and is of the form |
| | 8379 | "TLS/major.minor CipherSuite". If not encrypted, the buffer is cleared to |
| | 8380 | the empty string. |
| | 8381 | |
| | 8382 | </p> |
| | 8383 | <h3 class="function"><a id="httpGetState">httpGetState</a></h3> |
| | 8384 | <p class="description">Get the current state of the HTTP request.</p> |
| | 8385 | <p class="code"> |
| | 8386 | <a href="#http_state_t">http_state_t</a> httpGetState(<a href="#http_t">http_t</a> *http);</p> |
| | 8387 | <h4 class="parameters">Parameters</h4> |
| | 8388 | <table class="list"><tbody> |
| | 8389 | <tr><th>http</th> |
| | 8390 | <td class="description">HTTP connection</td></tr> |
| | 8391 | </tbody></table> |
| | 8392 | <h4 class="returnvalue">Return Value</h4> |
| | 8393 | <p class="description">HTTP state</p> |
| | 8394 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpGetStatus">httpGetStatus</a></h3> |
| | 8395 | <p class="description">Get the status of the last HTTP request.</p> |
| | 8396 | <p class="code"> |
| | 8397 | http_status_t httpGetStatus(<a href="#http_t">http_t</a> *http);</p> |
| | 8398 | <h4 class="parameters">Parameters</h4> |
| | 8399 | <table class="list"><tbody> |
| | 8400 | <tr><th>http</th> |
| | 8401 | <td class="description">HTTP connection</td></tr> |
| | 8402 | </tbody></table> |
| | 8403 | <h4 class="returnvalue">Return Value</h4> |
| | 8404 | <p class="description">HTTP status</p> |
| | 8405 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpGetSubField2">httpGetSubField2</a></h3> |
| | 8406 | <p class="description">Get a sub-field value.</p> |
| | 8407 | <p class="code"> |
| | 8408 | <span class="reserved">char</span> *httpGetSubField2(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">char</span> *value, <span class="reserved">int</span> valuelen);</p> |
| | 8409 | <h4 class="parameters">Parameters</h4> |
| | 8410 | <table class="list"><tbody> |
| | 8411 | <tr><th>http</th> |
| | 8412 | <td class="description">HTTP connection</td></tr> |
| | 8413 | <tr><th>field</th> |
| | 8414 | <td class="description">Field index</td></tr> |
| | 8415 | <tr><th>name</th> |
| | 8416 | <td class="description">Name of sub-field</td></tr> |
| | 8417 | <tr><th>value</th> |
| | 8418 | <td class="description">Value string</td></tr> |
| | 8419 | <tr><th>valuelen</th> |
| | 8420 | <td class="description">Size of value buffer</td></tr> |
| | 8421 | </tbody></table> |
| | 8422 | <h4 class="returnvalue">Return Value</h4> |
| | 8423 | <p class="description">Value or <code>NULL</code></p> |
| | 8424 | <h3 class="function"><a id="httpGetVersion">httpGetVersion</a></h3> |
| | 8425 | <p class="description">Get the HTTP version at the other end.</p> |
| | 8426 | <p class="code"> |
| | 8427 | <a href="#http_version_t">http_version_t</a> httpGetVersion(<a href="#http_t">http_t</a> *http);</p> |
| | 8428 | <h4 class="parameters">Parameters</h4> |
| | 8429 | <table class="list"><tbody> |
| | 8430 | <tr><th>http</th> |
| | 8431 | <td class="description">HTTP connection</td></tr> |
| | 8432 | </tbody></table> |
| | 8433 | <h4 class="returnvalue">Return Value</h4> |
| | 8434 | <p class="description">Version number</p> |
| | 8435 | <h3 class="function"><a id="httpGets2">httpGets2</a></h3> |
| | 8436 | <p class="description">Get a line of text from a HTTP connection.</p> |
| | 8437 | <p class="code"> |
| | 8438 | <span class="reserved">char</span> *httpGets2(<a href="#http_t">http_t</a> *http, <span class="reserved">char</span> *line, size_t length);</p> |
| | 8439 | <h4 class="parameters">Parameters</h4> |
| | 8440 | <table class="list"><tbody> |
| | 8441 | <tr><th>http</th> |
| | 8442 | <td class="description">HTTP connection</td></tr> |
| | 8443 | <tr><th>line</th> |
| | 8444 | <td class="description">Line to read into</td></tr> |
| | 8445 | <tr><th>length</th> |
| | 8446 | <td class="description">Max length of buffer</td></tr> |
| | 8447 | </tbody></table> |
| | 8448 | <h4 class="returnvalue">Return Value</h4> |
| | 8449 | <p class="description">Line or <code>NULL</code></p> |
| | 8450 | <h3 class="function"><a id="httpInitialize">httpInitialize</a></h3> |
| | 8451 | <p class="description">Initialize the HTTP interface library and set the |
| | 8452 | default HTTP proxy (if any).</p> |
| | 8453 | <p class="code"> |
| | 8454 | <span class="reserved">void</span> httpInitialize(<span class="reserved">void</span>);</p> |
| | 8455 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpIsChunked">httpIsChunked</a></h3> |
| | 8456 | <p class="description">Report whether a message body is chunked.</p> |
| | 8457 | <p class="code"> |
| | 8458 | <span class="reserved">int</span> httpIsChunked(<a href="#http_t">http_t</a> *http);</p> |
| | 8459 | <h4 class="parameters">Parameters</h4> |
| | 8460 | <table class="list"><tbody> |
| | 8461 | <tr><th>http</th> |
| | 8462 | <td class="description">HTTP connection</td></tr> |
| | 8463 | </tbody></table> |
| | 8464 | <h4 class="returnvalue">Return Value</h4> |
| | 8465 | <p class="description">1 if chunked, 0 if not</p> |
| | 8466 | <h4 class="discussion">Discussion</h4> |
| | 8467 | <p class="discussion">This function returns non-zero if the message body is composed of |
| | 8468 | variable-length chunks. |
| | 8469 | |
| | 8470 | </p> |
| | 8471 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpIsEncrypted">httpIsEncrypted</a></h3> |
| | 8472 | <p class="description">Report whether a connection is encrypted.</p> |
| | 8473 | <p class="code"> |
| | 8474 | <span class="reserved">int</span> httpIsEncrypted(<a href="#http_t">http_t</a> *http);</p> |
| | 8475 | <h4 class="parameters">Parameters</h4> |
| | 8476 | <table class="list"><tbody> |
| | 8477 | <tr><th>http</th> |
| | 8478 | <td class="description">HTTP connection</td></tr> |
| | 8479 | </tbody></table> |
| | 8480 | <h4 class="returnvalue">Return Value</h4> |
| | 8481 | <p class="description">1 if encrypted, 0 if not</p> |
| | 8482 | <h4 class="discussion">Discussion</h4> |
| | 8483 | <p class="discussion">This function returns non-zero if the connection is currently encrypted. |
| | 8484 | |
| | 8485 | </p> |
| | 8486 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="httpMD5">httpMD5</a></h3> |
| | 8487 | <p class="description">Compute the MD5 sum of the username:group:password.</p> |
| | 8488 | <p class="code"> |
| | 8489 | <span class="reserved">char</span> *httpMD5(<span class="reserved">const</span> <span class="reserved">char</span> *username, <span class="reserved">const</span> <span class="reserved">char</span> *realm, <span class="reserved">const</span> <span class="reserved">char</span> *passwd, <span class="reserved">char</span> md5[33]);</p> |
| | 8490 | <h4 class="parameters">Parameters</h4> |
| | 8491 | <table class="list"><tbody> |
| | 8492 | <tr><th>username</th> |
| | 8493 | <td class="description">User name</td></tr> |
| | 8494 | <tr><th>realm</th> |
| | 8495 | <td class="description">Realm name</td></tr> |
| | 8496 | <tr><th>passwd</th> |
| | 8497 | <td class="description">Password string</td></tr> |
| | 8498 | <tr><th>md5[33]</th> |
| | 8499 | <td class="description">MD5 string</td></tr> |
| | 8500 | </tbody></table> |
| | 8501 | <h4 class="returnvalue">Return Value</h4> |
| | 8502 | <p class="description">MD5 sum</p> |
| | 8503 | <h4 class="discussion">Discussion</h4> |
| | 8504 | <p class="discussion">The function was used for HTTP Digest authentication. Since CUPS 2.4.0 |
| | 8505 | it produces an empty string. Please use <a href="#cupsDoAuthentication"><code>cupsDoAuthentication</code></a> instead. |
| | 8506 | |
| | 8507 | </p> |
| | 8508 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="httpMD5Final">httpMD5Final</a></h3> |
| | 8509 | <p class="description">Combine the MD5 sum of the username, group, and password |
| | 8510 | with the server-supplied nonce value, method, and |
| | 8511 | request-uri.</p> |
| | 8512 | <p class="code"> |
| | 8513 | <span class="reserved">char</span> *httpMD5Final(<span class="reserved">const</span> <span class="reserved">char</span> *nonce, <span class="reserved">const</span> <span class="reserved">char</span> *method, <span class="reserved">const</span> <span class="reserved">char</span> *resource, <span class="reserved">char</span> md5[33]);</p> |
| | 8514 | <h4 class="parameters">Parameters</h4> |
| | 8515 | <table class="list"><tbody> |
| | 8516 | <tr><th>nonce</th> |
| | 8517 | <td class="description">Server nonce value</td></tr> |
| | 8518 | <tr><th>method</th> |
| | 8519 | <td class="description">METHOD (GET, POST, etc.)</td></tr> |
| | 8520 | <tr><th>resource</th> |
| | 8521 | <td class="description">Resource path</td></tr> |
| | 8522 | <tr><th>md5[33]</th> |
| | 8523 | <td class="description">MD5 sum</td></tr> |
| | 8524 | </tbody></table> |
| | 8525 | <h4 class="returnvalue">Return Value</h4> |
| | 8526 | <p class="description">New sum</p> |
| | 8527 | <h4 class="discussion">Discussion</h4> |
| | 8528 | <p class="discussion">The function was used for HTTP Digest authentication. Since CUPS 2.4.0 |
| | 8529 | it produces an empty string. Please use <a href="#cupsDoAuthentication"><code>cupsDoAuthentication</code></a> instead. |
| | 8530 | |
| | 8531 | </p> |
| | 8532 | <h3 class="function"><span class="info"> DEPRECATED </span><a id="httpMD5String">httpMD5String</a></h3> |
| | 8533 | <p class="description">Convert an MD5 sum to a character string.</p> |
| | 8534 | <p class="code"> |
| | 8535 | <span class="reserved">char</span> *httpMD5String(<span class="reserved">const</span> <span class="reserved">unsigned</span> <span class="reserved">char</span> *sum, <span class="reserved">char</span> md5[33]);</p> |
| | 8536 | <h4 class="parameters">Parameters</h4> |
| | 8537 | <table class="list"><tbody> |
| | 8538 | <tr><th>sum</th> |
| | 8539 | <td class="description">MD5 sum data</td></tr> |
| | 8540 | <tr><th>md5[33]</th> |
| | 8541 | <td class="description">MD5 sum in hex</td></tr> |
| | 8542 | </tbody></table> |
| | 8543 | <h4 class="returnvalue">Return Value</h4> |
| | 8544 | <p class="description">MD5 sum in hex</p> |
| | 8545 | <h4 class="discussion">Discussion</h4> |
| | 8546 | <p class="discussion">The function was used for HTTP Digest authentication. Since CUPS 2.4.0 |
| | 8547 | it produces an empty string. Please use <a href="#cupsDoAuthentication"><code>cupsDoAuthentication</code></a> instead. |
| | 8548 | |
| | 8549 | </p> |
| | 8550 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpPeek">httpPeek</a></h3> |
| | 8551 | <p class="description">Peek at data from a HTTP connection.</p> |
| | 8552 | <p class="code"> |
| | 8553 | ssize_t httpPeek(<a href="#http_t">http_t</a> *http, <span class="reserved">char</span> *buffer, size_t length);</p> |
| | 8554 | <h4 class="parameters">Parameters</h4> |
| | 8555 | <table class="list"><tbody> |
| | 8556 | <tr><th>http</th> |
| | 8557 | <td class="description">HTTP connection</td></tr> |
| | 8558 | <tr><th>buffer</th> |
| | 8559 | <td class="description">Buffer for data</td></tr> |
| | 8560 | <tr><th>length</th> |
| | 8561 | <td class="description">Maximum number of bytes</td></tr> |
| | 8562 | </tbody></table> |
| | 8563 | <h4 class="returnvalue">Return Value</h4> |
| | 8564 | <p class="description">Number of bytes copied</p> |
| | 8565 | <h4 class="discussion">Discussion</h4> |
| | 8566 | <p class="discussion">This function copies available data from the given HTTP connection, reading |
| | 8567 | a buffer as needed. The data is still available for reading using |
| | 8568 | <a href="#httpRead2"><code>httpRead2</code></a>.<br> |
| | 8569 | <br> |
| | 8570 | For non-blocking connections the usual timeouts apply. |
| | 8571 | |
| | 8572 | </p> |
| | 8573 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpRead2">httpRead2</a></h3> |
| | 8574 | <p class="description">Read data from a HTTP connection.</p> |
| | 8575 | <p class="code"> |
| | 8576 | ssize_t httpRead2(<a href="#http_t">http_t</a> *http, <span class="reserved">char</span> *buffer, size_t length);</p> |
| | 8577 | <h4 class="parameters">Parameters</h4> |
| | 8578 | <table class="list"><tbody> |
| | 8579 | <tr><th>http</th> |
| | 8580 | <td class="description">HTTP connection</td></tr> |
| | 8581 | <tr><th>buffer</th> |
| | 8582 | <td class="description">Buffer for data</td></tr> |
| | 8583 | <tr><th>length</th> |
| | 8584 | <td class="description">Maximum number of bytes</td></tr> |
| | 8585 | </tbody></table> |
| | 8586 | <h4 class="returnvalue">Return Value</h4> |
| | 8587 | <p class="description">Number of bytes read</p> |
| | 8588 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpReadRequest">httpReadRequest</a></h3> |
| | 8589 | <p class="description">Read a HTTP request from a connection.</p> |
| | 8590 | <p class="code"> |
| | 8591 | <a href="#http_state_t">http_state_t</a> httpReadRequest(<a href="#http_t">http_t</a> *http, <span class="reserved">char</span> *uri, size_t urilen);</p> |
| | 8592 | <h4 class="parameters">Parameters</h4> |
| | 8593 | <table class="list"><tbody> |
| | 8594 | <tr><th>http</th> |
| | 8595 | <td class="description">HTTP connection</td></tr> |
| | 8596 | <tr><th>uri</th> |
| | 8597 | <td class="description">URI buffer</td></tr> |
| | 8598 | <tr><th>urilen</th> |
| | 8599 | <td class="description">Size of URI buffer</td></tr> |
| | 8600 | </tbody></table> |
| | 8601 | <h4 class="returnvalue">Return Value</h4> |
| | 8602 | <p class="description">New state of connection</p> |
| | 8603 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpResolveHostname">httpResolveHostname</a></h3> |
| | 8604 | <p class="description">Resolve the hostname of the HTTP connection |
| | 8605 | address.</p> |
| | 8606 | <p class="code"> |
| | 8607 | <span class="reserved">const</span> <span class="reserved">char</span> *httpResolveHostname(<a href="#http_t">http_t</a> *http, <span class="reserved">char</span> *buffer, size_t bufsize);</p> |
| | 8608 | <h4 class="parameters">Parameters</h4> |
| | 8609 | <table class="list"><tbody> |
| | 8610 | <tr><th>http</th> |
| | 8611 | <td class="description">HTTP connection</td></tr> |
| | 8612 | <tr><th>buffer</th> |
| | 8613 | <td class="description">Hostname buffer</td></tr> |
| | 8614 | <tr><th>bufsize</th> |
| | 8615 | <td class="description">Size of buffer</td></tr> |
| | 8616 | </tbody></table> |
| | 8617 | <h4 class="returnvalue">Return Value</h4> |
| | 8618 | <p class="description">Resolved hostname or <code>NULL</code></p> |
| | 8619 | <h3 class="function"><a id="httpResolveURI">httpResolveURI</a></h3> |
| | 8620 | <p class="description">Resolve a DNS-SD URI.</p> |
| | 8621 | <p class="code"> |
| | 8622 | <span class="reserved">const</span> <span class="reserved">char</span> *httpResolveURI(<span class="reserved">const</span> <span class="reserved">char</span> *uri, <span class="reserved">char</span> *resolved_uri, size_t resolved_size, <a href="#http_resolve_t">http_resolve_t</a> options, <a href="#http_resolve_cb_t">http_resolve_cb_t</a> cb, <span class="reserved">void</span> *cb_data);</p> |
| | 8623 | <h4 class="parameters">Parameters</h4> |
| | 8624 | <table class="list"><tbody> |
| | 8625 | <tr><th>uri</th> |
| | 8626 | <td class="description">DNS-SD URI</td></tr> |
| | 8627 | <tr><th>resolved_uri</th> |
| | 8628 | <td class="description">Buffer for resolved URI</td></tr> |
| | 8629 | <tr><th>resolved_size</th> |
| | 8630 | <td class="description">Size of URI buffer</td></tr> |
| | 8631 | <tr><th>options</th> |
| | 8632 | <td class="description">Resolve options</td></tr> |
| | 8633 | <tr><th>cb</th> |
| | 8634 | <td class="description">Continue callback function</td></tr> |
| | 8635 | <tr><th>cb_data</th> |
| | 8636 | <td class="description">Context pointer for callback</td></tr> |
| | 8637 | </tbody></table> |
| | 8638 | <h4 class="returnvalue">Return Value</h4> |
| | 8639 | <p class="description">Resolved URI</p> |
| | 8640 | <h4 class="discussion">Discussion</h4> |
| | 8641 | <p class="discussion">This function resolves a DNS-SD URI of the form |
| | 8642 | "scheme://service-instance-name._protocol._tcp.domain/...". The "options" |
| | 8643 | parameter specifies a bitfield of resolution options including: |
| | 8644 | |
| | 8645 | </p><ul> |
| | 8646 | <li><code>HTTP_RESOLVE_DEFAULT</code>: Use default options |
| | 8647 | </li> |
| | 8648 | <li><code>HTTP_RESOLVE_FQDN</code>: Resolve the fully-qualified domain name instead of an IP address |
| | 8649 | </li> |
| | 8650 | <li><code>HTTP_RESOLVE_FAXOUT</code>: Resolve the FaxOut service instead of Print (IPP/IPPS)</li> |
| | 8651 | </ul> |
| | 8652 | <p class="discussion">The "cb" parameter specifies a callback that allows resolution to be |
| | 8653 | terminated. The callback is provided the "cb_data" value and returns a |
| | 8654 | <code>bool</code> value that is <code>true</code> to continue and <code>false</code> to stop. If no callback |
| | 8655 | is specified ("cb" is <code>NULL</code>), then this function will block up to 90 seconds |
| | 8656 | to resolve the specified URI.</p> |
| | 8657 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpSeparateURI">httpSeparateURI</a></h3> |
| | 8658 | <p class="description">Separate a Universal Resource Identifier into its |
| | 8659 | components.</p> |
| | 8660 | <p class="code"> |
| | 8661 | <a href="#http_uri_status_t">http_uri_status_t</a> httpSeparateURI(<a href="#http_uri_coding_t">http_uri_coding_t</a> decoding, <span class="reserved">const</span> <span class="reserved">char</span> *uri, <span class="reserved">char</span> *scheme, <span class="reserved">int</span> schemelen, <span class="reserved">char</span> *username, <span class="reserved">int</span> usernamelen, <span class="reserved">char</span> *host, <span class="reserved">int</span> hostlen, <span class="reserved">int</span> *port, <span class="reserved">char</span> *resource, <span class="reserved">int</span> resourcelen);</p> |
| | 8662 | <h4 class="parameters">Parameters</h4> |
| | 8663 | <table class="list"><tbody> |
| | 8664 | <tr><th>decoding</th> |
| | 8665 | <td class="description">Decoding flags</td></tr> |
| | 8666 | <tr><th>uri</th> |
| | 8667 | <td class="description">Universal Resource Identifier</td></tr> |
| | 8668 | <tr><th>scheme</th> |
| | 8669 | <td class="description">Scheme (http, https, etc.)</td></tr> |
| | 8670 | <tr><th>schemelen</th> |
| | 8671 | <td class="description">Size of scheme buffer</td></tr> |
| | 8672 | <tr><th>username</th> |
| | 8673 | <td class="description">Username</td></tr> |
| | 8674 | <tr><th>usernamelen</th> |
| | 8675 | <td class="description">Size of username buffer</td></tr> |
| | 8676 | <tr><th>host</th> |
| | 8677 | <td class="description">Hostname</td></tr> |
| | 8678 | <tr><th>hostlen</th> |
| | 8679 | <td class="description">Size of hostname buffer</td></tr> |
| | 8680 | <tr><th>port</th> |
| | 8681 | <td class="description">Port number to use</td></tr> |
| | 8682 | <tr><th>resource</th> |
| | 8683 | <td class="description">Resource/filename</td></tr> |
| | 8684 | <tr><th>resourcelen</th> |
| | 8685 | <td class="description">Size of resource buffer</td></tr> |
| | 8686 | </tbody></table> |
| | 8687 | <h4 class="returnvalue">Return Value</h4> |
| | 8688 | <p class="description">Result of separation</p> |
| | 8689 | <h3 class="function"><span class="info"> CUPS 1.3 </span><a id="httpSetAuthString">httpSetAuthString</a></h3> |
| | 8690 | <p class="description">Set the current authorization string.</p> |
| | 8691 | <p class="code"> |
| | 8692 | <span class="reserved">void</span> httpSetAuthString(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *scheme, <span class="reserved">const</span> <span class="reserved">char</span> *data);</p> |
| | 8693 | <h4 class="parameters">Parameters</h4> |
| | 8694 | <table class="list"><tbody> |
| | 8695 | <tr><th>http</th> |
| | 8696 | <td class="description">HTTP connection</td></tr> |
| | 8697 | <tr><th>scheme</th> |
| | 8698 | <td class="description">Auth scheme (NULL to clear it)</td></tr> |
| | 8699 | <tr><th>data</th> |
| | 8700 | <td class="description">Auth data (NULL for none)</td></tr> |
| | 8701 | </tbody></table> |
| | 8702 | <h4 class="discussion">Discussion</h4> |
| | 8703 | <p class="discussion">This function just stores a copy of the current authorization string in |
| | 8704 | the HTTP connection object. You must still call <a href="#httpSetField"><code>httpSetField</code></a> to set |
| | 8705 | <code>HTTP_FIELD_AUTHORIZATION</code> prior to issuing a HTTP request using |
| | 8706 | <a href="#httpWriteRequest"><code>httpWriteRequest</code></a>. |
| | 8707 | |
| | 8708 | </p> |
| | 8709 | <h3 class="function"><a id="httpSetBlocking">httpSetBlocking</a></h3> |
| | 8710 | <p class="description">Set blocking/non-blocking behavior on a connection.</p> |
| | 8711 | <p class="code"> |
| | 8712 | <span class="reserved">void</span> httpSetBlocking(<a href="#http_t">http_t</a> *http, <span class="reserved">bool</span> b);</p> |
| | 8713 | <h4 class="parameters">Parameters</h4> |
| | 8714 | <table class="list"><tbody> |
| | 8715 | <tr><th>http</th> |
| | 8716 | <td class="description">HTTP connection</td></tr> |
| | 8717 | <tr><th>b</th> |
| | 8718 | <td class="description"><code>true</code> for blocking, <code>false</code> for non-blocking</td></tr> |
| | 8719 | </tbody></table> |
| | 8720 | <h3 class="function"><span class="info"> CUPS 1.1.19 </span><a id="httpSetCookie">httpSetCookie</a></h3> |
| | 8721 | <p class="description">Add Set-Cookie value(s).</p> |
| | 8722 | <p class="code"> |
| | 8723 | <span class="reserved">void</span> httpSetCookie(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *cookie);</p> |
| | 8724 | <h4 class="parameters">Parameters</h4> |
| | 8725 | <table class="list"><tbody> |
| | 8726 | <tr><th>http</th> |
| | 8727 | <td class="description">HTTP cnnection</td></tr> |
| | 8728 | <tr><th>cookie</th> |
| | 8729 | <td class="description">Cookie string</td></tr> |
| | 8730 | </tbody></table> |
| | 8731 | <h4 class="discussion">Discussion</h4> |
| | 8732 | <p class="discussion">This function adds one or more Set-Cookie header values that will be sent to |
| | 8733 | the client with the <a href="#httpWriteResponse"><code>httpWriteResponse</code></a> function. Each value conforms |
| | 8734 | to the format defined in RFC 6265. Multiple values can be passed in the |
| | 8735 | "cookie" string separated by a newline character.<br> |
| | 8736 | <br> |
| | 8737 | Call the <a href="#httpClearCookies"><code>httpClearCookies</code></a> function to clear all Set-Cookie values. |
| | 8738 | |
| | 8739 | </p> |
| | 8740 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpSetDefaultField">httpSetDefaultField</a></h3> |
| | 8741 | <p class="description">Set the default value of an HTTP header.</p> |
| | 8742 | <p class="code"> |
| | 8743 | <span class="reserved">void</span> httpSetDefaultField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 8744 | <h4 class="parameters">Parameters</h4> |
| | 8745 | <table class="list"><tbody> |
| | 8746 | <tr><th>http</th> |
| | 8747 | <td class="description">HTTP connection</td></tr> |
| | 8748 | <tr><th>field</th> |
| | 8749 | <td class="description">Field index</td></tr> |
| | 8750 | <tr><th>value</th> |
| | 8751 | <td class="description">Value</td></tr> |
| | 8752 | </tbody></table> |
| | 8753 | <h4 class="discussion">Discussion</h4> |
| | 8754 | <p class="discussion">Currently only <code>HTTP_FIELD_ACCEPT_ENCODING</code>, <code>HTTP_FIELD_SERVER</code>, |
| | 8755 | and <code>HTTP_FIELD_USER_AGENT</code> can be set. |
| | 8756 | |
| | 8757 | </p> |
| | 8758 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpSetEncryption">httpSetEncryption</a></h3> |
| | 8759 | <p class="description">Set the required encryption on the link.</p> |
| | 8760 | <p class="code"> |
| | 8761 | <span class="reserved">bool</span> httpSetEncryption(<a href="#http_t">http_t</a> *http, <a href="#http_encryption_t">http_encryption_t</a> e);</p> |
| | 8762 | <h4 class="parameters">Parameters</h4> |
| | 8763 | <table class="list"><tbody> |
| | 8764 | <tr><th>http</th> |
| | 8765 | <td class="description">HTTP connection</td></tr> |
| | 8766 | <tr><th>e</th> |
| | 8767 | <td class="description">New encryption preference</td></tr> |
| | 8768 | </tbody></table> |
| | 8769 | <h4 class="returnvalue">Return Value</h4> |
| | 8770 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 8771 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpSetExpect">httpSetExpect</a></h3> |
| | 8772 | <p class="description">Set the Expect: header in a request.</p> |
| | 8773 | <p class="code"> |
| | 8774 | <span class="reserved">void</span> httpSetExpect(<a href="#http_t">http_t</a> *http, http_status_t expect);</p> |
| | 8775 | <h4 class="parameters">Parameters</h4> |
| | 8776 | <table class="list"><tbody> |
| | 8777 | <tr><th>http</th> |
| | 8778 | <td class="description">HTTP connection</td></tr> |
| | 8779 | <tr><th>expect</th> |
| | 8780 | <td class="description">HTTP status to expect (<code>HTTP_STATUS_CONTINUE</code>)</td></tr> |
| | 8781 | </tbody></table> |
| | 8782 | <h4 class="discussion">Discussion</h4> |
| | 8783 | <p class="discussion">Currently only <code>HTTP_STATUS_CONTINUE</code> is supported for the "expect" |
| | 8784 | argument. |
| | 8785 | |
| | 8786 | </p> |
| | 8787 | <h3 class="function"><a id="httpSetField">httpSetField</a></h3> |
| | 8788 | <p class="description">Set the value of an HTTP header.</p> |
| | 8789 | <p class="code"> |
| | 8790 | <span class="reserved">void</span> httpSetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 8791 | <h4 class="parameters">Parameters</h4> |
| | 8792 | <table class="list"><tbody> |
| | 8793 | <tr><th>http</th> |
| | 8794 | <td class="description">HTTP connection</td></tr> |
| | 8795 | <tr><th>field</th> |
| | 8796 | <td class="description">Field index</td></tr> |
| | 8797 | <tr><th>value</th> |
| | 8798 | <td class="description">Value</td></tr> |
| | 8799 | </tbody></table> |
| | 8800 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpSetKeepAlive">httpSetKeepAlive</a></h3> |
| | 8801 | <p class="description">Set the current Keep-Alive state of a connection.</p> |
| | 8802 | <p class="code"> |
| | 8803 | <span class="reserved">void</span> httpSetKeepAlive(<a href="#http_t">http_t</a> *http, <a href="#http_keepalive_t">http_keepalive_t</a> keep_alive);</p> |
| | 8804 | <h4 class="parameters">Parameters</h4> |
| | 8805 | <table class="list"><tbody> |
| | 8806 | <tr><th>http</th> |
| | 8807 | <td class="description">HTTP connection</td></tr> |
| | 8808 | <tr><th>keep_alive</th> |
| | 8809 | <td class="description">New Keep-Alive value</td></tr> |
| | 8810 | </tbody></table> |
| | 8811 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpSetLength">httpSetLength</a></h3> |
| | 8812 | <p class="description">Set the content-length and content-encoding.</p> |
| | 8813 | <p class="code"> |
| | 8814 | <span class="reserved">void</span> httpSetLength(<a href="#http_t">http_t</a> *http, size_t length);</p> |
| | 8815 | <h4 class="parameters">Parameters</h4> |
| | 8816 | <table class="list"><tbody> |
| | 8817 | <tr><th>http</th> |
| | 8818 | <td class="description">HTTP connection</td></tr> |
| | 8819 | <tr><th>length</th> |
| | 8820 | <td class="description">Length (0 for chunked)</td></tr> |
| | 8821 | </tbody></table> |
| | 8822 | <h3 class="function"><span class="info"> CUPS 1.5 </span><a id="httpSetTimeout">httpSetTimeout</a></h3> |
| | 8823 | <p class="description">Set read/write timeouts and an optional callback.</p> |
| | 8824 | <p class="code"> |
| | 8825 | <span class="reserved">void</span> httpSetTimeout(<a href="#http_t">http_t</a> *http, <span class="reserved">double</span> timeout, <a href="#http_timeout_cb_t">http_timeout_cb_t</a> cb, <span class="reserved">void</span> *user_data);</p> |
| | 8826 | <h4 class="parameters">Parameters</h4> |
| | 8827 | <table class="list"><tbody> |
| | 8828 | <tr><th>http</th> |
| | 8829 | <td class="description">HTTP connection</td></tr> |
| | 8830 | <tr><th>timeout</th> |
| | 8831 | <td class="description">Number of seconds for timeout, must be greater than <code>0.0</code></td></tr> |
| | 8832 | <tr><th>cb</th> |
| | 8833 | <td class="description">Callback function or <code>NULL</code></td></tr> |
| | 8834 | <tr><th>user_data</th> |
| | 8835 | <td class="description">User data pointer</td></tr> |
| | 8836 | </tbody></table> |
| | 8837 | <h4 class="discussion">Discussion</h4> |
| | 8838 | <p class="discussion">The optional timeout callback receives both the HTTP connection and a user |
| | 8839 | data pointer and must return 1 to continue or 0 to error (time) out. |
| | 8840 | |
| | 8841 | </p> |
| | 8842 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpShutdown">httpShutdown</a></h3> |
| | 8843 | <p class="description">Shutdown one side of an HTTP connection.</p> |
| | 8844 | <p class="code"> |
| | 8845 | <span class="reserved">void</span> httpShutdown(<a href="#http_t">http_t</a> *http);</p> |
| | 8846 | <h4 class="parameters">Parameters</h4> |
| | 8847 | <table class="list"><tbody> |
| | 8848 | <tr><th>http</th> |
| | 8849 | <td class="description">HTTP connection</td></tr> |
| | 8850 | </tbody></table> |
| | 8851 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpStateString">httpStateString</a></h3> |
| | 8852 | <p class="description">Return the string describing a HTTP state value.</p> |
| | 8853 | <p class="code"> |
| | 8854 | <span class="reserved">const</span> <span class="reserved">char</span> *httpStateString(<a href="#http_state_t">http_state_t</a> state);</p> |
| | 8855 | <h4 class="parameters">Parameters</h4> |
| | 8856 | <table class="list"><tbody> |
| | 8857 | <tr><th>state</th> |
| | 8858 | <td class="description">HTTP state value</td></tr> |
| | 8859 | </tbody></table> |
| | 8860 | <h4 class="returnvalue">Return Value</h4> |
| | 8861 | <p class="description">State string</p> |
| | 8862 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpStatusString">httpStatusString</a></h3> |
| | 8863 | <p class="description">Return a short string describing a HTTP status code.</p> |
| | 8864 | <p class="code"> |
| | 8865 | <span class="reserved">const</span> <span class="reserved">char</span> *httpStatusString(http_status_t status);</p> |
| | 8866 | <h4 class="parameters">Parameters</h4> |
| | 8867 | <table class="list"><tbody> |
| | 8868 | <tr><th>status</th> |
| | 8869 | <td class="description">HTTP status code</td></tr> |
| | 8870 | </tbody></table> |
| | 8871 | <h4 class="returnvalue">Return Value</h4> |
| | 8872 | <p class="description">Localized status string</p> |
| | 8873 | <h4 class="discussion">Discussion</h4> |
| | 8874 | <p class="discussion">The returned string is localized to the current POSIX locale and is based |
| | 8875 | on the status strings defined in RFC 7231. |
| | 8876 | |
| | 8877 | </p> |
| | 8878 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpURIStatusString">httpURIStatusString</a></h3> |
| | 8879 | <p class="description">Return a string describing a URI status code.</p> |
| | 8880 | <p class="code"> |
| | 8881 | <span class="reserved">const</span> <span class="reserved">char</span> *httpURIStatusString(<a href="#http_uri_status_t">http_uri_status_t</a> status);</p> |
| | 8882 | <h4 class="parameters">Parameters</h4> |
| | 8883 | <table class="list"><tbody> |
| | 8884 | <tr><th>status</th> |
| | 8885 | <td class="description">URI status code</td></tr> |
| | 8886 | </tbody></table> |
| | 8887 | <h4 class="returnvalue">Return Value</h4> |
| | 8888 | <p class="description">Localized status string</p> |
| | 8889 | <h3 class="function"><a id="httpUpdate">httpUpdate</a></h3> |
| | 8890 | <p class="description">Update the current HTTP state for incoming data.</p> |
| | 8891 | <p class="code"> |
| | 8892 | http_status_t httpUpdate(<a href="#http_t">http_t</a> *http);</p> |
| | 8893 | <h4 class="parameters">Parameters</h4> |
| | 8894 | <table class="list"><tbody> |
| | 8895 | <tr><th>http</th> |
| | 8896 | <td class="description">HTTP connection</td></tr> |
| | 8897 | </tbody></table> |
| | 8898 | <h4 class="returnvalue">Return Value</h4> |
| | 8899 | <p class="description">HTTP status</p> |
| | 8900 | <h3 class="function"><span class="info"> CUPS 1.1.19 </span><a id="httpWait">httpWait</a></h3> |
| | 8901 | <p class="description">Wait for data available on a connection.</p> |
| | 8902 | <p class="code"> |
| | 8903 | <span class="reserved">int</span> httpWait(<a href="#http_t">http_t</a> *http, <span class="reserved">int</span> msec);</p> |
| | 8904 | <h4 class="parameters">Parameters</h4> |
| | 8905 | <table class="list"><tbody> |
| | 8906 | <tr><th>http</th> |
| | 8907 | <td class="description">HTTP connection</td></tr> |
| | 8908 | <tr><th>msec</th> |
| | 8909 | <td class="description">Milliseconds to wait</td></tr> |
| | 8910 | </tbody></table> |
| | 8911 | <h4 class="returnvalue">Return Value</h4> |
| | 8912 | <p class="description">1 if data is available, 0 otherwise</p> |
| | 8913 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="httpWrite2">httpWrite2</a></h3> |
| | 8914 | <p class="description">Write data to a HTTP connection.</p> |
| | 8915 | <p class="code"> |
| | 8916 | ssize_t httpWrite2(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *buffer, size_t length);</p> |
| | 8917 | <h4 class="parameters">Parameters</h4> |
| | 8918 | <table class="list"><tbody> |
| | 8919 | <tr><th>http</th> |
| | 8920 | <td class="description">HTTP connection</td></tr> |
| | 8921 | <tr><th>buffer</th> |
| | 8922 | <td class="description">Buffer for data</td></tr> |
| | 8923 | <tr><th>length</th> |
| | 8924 | <td class="description">Number of bytes to write</td></tr> |
| | 8925 | </tbody></table> |
| | 8926 | <h4 class="returnvalue">Return Value</h4> |
| | 8927 | <p class="description">Number of bytes written</p> |
| | 8928 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="httpWriteRequest">httpWriteRequest</a></h3> |
| | 8929 | <p class="description">Send a HTTP request.</p> |
| | 8930 | <p class="code"> |
| | 8931 | <span class="reserved">bool</span> httpWriteRequest(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *method, <span class="reserved">const</span> <span class="reserved">char</span> *uri);</p> |
| | 8932 | <h4 class="parameters">Parameters</h4> |
| | 8933 | <table class="list"><tbody> |
| | 8934 | <tr><th>http</th> |
| | 8935 | <td class="description">HTTP connection</td></tr> |
| | 8936 | <tr><th>method</th> |
| | 8937 | <td class="description">Method string ("GET", "POST", etc.)</td></tr> |
| | 8938 | <tr><th>uri</th> |
| | 8939 | <td class="description">URI</td></tr> |
| | 8940 | </tbody></table> |
| | 8941 | <h4 class="returnvalue">Return Value</h4> |
| | 8942 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 8943 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="httpWriteResponse">httpWriteResponse</a></h3> |
| | 8944 | <p class="description">Write a HTTP response to a client connection.</p> |
| | 8945 | <p class="code"> |
| | 8946 | <span class="reserved">int</span> httpWriteResponse(<a href="#http_t">http_t</a> *http, http_status_t status);</p> |
| | 8947 | <h4 class="parameters">Parameters</h4> |
| | 8948 | <table class="list"><tbody> |
| | 8949 | <tr><th>http</th> |
| | 8950 | <td class="description">HTTP connection</td></tr> |
| | 8951 | <tr><th>status</th> |
| | 8952 | <td class="description">Status code</td></tr> |
| | 8953 | </tbody></table> |
| | 8954 | <h4 class="returnvalue">Return Value</h4> |
| | 8955 | <p class="description">0 on success, -1 on error</p> |
| | 8956 | <h3 class="function"><a id="ippAddBoolean">ippAddBoolean</a></h3> |
| | 8957 | <p class="description">Add a boolean attribute to an IPP message.</p> |
| | 8958 | <p class="code"> |
| | 8959 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBoolean(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">char</span> value);</p> |
| | 8960 | <h4 class="parameters">Parameters</h4> |
| | 8961 | <table class="list"><tbody> |
| | 8962 | <tr><th>ipp</th> |
| | 8963 | <td class="description">IPP message</td></tr> |
| | 8964 | <tr><th>group</th> |
| | 8965 | <td class="description">IPP group</td></tr> |
| | 8966 | <tr><th>name</th> |
| | 8967 | <td class="description">Name of attribute</td></tr> |
| | 8968 | <tr><th>value</th> |
| | 8969 | <td class="description">Value of attribute</td></tr> |
| | 8970 | </tbody></table> |
| | 8971 | <h4 class="returnvalue">Return Value</h4> |
| | 8972 | <p class="description">New attribute</p> |
| | 8973 | <h4 class="discussion">Discussion</h4> |
| | 8974 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 8975 | 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> |
| | 8976 | <br> |
| | 8977 | The "group" parameter specifies the IPP attribute group tag: none |
| | 8978 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 8979 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 8980 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 8981 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| | 8982 | <h3 class="function"><a id="ippAddBooleans">ippAddBooleans</a></h3> |
| | 8983 | <p class="description">Add an array of boolean values.</p> |
| | 8984 | <p class="code"> |
| | 8985 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBooleans(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> num_values, <span class="reserved">const</span> <span class="reserved">char</span> *values);</p> |
| | 8986 | <h4 class="parameters">Parameters</h4> |
| | 8987 | <table class="list"><tbody> |
| | 8988 | <tr><th>ipp</th> |
| | 8989 | <td class="description">IPP message</td></tr> |
| | 8990 | <tr><th>group</th> |
| | 8991 | <td class="description">IPP group</td></tr> |
| | 8992 | <tr><th>name</th> |
| | 8993 | <td class="description">Name of attribute</td></tr> |
| | 8994 | <tr><th>num_values</th> |
| | 8995 | <td class="description">Number of values</td></tr> |
| | 8996 | <tr><th>values</th> |
| | 8997 | <td class="description">Values</td></tr> |
| | 8998 | </tbody></table> |
| | 8999 | <h4 class="returnvalue">Return Value</h4> |
| | 9000 | <p class="description">New attribute</p> |
| | 9001 | <h4 class="discussion">Discussion</h4> |
| | 9002 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9003 | 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> |
| | 9004 | <br> |
| | 9005 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9006 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9007 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9008 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9009 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| | 9010 | <h3 class="function"><span class="info"> CUPS 1.1.19 </span><a id="ippAddCollection">ippAddCollection</a></h3> |
| | 9011 | <p class="description">Add a collection value.</p> |
| | 9012 | <p class="code"> |
| | 9013 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollection(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <a href="#ipp_t">ipp_t</a> *value);</p> |
| | 9014 | <h4 class="parameters">Parameters</h4> |
| | 9015 | <table class="list"><tbody> |
| | 9016 | <tr><th>ipp</th> |
| | 9017 | <td class="description">IPP message</td></tr> |
| | 9018 | <tr><th>group</th> |
| | 9019 | <td class="description">IPP group</td></tr> |
| | 9020 | <tr><th>name</th> |
| | 9021 | <td class="description">Name of attribute</td></tr> |
| | 9022 | <tr><th>value</th> |
| | 9023 | <td class="description">Value</td></tr> |
| | 9024 | </tbody></table> |
| | 9025 | <h4 class="returnvalue">Return Value</h4> |
| | 9026 | <p class="description">New attribute</p> |
| | 9027 | <h4 class="discussion">Discussion</h4> |
| | 9028 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9029 | 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> |
| | 9030 | <br> |
| | 9031 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9032 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9033 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9034 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9035 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). |
| | 9036 | |
| | 9037 | </p> |
| | 9038 | <h3 class="function"><span class="info"> CUPS 1.1.19 </span><a id="ippAddCollections">ippAddCollections</a></h3> |
| | 9039 | <p class="description">Add an array of collection values.</p> |
| | 9040 | <p class="code"> |
| | 9041 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollections(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> num_values, <span class="reserved">const</span> <a href="#ipp_t">ipp_t</a> **values);</p> |
| | 9042 | <h4 class="parameters">Parameters</h4> |
| | 9043 | <table class="list"><tbody> |
| | 9044 | <tr><th>ipp</th> |
| | 9045 | <td class="description">IPP message</td></tr> |
| | 9046 | <tr><th>group</th> |
| | 9047 | <td class="description">IPP group</td></tr> |
| | 9048 | <tr><th>name</th> |
| | 9049 | <td class="description">Name of attribute</td></tr> |
| | 9050 | <tr><th>num_values</th> |
| | 9051 | <td class="description">Number of values</td></tr> |
| | 9052 | <tr><th>values</th> |
| | 9053 | <td class="description">Values</td></tr> |
| | 9054 | </tbody></table> |
| | 9055 | <h4 class="returnvalue">Return Value</h4> |
| | 9056 | <p class="description">New attribute</p> |
| | 9057 | <h4 class="discussion">Discussion</h4> |
| | 9058 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9059 | 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> |
| | 9060 | <br> |
| | 9061 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9062 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9063 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9064 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9065 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). |
| | 9066 | |
| | 9067 | </p> |
| | 9068 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="ippAddCredentialsString">ippAddCredentialsString</a></h3> |
| | 9069 | <p class="description">Add a credentials string attribute to an IPP message.</p> |
| | 9070 | <p class="code"> |
| | 9071 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCredentialsString(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *credentials);</p> |
| | 9072 | <h4 class="parameters">Parameters</h4> |
| | 9073 | <table class="list"><tbody> |
| | 9074 | <tr><th>ipp</th> |
| | 9075 | <td class="description">IPP message</td></tr> |
| | 9076 | <tr><th>group</th> |
| | 9077 | <td class="description">IPP group</td></tr> |
| | 9078 | <tr><th>name</th> |
| | 9079 | <td class="description">Attribute name</td></tr> |
| | 9080 | <tr><th>credentials</th> |
| | 9081 | <td class="description">Credentials string</td></tr> |
| | 9082 | </tbody></table> |
| | 9083 | <h4 class="returnvalue">Return Value</h4> |
| | 9084 | <p class="description">New attribute</p> |
| | 9085 | <h4 class="discussion">Discussion</h4> |
| | 9086 | <p class="discussion">This function adds a 1setOf text attribute to an IPP message corresponding to |
| | 9087 | the specified credentials string.<br> |
| | 9088 | <br> |
| | 9089 | The "ipp" parameter refers to an IPP message previously created using |
| | 9090 | 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> |
| | 9091 | <br> |
| | 9092 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9093 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9094 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9095 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9096 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). |
| | 9097 | |
| | 9098 | </p> |
| | 9099 | <h3 class="function"><a id="ippAddDate">ippAddDate</a></h3> |
| | 9100 | <p class="description">Add a dateTime attribute to an IPP message.</p> |
| | 9101 | <p class="code"> |
| | 9102 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddDate(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <a href="#ipp_uchar_t">ipp_uchar_t</a> *value);</p> |
| | 9103 | <h4 class="parameters">Parameters</h4> |
| | 9104 | <table class="list"><tbody> |
| | 9105 | <tr><th>ipp</th> |
| | 9106 | <td class="description">IPP message</td></tr> |
| | 9107 | <tr><th>group</th> |
| | 9108 | <td class="description">IPP group</td></tr> |
| | 9109 | <tr><th>name</th> |
| | 9110 | <td class="description">Name of attribute</td></tr> |
| | 9111 | <tr><th>value</th> |
| | 9112 | <td class="description">Value</td></tr> |
| | 9113 | </tbody></table> |
| | 9114 | <h4 class="returnvalue">Return Value</h4> |
| | 9115 | <p class="description">New attribute</p> |
| | 9116 | <h4 class="discussion">Discussion</h4> |
| | 9117 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9118 | 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> |
| | 9119 | <br> |
| | 9120 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9121 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9122 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9123 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9124 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| | 9125 | <h3 class="function"><a id="ippAddInteger">ippAddInteger</a></h3> |
| | 9126 | <p class="description">Add a integer attribute to an IPP message.</p> |
| | 9127 | <p class="code"> |
| | 9128 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> value);</p> |
| | 9129 | <h4 class="parameters">Parameters</h4> |
| | 9130 | <table class="list"><tbody> |
| | 9131 | <tr><th>ipp</th> |
| | 9132 | <td class="description">IPP message</td></tr> |
| | 9133 | <tr><th>group</th> |
| | 9134 | <td class="description">IPP group</td></tr> |
| | 9135 | <tr><th>value_tag</th> |
| | 9136 | <td class="description">Type of attribute</td></tr> |
| | 9137 | <tr><th>name</th> |
| | 9138 | <td class="description">Name of attribute</td></tr> |
| | 9139 | <tr><th>value</th> |
| | 9140 | <td class="description">Value of attribute</td></tr> |
| | 9141 | </tbody></table> |
| | 9142 | <h4 class="returnvalue">Return Value</h4> |
| | 9143 | <p class="description">New attribute</p> |
| | 9144 | <h4 class="discussion">Discussion</h4> |
| | 9145 | <p class="discussion">This function adds an integer or enum attribute to an IPP message.<br> |
| | 9146 | <br> |
| | 9147 | The "ipp" parameter refers to an IPP message previously created using |
| | 9148 | 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> |
| | 9149 | <br> |
| | 9150 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9151 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9152 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9153 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9154 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| | 9155 | <br> |
| | 9156 | Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer |
| | 9157 | (<code>IPP_TAG_INTEGER</code>).</p> |
| | 9158 | <h3 class="function"><a id="ippAddIntegers">ippAddIntegers</a></h3> |
| | 9159 | <p class="description">Add an array of integer values.</p> |
| | 9160 | <p class="code"> |
| | 9161 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> num_values, <span class="reserved">const</span> <span class="reserved">int</span> *values);</p> |
| | 9162 | <h4 class="parameters">Parameters</h4> |
| | 9163 | <table class="list"><tbody> |
| | 9164 | <tr><th>ipp</th> |
| | 9165 | <td class="description">IPP message</td></tr> |
| | 9166 | <tr><th>group</th> |
| | 9167 | <td class="description">IPP group</td></tr> |
| | 9168 | <tr><th>value_tag</th> |
| | 9169 | <td class="description">Type of attribute</td></tr> |
| | 9170 | <tr><th>name</th> |
| | 9171 | <td class="description">Name of attribute</td></tr> |
| | 9172 | <tr><th>num_values</th> |
| | 9173 | <td class="description">Number of values</td></tr> |
| | 9174 | <tr><th>values</th> |
| | 9175 | <td class="description">Values</td></tr> |
| | 9176 | </tbody></table> |
| | 9177 | <h4 class="returnvalue">Return Value</h4> |
| | 9178 | <p class="description">New attribute</p> |
| | 9179 | <h4 class="discussion">Discussion</h4> |
| | 9180 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9181 | 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> |
| | 9182 | <br> |
| | 9183 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9184 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9185 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9186 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9187 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| | 9188 | <br> |
| | 9189 | Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer |
| | 9190 | (<code>IPP_TAG_INTEGER</code>).</p> |
| | 9191 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="ippAddOctetString">ippAddOctetString</a></h3> |
| | 9192 | <p class="description">Add an octetString value to an IPP message.</p> |
| | 9193 | <p class="code"> |
| | 9194 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddOctetString(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">void</span> *data, <span class="reserved">int</span> datalen);</p> |
| | 9195 | <h4 class="parameters">Parameters</h4> |
| | 9196 | <table class="list"><tbody> |
| | 9197 | <tr><th>ipp</th> |
| | 9198 | <td class="description">IPP message</td></tr> |
| | 9199 | <tr><th>group</th> |
| | 9200 | <td class="description">IPP group</td></tr> |
| | 9201 | <tr><th>name</th> |
| | 9202 | <td class="description">Name of attribute</td></tr> |
| | 9203 | <tr><th>data</th> |
| | 9204 | <td class="description">octetString data</td></tr> |
| | 9205 | <tr><th>datalen</th> |
| | 9206 | <td class="description">Length of data in bytes</td></tr> |
| | 9207 | </tbody></table> |
| | 9208 | <h4 class="returnvalue">Return Value</h4> |
| | 9209 | <p class="description">New attribute</p> |
| | 9210 | <h4 class="discussion">Discussion</h4> |
| | 9211 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9212 | 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> |
| | 9213 | <br> |
| | 9214 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9215 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9216 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9217 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9218 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). |
| | 9219 | |
| | 9220 | </p> |
| | 9221 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippAddOutOfBand">ippAddOutOfBand</a></h3> |
| | 9222 | <p class="description">Add an out-of-band value to an IPP message.</p> |
| | 9223 | <p class="code"> |
| | 9224 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *name);</p> |
| | 9225 | <h4 class="parameters">Parameters</h4> |
| | 9226 | <table class="list"><tbody> |
| | 9227 | <tr><th>ipp</th> |
| | 9228 | <td class="description">IPP message</td></tr> |
| | 9229 | <tr><th>group</th> |
| | 9230 | <td class="description">IPP group</td></tr> |
| | 9231 | <tr><th>value_tag</th> |
| | 9232 | <td class="description">Type of attribute</td></tr> |
| | 9233 | <tr><th>name</th> |
| | 9234 | <td class="description">Name of attribute</td></tr> |
| | 9235 | </tbody></table> |
| | 9236 | <h4 class="returnvalue">Return Value</h4> |
| | 9237 | <p class="description">New attribute</p> |
| | 9238 | <h4 class="discussion">Discussion</h4> |
| | 9239 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9240 | 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> |
| | 9241 | <br> |
| | 9242 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9243 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9244 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9245 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9246 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| | 9247 | <br> |
| | 9248 | Supported out-of-band values include unsupported-value |
| | 9249 | (<code>IPP_TAG_UNSUPPORTED_VALUE</code>), default (<code>IPP_TAG_DEFAULT</code>), unknown |
| | 9250 | (<code>IPP_TAG_UNKNOWN</code>), no-value (<code>IPP_TAG_NOVALUE</code>), not-settable |
| | 9251 | (<code>IPP_TAG_NOTSETTABLE</code>), delete-attribute (<code>IPP_TAG_DELETEATTR</code>), and |
| | 9252 | admin-define (<code>IPP_TAG_ADMINDEFINE</code>). |
| | 9253 | |
| | 9254 | </p> |
| | 9255 | <h3 class="function"><a id="ippAddRange">ippAddRange</a></h3> |
| | 9256 | <p class="description">Add a range of values to an IPP message.</p> |
| | 9257 | <p class="code"> |
| | 9258 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRange(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> lower, <span class="reserved">int</span> upper);</p> |
| | 9259 | <h4 class="parameters">Parameters</h4> |
| | 9260 | <table class="list"><tbody> |
| | 9261 | <tr><th>ipp</th> |
| | 9262 | <td class="description">IPP message</td></tr> |
| | 9263 | <tr><th>group</th> |
| | 9264 | <td class="description">IPP group</td></tr> |
| | 9265 | <tr><th>name</th> |
| | 9266 | <td class="description">Name of attribute</td></tr> |
| | 9267 | <tr><th>lower</th> |
| | 9268 | <td class="description">Lower value</td></tr> |
| | 9269 | <tr><th>upper</th> |
| | 9270 | <td class="description">Upper value</td></tr> |
| | 9271 | </tbody></table> |
| | 9272 | <h4 class="returnvalue">Return Value</h4> |
| | 9273 | <p class="description">New attribute</p> |
| | 9274 | <h4 class="discussion">Discussion</h4> |
| | 9275 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9276 | 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> |
| | 9277 | <br> |
| | 9278 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9279 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9280 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9281 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9282 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| | 9283 | <br> |
| | 9284 | The "lower" parameter must be less than or equal to the "upper" parameter.</p> |
| | 9285 | <h3 class="function"><a id="ippAddRanges">ippAddRanges</a></h3> |
| | 9286 | <p class="description">Add ranges of values to an IPP message.</p> |
| | 9287 | <p class="code"> |
| | 9288 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRanges(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> num_values, <span class="reserved">const</span> <span class="reserved">int</span> *lower, <span class="reserved">const</span> <span class="reserved">int</span> *upper);</p> |
| | 9289 | <h4 class="parameters">Parameters</h4> |
| | 9290 | <table class="list"><tbody> |
| | 9291 | <tr><th>ipp</th> |
| | 9292 | <td class="description">IPP message</td></tr> |
| | 9293 | <tr><th>group</th> |
| | 9294 | <td class="description">IPP group</td></tr> |
| | 9295 | <tr><th>name</th> |
| | 9296 | <td class="description">Name of attribute</td></tr> |
| | 9297 | <tr><th>num_values</th> |
| | 9298 | <td class="description">Number of values</td></tr> |
| | 9299 | <tr><th>lower</th> |
| | 9300 | <td class="description">Lower values</td></tr> |
| | 9301 | <tr><th>upper</th> |
| | 9302 | <td class="description">Upper values</td></tr> |
| | 9303 | </tbody></table> |
| | 9304 | <h4 class="returnvalue">Return Value</h4> |
| | 9305 | <p class="description">New attribute</p> |
| | 9306 | <h4 class="discussion">Discussion</h4> |
| | 9307 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9308 | 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> |
| | 9309 | <br> |
| | 9310 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9311 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9312 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9313 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9314 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| | 9315 | <h3 class="function"><a id="ippAddResolution">ippAddResolution</a></h3> |
| | 9316 | <p class="description">Add a resolution value to an IPP message.</p> |
| | 9317 | <p class="code"> |
| | 9318 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolution(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <a href="#ipp_res_t">ipp_res_t</a> units, <span class="reserved">int</span> xres, <span class="reserved">int</span> yres);</p> |
| | 9319 | <h4 class="parameters">Parameters</h4> |
| | 9320 | <table class="list"><tbody> |
| | 9321 | <tr><th>ipp</th> |
| | 9322 | <td class="description">IPP message</td></tr> |
| | 9323 | <tr><th>group</th> |
| | 9324 | <td class="description">IPP group</td></tr> |
| | 9325 | <tr><th>name</th> |
| | 9326 | <td class="description">Name of attribute</td></tr> |
| | 9327 | <tr><th>units</th> |
| | 9328 | <td class="description">Units for resolution</td></tr> |
| | 9329 | <tr><th>xres</th> |
| | 9330 | <td class="description">X resolution</td></tr> |
| | 9331 | <tr><th>yres</th> |
| | 9332 | <td class="description">Y resolution</td></tr> |
| | 9333 | </tbody></table> |
| | 9334 | <h4 class="returnvalue">Return Value</h4> |
| | 9335 | <p class="description">New attribute</p> |
| | 9336 | <h4 class="discussion">Discussion</h4> |
| | 9337 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9338 | 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> |
| | 9339 | <br> |
| | 9340 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9341 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9342 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9343 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9344 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| | 9345 | <h3 class="function"><a id="ippAddResolutions">ippAddResolutions</a></h3> |
| | 9346 | <p class="description">Add resolution values to an IPP message.</p> |
| | 9347 | <p class="code"> |
| | 9348 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolutions(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> num_values, <a href="#ipp_res_t">ipp_res_t</a> units, <span class="reserved">const</span> <span class="reserved">int</span> *xres, <span class="reserved">const</span> <span class="reserved">int</span> *yres);</p> |
| | 9349 | <h4 class="parameters">Parameters</h4> |
| | 9350 | <table class="list"><tbody> |
| | 9351 | <tr><th>ipp</th> |
| | 9352 | <td class="description">IPP message</td></tr> |
| | 9353 | <tr><th>group</th> |
| | 9354 | <td class="description">IPP group</td></tr> |
| | 9355 | <tr><th>name</th> |
| | 9356 | <td class="description">Name of attribute</td></tr> |
| | 9357 | <tr><th>num_values</th> |
| | 9358 | <td class="description">Number of values</td></tr> |
| | 9359 | <tr><th>units</th> |
| | 9360 | <td class="description">Units for resolution</td></tr> |
| | 9361 | <tr><th>xres</th> |
| | 9362 | <td class="description">X resolutions</td></tr> |
| | 9363 | <tr><th>yres</th> |
| | 9364 | <td class="description">Y resolutions</td></tr> |
| | 9365 | </tbody></table> |
| | 9366 | <h4 class="returnvalue">Return Value</h4> |
| | 9367 | <p class="description">New attribute</p> |
| | 9368 | <h4 class="discussion">Discussion</h4> |
| | 9369 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9370 | 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> |
| | 9371 | <br> |
| | 9372 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9373 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9374 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9375 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9376 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> |
| | 9377 | <h3 class="function"><a id="ippAddSeparator">ippAddSeparator</a></h3> |
| | 9378 | <p class="description">Add a group separator to an IPP message.</p> |
| | 9379 | <p class="code"> |
| | 9380 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddSeparator(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 9381 | <h4 class="parameters">Parameters</h4> |
| | 9382 | <table class="list"><tbody> |
| | 9383 | <tr><th>ipp</th> |
| | 9384 | <td class="description">IPP message</td></tr> |
| | 9385 | </tbody></table> |
| | 9386 | <h4 class="returnvalue">Return Value</h4> |
| | 9387 | <p class="description">New attribute</p> |
| | 9388 | <h4 class="discussion">Discussion</h4> |
| | 9389 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9390 | 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> |
| | 9391 | <h3 class="function"><a id="ippAddString">ippAddString</a></h3> |
| | 9392 | <p class="description">Add a language-encoded string to an IPP message.</p> |
| | 9393 | <p class="code"> |
| | 9394 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *language, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 9395 | <h4 class="parameters">Parameters</h4> |
| | 9396 | <table class="list"><tbody> |
| | 9397 | <tr><th>ipp</th> |
| | 9398 | <td class="description">IPP message</td></tr> |
| | 9399 | <tr><th>group</th> |
| | 9400 | <td class="description">IPP group</td></tr> |
| | 9401 | <tr><th>value_tag</th> |
| | 9402 | <td class="description">Type of attribute</td></tr> |
| | 9403 | <tr><th>name</th> |
| | 9404 | <td class="description">Name of attribute</td></tr> |
| | 9405 | <tr><th>language</th> |
| | 9406 | <td class="description">Language code</td></tr> |
| | 9407 | <tr><th>value</th> |
| | 9408 | <td class="description">Value</td></tr> |
| | 9409 | </tbody></table> |
| | 9410 | <h4 class="returnvalue">Return Value</h4> |
| | 9411 | <p class="description">New attribute</p> |
| | 9412 | <h4 class="discussion">Discussion</h4> |
| | 9413 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9414 | 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> |
| | 9415 | <br> |
| | 9416 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9417 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9418 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9419 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9420 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| | 9421 | <br> |
| | 9422 | Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword |
| | 9423 | (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType |
| | 9424 | (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage |
| | 9425 | (<code>IPP_TAG_NAMELANG), text (`IPP_TAG_TEXT`), textWithLanguage |
| | 9426 | (`IPP_TAG_TEXTLANG`), uri (`IPP_TAG_URI`), and uriScheme |
| | 9427 | (`IPP_TAG_URISCHEME`). |
| | 9428 | |
| | 9429 | The "language" parameter must be non-`NULL` for nameWithLanguage and |
| | 9430 | textWithLanguage string values and must be `NULL` for all other string values.</code></p> |
| | 9431 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippAddStringf">ippAddStringf</a></h3> |
| | 9432 | <p class="description">Add a formatted string to an IPP message.</p> |
| | 9433 | <p class="code"> |
| | 9434 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *language, <span class="reserved">const</span> <span class="reserved">char</span> *format, ...);</p> |
| | 9435 | <h4 class="parameters">Parameters</h4> |
| | 9436 | <table class="list"><tbody> |
| | 9437 | <tr><th>ipp</th> |
| | 9438 | <td class="description">IPP message</td></tr> |
| | 9439 | <tr><th>group</th> |
| | 9440 | <td class="description">IPP group</td></tr> |
| | 9441 | <tr><th>value_tag</th> |
| | 9442 | <td class="description">Type of attribute</td></tr> |
| | 9443 | <tr><th>name</th> |
| | 9444 | <td class="description">Name of attribute</td></tr> |
| | 9445 | <tr><th>language</th> |
| | 9446 | <td class="description">Language code (<code>NULL</code> for default)</td></tr> |
| | 9447 | <tr><th>format</th> |
| | 9448 | <td class="description">Printf-style format string</td></tr> |
| | 9449 | <tr><th>...</th> |
| | 9450 | <td class="description">Additional arguments as needed</td></tr> |
| | 9451 | </tbody></table> |
| | 9452 | <h4 class="returnvalue">Return Value</h4> |
| | 9453 | <p class="description">New attribute</p> |
| | 9454 | <h4 class="discussion">Discussion</h4> |
| | 9455 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9456 | 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> |
| | 9457 | <br> |
| | 9458 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9459 | (<code>IPP_TAG_ZERO</code>, for member attributes), document |
| | 9460 | (<code>IPP_TAG_DOCUMENT</code>), event notification |
| | 9461 | (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), |
| | 9462 | printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), |
| | 9463 | or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| | 9464 | <br> |
| | 9465 | Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword |
| | 9466 | (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType |
| | 9467 | (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage |
| | 9468 | (<code>IPP_TAG_NAMELANG), text (`IPP_TAG_TEXT`), textWithLanguage |
| | 9469 | (`IPP_TAG_TEXTLANG`), uri (`IPP_TAG_URI`), and uriScheme |
| | 9470 | (`IPP_TAG_URISCHEME`). |
| | 9471 | |
| | 9472 | The "language" parameter must be non-`NULL` for nameWithLanguage |
| | 9473 | and textWithLanguage string values and must be `NULL` for all other |
| | 9474 | string values. |
| | 9475 | |
| | 9476 | The "format" parameter uses formatting characters compatible with the |
| | 9477 | printf family of standard functions. Additional arguments follow it as |
| | 9478 | needed. The formatted string is truncated as needed to the maximum length of |
| | 9479 | the corresponding value type. |
| | 9480 | |
| | 9481 | </code>since CUPS 1.7@</p> |
| | 9482 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippAddStringfv">ippAddStringfv</a></h3> |
| | 9483 | <p class="description">Add a formatted string to an IPP message.</p> |
| | 9484 | <p class="code"> |
| | 9485 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *language, <span class="reserved">const</span> <span class="reserved">char</span> *format, va_list ap);</p> |
| | 9486 | <h4 class="parameters">Parameters</h4> |
| | 9487 | <table class="list"><tbody> |
| | 9488 | <tr><th>ipp</th> |
| | 9489 | <td class="description">IPP message</td></tr> |
| | 9490 | <tr><th>group</th> |
| | 9491 | <td class="description">IPP group</td></tr> |
| | 9492 | <tr><th>value_tag</th> |
| | 9493 | <td class="description">Type of attribute</td></tr> |
| | 9494 | <tr><th>name</th> |
| | 9495 | <td class="description">Name of attribute</td></tr> |
| | 9496 | <tr><th>language</th> |
| | 9497 | <td class="description">Language code (<code>NULL</code> for default)</td></tr> |
| | 9498 | <tr><th>format</th> |
| | 9499 | <td class="description">Printf-style format string</td></tr> |
| | 9500 | <tr><th>ap</th> |
| | 9501 | <td class="description">Additional arguments</td></tr> |
| | 9502 | </tbody></table> |
| | 9503 | <h4 class="returnvalue">Return Value</h4> |
| | 9504 | <p class="description">New attribute</p> |
| | 9505 | <h4 class="discussion">Discussion</h4> |
| | 9506 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9507 | 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> |
| | 9508 | <br> |
| | 9509 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9510 | (<code>IPP_TAG_ZERO</code>, for member attributes), document |
| | 9511 | (<code>IPP_TAG_DOCUMENT</code>), event notification |
| | 9512 | (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), |
| | 9513 | printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), |
| | 9514 | or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| | 9515 | <br> |
| | 9516 | Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword |
| | 9517 | (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType |
| | 9518 | (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage |
| | 9519 | (<code>IPP_TAG_NAMELANG), text (`IPP_TAG_TEXT`), textWithLanguage |
| | 9520 | (`IPP_TAG_TEXTLANG`), uri (`IPP_TAG_URI`), and uriScheme |
| | 9521 | (`IPP_TAG_URISCHEME`). |
| | 9522 | |
| | 9523 | The "language" parameter must be non-`NULL` for nameWithLanguage |
| | 9524 | and textWithLanguage string values and must be `NULL` for all other |
| | 9525 | string values. |
| | 9526 | |
| | 9527 | The "format" parameter uses formatting characters compatible with the |
| | 9528 | printf family of standard functions. Additional arguments are passed in the |
| | 9529 | stdarg pointer "ap". The formatted string is truncated as needed to the |
| | 9530 | maximum length of the corresponding value type. |
| | 9531 | |
| | 9532 | </code>since CUPS 1.7@</p> |
| | 9533 | <h3 class="function"><a id="ippAddStrings">ippAddStrings</a></h3> |
| | 9534 | <p class="description">Add language-encoded strings to an IPP message.</p> |
| | 9535 | <p class="code"> |
| | 9536 | <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, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> num_values, <span class="reserved">const</span> <span class="reserved">char</span> *language, <span class="reserved">const</span> <span class="reserved">char</span> *const *values);</p> |
| | 9537 | <h4 class="parameters">Parameters</h4> |
| | 9538 | <table class="list"><tbody> |
| | 9539 | <tr><th>ipp</th> |
| | 9540 | <td class="description">IPP message</td></tr> |
| | 9541 | <tr><th>group</th> |
| | 9542 | <td class="description">IPP group</td></tr> |
| | 9543 | <tr><th>value_tag</th> |
| | 9544 | <td class="description">Type of attribute</td></tr> |
| | 9545 | <tr><th>name</th> |
| | 9546 | <td class="description">Name of attribute</td></tr> |
| | 9547 | <tr><th>num_values</th> |
| | 9548 | <td class="description">Number of values</td></tr> |
| | 9549 | <tr><th>language</th> |
| | 9550 | <td class="description">Language code (<code>NULL</code> for default)</td></tr> |
| | 9551 | <tr><th>values</th> |
| | 9552 | <td class="description">Values</td></tr> |
| | 9553 | </tbody></table> |
| | 9554 | <h4 class="returnvalue">Return Value</h4> |
| | 9555 | <p class="description">New attribute</p> |
| | 9556 | <h4 class="discussion">Discussion</h4> |
| | 9557 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 9558 | 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> |
| | 9559 | <br> |
| | 9560 | The "group" parameter specifies the IPP attribute group tag: none |
| | 9561 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 9562 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 9563 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 9564 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> |
| | 9565 | <br> |
| | 9566 | Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword |
| | 9567 | (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType |
| | 9568 | (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage |
| | 9569 | (<code>IPP_TAG_NAMELANG), text (`IPP_TAG_TEXT`), textWithLanguage |
| | 9570 | (`IPP_TAG_TEXTLANG`), uri (`IPP_TAG_URI`), and uriScheme |
| | 9571 | (`IPP_TAG_URISCHEME`). |
| | 9572 | |
| | 9573 | The "language" parameter must be non-`NULL` for nameWithLanguage and |
| | 9574 | textWithLanguage string values and must be `NULL` for all other string values.</code></p> |
| | 9575 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippAttributeString">ippAttributeString</a></h3> |
| | 9576 | <p class="description">Convert the attribute's value to a string.</p> |
| | 9577 | <p class="code"> |
| | 9578 | size_t ippAttributeString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">char</span> *buffer, size_t bufsize);</p> |
| | 9579 | <h4 class="parameters">Parameters</h4> |
| | 9580 | <table class="list"><tbody> |
| | 9581 | <tr><th>attr</th> |
| | 9582 | <td class="description">Attribute</td></tr> |
| | 9583 | <tr><th>buffer</th> |
| | 9584 | <td class="description">String buffer or NULL</td></tr> |
| | 9585 | <tr><th>bufsize</th> |
| | 9586 | <td class="description">Size of string buffer</td></tr> |
| | 9587 | </tbody></table> |
| | 9588 | <h4 class="returnvalue">Return Value</h4> |
| | 9589 | <p class="description">Number of bytes less nul</p> |
| | 9590 | <h4 class="discussion">Discussion</h4> |
| | 9591 | <p class="discussion">Returns the number of bytes that would be written, not including the |
| | 9592 | trailing nul. The buffer pointer can be NULL to get the required length, |
| | 9593 | just like (v)snprintf. |
| | 9594 | |
| | 9595 | </p> |
| | 9596 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippContainsInteger">ippContainsInteger</a></h3> |
| | 9597 | <p class="description">Determine whether an attribute contains the |
| | 9598 | specified value or is within the list of ranges.</p> |
| | 9599 | <p class="code"> |
| | 9600 | <span class="reserved">int</span> ippContainsInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">int</span> value);</p> |
| | 9601 | <h4 class="parameters">Parameters</h4> |
| | 9602 | <table class="list"><tbody> |
| | 9603 | <tr><th>attr</th> |
| | 9604 | <td class="description">Attribute</td></tr> |
| | 9605 | <tr><th>value</th> |
| | 9606 | <td class="description">Integer/enum value</td></tr> |
| | 9607 | </tbody></table> |
| | 9608 | <h4 class="returnvalue">Return Value</h4> |
| | 9609 | <p class="description">1 on a match, 0 on no match</p> |
| | 9610 | <h4 class="discussion">Discussion</h4> |
| | 9611 | <p class="discussion">Returns non-zero when the attribute contains either a matching integer or |
| | 9612 | enum value, or the value falls within one of the rangeOfInteger values for |
| | 9613 | the attribute. |
| | 9614 | |
| | 9615 | </p> |
| | 9616 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippContainsString">ippContainsString</a></h3> |
| | 9617 | <p class="description">Determine whether an attribute contains the |
| | 9618 | specified string value.</p> |
| | 9619 | <p class="code"> |
| | 9620 | <span class="reserved">int</span> ippContainsString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 9621 | <h4 class="parameters">Parameters</h4> |
| | 9622 | <table class="list"><tbody> |
| | 9623 | <tr><th>attr</th> |
| | 9624 | <td class="description">Attribute</td></tr> |
| | 9625 | <tr><th>value</th> |
| | 9626 | <td class="description">String value</td></tr> |
| | 9627 | </tbody></table> |
| | 9628 | <h4 class="returnvalue">Return Value</h4> |
| | 9629 | <p class="description">1 on a match, 0 on no match</p> |
| | 9630 | <h4 class="discussion">Discussion</h4> |
| | 9631 | <p class="discussion">Returns non-zero when the attribute contains a matching charset, keyword, |
| | 9632 | naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value. |
| | 9633 | |
| | 9634 | </p> |
| | 9635 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippCopyAttribute">ippCopyAttribute</a></h3> |
| | 9636 | <p class="description">Copy an attribute.</p> |
| | 9637 | <p class="code"> |
| | 9638 | <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, <span class="reserved">int</span> quickcopy);</p> |
| | 9639 | <h4 class="parameters">Parameters</h4> |
| | 9640 | <table class="list"><tbody> |
| | 9641 | <tr><th>dst</th> |
| | 9642 | <td class="description">Destination IPP message</td></tr> |
| | 9643 | <tr><th>srcattr</th> |
| | 9644 | <td class="description">Attribute to copy</td></tr> |
| | 9645 | <tr><th>quickcopy</th> |
| | 9646 | <td class="description">1 for a referenced copy, 0 for normal</td></tr> |
| | 9647 | </tbody></table> |
| | 9648 | <h4 class="returnvalue">Return Value</h4> |
| | 9649 | <p class="description">New attribute</p> |
| | 9650 | <h4 class="discussion">Discussion</h4> |
| | 9651 | <p class="discussion">The specified attribute, <code>attr</code>, is copied to the destination IPP message. |
| | 9652 | When "quickcopy" is non-zero, a "shallow" reference copy of the attribute is |
| | 9653 | created - this should only be done as long as the original source IPP message will |
| | 9654 | not be freed for the life of the destination. |
| | 9655 | |
| | 9656 | </p> |
| | 9657 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippCopyAttributes">ippCopyAttributes</a></h3> |
| | 9658 | <p class="description">Copy attributes from one IPP message to another.</p> |
| | 9659 | <p class="code"> |
| | 9660 | <span class="reserved">int</span> ippCopyAttributes(<a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_t">ipp_t</a> *src, <span class="reserved">int</span> quickcopy, <a href="#ipp_copy_cb_t">ipp_copy_cb_t</a> cb, <span class="reserved">void</span> *context);</p> |
| | 9661 | <h4 class="parameters">Parameters</h4> |
| | 9662 | <table class="list"><tbody> |
| | 9663 | <tr><th>dst</th> |
| | 9664 | <td class="description">Destination IPP message</td></tr> |
| | 9665 | <tr><th>src</th> |
| | 9666 | <td class="description">Source IPP message</td></tr> |
| | 9667 | <tr><th>quickcopy</th> |
| | 9668 | <td class="description">1 for a referenced copy, 0 for normal</td></tr> |
| | 9669 | <tr><th>cb</th> |
| | 9670 | <td class="description">Copy callback or <code>NULL</code> for none</td></tr> |
| | 9671 | <tr><th>context</th> |
| | 9672 | <td class="description">Context pointer</td></tr> |
| | 9673 | </tbody></table> |
| | 9674 | <h4 class="returnvalue">Return Value</h4> |
| | 9675 | <p class="description">1 on success, 0 on error</p> |
| | 9676 | <h4 class="discussion">Discussion</h4> |
| | 9677 | <p class="discussion">Zero or more attributes are copied from the source IPP message "src" to the |
| | 9678 | destination IPP message "dst". When "quickcopy" is non-zero, a "shallow" |
| | 9679 | reference copy of the attribute is created - this should only be done as long |
| | 9680 | as the original source IPP message will not be freed for the life of the |
| | 9681 | destination.<br> |
| | 9682 | <br> |
| | 9683 | The "cb" and "context" parameters provide a generic way to "filter" the |
| | 9684 | attributes that are copied - the function must return 1 to copy the attribute or |
| | 9685 | 0 to skip it. The function may also choose to do a partial copy of the source attribute |
| | 9686 | itself. |
| | 9687 | |
| | 9688 | </p> |
| | 9689 | <h3 class="function"><a id="ippCopyCredentialsString">ippCopyCredentialsString</a></h3> |
| | 9690 | <p class="description">Copy a credentials value from an IPP attribute.</p> |
| | 9691 | <p class="code"> |
| | 9692 | <span class="reserved">char</span> *ippCopyCredentialsString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| | 9693 | <h4 class="parameters">Parameters</h4> |
| | 9694 | <table class="list"><tbody> |
| | 9695 | <tr><th>attr</th> |
| | 9696 | <td class="description">Attribute</td></tr> |
| | 9697 | </tbody></table> |
| | 9698 | <h4 class="returnvalue">Return Value</h4> |
| | 9699 | <p class="description">Combined string or <code>NULL</code> on error</p> |
| | 9700 | <h4 class="discussion">Discussion</h4> |
| | 9701 | <p class="discussion">This function concatenates the 1setOf text credential values of an attribute, |
| | 9702 | separated by newlines. The returned string must be freed using the <code>free</code> |
| | 9703 | function.</p> |
| | 9704 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippCreateRequestedArray">ippCreateRequestedArray</a></h3> |
| | 9705 | <p class="description">Create a CUPS array of attribute names from the |
| | 9706 | given requested-attributes attribute.</p> |
| | 9707 | <p class="code"> |
| | 9708 | <a href="#cups_array_t">cups_array_t</a> *ippCreateRequestedArray(<a href="#ipp_t">ipp_t</a> *request);</p> |
| | 9709 | <h4 class="parameters">Parameters</h4> |
| | 9710 | <table class="list"><tbody> |
| | 9711 | <tr><th>request</th> |
| | 9712 | <td class="description">IPP request</td></tr> |
| | 9713 | </tbody></table> |
| | 9714 | <h4 class="returnvalue">Return Value</h4> |
| | 9715 | <p class="description">CUPS array or <code>NULL</code> if all</p> |
| | 9716 | <h4 class="discussion">Discussion</h4> |
| | 9717 | <p class="discussion">This function creates a (sorted) CUPS array of attribute names matching the |
| | 9718 | list of "requested-attribute" values supplied in an IPP request. All IANA- |
| | 9719 | registered values are supported in addition to the CUPS IPP extension |
| | 9720 | attributes.<br> |
| | 9721 | <br> |
| | 9722 | The <code>request</code> parameter specifies the request message that was read from |
| | 9723 | the client. |
| | 9724 | |
| | 9725 | <code>NULL</code> is returned if all attributes should be returned. Otherwise, the |
| | 9726 | result is a sorted array of attribute names, where <code>cupsArrayFind(array, |
| | 9727 | "attribute-name")</code> will return a non-NULL pointer. The array must be freed |
| | 9728 | using the <code>cupsArrayDelete</code> function. |
| | 9729 | |
| | 9730 | </p> |
| | 9731 | <h3 class="function"><a id="ippDateToTime">ippDateToTime</a></h3> |
| | 9732 | <p class="description">Convert from RFC 2579 Date/Time format to time in |
| | 9733 | seconds.</p> |
| | 9734 | <p class="code"> |
| | 9735 | time_t ippDateToTime(<span class="reserved">const</span> <a href="#ipp_uchar_t">ipp_uchar_t</a> *date);</p> |
| | 9736 | <h4 class="parameters">Parameters</h4> |
| | 9737 | <table class="list"><tbody> |
| | 9738 | <tr><th>date</th> |
| | 9739 | <td class="description">RFC 2579 date info</td></tr> |
| | 9740 | </tbody></table> |
| | 9741 | <h4 class="returnvalue">Return Value</h4> |
| | 9742 | <p class="description">UNIX time value</p> |
| | 9743 | <h3 class="function"><a id="ippDelete">ippDelete</a></h3> |
| | 9744 | <p class="description">Delete an IPP message.</p> |
| | 9745 | <p class="code"> |
| | 9746 | <span class="reserved">void</span> ippDelete(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 9747 | <h4 class="parameters">Parameters</h4> |
| | 9748 | <table class="list"><tbody> |
| | 9749 | <tr><th>ipp</th> |
| | 9750 | <td class="description">IPP message</td></tr> |
| | 9751 | </tbody></table> |
| | 9752 | <h3 class="function"><span class="info"> CUPS 1.1.19 </span><a id="ippDeleteAttribute">ippDeleteAttribute</a></h3> |
| | 9753 | <p class="description">Delete a single attribute in an IPP message.</p> |
| | 9754 | <p class="code"> |
| | 9755 | <span class="reserved">void</span> ippDeleteAttribute(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| | 9756 | <h4 class="parameters">Parameters</h4> |
| | 9757 | <table class="list"><tbody> |
| | 9758 | <tr><th>ipp</th> |
| | 9759 | <td class="description">IPP message</td></tr> |
| | 9760 | <tr><th>attr</th> |
| | 9761 | <td class="description">Attribute to delete</td></tr> |
| | 9762 | </tbody></table> |
| | 9763 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippDeleteValues">ippDeleteValues</a></h3> |
| | 9764 | <p class="description">Delete values in an attribute.</p> |
| | 9765 | <p class="code"> |
| | 9766 | <span class="reserved">int</span> ippDeleteValues(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <span class="reserved">int</span> count);</p> |
| | 9767 | <h4 class="parameters">Parameters</h4> |
| | 9768 | <table class="list"><tbody> |
| | 9769 | <tr><th>ipp</th> |
| | 9770 | <td class="description">IPP message</td></tr> |
| | 9771 | <tr><th>attr</th> |
| | 9772 | <td class="description">Attribute</td></tr> |
| | 9773 | <tr><th>element</th> |
| | 9774 | <td class="description">Index of first value to delete (0-based)</td></tr> |
| | 9775 | <tr><th>count</th> |
| | 9776 | <td class="description">Number of values to delete</td></tr> |
| | 9777 | </tbody></table> |
| | 9778 | <h4 class="returnvalue">Return Value</h4> |
| | 9779 | <p class="description">1 on success, 0 on failure</p> |
| | 9780 | <h4 class="discussion">Discussion</h4> |
| | 9781 | <p class="discussion">This function deletes one or more values in an attribute. The "element" |
| | 9782 | parameter specifies the first value to delete, starting at 0. It must be |
| | 9783 | less than the number of values returned by <a href="#ippGetCount"><code>ippGetCount</code></a>.<br> |
| | 9784 | <br> |
| | 9785 | The "attr" parameter may be modified as a result of setting the value, |
| | 9786 | which will set the variable to <code>NULL</code>.<br> |
| | 9787 | <br> |
| | 9788 | Deleting all values in an attribute deletes the attribute. |
| | 9789 | |
| | 9790 | </p> |
| | 9791 | <h3 class="function"><a id="ippEnumString">ippEnumString</a></h3> |
| | 9792 | <p class="description">Return a string corresponding to the enum value.</p> |
| | 9793 | <p class="code"> |
| | 9794 | <span class="reserved">const</span> <span class="reserved">char</span> *ippEnumString(<span class="reserved">const</span> <span class="reserved">char</span> *attrname, <span class="reserved">int</span> enumvalue);</p> |
| | 9795 | <h4 class="parameters">Parameters</h4> |
| | 9796 | <table class="list"><tbody> |
| | 9797 | <tr><th>attrname</th> |
| | 9798 | <td class="description">Attribute name</td></tr> |
| | 9799 | <tr><th>enumvalue</th> |
| | 9800 | <td class="description">Enum value</td></tr> |
| | 9801 | </tbody></table> |
| | 9802 | <h4 class="returnvalue">Return Value</h4> |
| | 9803 | <p class="description">Enum string</p> |
| | 9804 | <h3 class="function"><a id="ippEnumValue">ippEnumValue</a></h3> |
| | 9805 | <p class="description">Return the value associated with a given enum string.</p> |
| | 9806 | <p class="code"> |
| | 9807 | <span class="reserved">int</span> ippEnumValue(<span class="reserved">const</span> <span class="reserved">char</span> *attrname, <span class="reserved">const</span> <span class="reserved">char</span> *enumstring);</p> |
| | 9808 | <h4 class="parameters">Parameters</h4> |
| | 9809 | <table class="list"><tbody> |
| | 9810 | <tr><th>attrname</th> |
| | 9811 | <td class="description">Attribute name</td></tr> |
| | 9812 | <tr><th>enumstring</th> |
| | 9813 | <td class="description">Enum string</td></tr> |
| | 9814 | </tbody></table> |
| | 9815 | <h4 class="returnvalue">Return Value</h4> |
| | 9816 | <p class="description">Enum value or -1 if unknown</p> |
| | 9817 | <h3 class="function"><a id="ippErrorString">ippErrorString</a></h3> |
| | 9818 | <p class="description">Return a name for the given status code.</p> |
| | 9819 | <p class="code"> |
| | 9820 | <span class="reserved">const</span> <span class="reserved">char</span> *ippErrorString(ipp_status_t error);</p> |
| | 9821 | <h4 class="parameters">Parameters</h4> |
| | 9822 | <table class="list"><tbody> |
| | 9823 | <tr><th>error</th> |
| | 9824 | <td class="description">Error status</td></tr> |
| | 9825 | </tbody></table> |
| | 9826 | <h4 class="returnvalue">Return Value</h4> |
| | 9827 | <p class="description">Text string</p> |
| | 9828 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="ippErrorValue">ippErrorValue</a></h3> |
| | 9829 | <p class="description">Return a status code for the given name.</p> |
| | 9830 | <p class="code"> |
| | 9831 | ipp_status_t ippErrorValue(<span class="reserved">const</span> <span class="reserved">char</span> *name);</p> |
| | 9832 | <h4 class="parameters">Parameters</h4> |
| | 9833 | <table class="list"><tbody> |
| | 9834 | <tr><th>name</th> |
| | 9835 | <td class="description">Name</td></tr> |
| | 9836 | </tbody></table> |
| | 9837 | <h4 class="returnvalue">Return Value</h4> |
| | 9838 | <p class="description">IPP status code</p> |
| | 9839 | <h3 class="function"><a id="ippFileClose">ippFileClose</a></h3> |
| | 9840 | <p class="description">Close an IPP data file.</p> |
| | 9841 | <p class="code"> |
| | 9842 | <span class="reserved">bool</span> ippFileClose(<a href="#ipp_file_t">ipp_file_t</a> *file);</p> |
| | 9843 | <h4 class="parameters">Parameters</h4> |
| | 9844 | <table class="list"><tbody> |
| | 9845 | <tr><th>file</th> |
| | 9846 | <td class="description">IPP data file</td></tr> |
| | 9847 | </tbody></table> |
| | 9848 | <h4 class="returnvalue">Return Value</h4> |
| | 9849 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 9850 | <h4 class="discussion">Discussion</h4> |
| | 9851 | <p class="discussion">This function closes the current IPP data file. The <code>ipp_file_t</code> object can |
| | 9852 | be reused for another file as needed.</p> |
| | 9853 | <h3 class="function"><a id="ippFileDelete">ippFileDelete</a></h3> |
| | 9854 | <p class="description">Close an IPP data file and free all memory.</p> |
| | 9855 | <p class="code"> |
| | 9856 | <span class="reserved">bool</span> ippFileDelete(<a href="#ipp_file_t">ipp_file_t</a> *file);</p> |
| | 9857 | <h4 class="parameters">Parameters</h4> |
| | 9858 | <table class="list"><tbody> |
| | 9859 | <tr><th>file</th> |
| | 9860 | <td class="description">IPP data file</td></tr> |
| | 9861 | </tbody></table> |
| | 9862 | <h4 class="returnvalue">Return Value</h4> |
| | 9863 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 9864 | <h4 class="discussion">Discussion</h4> |
| | 9865 | <p class="discussion">This function closes an IPP data file, if necessary, and frees all memory |
| | 9866 | associated with it.</p> |
| | 9867 | <h3 class="function"><a id="ippFileExpandVars">ippFileExpandVars</a></h3> |
| | 9868 | <p class="description">Expand IPP data file and environment variables in a string.</p> |
| | 9869 | <p class="code"> |
| | 9870 | size_t ippFileExpandVars(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">char</span> *dst, <span class="reserved">const</span> <span class="reserved">char</span> *src, size_t dstsize);</p> |
| | 9871 | <h4 class="parameters">Parameters</h4> |
| | 9872 | <table class="list"><tbody> |
| | 9873 | <tr><th>file</th> |
| | 9874 | <td class="description">IPP data file</td></tr> |
| | 9875 | <tr><th>dst</th> |
| | 9876 | <td class="description">Destination buffer</td></tr> |
| | 9877 | <tr><th>src</th> |
| | 9878 | <td class="description">Source string</td></tr> |
| | 9879 | <tr><th>dstsize</th> |
| | 9880 | <td class="description">Size of destination buffer</td></tr> |
| | 9881 | </tbody></table> |
| | 9882 | <h4 class="returnvalue">Return Value</h4> |
| | 9883 | <p class="description">Required size for expanded variables</p> |
| | 9884 | <h4 class="discussion">Discussion</h4> |
| | 9885 | <p class="discussion">This function expands IPP data file variables of the form "$name" and |
| | 9886 | environment variables of the form "$ENV[name]" in the source string to the |
| | 9887 | destination string. The</p> |
| | 9888 | <h3 class="function"><a id="ippFileGetAttribute">ippFileGetAttribute</a></h3> |
| | 9889 | <p class="description">Get a single named attribute from an IPP data file.</p> |
| | 9890 | <p class="code"> |
| | 9891 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFileGetAttribute(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">const</span> <span class="reserved">char</span> *name, ipp_tag_t value_tag);</p> |
| | 9892 | <h4 class="parameters">Parameters</h4> |
| | 9893 | <table class="list"><tbody> |
| | 9894 | <tr><th>file</th> |
| | 9895 | <td class="description">IPP data file</td></tr> |
| | 9896 | <tr><th>name</th> |
| | 9897 | <td class="description">Attribute name</td></tr> |
| | 9898 | <tr><th>value_tag</th> |
| | 9899 | <td class="description">Value tag or <code>IPP_TAG_ZERO</code> for any</td></tr> |
| | 9900 | </tbody></table> |
| | 9901 | <h4 class="returnvalue">Return Value</h4> |
| | 9902 | <p class="description">Attribute or <code>NULL</code> if none</p> |
| | 9903 | <h4 class="discussion">Discussion</h4> |
| | 9904 | <p class="discussion">This function finds the first occurence of a named attribute in the current |
| | 9905 | IPP attributes in the specified data file. Unlike |
| | 9906 | <a href="#ippFileGetAttributes"><code>ippFileGetAttributes</code></a>, this function does not clear the attribute |
| | 9907 | state.</p> |
| | 9908 | <h3 class="function"><a id="ippFileGetAttributes">ippFileGetAttributes</a></h3> |
| | 9909 | <p class="description">Get the current set of attributes from an IPP data file.</p> |
| | 9910 | <p class="code"> |
| | 9911 | <a href="#ipp_t">ipp_t</a> *ippFileGetAttributes(<a href="#ipp_file_t">ipp_file_t</a> *file);</p> |
| | 9912 | <h4 class="parameters">Parameters</h4> |
| | 9913 | <table class="list"><tbody> |
| | 9914 | <tr><th>file</th> |
| | 9915 | <td class="description">IPP data file</td></tr> |
| | 9916 | </tbody></table> |
| | 9917 | <h4 class="returnvalue">Return Value</h4> |
| | 9918 | <p class="description">IPP attributes</p> |
| | 9919 | <h4 class="discussion">Discussion</h4> |
| | 9920 | <p class="discussion">This function gets the current set of attributes from an IPP data file.</p> |
| | 9921 | <h3 class="function"><a id="ippFileGetFilename">ippFileGetFilename</a></h3> |
| | 9922 | <p class="description">Get the filename for an IPP data file.</p> |
| | 9923 | <p class="code"> |
| | 9924 | <span class="reserved">const</span> <span class="reserved">char</span> *ippFileGetFilename(<a href="#ipp_file_t">ipp_file_t</a> *file);</p> |
| | 9925 | <h4 class="parameters">Parameters</h4> |
| | 9926 | <table class="list"><tbody> |
| | 9927 | <tr><th>file</th> |
| | 9928 | <td class="description">IPP data file</td></tr> |
| | 9929 | </tbody></table> |
| | 9930 | <h4 class="returnvalue">Return Value</h4> |
| | 9931 | <p class="description">Filename</p> |
| | 9932 | <h4 class="discussion">Discussion</h4> |
| | 9933 | <p class="discussion">This function returns the filename associated with an IPP data file.</p> |
| | 9934 | <h3 class="function"><a id="ippFileGetLineNumber">ippFileGetLineNumber</a></h3> |
| | 9935 | <p class="description">Get the current line number in an IPP data file.</p> |
| | 9936 | <p class="code"> |
| | 9937 | <span class="reserved">int</span> ippFileGetLineNumber(<a href="#ipp_file_t">ipp_file_t</a> *file);</p> |
| | 9938 | <h4 class="parameters">Parameters</h4> |
| | 9939 | <table class="list"><tbody> |
| | 9940 | <tr><th>file</th> |
| | 9941 | <td class="description">IPP data file</td></tr> |
| | 9942 | </tbody></table> |
| | 9943 | <h4 class="returnvalue">Return Value</h4> |
| | 9944 | <p class="description">Line number</p> |
| | 9945 | <h4 class="discussion">Discussion</h4> |
| | 9946 | <p class="discussion">This function returns the current line number in an IPP data file.</p> |
| | 9947 | <h3 class="function"><a id="ippFileGetVar">ippFileGetVar</a></h3> |
| | 9948 | <p class="description">Get the value of an IPP data file variable.</p> |
| | 9949 | <p class="code"> |
| | 9950 | <span class="reserved">const</span> <span class="reserved">char</span> *ippFileGetVar(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">const</span> <span class="reserved">char</span> *name);</p> |
| | 9951 | <h4 class="parameters">Parameters</h4> |
| | 9952 | <table class="list"><tbody> |
| | 9953 | <tr><th>file</th> |
| | 9954 | <td class="description">IPP data file</td></tr> |
| | 9955 | <tr><th>name</th> |
| | 9956 | <td class="description">Variable name</td></tr> |
| | 9957 | </tbody></table> |
| | 9958 | <h4 class="returnvalue">Return Value</h4> |
| | 9959 | <p class="description">Variable value or <code>NULL</code> if none.</p> |
| | 9960 | <h4 class="discussion">Discussion</h4> |
| | 9961 | <p class="discussion">This function returns the value of an IPP data file variable. <code>NULL</code> is |
| | 9962 | returned if the variable is not set.</p> |
| | 9963 | <h3 class="function"><a id="ippFileNew">ippFileNew</a></h3> |
| | 9964 | <p class="description">Create a new IPP data file object for reading or writing.</p> |
| | 9965 | <p class="code"> |
| | 9966 | <a href="#ipp_file_t">ipp_file_t</a> *ippFileNew(<a href="#ipp_file_t">ipp_file_t</a> *parent, <a href="#ipp_fattr_cb_t">ipp_fattr_cb_t</a> attr_cb, <a href="#ipp_ferror_cb_t">ipp_ferror_cb_t</a> error_cb, <span class="reserved">void</span> *cb_data);</p> |
| | 9967 | <h4 class="parameters">Parameters</h4> |
| | 9968 | <table class="list"><tbody> |
| | 9969 | <tr><th>parent</th> |
| | 9970 | <td class="description">Parent data file or <code>NULL</code> for none</td></tr> |
| | 9971 | <tr><th>attr_cb</th> |
| | 9972 | <td class="description">Attribute filtering callback, if any</td></tr> |
| | 9973 | <tr><th>error_cb</th> |
| | 9974 | <td class="description">Error reporting callback, if any</td></tr> |
| | 9975 | <tr><th>cb_data</th> |
| | 9976 | <td class="description">Callback data, if any</td></tr> |
| | 9977 | </tbody></table> |
| | 9978 | <h4 class="returnvalue">Return Value</h4> |
| | 9979 | <p class="description">IPP data file</p> |
| | 9980 | <h4 class="discussion">Discussion</h4> |
| | 9981 | <p class="discussion">This function opens an IPP data file for reading (mode="r") or writing |
| | 9982 | (mode="w"). If the "parent" argument is not <code>NULL</code>, all variables from the |
| | 9983 | parent data file are copied to the new file.</p> |
| | 9984 | <h3 class="function"><a id="ippFileOpen">ippFileOpen</a></h3> |
| | 9985 | <p class="description">Open an IPP data file for reading or writing.</p> |
| | 9986 | <p class="code"> |
| | 9987 | <span class="reserved">bool</span> ippFileOpen(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">const</span> <span class="reserved">char</span> *filename, <span class="reserved">const</span> <span class="reserved">char</span> *mode);</p> |
| | 9988 | <h4 class="parameters">Parameters</h4> |
| | 9989 | <table class="list"><tbody> |
| | 9990 | <tr><th>file</th> |
| | 9991 | <td class="description">IPP data file</td></tr> |
| | 9992 | <tr><th>filename</th> |
| | 9993 | <td class="description">Filename to open</td></tr> |
| | 9994 | <tr><th>mode</th> |
| | 9995 | <td class="description">Open mode - "r" to read and "w" to write</td></tr> |
| | 9996 | </tbody></table> |
| | 9997 | <h4 class="returnvalue">Return Value</h4> |
| | 9998 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 9999 | <h4 class="discussion">Discussion</h4> |
| | 10000 | <p class="discussion">This function opens an IPP data file for reading (mode="r") or writing |
| | 10001 | (mode="w"). If the "parent" argument is not <code>NULL</code>, all variables from the |
| | 10002 | parent data file are copied to the new file.</p> |
| | 10003 | <h3 class="function"><a id="ippFileRead">ippFileRead</a></h3> |
| | 10004 | <p class="description">Read an IPP data file.</p> |
| | 10005 | <p class="code"> |
| | 10006 | <span class="reserved">bool</span> ippFileRead(<a href="#ipp_file_t">ipp_file_t</a> *file, <a href="#ipp_ftoken_cb_t">ipp_ftoken_cb_t</a> token_cb, <span class="reserved">bool</span> with_groups);</p> |
| | 10007 | <h4 class="parameters">Parameters</h4> |
| | 10008 | <table class="list"><tbody> |
| | 10009 | <tr><th>file</th> |
| | 10010 | <td class="description">IPP data file</td></tr> |
| | 10011 | <tr><th>token_cb</th> |
| | 10012 | <td class="description">Token callback</td></tr> |
| | 10013 | <tr><th>with_groups</th> |
| | 10014 | <td class="description">Read attributes with GROUP directives</td></tr> |
| | 10015 | </tbody></table> |
| | 10016 | <h4 class="returnvalue">Return Value</h4> |
| | 10017 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 10018 | <h3 class="function"><a id="ippFileReadCollection">ippFileReadCollection</a></h3> |
| | 10019 | <p class="description">Read a collection from an IPP data file.</p> |
| | 10020 | <p class="code"> |
| | 10021 | <a href="#ipp_t">ipp_t</a> *ippFileReadCollection(<a href="#ipp_file_t">ipp_file_t</a> *file);</p> |
| | 10022 | <h4 class="parameters">Parameters</h4> |
| | 10023 | <table class="list"><tbody> |
| | 10024 | <tr><th>file</th> |
| | 10025 | <td class="description">IPP data file</td></tr> |
| | 10026 | </tbody></table> |
| | 10027 | <h4 class="returnvalue">Return Value</h4> |
| | 10028 | <p class="description">Collection value</p> |
| | 10029 | <h4 class="discussion">Discussion</h4> |
| | 10030 | <p class="discussion">This function reads a collection value from an IPP data file. Collection |
| | 10031 | values are surrounded by curly braces ("{" and "}") and have "MEMBER" |
| | 10032 | directives to define member attributes in the collection.</p> |
| | 10033 | <h3 class="function"><a id="ippFileReadToken">ippFileReadToken</a></h3> |
| | 10034 | <p class="description">Read a token from an IPP data file.</p> |
| | 10035 | <p class="code"> |
| | 10036 | <span class="reserved">bool</span> ippFileReadToken(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">char</span> *token, size_t tokensize);</p> |
| | 10037 | <h4 class="parameters">Parameters</h4> |
| | 10038 | <table class="list"><tbody> |
| | 10039 | <tr><th>file</th> |
| | 10040 | <td class="description">IPP data file</td></tr> |
| | 10041 | <tr><th>token</th> |
| | 10042 | <td class="description">Token buffer</td></tr> |
| | 10043 | <tr><th>tokensize</th> |
| | 10044 | <td class="description">Size of token buffer</td></tr> |
| | 10045 | </tbody></table> |
| | 10046 | <h4 class="returnvalue">Return Value</h4> |
| | 10047 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 10048 | <h4 class="discussion">Discussion</h4> |
| | 10049 | <p class="discussion">This function reads a single token or value from an IPP data file, skipping |
| | 10050 | comments and whitespace as needed.</p> |
| | 10051 | <h3 class="function"><a id="ippFileRestorePosition">ippFileRestorePosition</a></h3> |
| | 10052 | <p class="description">Restore the previous position in an IPP data file.</p> |
| | 10053 | <p class="code"> |
| | 10054 | <span class="reserved">bool</span> ippFileRestorePosition(<a href="#ipp_file_t">ipp_file_t</a> *file);</p> |
| | 10055 | <h4 class="parameters">Parameters</h4> |
| | 10056 | <table class="list"><tbody> |
| | 10057 | <tr><th>file</th> |
| | 10058 | <td class="description">IPP data file</td></tr> |
| | 10059 | </tbody></table> |
| | 10060 | <h4 class="returnvalue">Return Value</h4> |
| | 10061 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 10062 | <h4 class="discussion">Discussion</h4> |
| | 10063 | <p class="discussion">This function restores the previous position in an IPP data file that is open |
| | 10064 | for reading.</p> |
| | 10065 | <h3 class="function"><a id="ippFileSavePosition">ippFileSavePosition</a></h3> |
| | 10066 | <p class="description">Save the current position in an IPP data file.</p> |
| | 10067 | <p class="code"> |
| | 10068 | <span class="reserved">bool</span> ippFileSavePosition(<a href="#ipp_file_t">ipp_file_t</a> *file);</p> |
| | 10069 | <h4 class="parameters">Parameters</h4> |
| | 10070 | <table class="list"><tbody> |
| | 10071 | <tr><th>file</th> |
| | 10072 | <td class="description">IPP data file</td></tr> |
| | 10073 | </tbody></table> |
| | 10074 | <h4 class="returnvalue">Return Value</h4> |
| | 10075 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 10076 | <h4 class="discussion">Discussion</h4> |
| | 10077 | <p class="discussion">This function saves the current position in an IPP data file that is open |
| | 10078 | for reading.</p> |
| | 10079 | <h3 class="function"><a id="ippFileSetAttributes">ippFileSetAttributes</a></h3> |
| | 10080 | <p class="description">Set the attributes for an IPP data file.</p> |
| | 10081 | <p class="code"> |
| | 10082 | <span class="reserved">bool</span> ippFileSetAttributes(<a href="#ipp_file_t">ipp_file_t</a> *file, <a href="#ipp_t">ipp_t</a> *attrs);</p> |
| | 10083 | <h4 class="parameters">Parameters</h4> |
| | 10084 | <table class="list"><tbody> |
| | 10085 | <tr><th>file</th> |
| | 10086 | <td class="description">IPP data file</td></tr> |
| | 10087 | <tr><th>attrs</th> |
| | 10088 | <td class="description">IPP attributes</td></tr> |
| | 10089 | </tbody></table> |
| | 10090 | <h4 class="returnvalue">Return Value</h4> |
| | 10091 | <p class="description"><code>true</code> on success, <code>false</code> otherwise</p> |
| | 10092 | <h4 class="discussion">Discussion</h4> |
| | 10093 | <p class="discussion">This function sets the current set of attributes for an IPP data file, |
| | 10094 | typically an empty collection created with <a href="#ippNew"><code>ippNew</code></a>.</p> |
| | 10095 | <h3 class="function"><a id="ippFileSetGroupTag">ippFileSetGroupTag</a></h3> |
| | 10096 | <p class="description">Set the group tag for an IPP data file.</p> |
| | 10097 | <p class="code"> |
| | 10098 | <span class="reserved">bool</span> ippFileSetGroupTag(<a href="#ipp_file_t">ipp_file_t</a> *file, ipp_tag_t group_tag);</p> |
| | 10099 | <h4 class="parameters">Parameters</h4> |
| | 10100 | <table class="list"><tbody> |
| | 10101 | <tr><th>file</th> |
| | 10102 | <td class="description">IPP data file</td></tr> |
| | 10103 | <tr><th>group_tag</th> |
| | 10104 | <td class="description">Group tag</td></tr> |
| | 10105 | </tbody></table> |
| | 10106 | <h4 class="returnvalue">Return Value</h4> |
| | 10107 | <p class="description"><code>true</code> on success, <code>false</code> otherwise</p> |
| | 10108 | <h4 class="discussion">Discussion</h4> |
| | 10109 | <p class="discussion">This function sets the group tag associated with attributes that are read |
| | 10110 | from an IPP data file.</p> |
| | 10111 | <h3 class="function"><a id="ippFileSetVar">ippFileSetVar</a></h3> |
| | 10112 | <p class="description">Set an IPP data file variable to a constant value.</p> |
| | 10113 | <p class="code"> |
| | 10114 | <span class="reserved">bool</span> ippFileSetVar(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *value);</p> |
| | 10115 | <h4 class="parameters">Parameters</h4> |
| | 10116 | <table class="list"><tbody> |
| | 10117 | <tr><th>file</th> |
| | 10118 | <td class="description">IPP data file</td></tr> |
| | 10119 | <tr><th>name</th> |
| | 10120 | <td class="description">Variable name</td></tr> |
| | 10121 | <tr><th>value</th> |
| | 10122 | <td class="description">Value</td></tr> |
| | 10123 | </tbody></table> |
| | 10124 | <h4 class="returnvalue">Return Value</h4> |
| | 10125 | <p class="description"><code>true</code> on success, <code>false</code> on failure</p> |
| | 10126 | <h4 class="discussion">Discussion</h4> |
| | 10127 | <p class="discussion">This function sets an IPP data file variable to a constant value. Setting |
| | 10128 | the "uri" variable also initializes the "scheme", "uriuser", "hostname", |
| | 10129 | "port", and "resource" variables.</p> |
| | 10130 | <h3 class="function"><a id="ippFileSetVarf">ippFileSetVarf</a></h3> |
| | 10131 | <p class="description">Set an IPP data file variable to a formatted value.</p> |
| | 10132 | <p class="code"> |
| | 10133 | <span class="reserved">bool</span> ippFileSetVarf(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">const</span> <span class="reserved">char</span> *value, ...);</p> |
| | 10134 | <h4 class="parameters">Parameters</h4> |
| | 10135 | <table class="list"><tbody> |
| | 10136 | <tr><th>file</th> |
| | 10137 | <td class="description">IPP data file</td></tr> |
| | 10138 | <tr><th>name</th> |
| | 10139 | <td class="description">Variable name</td></tr> |
| | 10140 | <tr><th>value</th> |
| | 10141 | <td class="description">Printf-style value</td></tr> |
| | 10142 | <tr><th>...</th> |
| | 10143 | <td class="description">Additional arguments as needed</td></tr> |
| | 10144 | </tbody></table> |
| | 10145 | <h4 class="returnvalue">Return Value</h4> |
| | 10146 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 10147 | <h4 class="discussion">Discussion</h4> |
| | 10148 | <p class="discussion">This function sets an IPP data file variable to a formatted value. Setting |
| | 10149 | the "uri" variable also initializes the "scheme", "uriuser", "hostname", |
| | 10150 | "port", and "resource" variables.</p> |
| | 10151 | <h3 class="function"><a id="ippFileWriteAttributes">ippFileWriteAttributes</a></h3> |
| | 10152 | <p class="description">Write an IPP message to an IPP data file.</p> |
| | 10153 | <p class="code"> |
| | 10154 | <span class="reserved">bool</span> ippFileWriteAttributes(<a href="#ipp_file_t">ipp_file_t</a> *file, <a href="#ipp_t">ipp_t</a> *ipp, <span class="reserved">bool</span> with_groups);</p> |
| | 10155 | <h4 class="parameters">Parameters</h4> |
| | 10156 | <table class="list"><tbody> |
| | 10157 | <tr><th>file</th> |
| | 10158 | <td class="description">IPP data file</td></tr> |
| | 10159 | <tr><th>ipp</th> |
| | 10160 | <td class="description">IPP attributes to write</td></tr> |
| | 10161 | <tr><th>with_groups</th> |
| | 10162 | <td class="description"><code>true</code> to include GROUPs, <code>false</code> otherwise</td></tr> |
| | 10163 | </tbody></table> |
| | 10164 | <h4 class="returnvalue">Return Value</h4> |
| | 10165 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 10166 | <h4 class="discussion">Discussion</h4> |
| | 10167 | <p class="discussion">This function writes an IPP message to an IPP data file using the attribute |
| | 10168 | filter specified in the call to <a href="#ippFileOpen"><code>ippFileOpen</code></a>. If "with_group" is |
| | 10169 | <code>true</code>, "GROUP" directives are written as necessary to place the attributes |
| | 10170 | in the correct groups.</p> |
| | 10171 | <h3 class="function"><a id="ippFileWriteComment">ippFileWriteComment</a></h3> |
| | 10172 | <p class="description">Write a comment to an IPP data file.</p> |
| | 10173 | <p class="code"> |
| | 10174 | <span class="reserved">bool</span> ippFileWriteComment(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">const</span> <span class="reserved">char</span> *comment, ...);</p> |
| | 10175 | <h4 class="parameters">Parameters</h4> |
| | 10176 | <table class="list"><tbody> |
| | 10177 | <tr><th>file</th> |
| | 10178 | <td class="description">IPP data file</td></tr> |
| | 10179 | <tr><th>comment</th> |
| | 10180 | <td class="description">Printf-style comment string</td></tr> |
| | 10181 | <tr><th>...</th> |
| | 10182 | <td class="description">Additional arguments as needed</td></tr> |
| | 10183 | </tbody></table> |
| | 10184 | <h4 class="returnvalue">Return Value</h4> |
| | 10185 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 10186 | <h4 class="discussion">Discussion</h4> |
| | 10187 | <p class="discussion">This function writes a comment to an IPP data file. Every line in the string |
| | 10188 | is prefixed with the "#" character and indented as needed.</p> |
| | 10189 | <h3 class="function"><a id="ippFileWriteToken">ippFileWriteToken</a></h3> |
| | 10190 | <p class="description">Write a token or value string to an IPP data file.</p> |
| | 10191 | <p class="code"> |
| | 10192 | <span class="reserved">bool</span> ippFileWriteToken(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">const</span> <span class="reserved">char</span> *token);</p> |
| | 10193 | <h4 class="parameters">Parameters</h4> |
| | 10194 | <table class="list"><tbody> |
| | 10195 | <tr><th>file</th> |
| | 10196 | <td class="description">IPP data file</td></tr> |
| | 10197 | <tr><th>token</th> |
| | 10198 | <td class="description">Token/value string</td></tr> |
| | 10199 | </tbody></table> |
| | 10200 | <h4 class="returnvalue">Return Value</h4> |
| | 10201 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 10202 | <h4 class="discussion">Discussion</h4> |
| | 10203 | <p class="discussion">This function writes a token or value string to an IPP data file, quoting |
| | 10204 | and indenting the string as needed.</p> |
| | 10205 | <h3 class="function"><a id="ippFileWriteTokenf">ippFileWriteTokenf</a></h3> |
| | 10206 | <p class="description">Write a formatted token or value string to an IPP data file.</p> |
| | 10207 | <p class="code"> |
| | 10208 | <span class="reserved">bool</span> ippFileWriteTokenf(<a href="#ipp_file_t">ipp_file_t</a> *file, <span class="reserved">const</span> <span class="reserved">char</span> *token, ...);</p> |
| | 10209 | <h4 class="parameters">Parameters</h4> |
| | 10210 | <table class="list"><tbody> |
| | 10211 | <tr><th>file</th> |
| | 10212 | <td class="description">IPP data file</td></tr> |
| | 10213 | <tr><th>token</th> |
| | 10214 | <td class="description">Printf-style token/value string</td></tr> |
| | 10215 | <tr><th>...</th> |
| | 10216 | <td class="description">Additional arguments as needed</td></tr> |
| | 10217 | </tbody></table> |
| | 10218 | <h4 class="returnvalue">Return Value</h4> |
| | 10219 | <p class="description"><code>true</code> on success, <code>false</code> on error</p> |
| | 10220 | <h4 class="discussion">Discussion</h4> |
| | 10221 | <p class="discussion">This function writes a formatted token or value string to an IPP data file, |
| | 10222 | quoting and indenting the string as needed.</p> |
| | 10223 | <h3 class="function"><a id="ippFindAttribute">ippFindAttribute</a></h3> |
| | 10224 | <p class="description">Find a named attribute in a request.</p> |
| | 10225 | <p class="code"> |
| | 10226 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindAttribute(<a href="#ipp_t">ipp_t</a> *ipp, <span class="reserved">const</span> <span class="reserved">char</span> *name, ipp_tag_t type);</p> |
| | 10227 | <h4 class="parameters">Parameters</h4> |
| | 10228 | <table class="list"><tbody> |
| | 10229 | <tr><th>ipp</th> |
| | 10230 | <td class="description">IPP message</td></tr> |
| | 10231 | <tr><th>name</th> |
| | 10232 | <td class="description">Name of attribute</td></tr> |
| | 10233 | <tr><th>type</th> |
| | 10234 | <td class="description">Type of attribute</td></tr> |
| | 10235 | </tbody></table> |
| | 10236 | <h4 class="returnvalue">Return Value</h4> |
| | 10237 | <p class="description">Matching attribute</p> |
| | 10238 | <h4 class="discussion">Discussion</h4> |
| | 10239 | <p class="discussion">This function finds the first occurrence of a named attribute in an IPP |
| | 10240 | message. The attribute name can contain a hierarchical list of attribute and |
| | 10241 | member names separated by slashes, for example "media-col/media-size".</p> |
| | 10242 | <h3 class="function"><a id="ippFindNextAttribute">ippFindNextAttribute</a></h3> |
| | 10243 | <p class="description">Find the next named attribute in a request.</p> |
| | 10244 | <p class="code"> |
| | 10245 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindNextAttribute(<a href="#ipp_t">ipp_t</a> *ipp, <span class="reserved">const</span> <span class="reserved">char</span> *name, ipp_tag_t type);</p> |
| | 10246 | <h4 class="parameters">Parameters</h4> |
| | 10247 | <table class="list"><tbody> |
| | 10248 | <tr><th>ipp</th> |
| | 10249 | <td class="description">IPP message</td></tr> |
| | 10250 | <tr><th>name</th> |
| | 10251 | <td class="description">Name of attribute</td></tr> |
| | 10252 | <tr><th>type</th> |
| | 10253 | <td class="description">Type of attribute</td></tr> |
| | 10254 | </tbody></table> |
| | 10255 | <h4 class="returnvalue">Return Value</h4> |
| | 10256 | <p class="description">Matching attribute</p> |
| | 10257 | <h4 class="discussion">Discussion</h4> |
| | 10258 | <p class="discussion">This function finds the next named attribute in an IPP message. The |
| | 10259 | attribute name can contain a hierarchical list of attribute and member names |
| | 10260 | separated by slashes, for example "media-col/media-size".</p> |
| | 10261 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetBoolean">ippGetBoolean</a></h3> |
| | 10262 | <p class="description">Get a boolean value for an attribute.</p> |
| | 10263 | <p class="code"> |
| | 10264 | <span class="reserved">int</span> ippGetBoolean(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">int</span> element);</p> |
| | 10265 | <h4 class="parameters">Parameters</h4> |
| | 10266 | <table class="list"><tbody> |
| | 10267 | <tr><th>attr</th> |
| | 10268 | <td class="description">IPP attribute</td></tr> |
| | 10269 | <tr><th>element</th> |
| | 10270 | <td class="description">Value number (0-based)</td></tr> |
| | 10271 | </tbody></table> |
| | 10272 | <h4 class="returnvalue">Return Value</h4> |
| | 10273 | <p class="description">Boolean value or 0 on error</p> |
| | 10274 | <h4 class="discussion">Discussion</h4> |
| | 10275 | <p class="discussion">The "element" parameter specifies which value to get from 0 to |
| | 10276 | <code>ippGetCount(attr)</code> - 1. |
| | 10277 | |
| | 10278 | </p> |
| | 10279 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetCollection">ippGetCollection</a></h3> |
| | 10280 | <p class="description">Get a collection value for an attribute.</p> |
| | 10281 | <p class="code"> |
| | 10282 | <a href="#ipp_t">ipp_t</a> *ippGetCollection(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">int</span> element);</p> |
| | 10283 | <h4 class="parameters">Parameters</h4> |
| | 10284 | <table class="list"><tbody> |
| | 10285 | <tr><th>attr</th> |
| | 10286 | <td class="description">IPP attribute</td></tr> |
| | 10287 | <tr><th>element</th> |
| | 10288 | <td class="description">Value number (0-based)</td></tr> |
| | 10289 | </tbody></table> |
| | 10290 | <h4 class="returnvalue">Return Value</h4> |
| | 10291 | <p class="description">Collection value or <code>NULL</code> on error</p> |
| | 10292 | <h4 class="discussion">Discussion</h4> |
| | 10293 | <p class="discussion">The "element" parameter specifies which value to get from 0 to |
| | 10294 | <code>ippGetCount(attr)</code> - 1. |
| | 10295 | |
| | 10296 | </p> |
| | 10297 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetCount">ippGetCount</a></h3> |
| | 10298 | <p class="description">Get the number of values in an attribute.</p> |
| | 10299 | <p class="code"> |
| | 10300 | <span class="reserved">int</span> ippGetCount(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| | 10301 | <h4 class="parameters">Parameters</h4> |
| | 10302 | <table class="list"><tbody> |
| | 10303 | <tr><th>attr</th> |
| | 10304 | <td class="description">IPP attribute</td></tr> |
| | 10305 | </tbody></table> |
| | 10306 | <h4 class="returnvalue">Return Value</h4> |
| | 10307 | <p class="description">Number of values or 0 on error</p> |
| | 10308 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetDate">ippGetDate</a></h3> |
| | 10309 | <p class="description">Get a dateTime value for an attribute.</p> |
| | 10310 | <p class="code"> |
| | 10311 | <span class="reserved">const</span> <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippGetDate(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">int</span> element);</p> |
| | 10312 | <h4 class="parameters">Parameters</h4> |
| | 10313 | <table class="list"><tbody> |
| | 10314 | <tr><th>attr</th> |
| | 10315 | <td class="description">IPP attribute</td></tr> |
| | 10316 | <tr><th>element</th> |
| | 10317 | <td class="description">Value number (0-based)</td></tr> |
| | 10318 | </tbody></table> |
| | 10319 | <h4 class="returnvalue">Return Value</h4> |
| | 10320 | <p class="description">dateTime value or <code>NULL</code></p> |
| | 10321 | <h4 class="discussion">Discussion</h4> |
| | 10322 | <p class="discussion">The "element" parameter specifies which value to get from 0 to |
| | 10323 | <code>ippGetCount(attr)</code> - 1. |
| | 10324 | |
| | 10325 | </p> |
| | 10326 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="ippGetFirstAttribute">ippGetFirstAttribute</a></h3> |
| | 10327 | <p class="description">Return the first attribute in the message.</p> |
| | 10328 | <p class="code"> |
| | 10329 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippGetFirstAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10330 | <h4 class="parameters">Parameters</h4> |
| | 10331 | <table class="list"><tbody> |
| | 10332 | <tr><th>ipp</th> |
| | 10333 | <td class="description">IPP message</td></tr> |
| | 10334 | </tbody></table> |
| | 10335 | <h4 class="returnvalue">Return Value</h4> |
| | 10336 | <p class="description">First attribute or <code>NULL</code> if none</p> |
| | 10337 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetGroupTag">ippGetGroupTag</a></h3> |
| | 10338 | <p class="description">Get the group associated with an attribute.</p> |
| | 10339 | <p class="code"> |
| | 10340 | ipp_tag_t ippGetGroupTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| | 10341 | <h4 class="parameters">Parameters</h4> |
| | 10342 | <table class="list"><tbody> |
| | 10343 | <tr><th>attr</th> |
| | 10344 | <td class="description">IPP attribute</td></tr> |
| | 10345 | </tbody></table> |
| | 10346 | <h4 class="returnvalue">Return Value</h4> |
| | 10347 | <p class="description">Group tag or <code>IPP_TAG_ZERO</code> on error</p> |
| | 10348 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetInteger">ippGetInteger</a></h3> |
| | 10349 | <p class="description">Get the integer/enum value for an attribute.</p> |
| | 10350 | <p class="code"> |
| | 10351 | <span class="reserved">int</span> ippGetInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">int</span> element);</p> |
| | 10352 | <h4 class="parameters">Parameters</h4> |
| | 10353 | <table class="list"><tbody> |
| | 10354 | <tr><th>attr</th> |
| | 10355 | <td class="description">IPP attribute</td></tr> |
| | 10356 | <tr><th>element</th> |
| | 10357 | <td class="description">Value number (0-based)</td></tr> |
| | 10358 | </tbody></table> |
| | 10359 | <h4 class="returnvalue">Return Value</h4> |
| | 10360 | <p class="description">Value or 0 on error</p> |
| | 10361 | <h4 class="discussion">Discussion</h4> |
| | 10362 | <p class="discussion">The "element" parameter specifies which value to get from 0 to |
| | 10363 | <code>ippGetCount(attr)</code> - 1. |
| | 10364 | |
| | 10365 | </p> |
| | 10366 | <h3 class="function"><a id="ippGetLength">ippGetLength</a></h3> |
| | 10367 | <p class="description">Compute the length of an IPP message.</p> |
| | 10368 | <p class="code"> |
| | 10369 | size_t ippGetLength(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10370 | <h4 class="parameters">Parameters</h4> |
| | 10371 | <table class="list"><tbody> |
| | 10372 | <tr><th>ipp</th> |
| | 10373 | <td class="description">IPP message</td></tr> |
| | 10374 | </tbody></table> |
| | 10375 | <h4 class="returnvalue">Return Value</h4> |
| | 10376 | <p class="description">Size of IPP message</p> |
| | 10377 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetName">ippGetName</a></h3> |
| | 10378 | <p class="description">Get the attribute name.</p> |
| | 10379 | <p class="code"> |
| | 10380 | <span class="reserved">const</span> <span class="reserved">char</span> *ippGetName(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| | 10381 | <h4 class="parameters">Parameters</h4> |
| | 10382 | <table class="list"><tbody> |
| | 10383 | <tr><th>attr</th> |
| | 10384 | <td class="description">IPP attribute</td></tr> |
| | 10385 | </tbody></table> |
| | 10386 | <h4 class="returnvalue">Return Value</h4> |
| | 10387 | <p class="description">Attribute name or <code>NULL</code> for separators</p> |
| | 10388 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="ippGetNextAttribute">ippGetNextAttribute</a></h3> |
| | 10389 | <p class="description">Return the next attribute in the message.</p> |
| | 10390 | <p class="code"> |
| | 10391 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippGetNextAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10392 | <h4 class="parameters">Parameters</h4> |
| | 10393 | <table class="list"><tbody> |
| | 10394 | <tr><th>ipp</th> |
| | 10395 | <td class="description">IPP message</td></tr> |
| | 10396 | </tbody></table> |
| | 10397 | <h4 class="returnvalue">Return Value</h4> |
| | 10398 | <p class="description">Next attribute or <code>NULL</code> if none</p> |
| | 10399 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippGetOctetString">ippGetOctetString</a></h3> |
| | 10400 | <p class="description">Get an octetString value from an IPP attribute.</p> |
| | 10401 | <p class="code"> |
| | 10402 | <span class="reserved">void</span> *ippGetOctetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">int</span> element, <span class="reserved">int</span> *datalen);</p> |
| | 10403 | <h4 class="parameters">Parameters</h4> |
| | 10404 | <table class="list"><tbody> |
| | 10405 | <tr><th>attr</th> |
| | 10406 | <td class="description">IPP attribute</td></tr> |
| | 10407 | <tr><th>element</th> |
| | 10408 | <td class="description">Value number (0-based)</td></tr> |
| | 10409 | <tr><th>datalen</th> |
| | 10410 | <td class="description">Length of octetString data</td></tr> |
| | 10411 | </tbody></table> |
| | 10412 | <h4 class="returnvalue">Return Value</h4> |
| | 10413 | <p class="description">Pointer to octetString data</p> |
| | 10414 | <h4 class="discussion">Discussion</h4> |
| | 10415 | <p class="discussion">The "element" parameter specifies which value to get from 0 to |
| | 10416 | <code>ippGetCount(attr)</code> - 1. |
| | 10417 | |
| | 10418 | </p> |
| | 10419 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetOperation">ippGetOperation</a></h3> |
| | 10420 | <p class="description">Get the operation ID in an IPP message.</p> |
| | 10421 | <p class="code"> |
| | 10422 | <a href="#ipp_op_t">ipp_op_t</a> ippGetOperation(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10423 | <h4 class="parameters">Parameters</h4> |
| | 10424 | <table class="list"><tbody> |
| | 10425 | <tr><th>ipp</th> |
| | 10426 | <td class="description">IPP request message</td></tr> |
| | 10427 | </tbody></table> |
| | 10428 | <h4 class="returnvalue">Return Value</h4> |
| | 10429 | <p class="description">Operation ID or 0 on error</p> |
| | 10430 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="ippGetPort">ippGetPort</a></h3> |
| | 10431 | <p class="description">Return the default IPP port number.</p> |
| | 10432 | <p class="code"> |
| | 10433 | <span class="reserved">int</span> ippGetPort(<span class="reserved">void</span>);</p> |
| | 10434 | <h4 class="returnvalue">Return Value</h4> |
| | 10435 | <p class="description">Port number</p> |
| | 10436 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetRange">ippGetRange</a></h3> |
| | 10437 | <p class="description">Get a rangeOfInteger value from an attribute.</p> |
| | 10438 | <p class="code"> |
| | 10439 | <span class="reserved">int</span> ippGetRange(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">int</span> element, <span class="reserved">int</span> *uppervalue);</p> |
| | 10440 | <h4 class="parameters">Parameters</h4> |
| | 10441 | <table class="list"><tbody> |
| | 10442 | <tr><th>attr</th> |
| | 10443 | <td class="description">IPP attribute</td></tr> |
| | 10444 | <tr><th>element</th> |
| | 10445 | <td class="description">Value number (0-based)</td></tr> |
| | 10446 | <tr><th>uppervalue</th> |
| | 10447 | <td class="description">Upper value of range</td></tr> |
| | 10448 | </tbody></table> |
| | 10449 | <h4 class="returnvalue">Return Value</h4> |
| | 10450 | <p class="description">Lower value of range or 0</p> |
| | 10451 | <h4 class="discussion">Discussion</h4> |
| | 10452 | <p class="discussion">The "element" parameter specifies which value to get from 0 to |
| | 10453 | <code>ippGetCount(attr)</code> - 1. |
| | 10454 | |
| | 10455 | </p> |
| | 10456 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetRequestId">ippGetRequestId</a></h3> |
| | 10457 | <p class="description">Get the request ID from an IPP message.</p> |
| | 10458 | <p class="code"> |
| | 10459 | <span class="reserved">int</span> ippGetRequestId(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10460 | <h4 class="parameters">Parameters</h4> |
| | 10461 | <table class="list"><tbody> |
| | 10462 | <tr><th>ipp</th> |
| | 10463 | <td class="description">IPP message</td></tr> |
| | 10464 | </tbody></table> |
| | 10465 | <h4 class="returnvalue">Return Value</h4> |
| | 10466 | <p class="description">Request ID or 0 on error</p> |
| | 10467 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetResolution">ippGetResolution</a></h3> |
| | 10468 | <p class="description">Get a resolution value for an attribute.</p> |
| | 10469 | <p class="code"> |
| | 10470 | <span class="reserved">int</span> ippGetResolution(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">int</span> element, <span class="reserved">int</span> *yres, <a href="#ipp_res_t">ipp_res_t</a> *units);</p> |
| | 10471 | <h4 class="parameters">Parameters</h4> |
| | 10472 | <table class="list"><tbody> |
| | 10473 | <tr><th>attr</th> |
| | 10474 | <td class="description">IPP attribute</td></tr> |
| | 10475 | <tr><th>element</th> |
| | 10476 | <td class="description">Value number (0-based)</td></tr> |
| | 10477 | <tr><th>yres</th> |
| | 10478 | <td class="description">Vertical/feed resolution</td></tr> |
| | 10479 | <tr><th>units</th> |
| | 10480 | <td class="description">Units for resolution</td></tr> |
| | 10481 | </tbody></table> |
| | 10482 | <h4 class="returnvalue">Return Value</h4> |
| | 10483 | <p class="description">Horizontal/cross feed resolution or 0</p> |
| | 10484 | <h4 class="discussion">Discussion</h4> |
| | 10485 | <p class="discussion">The "element" parameter specifies which value to get from 0 to |
| | 10486 | <code>ippGetCount(attr)</code> - 1. |
| | 10487 | |
| | 10488 | </p> |
| | 10489 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetState">ippGetState</a></h3> |
| | 10490 | <p class="description">Get the IPP message state.</p> |
| | 10491 | <p class="code"> |
| | 10492 | <a href="#ipp_state_t">ipp_state_t</a> ippGetState(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10493 | <h4 class="parameters">Parameters</h4> |
| | 10494 | <table class="list"><tbody> |
| | 10495 | <tr><th>ipp</th> |
| | 10496 | <td class="description">IPP message</td></tr> |
| | 10497 | </tbody></table> |
| | 10498 | <h4 class="returnvalue">Return Value</h4> |
| | 10499 | <p class="description">IPP message state value</p> |
| | 10500 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetStatusCode">ippGetStatusCode</a></h3> |
| | 10501 | <p class="description">Get the status code from an IPP response or event message.</p> |
| | 10502 | <p class="code"> |
| | 10503 | ipp_status_t ippGetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10504 | <h4 class="parameters">Parameters</h4> |
| | 10505 | <table class="list"><tbody> |
| | 10506 | <tr><th>ipp</th> |
| | 10507 | <td class="description">IPP response or event message</td></tr> |
| | 10508 | </tbody></table> |
| | 10509 | <h4 class="returnvalue">Return Value</h4> |
| | 10510 | <p class="description">Status code in IPP message</p> |
| | 10511 | <h3 class="function"><a id="ippGetString">ippGetString</a></h3> |
| | 10512 | <p class="description"></p> |
| | 10513 | <p class="code"> |
| | 10514 | <span class="reserved">const</span> <span class="reserved">char</span> *ippGetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, <span class="reserved">int</span> element, <span class="reserved">const</span> <span class="reserved">char</span> **language);</p> |
| | 10515 | <h4 class="parameters">Parameters</h4> |
| | 10516 | <table class="list"><tbody> |
| | 10517 | <tr><th>attr</th> |
| | 10518 | <td class="description">IPP attribute</td></tr> |
| | 10519 | <tr><th>element</th> |
| | 10520 | <td class="description">Value number (0-based)</td></tr> |
| | 10521 | <tr><th>language</th> |
| | 10522 | <td class="description">Language code (<code>NULL</code> for don't care)</td></tr> |
| | 10523 | </tbody></table> |
| | 10524 | <h4 class="returnvalue">Return Value</h4> |
| | 10525 | <p class="description">Get the string and optionally the language code for an attribute.</p> |
| | 10526 | <p class="discussion">The "element" parameter specifies which value to get from 0 to |
| | 10527 | <code>ippGetCount(attr)</code> - 1. |
| | 10528 | |
| | 10529 | </p> |
| | 10530 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetValueTag">ippGetValueTag</a></h3> |
| | 10531 | <p class="description">Get the value tag for an attribute.</p> |
| | 10532 | <p class="code"> |
| | 10533 | ipp_tag_t ippGetValueTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| | 10534 | <h4 class="parameters">Parameters</h4> |
| | 10535 | <table class="list"><tbody> |
| | 10536 | <tr><th>attr</th> |
| | 10537 | <td class="description">IPP attribute</td></tr> |
| | 10538 | </tbody></table> |
| | 10539 | <h4 class="returnvalue">Return Value</h4> |
| | 10540 | <p class="description">Value tag or <code>IPP_TAG_ZERO</code> on error</p> |
| | 10541 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippGetVersion">ippGetVersion</a></h3> |
| | 10542 | <p class="description">Get the major and minor version number from an IPP message.</p> |
| | 10543 | <p class="code"> |
| | 10544 | <span class="reserved">int</span> ippGetVersion(<a href="#ipp_t">ipp_t</a> *ipp, <span class="reserved">int</span> *minor);</p> |
| | 10545 | <h4 class="parameters">Parameters</h4> |
| | 10546 | <table class="list"><tbody> |
| | 10547 | <tr><th>ipp</th> |
| | 10548 | <td class="description">IPP message</td></tr> |
| | 10549 | <tr><th>minor</th> |
| | 10550 | <td class="description">Minor version number or <code>NULL</code> for don't care</td></tr> |
| | 10551 | </tbody></table> |
| | 10552 | <h4 class="returnvalue">Return Value</h4> |
| | 10553 | <p class="description">Major version number or 0 on error</p> |
| | 10554 | <h3 class="function"><a id="ippNew">ippNew</a></h3> |
| | 10555 | <p class="description">Allocate a new IPP message.</p> |
| | 10556 | <p class="code"> |
| | 10557 | <a href="#ipp_t">ipp_t</a> *ippNew(<span class="reserved">void</span>);</p> |
| | 10558 | <h4 class="returnvalue">Return Value</h4> |
| | 10559 | <p class="description">New IPP message</p> |
| | 10560 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="ippNewRequest">ippNewRequest</a></h3> |
| | 10561 | <p class="description">Allocate a new IPP request message.</p> |
| | 10562 | <p class="code"> |
| | 10563 | <a href="#ipp_t">ipp_t</a> *ippNewRequest(<a href="#ipp_op_t">ipp_op_t</a> op);</p> |
| | 10564 | <h4 class="parameters">Parameters</h4> |
| | 10565 | <table class="list"><tbody> |
| | 10566 | <tr><th>op</th> |
| | 10567 | <td class="description">Operation code</td></tr> |
| | 10568 | </tbody></table> |
| | 10569 | <h4 class="returnvalue">Return Value</h4> |
| | 10570 | <p class="description">IPP request message</p> |
| | 10571 | <h4 class="discussion">Discussion</h4> |
| | 10572 | <p class="discussion">The new request message is initialized with the "attributes-charset" and |
| | 10573 | "attributes-natural-language" attributes added. The |
| | 10574 | "attributes-natural-language" value is derived from the current locale. |
| | 10575 | |
| | 10576 | </p> |
| | 10577 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippNewResponse">ippNewResponse</a></h3> |
| | 10578 | <p class="description">Allocate a new IPP response message.</p> |
| | 10579 | <p class="code"> |
| | 10580 | <a href="#ipp_t">ipp_t</a> *ippNewResponse(<a href="#ipp_t">ipp_t</a> *request);</p> |
| | 10581 | <h4 class="parameters">Parameters</h4> |
| | 10582 | <table class="list"><tbody> |
| | 10583 | <tr><th>request</th> |
| | 10584 | <td class="description">IPP request message</td></tr> |
| | 10585 | </tbody></table> |
| | 10586 | <h4 class="returnvalue">Return Value</h4> |
| | 10587 | <p class="description">IPP response message</p> |
| | 10588 | <h4 class="discussion">Discussion</h4> |
| | 10589 | <p class="discussion">The new response message is initialized with the same "version-number", |
| | 10590 | "request-id", "attributes-charset", and "attributes-natural-language" as the |
| | 10591 | provided request message. If the "attributes-charset" or |
| | 10592 | "attributes-natural-language" attributes are missing from the request, |
| | 10593 | 'utf-8' and a value derived from the current locale are substituted, |
| | 10594 | respectively. |
| | 10595 | |
| | 10596 | </p> |
| | 10597 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="ippOpString">ippOpString</a></h3> |
| | 10598 | <p class="description">Return a name for the given operation id.</p> |
| | 10599 | <p class="code"> |
| | 10600 | <span class="reserved">const</span> <span class="reserved">char</span> *ippOpString(<a href="#ipp_op_t">ipp_op_t</a> op);</p> |
| | 10601 | <h4 class="parameters">Parameters</h4> |
| | 10602 | <table class="list"><tbody> |
| | 10603 | <tr><th>op</th> |
| | 10604 | <td class="description">Operation ID</td></tr> |
| | 10605 | </tbody></table> |
| | 10606 | <h4 class="returnvalue">Return Value</h4> |
| | 10607 | <p class="description">Name</p> |
| | 10608 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="ippOpValue">ippOpValue</a></h3> |
| | 10609 | <p class="description">Return an operation id for the given name.</p> |
| | 10610 | <p class="code"> |
| | 10611 | <a href="#ipp_op_t">ipp_op_t</a> ippOpValue(<span class="reserved">const</span> <span class="reserved">char</span> *name);</p> |
| | 10612 | <h4 class="parameters">Parameters</h4> |
| | 10613 | <table class="list"><tbody> |
| | 10614 | <tr><th>name</th> |
| | 10615 | <td class="description">Textual name</td></tr> |
| | 10616 | </tbody></table> |
| | 10617 | <h4 class="returnvalue">Return Value</h4> |
| | 10618 | <p class="description">Operation ID</p> |
| | 10619 | <h3 class="function"><a id="ippRead">ippRead</a></h3> |
| | 10620 | <p class="description">Read data for an IPP message from a HTTP connection.</p> |
| | 10621 | <p class="code"> |
| | 10622 | <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> |
| | 10623 | <h4 class="parameters">Parameters</h4> |
| | 10624 | <table class="list"><tbody> |
| | 10625 | <tr><th>http</th> |
| | 10626 | <td class="description">HTTP connection</td></tr> |
| | 10627 | <tr><th>ipp</th> |
| | 10628 | <td class="description">IPP data</td></tr> |
| | 10629 | </tbody></table> |
| | 10630 | <h4 class="returnvalue">Return Value</h4> |
| | 10631 | <p class="description">Current state</p> |
| | 10632 | <h3 class="function"><span class="info"> CUPS 1.1.19 </span><a id="ippReadFile">ippReadFile</a></h3> |
| | 10633 | <p class="description">Read data for an IPP message from a file.</p> |
| | 10634 | <p class="code"> |
| | 10635 | <a href="#ipp_state_t">ipp_state_t</a> ippReadFile(<span class="reserved">int</span> fd, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10636 | <h4 class="parameters">Parameters</h4> |
| | 10637 | <table class="list"><tbody> |
| | 10638 | <tr><th>fd</th> |
| | 10639 | <td class="description">HTTP data</td></tr> |
| | 10640 | <tr><th>ipp</th> |
| | 10641 | <td class="description">IPP data</td></tr> |
| | 10642 | </tbody></table> |
| | 10643 | <h4 class="returnvalue">Return Value</h4> |
| | 10644 | <p class="description">Current state</p> |
| | 10645 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="ippReadIO">ippReadIO</a></h3> |
| | 10646 | <p class="description">Read data for an IPP message.</p> |
| | 10647 | <p class="code"> |
| | 10648 | <a href="#ipp_state_t">ipp_state_t</a> ippReadIO(<span class="reserved">void</span> *src, <a href="#ipp_io_cb_t">ipp_io_cb_t</a> cb, <span class="reserved">int</span> blocking, <a href="#ipp_t">ipp_t</a> *parent, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10649 | <h4 class="parameters">Parameters</h4> |
| | 10650 | <table class="list"><tbody> |
| | 10651 | <tr><th>src</th> |
| | 10652 | <td class="description">Data source</td></tr> |
| | 10653 | <tr><th>cb</th> |
| | 10654 | <td class="description">Read callback function</td></tr> |
| | 10655 | <tr><th>blocking</th> |
| | 10656 | <td class="description">Use blocking IO?</td></tr> |
| | 10657 | <tr><th>parent</th> |
| | 10658 | <td class="description">Parent request, if any</td></tr> |
| | 10659 | <tr><th>ipp</th> |
| | 10660 | <td class="description">IPP data</td></tr> |
| | 10661 | </tbody></table> |
| | 10662 | <h4 class="returnvalue">Return Value</h4> |
| | 10663 | <p class="description">Current state</p> |
| | 10664 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="ippRestore">ippRestore</a></h3> |
| | 10665 | <p class="description">Restore a previously saved find position.</p> |
| | 10666 | <p class="code"> |
| | 10667 | <span class="reserved">void</span> ippRestore(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10668 | <h4 class="parameters">Parameters</h4> |
| | 10669 | <table class="list"><tbody> |
| | 10670 | <tr><th>ipp</th> |
| | 10671 | <td class="description">IPP message</td></tr> |
| | 10672 | </tbody></table> |
| | 10673 | <h3 class="function"><span class="info"> CUPS 2.5 </span><a id="ippSave">ippSave</a></h3> |
| | 10674 | <p class="description">Save the current find position.</p> |
| | 10675 | <p class="code"> |
| | 10676 | <span class="reserved">void</span> ippSave(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 10677 | <h4 class="parameters">Parameters</h4> |
| | 10678 | <table class="list"><tbody> |
| | 10679 | <tr><th>ipp</th> |
| | 10680 | <td class="description">IPP message</td></tr> |
| | 10681 | </tbody></table> |
| | 10682 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetBoolean">ippSetBoolean</a></h3> |
| | 10683 | <p class="description">Set a boolean value in an attribute.</p> |
| | 10684 | <p class="code"> |
| | 10685 | <span class="reserved">int</span> ippSetBoolean(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <span class="reserved">int</span> boolvalue);</p> |
| | 10686 | <h4 class="parameters">Parameters</h4> |
| | 10687 | <table class="list"><tbody> |
| | 10688 | <tr><th>ipp</th> |
| | 10689 | <td class="description">IPP message</td></tr> |
| | 10690 | <tr><th>attr</th> |
| | 10691 | <td class="description">IPP attribute</td></tr> |
| | 10692 | <tr><th>element</th> |
| | 10693 | <td class="description">Value number (0-based)</td></tr> |
| | 10694 | <tr><th>boolvalue</th> |
| | 10695 | <td class="description">Boolean value</td></tr> |
| | 10696 | </tbody></table> |
| | 10697 | <h4 class="returnvalue">Return Value</h4> |
| | 10698 | <p class="description">1 on success, 0 on failure</p> |
| | 10699 | <h4 class="discussion">Discussion</h4> |
| | 10700 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10701 | 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> |
| | 10702 | <br> |
| | 10703 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 10704 | <br> |
| | 10705 | The "element" parameter specifies which value to set from 0 to |
| | 10706 | <code>ippGetCount(attr)</code>. |
| | 10707 | |
| | 10708 | </p> |
| | 10709 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetCollection">ippSetCollection</a></h3> |
| | 10710 | <p class="description">Set a collection value in an attribute.</p> |
| | 10711 | <p class="code"> |
| | 10712 | <span class="reserved">int</span> ippSetCollection(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <a href="#ipp_t">ipp_t</a> *colvalue);</p> |
| | 10713 | <h4 class="parameters">Parameters</h4> |
| | 10714 | <table class="list"><tbody> |
| | 10715 | <tr><th>ipp</th> |
| | 10716 | <td class="description">IPP message</td></tr> |
| | 10717 | <tr><th>attr</th> |
| | 10718 | <td class="description">IPP attribute</td></tr> |
| | 10719 | <tr><th>element</th> |
| | 10720 | <td class="description">Value number (0-based)</td></tr> |
| | 10721 | <tr><th>colvalue</th> |
| | 10722 | <td class="description">Collection value</td></tr> |
| | 10723 | </tbody></table> |
| | 10724 | <h4 class="returnvalue">Return Value</h4> |
| | 10725 | <p class="description">1 on success, 0 on failure</p> |
| | 10726 | <h4 class="discussion">Discussion</h4> |
| | 10727 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10728 | 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> |
| | 10729 | <br> |
| | 10730 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 10731 | <br> |
| | 10732 | The "element" parameter specifies which value to set from 0 to |
| | 10733 | <code>ippGetCount(attr)</code>. |
| | 10734 | |
| | 10735 | </p> |
| | 10736 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetDate">ippSetDate</a></h3> |
| | 10737 | <p class="description">Set a dateTime value in an attribute.</p> |
| | 10738 | <p class="code"> |
| | 10739 | <span class="reserved">int</span> ippSetDate(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <span class="reserved">const</span> <a href="#ipp_uchar_t">ipp_uchar_t</a> *datevalue);</p> |
| | 10740 | <h4 class="parameters">Parameters</h4> |
| | 10741 | <table class="list"><tbody> |
| | 10742 | <tr><th>ipp</th> |
| | 10743 | <td class="description">IPP message</td></tr> |
| | 10744 | <tr><th>attr</th> |
| | 10745 | <td class="description">IPP attribute</td></tr> |
| | 10746 | <tr><th>element</th> |
| | 10747 | <td class="description">Value number (0-based)</td></tr> |
| | 10748 | <tr><th>datevalue</th> |
| | 10749 | <td class="description">dateTime value</td></tr> |
| | 10750 | </tbody></table> |
| | 10751 | <h4 class="returnvalue">Return Value</h4> |
| | 10752 | <p class="description">1 on success, 0 on failure</p> |
| | 10753 | <h4 class="discussion">Discussion</h4> |
| | 10754 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10755 | 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> |
| | 10756 | <br> |
| | 10757 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 10758 | <br> |
| | 10759 | The "element" parameter specifies which value to set from 0 to |
| | 10760 | <code>ippGetCount(attr)</code>. |
| | 10761 | |
| | 10762 | </p> |
| | 10763 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetGroupTag">ippSetGroupTag</a></h3> |
| | 10764 | <p class="description">Set the group tag of an attribute.</p> |
| | 10765 | <p class="code"> |
| | 10766 | <span class="reserved">int</span> 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> |
| | 10767 | <h4 class="parameters">Parameters</h4> |
| | 10768 | <table class="list"><tbody> |
| | 10769 | <tr><th>ipp</th> |
| | 10770 | <td class="description">IPP message</td></tr> |
| | 10771 | <tr><th>attr</th> |
| | 10772 | <td class="description">Attribute</td></tr> |
| | 10773 | <tr><th>group_tag</th> |
| | 10774 | <td class="description">Group tag</td></tr> |
| | 10775 | </tbody></table> |
| | 10776 | <h4 class="returnvalue">Return Value</h4> |
| | 10777 | <p class="description">1 on success, 0 on failure</p> |
| | 10778 | <h4 class="discussion">Discussion</h4> |
| | 10779 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10780 | 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> |
| | 10781 | <br> |
| | 10782 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 10783 | <br> |
| | 10784 | The "group" parameter specifies the IPP attribute group tag: none |
| | 10785 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), |
| | 10786 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation |
| | 10787 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription |
| | 10788 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). |
| | 10789 | |
| | 10790 | </p> |
| | 10791 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetInteger">ippSetInteger</a></h3> |
| | 10792 | <p class="description">Set an integer or enum value in an attribute.</p> |
| | 10793 | <p class="code"> |
| | 10794 | <span class="reserved">int</span> ippSetInteger(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <span class="reserved">int</span> intvalue);</p> |
| | 10795 | <h4 class="parameters">Parameters</h4> |
| | 10796 | <table class="list"><tbody> |
| | 10797 | <tr><th>ipp</th> |
| | 10798 | <td class="description">IPP message</td></tr> |
| | 10799 | <tr><th>attr</th> |
| | 10800 | <td class="description">IPP attribute</td></tr> |
| | 10801 | <tr><th>element</th> |
| | 10802 | <td class="description">Value number (0-based)</td></tr> |
| | 10803 | <tr><th>intvalue</th> |
| | 10804 | <td class="description">Integer/enum value</td></tr> |
| | 10805 | </tbody></table> |
| | 10806 | <h4 class="returnvalue">Return Value</h4> |
| | 10807 | <p class="description">1 on success, 0 on failure</p> |
| | 10808 | <h4 class="discussion">Discussion</h4> |
| | 10809 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10810 | 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> |
| | 10811 | <br> |
| | 10812 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 10813 | <br> |
| | 10814 | The "element" parameter specifies which value to set from 0 to |
| | 10815 | <code>ippGetCount(attr)</code>. |
| | 10816 | |
| | 10817 | </p> |
| | 10818 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetName">ippSetName</a></h3> |
| | 10819 | <p class="description">Set the name of an attribute.</p> |
| | 10820 | <p class="code"> |
| | 10821 | <span class="reserved">int</span> ippSetName(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">const</span> <span class="reserved">char</span> *name);</p> |
| | 10822 | <h4 class="parameters">Parameters</h4> |
| | 10823 | <table class="list"><tbody> |
| | 10824 | <tr><th>ipp</th> |
| | 10825 | <td class="description">IPP message</td></tr> |
| | 10826 | <tr><th>attr</th> |
| | 10827 | <td class="description">IPP attribute</td></tr> |
| | 10828 | <tr><th>name</th> |
| | 10829 | <td class="description">Attribute name</td></tr> |
| | 10830 | </tbody></table> |
| | 10831 | <h4 class="returnvalue">Return Value</h4> |
| | 10832 | <p class="description">1 on success, 0 on failure</p> |
| | 10833 | <h4 class="discussion">Discussion</h4> |
| | 10834 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10835 | 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> |
| | 10836 | <br> |
| | 10837 | The "attr" parameter may be modified as a result of setting the value. |
| | 10838 | |
| | 10839 | </p> |
| | 10840 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippSetOctetString">ippSetOctetString</a></h3> |
| | 10841 | <p class="description">Set an octetString value in an IPP attribute.</p> |
| | 10842 | <p class="code"> |
| | 10843 | <span class="reserved">int</span> ippSetOctetString(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <span class="reserved">const</span> <span class="reserved">void</span> *data, <span class="reserved">int</span> datalen);</p> |
| | 10844 | <h4 class="parameters">Parameters</h4> |
| | 10845 | <table class="list"><tbody> |
| | 10846 | <tr><th>ipp</th> |
| | 10847 | <td class="description">IPP message</td></tr> |
| | 10848 | <tr><th>attr</th> |
| | 10849 | <td class="description">IPP attribute</td></tr> |
| | 10850 | <tr><th>element</th> |
| | 10851 | <td class="description">Value number (0-based)</td></tr> |
| | 10852 | <tr><th>data</th> |
| | 10853 | <td class="description">Pointer to octetString data</td></tr> |
| | 10854 | <tr><th>datalen</th> |
| | 10855 | <td class="description">Length of octetString data</td></tr> |
| | 10856 | </tbody></table> |
| | 10857 | <h4 class="returnvalue">Return Value</h4> |
| | 10858 | <p class="description">1 on success, 0 on failure</p> |
| | 10859 | <h4 class="discussion">Discussion</h4> |
| | 10860 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10861 | 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> |
| | 10862 | <br> |
| | 10863 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 10864 | <br> |
| | 10865 | The "element" parameter specifies which value to set from 0 to |
| | 10866 | <code>ippGetCount(attr)</code>. |
| | 10867 | |
| | 10868 | </p> |
| | 10869 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetOperation">ippSetOperation</a></h3> |
| | 10870 | <p class="description">Set the operation ID in an IPP request message.</p> |
| | 10871 | <p class="code"> |
| | 10872 | <span class="reserved">int</span> ippSetOperation(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_op_t">ipp_op_t</a> op);</p> |
| | 10873 | <h4 class="parameters">Parameters</h4> |
| | 10874 | <table class="list"><tbody> |
| | 10875 | <tr><th>ipp</th> |
| | 10876 | <td class="description">IPP request message</td></tr> |
| | 10877 | <tr><th>op</th> |
| | 10878 | <td class="description">Operation ID</td></tr> |
| | 10879 | </tbody></table> |
| | 10880 | <h4 class="returnvalue">Return Value</h4> |
| | 10881 | <p class="description">1 on success, 0 on failure</p> |
| | 10882 | <h4 class="discussion">Discussion</h4> |
| | 10883 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10884 | the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. |
| | 10885 | |
| | 10886 | </p> |
| | 10887 | <h3 class="function"><a id="ippSetPort">ippSetPort</a></h3> |
| | 10888 | <p class="description">Set the default port number.</p> |
| | 10889 | <p class="code"> |
| | 10890 | <span class="reserved">void</span> ippSetPort(<span class="reserved">int</span> p);</p> |
| | 10891 | <h4 class="parameters">Parameters</h4> |
| | 10892 | <table class="list"><tbody> |
| | 10893 | <tr><th>p</th> |
| | 10894 | <td class="description">Port number to use</td></tr> |
| | 10895 | </tbody></table> |
| | 10896 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetRange">ippSetRange</a></h3> |
| | 10897 | <p class="description">Set a rangeOfInteger value in an attribute.</p> |
| | 10898 | <p class="code"> |
| | 10899 | <span class="reserved">int</span> ippSetRange(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <span class="reserved">int</span> lowervalue, <span class="reserved">int</span> uppervalue);</p> |
| | 10900 | <h4 class="parameters">Parameters</h4> |
| | 10901 | <table class="list"><tbody> |
| | 10902 | <tr><th>ipp</th> |
| | 10903 | <td class="description">IPP message</td></tr> |
| | 10904 | <tr><th>attr</th> |
| | 10905 | <td class="description">IPP attribute</td></tr> |
| | 10906 | <tr><th>element</th> |
| | 10907 | <td class="description">Value number (0-based)</td></tr> |
| | 10908 | <tr><th>lowervalue</th> |
| | 10909 | <td class="description">Lower bound for range</td></tr> |
| | 10910 | <tr><th>uppervalue</th> |
| | 10911 | <td class="description">Upper bound for range</td></tr> |
| | 10912 | </tbody></table> |
| | 10913 | <h4 class="returnvalue">Return Value</h4> |
| | 10914 | <p class="description">1 on success, 0 on failure</p> |
| | 10915 | <h4 class="discussion">Discussion</h4> |
| | 10916 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10917 | 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> |
| | 10918 | <br> |
| | 10919 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 10920 | <br> |
| | 10921 | The "element" parameter specifies which value to set from 0 to |
| | 10922 | <code>ippGetCount(attr)</code>. |
| | 10923 | |
| | 10924 | </p> |
| | 10925 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetRequestId">ippSetRequestId</a></h3> |
| | 10926 | <p class="description">Set the request ID in an IPP message.</p> |
| | 10927 | <p class="code"> |
| | 10928 | <span class="reserved">int</span> ippSetRequestId(<a href="#ipp_t">ipp_t</a> *ipp, <span class="reserved">int</span> request_id);</p> |
| | 10929 | <h4 class="parameters">Parameters</h4> |
| | 10930 | <table class="list"><tbody> |
| | 10931 | <tr><th>ipp</th> |
| | 10932 | <td class="description">IPP message</td></tr> |
| | 10933 | <tr><th>request_id</th> |
| | 10934 | <td class="description">Request ID</td></tr> |
| | 10935 | </tbody></table> |
| | 10936 | <h4 class="returnvalue">Return Value</h4> |
| | 10937 | <p class="description">1 on success, 0 on failure</p> |
| | 10938 | <h4 class="discussion">Discussion</h4> |
| | 10939 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10940 | 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> |
| | 10941 | <br> |
| | 10942 | The <code>request_id</code> parameter must be greater than 0. |
| | 10943 | |
| | 10944 | </p> |
| | 10945 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetResolution">ippSetResolution</a></h3> |
| | 10946 | <p class="description">Set a resolution value in an attribute.</p> |
| | 10947 | <p class="code"> |
| | 10948 | <span class="reserved">int</span> ippSetResolution(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <a href="#ipp_res_t">ipp_res_t</a> unitsvalue, <span class="reserved">int</span> xresvalue, <span class="reserved">int</span> yresvalue);</p> |
| | 10949 | <h4 class="parameters">Parameters</h4> |
| | 10950 | <table class="list"><tbody> |
| | 10951 | <tr><th>ipp</th> |
| | 10952 | <td class="description">IPP message</td></tr> |
| | 10953 | <tr><th>attr</th> |
| | 10954 | <td class="description">IPP attribute</td></tr> |
| | 10955 | <tr><th>element</th> |
| | 10956 | <td class="description">Value number (0-based)</td></tr> |
| | 10957 | <tr><th>unitsvalue</th> |
| | 10958 | <td class="description">Resolution units</td></tr> |
| | 10959 | <tr><th>xresvalue</th> |
| | 10960 | <td class="description">Horizontal/cross feed resolution</td></tr> |
| | 10961 | <tr><th>yresvalue</th> |
| | 10962 | <td class="description">Vertical/feed resolution</td></tr> |
| | 10963 | </tbody></table> |
| | 10964 | <h4 class="returnvalue">Return Value</h4> |
| | 10965 | <p class="description">1 on success, 0 on failure</p> |
| | 10966 | <h4 class="discussion">Discussion</h4> |
| | 10967 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 10968 | 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> |
| | 10969 | <br> |
| | 10970 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 10971 | <br> |
| | 10972 | The "element" parameter specifies which value to set from 0 to |
| | 10973 | <code>ippGetCount(attr)</code>. |
| | 10974 | |
| | 10975 | </p> |
| | 10976 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetState">ippSetState</a></h3> |
| | 10977 | <p class="description">Set the current state of the IPP message.</p> |
| | 10978 | <p class="code"> |
| | 10979 | <span class="reserved">int</span> ippSetState(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_state_t">ipp_state_t</a> state);</p> |
| | 10980 | <h4 class="parameters">Parameters</h4> |
| | 10981 | <table class="list"><tbody> |
| | 10982 | <tr><th>ipp</th> |
| | 10983 | <td class="description">IPP message</td></tr> |
| | 10984 | <tr><th>state</th> |
| | 10985 | <td class="description">IPP state value</td></tr> |
| | 10986 | </tbody></table> |
| | 10987 | <h4 class="returnvalue">Return Value</h4> |
| | 10988 | <p class="description">1 on success, 0 on failure</p> |
| | 10989 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetStatusCode">ippSetStatusCode</a></h3> |
| | 10990 | <p class="description">Set the status code in an IPP response or event message.</p> |
| | 10991 | <p class="code"> |
| | 10992 | <span class="reserved">int</span> ippSetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp, ipp_status_t status);</p> |
| | 10993 | <h4 class="parameters">Parameters</h4> |
| | 10994 | <table class="list"><tbody> |
| | 10995 | <tr><th>ipp</th> |
| | 10996 | <td class="description">IPP response or event message</td></tr> |
| | 10997 | <tr><th>status</th> |
| | 10998 | <td class="description">Status code</td></tr> |
| | 10999 | </tbody></table> |
| | 11000 | <h4 class="returnvalue">Return Value</h4> |
| | 11001 | <p class="description">1 on success, 0 on failure</p> |
| | 11002 | <h4 class="discussion">Discussion</h4> |
| | 11003 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 11004 | the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. |
| | 11005 | |
| | 11006 | </p> |
| | 11007 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetString">ippSetString</a></h3> |
| | 11008 | <p class="description">Set a string value in an attribute.</p> |
| | 11009 | <p class="code"> |
| | 11010 | <span class="reserved">int</span> ippSetString(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <span class="reserved">const</span> <span class="reserved">char</span> *strvalue);</p> |
| | 11011 | <h4 class="parameters">Parameters</h4> |
| | 11012 | <table class="list"><tbody> |
| | 11013 | <tr><th>ipp</th> |
| | 11014 | <td class="description">IPP message</td></tr> |
| | 11015 | <tr><th>attr</th> |
| | 11016 | <td class="description">IPP attribute</td></tr> |
| | 11017 | <tr><th>element</th> |
| | 11018 | <td class="description">Value number (0-based)</td></tr> |
| | 11019 | <tr><th>strvalue</th> |
| | 11020 | <td class="description">String value</td></tr> |
| | 11021 | </tbody></table> |
| | 11022 | <h4 class="returnvalue">Return Value</h4> |
| | 11023 | <p class="description">1 on success, 0 on failure</p> |
| | 11024 | <h4 class="discussion">Discussion</h4> |
| | 11025 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 11026 | 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> |
| | 11027 | <br> |
| | 11028 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 11029 | <br> |
| | 11030 | The "element" parameter specifies which value to set from 0 to |
| | 11031 | <code>ippGetCount(attr)</code>. |
| | 11032 | |
| | 11033 | </p> |
| | 11034 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippSetStringf">ippSetStringf</a></h3> |
| | 11035 | <p class="description">Set a formatted string value of an attribute.</p> |
| | 11036 | <p class="code"> |
| | 11037 | <span class="reserved">int</span> ippSetStringf(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <span class="reserved">const</span> <span class="reserved">char</span> *format, ...);</p> |
| | 11038 | <h4 class="parameters">Parameters</h4> |
| | 11039 | <table class="list"><tbody> |
| | 11040 | <tr><th>ipp</th> |
| | 11041 | <td class="description">IPP message</td></tr> |
| | 11042 | <tr><th>attr</th> |
| | 11043 | <td class="description">IPP attribute</td></tr> |
| | 11044 | <tr><th>element</th> |
| | 11045 | <td class="description">Value number (0-based)</td></tr> |
| | 11046 | <tr><th>format</th> |
| | 11047 | <td class="description">Printf-style format string</td></tr> |
| | 11048 | <tr><th>...</th> |
| | 11049 | <td class="description">Additional arguments as needed</td></tr> |
| | 11050 | </tbody></table> |
| | 11051 | <h4 class="returnvalue">Return Value</h4> |
| | 11052 | <p class="description">1 on success, 0 on failure</p> |
| | 11053 | <h4 class="discussion">Discussion</h4> |
| | 11054 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 11055 | 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> |
| | 11056 | <br> |
| | 11057 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 11058 | <br> |
| | 11059 | The "element" parameter specifies which value to set from 0 to |
| | 11060 | <code>ippGetCount(attr)</code>.<br> |
| | 11061 | <br> |
| | 11062 | The "format" parameter uses formatting characters compatible with the |
| | 11063 | printf family of standard functions. Additional arguments follow it as |
| | 11064 | needed. The formatted string is truncated as needed to the maximum length of |
| | 11065 | the corresponding value type. |
| | 11066 | |
| | 11067 | </p> |
| | 11068 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippSetStringfv">ippSetStringfv</a></h3> |
| | 11069 | <p class="description">Set a formatted string value of an attribute.</p> |
| | 11070 | <p class="code"> |
| | 11071 | <span class="reserved">int</span> ippSetStringfv(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, <span class="reserved">int</span> element, <span class="reserved">const</span> <span class="reserved">char</span> *format, va_list ap);</p> |
| | 11072 | <h4 class="parameters">Parameters</h4> |
| | 11073 | <table class="list"><tbody> |
| | 11074 | <tr><th>ipp</th> |
| | 11075 | <td class="description">IPP message</td></tr> |
| | 11076 | <tr><th>attr</th> |
| | 11077 | <td class="description">IPP attribute</td></tr> |
| | 11078 | <tr><th>element</th> |
| | 11079 | <td class="description">Value number (0-based)</td></tr> |
| | 11080 | <tr><th>format</th> |
| | 11081 | <td class="description">Printf-style format string</td></tr> |
| | 11082 | <tr><th>ap</th> |
| | 11083 | <td class="description">Pointer to additional arguments</td></tr> |
| | 11084 | </tbody></table> |
| | 11085 | <h4 class="returnvalue">Return Value</h4> |
| | 11086 | <p class="description">1 on success, 0 on failure</p> |
| | 11087 | <h4 class="discussion">Discussion</h4> |
| | 11088 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 11089 | 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> |
| | 11090 | <br> |
| | 11091 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 11092 | <br> |
| | 11093 | The "element" parameter specifies which value to set from 0 to |
| | 11094 | <code>ippGetCount(attr)</code>.<br> |
| | 11095 | <br> |
| | 11096 | The "format" parameter uses formatting characters compatible with the |
| | 11097 | printf family of standard functions. Additional arguments follow it as |
| | 11098 | needed. The formatted string is truncated as needed to the maximum length of |
| | 11099 | the corresponding value type. |
| | 11100 | |
| | 11101 | </p> |
| | 11102 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetValueTag">ippSetValueTag</a></h3> |
| | 11103 | <p class="description">Set the value tag of an attribute.</p> |
| | 11104 | <p class="code"> |
| | 11105 | <span class="reserved">int</span> 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> |
| | 11106 | <h4 class="parameters">Parameters</h4> |
| | 11107 | <table class="list"><tbody> |
| | 11108 | <tr><th>ipp</th> |
| | 11109 | <td class="description">IPP message</td></tr> |
| | 11110 | <tr><th>attr</th> |
| | 11111 | <td class="description">IPP attribute</td></tr> |
| | 11112 | <tr><th>value_tag</th> |
| | 11113 | <td class="description">Value tag</td></tr> |
| | 11114 | </tbody></table> |
| | 11115 | <h4 class="returnvalue">Return Value</h4> |
| | 11116 | <p class="description">1 on success, 0 on failure</p> |
| | 11117 | <h4 class="discussion">Discussion</h4> |
| | 11118 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 11119 | 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> |
| | 11120 | <br> |
| | 11121 | The "attr" parameter may be modified as a result of setting the value.<br> |
| | 11122 | <br> |
| | 11123 | Integer (<code>IPP_TAG_INTEGER</code>) values can be promoted to rangeOfInteger |
| | 11124 | (<code>IPP_TAG_RANGE</code>) values, the various string tags can be promoted to name |
| | 11125 | (<code>IPP_TAG_NAME</code>) or nameWithLanguage (<code>IPP_TAG_NAMELANG</code>) values, text |
| | 11126 | (<code>IPP_TAG_TEXT</code>) values can be promoted to textWithLanguage |
| | 11127 | (<code>IPP_TAG_TEXTLANG</code>) values, and all values can be demoted to the various |
| | 11128 | out-of-band value tags such as no-value (<code>IPP_TAG_NOVALUE</code>). All other |
| | 11129 | changes will be rejected.<br> |
| | 11130 | <br> |
| | 11131 | Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language |
| | 11132 | code in the "attributes-natural-language" attribute or, if not present, the language |
| | 11133 | code for the current locale. |
| | 11134 | |
| | 11135 | </p> |
| | 11136 | <h3 class="function"><span class="info"> CUPS 1.6 </span><a id="ippSetVersion">ippSetVersion</a></h3> |
| | 11137 | <p class="description">Set the version number in an IPP message.</p> |
| | 11138 | <p class="code"> |
| | 11139 | <span class="reserved">int</span> ippSetVersion(<a href="#ipp_t">ipp_t</a> *ipp, <span class="reserved">int</span> major, <span class="reserved">int</span> minor);</p> |
| | 11140 | <h4 class="parameters">Parameters</h4> |
| | 11141 | <table class="list"><tbody> |
| | 11142 | <tr><th>ipp</th> |
| | 11143 | <td class="description">IPP message</td></tr> |
| | 11144 | <tr><th>major</th> |
| | 11145 | <td class="description">Major version number (major.minor)</td></tr> |
| | 11146 | <tr><th>minor</th> |
| | 11147 | <td class="description">Minor version number (major.minor)</td></tr> |
| | 11148 | </tbody></table> |
| | 11149 | <h4 class="returnvalue">Return Value</h4> |
| | 11150 | <p class="description">1 on success, 0 on failure</p> |
| | 11151 | <h4 class="discussion">Discussion</h4> |
| | 11152 | <p class="discussion">The "ipp" parameter refers to an IPP message previously created using |
| | 11153 | 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> |
| | 11154 | <br> |
| | 11155 | The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2. |
| | 11156 | |
| | 11157 | </p> |
| | 11158 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="ippStateString">ippStateString</a></h3> |
| | 11159 | <p class="description">Return the name corresponding to a state value.</p> |
| | 11160 | <p class="code"> |
| | 11161 | <span class="reserved">const</span> <span class="reserved">char</span> *ippStateString(<a href="#ipp_state_t">ipp_state_t</a> state);</p> |
| | 11162 | <h4 class="parameters">Parameters</h4> |
| | 11163 | <table class="list"><tbody> |
| | 11164 | <tr><th>state</th> |
| | 11165 | <td class="description">State value</td></tr> |
| | 11166 | </tbody></table> |
| | 11167 | <h4 class="returnvalue">Return Value</h4> |
| | 11168 | <p class="description">State name</p> |
| | 11169 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="ippTagString">ippTagString</a></h3> |
| | 11170 | <p class="description">Return the tag name corresponding to a tag value.</p> |
| | 11171 | <p class="code"> |
| | 11172 | <span class="reserved">const</span> <span class="reserved">char</span> *ippTagString(ipp_tag_t tag);</p> |
| | 11173 | <h4 class="parameters">Parameters</h4> |
| | 11174 | <table class="list"><tbody> |
| | 11175 | <tr><th>tag</th> |
| | 11176 | <td class="description">Tag value</td></tr> |
| | 11177 | </tbody></table> |
| | 11178 | <h4 class="returnvalue">Return Value</h4> |
| | 11179 | <p class="description">Tag name</p> |
| | 11180 | <h4 class="discussion">Discussion</h4> |
| | 11181 | <p class="discussion">The returned names are defined in RFC 8011 and the IANA IPP Registry. |
| | 11182 | |
| | 11183 | </p> |
| | 11184 | <h3 class="function"><span class="info"> CUPS 1.4 </span><a id="ippTagValue">ippTagValue</a></h3> |
| | 11185 | <p class="description">Return the tag value corresponding to a tag name.</p> |
| | 11186 | <p class="code"> |
| | 11187 | ipp_tag_t ippTagValue(<span class="reserved">const</span> <span class="reserved">char</span> *name);</p> |
| | 11188 | <h4 class="parameters">Parameters</h4> |
| | 11189 | <table class="list"><tbody> |
| | 11190 | <tr><th>name</th> |
| | 11191 | <td class="description">Tag name</td></tr> |
| | 11192 | </tbody></table> |
| | 11193 | <h4 class="returnvalue">Return Value</h4> |
| | 11194 | <p class="description">Tag value</p> |
| | 11195 | <h4 class="discussion">Discussion</h4> |
| | 11196 | <p class="discussion">The tag names are defined in RFC 8011 and the IANA IPP Registry. |
| | 11197 | |
| | 11198 | </p> |
| | 11199 | <h3 class="function"><a id="ippTimeToDate">ippTimeToDate</a></h3> |
| | 11200 | <p class="description">Convert from time in seconds to RFC 2579 format.</p> |
| | 11201 | <p class="code"> |
| | 11202 | <span class="reserved">const</span> <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippTimeToDate(time_t t);</p> |
| | 11203 | <h4 class="parameters">Parameters</h4> |
| | 11204 | <table class="list"><tbody> |
| | 11205 | <tr><th>t</th> |
| | 11206 | <td class="description">Time in seconds</td></tr> |
| | 11207 | </tbody></table> |
| | 11208 | <h4 class="returnvalue">Return Value</h4> |
| | 11209 | <p class="description">RFC-2579 date/time data</p> |
| | 11210 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippValidateAttribute">ippValidateAttribute</a></h3> |
| | 11211 | <p class="description">Validate the contents of an attribute.</p> |
| | 11212 | <p class="code"> |
| | 11213 | <span class="reserved">int</span> ippValidateAttribute(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
| | 11214 | <h4 class="parameters">Parameters</h4> |
| | 11215 | <table class="list"><tbody> |
| | 11216 | <tr><th>attr</th> |
| | 11217 | <td class="description">Attribute</td></tr> |
| | 11218 | </tbody></table> |
| | 11219 | <h4 class="returnvalue">Return Value</h4> |
| | 11220 | <p class="description">1 if valid, 0 otherwise</p> |
| | 11221 | <h4 class="discussion">Discussion</h4> |
| | 11222 | <p class="discussion">This function validates the contents of an attribute based on the name and |
| | 11223 | value tag. 1 is returned if the attribute is valid, 0 otherwise. On |
| | 11224 | failure, <a href="#cupsGetErrorString"><code>cupsGetErrorString</code></a> is set to a human-readable message. |
| | 11225 | |
| | 11226 | </p> |
| | 11227 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="ippValidateAttributes">ippValidateAttributes</a></h3> |
| | 11228 | <p class="description">Validate all attributes in an IPP message.</p> |
| | 11229 | <p class="code"> |
| | 11230 | <span class="reserved">int</span> ippValidateAttributes(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 11231 | <h4 class="parameters">Parameters</h4> |
| | 11232 | <table class="list"><tbody> |
| | 11233 | <tr><th>ipp</th> |
| | 11234 | <td class="description">IPP message</td></tr> |
| | 11235 | </tbody></table> |
| | 11236 | <h4 class="returnvalue">Return Value</h4> |
| | 11237 | <p class="description">1 if valid, 0 otherwise</p> |
| | 11238 | <h4 class="discussion">Discussion</h4> |
| | 11239 | <p class="discussion">This function validates the contents of the IPP message, including each |
| | 11240 | attribute. Like <a href="#ippValidateAttribute"><code>ippValidateAttribute</code></a>, <a href="#cupsGetErrorString"><code>cupsGetErrorString</code></a> is |
| | 11241 | set to a human-readable message on failure. |
| | 11242 | |
| | 11243 | </p> |
| | 11244 | <h3 class="function"><a id="ippWrite">ippWrite</a></h3> |
| | 11245 | <p class="description">Write data for an IPP message to a HTTP connection.</p> |
| | 11246 | <p class="code"> |
| | 11247 | <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> |
| | 11248 | <h4 class="parameters">Parameters</h4> |
| | 11249 | <table class="list"><tbody> |
| | 11250 | <tr><th>http</th> |
| | 11251 | <td class="description">HTTP connection</td></tr> |
| | 11252 | <tr><th>ipp</th> |
| | 11253 | <td class="description">IPP data</td></tr> |
| | 11254 | </tbody></table> |
| | 11255 | <h4 class="returnvalue">Return Value</h4> |
| | 11256 | <p class="description">Current state</p> |
| | 11257 | <h3 class="function"><span class="info"> CUPS 1.1.19 </span><a id="ippWriteFile">ippWriteFile</a></h3> |
| | 11258 | <p class="description">Write data for an IPP message to a file.</p> |
| | 11259 | <p class="code"> |
| | 11260 | <a href="#ipp_state_t">ipp_state_t</a> ippWriteFile(<span class="reserved">int</span> fd, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 11261 | <h4 class="parameters">Parameters</h4> |
| | 11262 | <table class="list"><tbody> |
| | 11263 | <tr><th>fd</th> |
| | 11264 | <td class="description">HTTP data</td></tr> |
| | 11265 | <tr><th>ipp</th> |
| | 11266 | <td class="description">IPP data</td></tr> |
| | 11267 | </tbody></table> |
| | 11268 | <h4 class="returnvalue">Return Value</h4> |
| | 11269 | <p class="description">Current state</p> |
| | 11270 | <h3 class="function"><span class="info"> CUPS 1.2 </span><a id="ippWriteIO">ippWriteIO</a></h3> |
| | 11271 | <p class="description">Write data for an IPP message.</p> |
| | 11272 | <p class="code"> |
| | 11273 | <a href="#ipp_state_t">ipp_state_t</a> ippWriteIO(<span class="reserved">void</span> *dst, <a href="#ipp_io_cb_t">ipp_io_cb_t</a> cb, <span class="reserved">int</span> blocking, <a href="#ipp_t">ipp_t</a> *parent, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
| | 11274 | <h4 class="parameters">Parameters</h4> |
| | 11275 | <table class="list"><tbody> |
| | 11276 | <tr><th>dst</th> |
| | 11277 | <td class="description">Destination</td></tr> |
| | 11278 | <tr><th>cb</th> |
| | 11279 | <td class="description">Write callback function</td></tr> |
| | 11280 | <tr><th>blocking</th> |
| | 11281 | <td class="description">Use blocking IO?</td></tr> |
| | 11282 | <tr><th>parent</th> |
| | 11283 | <td class="description">Parent IPP message</td></tr> |
| | 11284 | <tr><th>ipp</th> |
| | 11285 | <td class="description">IPP data</td></tr> |
| | 11286 | </tbody></table> |
| | 11287 | <h4 class="returnvalue">Return Value</h4> |
| | 11288 | <p class="description">Current state</p> |
| | 11289 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="pwgFormatSizeName">pwgFormatSizeName</a></h3> |
| | 11290 | <p class="description">Generate a PWG self-describing media size name.</p> |
| | 11291 | <p class="code"> |
| | 11292 | <span class="reserved">int</span> pwgFormatSizeName(<span class="reserved">char</span> *keyword, size_t keysize, <span class="reserved">const</span> <span class="reserved">char</span> *prefix, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">int</span> width, <span class="reserved">int</span> length, <span class="reserved">const</span> <span class="reserved">char</span> *units);</p> |
| | 11293 | <h4 class="parameters">Parameters</h4> |
| | 11294 | <table class="list"><tbody> |
| | 11295 | <tr><th>keyword</th> |
| | 11296 | <td class="description">Keyword buffer</td></tr> |
| | 11297 | <tr><th>keysize</th> |
| | 11298 | <td class="description">Size of keyword buffer</td></tr> |
| | 11299 | <tr><th>prefix</th> |
| | 11300 | <td class="description">Prefix for PWG size or <code>NULL</code> for automatic</td></tr> |
| | 11301 | <tr><th>name</th> |
| | 11302 | <td class="description">Size name or <code>NULL</code></td></tr> |
| | 11303 | <tr><th>width</th> |
| | 11304 | <td class="description">Width of page in 2540ths</td></tr> |
| | 11305 | <tr><th>length</th> |
| | 11306 | <td class="description">Length of page in 2540ths</td></tr> |
| | 11307 | <tr><th>units</th> |
| | 11308 | <td class="description">Units - "in", "mm", or <code>NULL</code> for automatic</td></tr> |
| | 11309 | </tbody></table> |
| | 11310 | <h4 class="returnvalue">Return Value</h4> |
| | 11311 | <p class="description">1 on success, 0 on failure</p> |
| | 11312 | <h4 class="discussion">Discussion</h4> |
| | 11313 | <p class="discussion">This function generates a PWG self-describing media size name of the form |
| | 11314 | "prefix_name_WIDTHxLENGTHunits". The prefix is typically "custom" or "roll" |
| | 11315 | for user-supplied sizes but can also be "disc", "iso", "jis", "jpn", "na", |
| | 11316 | "oe", "om", "prc", or "roc". A value of <code>NULL</code> automatically chooses |
| | 11317 | "oe" or "om" depending on the units.<br> |
| | 11318 | <br> |
| | 11319 | The size name may only contain lowercase letters, numbers, "-", and ".". If |
| | 11320 | <code>NULL</code> is passed, the size name will contain the formatted dimensions.<br> |
| | 11321 | <br> |
| | 11322 | The width and length are specified in hundredths of millimeters, equivalent |
| | 11323 | to 1/100000th of a meter or 1/2540th of an inch. The width, length, and |
| | 11324 | units used for the generated size name are calculated automatically if the |
| | 11325 | units string is <code>NULL</code>, otherwise inches ("in") or millimeters ("mm") |
| | 11326 | are used. |
| | 11327 | |
| | 11328 | </p> |
| | 11329 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="pwgInitSize">pwgInitSize</a></h3> |
| | 11330 | <p class="description">Initialize a pwg_size_t structure using IPP Job Template |
| | 11331 | attributes.</p> |
| | 11332 | <p class="code"> |
| | 11333 | <span class="reserved">int</span> pwgInitSize(<a href="#pwg_size_t">pwg_size_t</a> *size, <a href="#ipp_t">ipp_t</a> *job, <span class="reserved">int</span> *margins_set);</p> |
| | 11334 | <h4 class="parameters">Parameters</h4> |
| | 11335 | <table class="list"><tbody> |
| | 11336 | <tr><th>size</th> |
| | 11337 | <td class="description">Size to initialize</td></tr> |
| | 11338 | <tr><th>job</th> |
| | 11339 | <td class="description">Job template attributes</td></tr> |
| | 11340 | <tr><th>margins_set</th> |
| | 11341 | <td class="description">1 if margins were set, 0 otherwise</td></tr> |
| | 11342 | </tbody></table> |
| | 11343 | <h4 class="returnvalue">Return Value</h4> |
| | 11344 | <p class="description">1 if size was initialized, 0 otherwise</p> |
| | 11345 | <h4 class="discussion">Discussion</h4> |
| | 11346 | <p class="discussion">This function initializes a pwg_size_t structure from an IPP "media" or |
| | 11347 | "media-col" attribute in the specified IPP message. 0 is returned if neither |
| | 11348 | attribute is found in the message or the values are not valid.<br> |
| | 11349 | <br> |
| | 11350 | The "margins_set" variable is initialized to 1 if any "media-xxx-margin" |
| | 11351 | member attribute was specified in the "media-col" Job Template attribute, |
| | 11352 | otherwise it is initialized to 0. |
| | 11353 | |
| | 11354 | </p> |
| | 11355 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="pwgMediaForLegacy">pwgMediaForLegacy</a></h3> |
| | 11356 | <p class="description">Find a PWG media size by ISO/IPP legacy name.</p> |
| | 11357 | <p class="code"> |
| | 11358 | <a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForLegacy(<span class="reserved">const</span> <span class="reserved">char</span> *legacy);</p> |
| | 11359 | <h4 class="parameters">Parameters</h4> |
| | 11360 | <table class="list"><tbody> |
| | 11361 | <tr><th>legacy</th> |
| | 11362 | <td class="description">Legacy size name</td></tr> |
| | 11363 | </tbody></table> |
| | 11364 | <h4 class="returnvalue">Return Value</h4> |
| | 11365 | <p class="description">Matching size or NULL</p> |
| | 11366 | <h4 class="discussion">Discussion</h4> |
| | 11367 | <p class="discussion">The "name" argument specifies the legacy ISO media size name, for example |
| | 11368 | "iso-a4" or "na-letter". |
| | 11369 | |
| | 11370 | </p> |
| | 11371 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="pwgMediaForPPD">pwgMediaForPPD</a></h3> |
| | 11372 | <p class="description">Find a PWG media size by Adobe PPD name.</p> |
| | 11373 | <p class="code"> |
| | 11374 | <a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForPPD(<span class="reserved">const</span> <span class="reserved">char</span> *ppd);</p> |
| | 11375 | <h4 class="parameters">Parameters</h4> |
| | 11376 | <table class="list"><tbody> |
| | 11377 | <tr><th>ppd</th> |
| | 11378 | <td class="description">PPD size name</td></tr> |
| | 11379 | </tbody></table> |
| | 11380 | <h4 class="returnvalue">Return Value</h4> |
| | 11381 | <p class="description">Matching size or NULL</p> |
| | 11382 | <h4 class="discussion">Discussion</h4> |
| | 11383 | <p class="discussion">The "ppd" argument specifies an Adobe page size name as defined in Table B.1 |
| | 11384 | of the Adobe PostScript Printer Description File Format Specification Version |
| | 11385 | 4.3.<br> |
| | 11386 | <br> |
| | 11387 | If the name is non-standard, the returned PWG media size is stored in |
| | 11388 | thread-local storage and is overwritten by each call to the function in the |
| | 11389 | thread. Custom names can be of the form "Custom.WIDTHxLENGTH[units]" or |
| | 11390 | "WIDTHxLENGTH[units]". |
| | 11391 | |
| | 11392 | </p> |
| | 11393 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="pwgMediaForPWG">pwgMediaForPWG</a></h3> |
| | 11394 | <p class="description">Find a PWG media size by 5101.1 self-describing name.</p> |
| | 11395 | <p class="code"> |
| | 11396 | <a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForPWG(<span class="reserved">const</span> <span class="reserved">char</span> *pwg);</p> |
| | 11397 | <h4 class="parameters">Parameters</h4> |
| | 11398 | <table class="list"><tbody> |
| | 11399 | <tr><th>pwg</th> |
| | 11400 | <td class="description">PWG size name</td></tr> |
| | 11401 | </tbody></table> |
| | 11402 | <h4 class="returnvalue">Return Value</h4> |
| | 11403 | <p class="description">Matching size or NULL</p> |
| | 11404 | <h4 class="discussion">Discussion</h4> |
| | 11405 | <p class="discussion">The "pwg" argument specifies a self-describing media size name of the form |
| | 11406 | "prefix_name_WIDTHxLENGTHunits" as defined in PWG 5101.1.<br> |
| | 11407 | <br> |
| | 11408 | If the name is non-standard, the returned PWG media size is stored in |
| | 11409 | thread-local storage and is overwritten by each call to the function in the |
| | 11410 | thread. |
| | 11411 | |
| | 11412 | </p> |
| | 11413 | <h3 class="function"><span class="info"> CUPS 1.7 </span><a id="pwgMediaForSize">pwgMediaForSize</a></h3> |
| | 11414 | <p class="description">Get the PWG media size for the given dimensions.</p> |
| | 11415 | <p class="code"> |
| | 11416 | <a href="#pwg_media_t">pwg_media_t</a> *pwgMediaForSize(<span class="reserved">int</span> width, <span class="reserved">int</span> length);</p> |
| | 11417 | <h4 class="parameters">Parameters</h4> |
| | 11418 | <table class="list"><tbody> |
| | 11419 | <tr><th>width</th> |
| | 11420 | <td class="description">Width in hundredths of millimeters</td></tr> |
| | 11421 | <tr><th>length</th> |
| | 11422 | <td class="description">Length in hundredths of millimeters</td></tr> |
| | 11423 | </tbody></table> |
| | 11424 | <h4 class="returnvalue">Return Value</h4> |
| | 11425 | <p class="description">PWG media name</p> |
| | 11426 | <h4 class="discussion">Discussion</h4> |
| | 11427 | <p class="discussion">The "width" and "length" are in hundredths of millimeters, equivalent to |
| | 11428 | 1/100000th of a meter or 1/2540th of an inch.<br> |
| | 11429 | <br> |
| | 11430 | If the dimensions are non-standard, the returned PWG media size is stored in |
| | 11431 | thread-local storage and is overwritten by each call to the function in the |
| | 11432 | thread. |
| | 11433 | |
| | 11434 | </p> |
| | 11435 | <h2 class="title"><a id="TYPES">Data Types</a></h2> |
| | 11436 | <h3 class="typedef"><a id="cups_acopy_cb_t">cups_acopy_cb_t</a></h3> |
| | 11437 | <p class="description">Array element copy function</p> |
| | 11438 | <p class="code"> |
| | 11439 | typedef void *(*)(void *element, void *data)cups_acopy_cb_t; |
| | 11440 | </p> |
| | 11441 | <h3 class="typedef"><a id="cups_adv_t">cups_adv_t</a></h3> |
| | 11442 | <p class="description">AdvanceMedia attribute values</p> |
| | 11443 | <p class="code"> |
| | 11444 | typedef enum <a href="#cups_adv_e">cups_adv_e</a> cups_adv_t; |
| | 11445 | </p> |
| | 11446 | <h3 class="typedef"><a id="cups_afree_cb_t">cups_afree_cb_t</a></h3> |
| | 11447 | <p class="description">Array element free function</p> |
| | 11448 | <p class="code"> |
| | 11449 | typedef void(*)(void *element, void *data)cups_afree_cb_t; |
| | 11450 | </p> |
| | 11451 | <h3 class="typedef"><a id="cups_ahash_cb_t">cups_ahash_cb_t</a></h3> |
| | 11452 | <p class="description">Array hash function</p> |
| | 11453 | <p class="code"> |
| | 11454 | typedef int(*)(void *element, void *data)cups_ahash_cb_t; |
| | 11455 | </p> |
| | 11456 | <h3 class="typedef"><a id="cups_array_cb_t">cups_array_cb_t</a></h3> |
| | 11457 | <p class="description">Array comparison function</p> |
| | 11458 | <p class="code"> |
| | 11459 | typedef int(*)(void *first, void *second, void *data)cups_array_cb_t; |
| | 11460 | </p> |
| | 11461 | <h3 class="typedef"><a id="cups_array_t">cups_array_t</a></h3> |
| | 11462 | <p class="description">CUPS array type</p> |
| | 11463 | <p class="code"> |
| | 11464 | typedef struct _cups_array_s cups_array_t; |
| | 11465 | </p> |
| | 11466 | <h3 class="typedef"><a id="cups_bool_t">cups_bool_t</a></h3> |
| | 11467 | <p class="description">Boolean type</p> |
| | 11468 | <p class="code"> |
| | 11469 | typedef enum <a href="#cups_bool_e">cups_bool_e</a> cups_bool_t; |
| | 11470 | </p> |
| | 11471 | <h3 class="typedef"><a id="cups_cert_san_cb_t">cups_cert_san_cb_t</a></h3> |
| | 11472 | <p class="description">Certificate signing subjectAltName callback</p> |
| | 11473 | <p class="code"> |
| | 11474 | typedef bool(*)(const char *common_name, const char *subject_alt_name, void *user_data)cups_cert_san_cb_t; |
| | 11475 | </p> |
| | 11476 | <h3 class="typedef"><a id="cups_client_cert_cb_t"><span class="info"> DEPRECATED </span>cups_client_cert_cb_t</a></h3> |
| | 11477 | <p class="description">Client credentials callback </p> |
| | 11478 | <p class="code"> |
| | 11479 | typedef int(*)(http_t *http, void *tls, <a href="#cups_array_t">cups_array_t</a> *distinguished_names, void *user_data)cups_client_cert_cb_t; |
| | 11480 | </p> |
| | 11481 | <h3 class="typedef"><a id="cups_cond_t">cups_cond_t</a></h3> |
| | 11482 | <p class="description">Condition variable</p> |
| | 11483 | <p class="code"> |
| | 11484 | typedef pthread_cond_t cups_cond_t; |
| | 11485 | </p> |
| | 11486 | <h3 class="typedef"><a id="cups_credpurpose_t">cups_credpurpose_t</a></h3> |
| | 11487 | <p class="description">Combined X.509 credential purposes for <a href="#cupsCreateCredentials"><code>cupsCreateCredentials</code></a> and <a href="#cupsCreateCredentialsRequest"><code>cupsCreateCredentialsRequest</code></a></p> |
| | 11488 | <p class="code"> |
| | 11489 | typedef unsigned cups_credpurpose_t; |
| | 11490 | </p> |
| | 11491 | <h3 class="typedef"><a id="cups_credtype_t">cups_credtype_t</a></h3> |
| | 11492 | <p class="description">X.509 credential types for <a href="#cupsCreateCredentials"><code>cupsCreateCredentials</code></a> and <a href="#cupsCreateCredentialsRequest"><code>cupsCreateCredentialsRequest</code></a></p> |
| | 11493 | <p class="code"> |
| | 11494 | typedef enum <a href="#cups_credtype_e">cups_credtype_e</a> cups_credtype_t; |
| | 11495 | </p> |
| | 11496 | <h3 class="typedef"><a id="cups_credusage_t">cups_credusage_t</a></h3> |
| | 11497 | <p class="description">Combined X.509 keyUsage flags for <a href="#cupsCreateCredentials"><code>cupsCreateCredentials</code></a> and <a href="#cupsCreateCredentialsRequest"><code>cupsCreateCredentialsRequest</code></a></p> |
| | 11498 | <p class="code"> |
| | 11499 | typedef unsigned cups_credusage_t; |
| | 11500 | </p> |
| | 11501 | <h3 class="typedef"><a id="cups_cspace_t">cups_cspace_t</a></h3> |
| | 11502 | <p class="description">cupsColorSpace attribute values</p> |
| | 11503 | <p class="code"> |
| | 11504 | typedef enum <a href="#cups_cspace_e">cups_cspace_e</a> cups_cspace_t; |
| | 11505 | </p> |
| | 11506 | <h3 class="typedef"><a id="cups_cut_t">cups_cut_t</a></h3> |
| | 11507 | <p class="description">CutMedia attribute values</p> |
| | 11508 | <p class="code"> |
| | 11509 | typedef enum <a href="#cups_cut_e">cups_cut_e</a> cups_cut_t; |
| | 11510 | </p> |
| | 11511 | <h3 class="typedef"><a id="cups_dbcs_t">cups_dbcs_t</a></h3> |
| | 11512 | <p class="description">DBCS Legacy 16-bit unit</p> |
| | 11513 | <p class="code"> |
| | 11514 | typedef unsigned short cups_dbcs_t; |
| | 11515 | </p> |
| | 11516 | <h3 class="typedef"><a id="cups_dentry_t">cups_dentry_t</a></h3> |
| | 11517 | <p class="description">Directory entry type</p> |
| | 11518 | <p class="code"> |
| | 11519 | typedef struct <a href="#cups_dentry_s">cups_dentry_s</a> cups_dentry_t; |
| | 11520 | </p> |
| | 11521 | <h3 class="typedef"><a id="cups_dest_cb_t"><span class="info"> CUPS 1.6 </span>cups_dest_cb_t</a></h3> |
| | 11522 | <p class="description">Destination enumeration callback </p> |
| | 11523 | <p class="code"> |
| | 11524 | typedef int(*)(void *user_data, unsigned flags, <a href="#cups_dest_t">cups_dest_t</a> *dest)cups_dest_cb_t; |
| | 11525 | </p> |
| | 11526 | <h3 class="typedef"><a id="cups_dest_flags_t">cups_dest_flags_t</a></h3> |
| | 11527 | <p class="description">Combined flags for <a href="#cupsConnectDest"><code>cupsConnectDest</code></a> and <a href="#cupsEnumDests"><code>cupsEnumDests</code></a></p> |
| | 11528 | <p class="code"> |
| | 11529 | typedef unsigned cups_dest_flags_t; |
| | 11530 | </p> |
| | 11531 | <h3 class="typedef"><a id="cups_dest_t">cups_dest_t</a></h3> |
| | 11532 | <p class="description">Destination</p> |
| | 11533 | <p class="code"> |
| | 11534 | typedef struct <a href="#cups_dest_s">cups_dest_s</a> cups_dest_t; |
| | 11535 | </p> |
| | 11536 | <h3 class="typedef"><a id="cups_dinfo_t"><span class="info"> CUPS 1.6 </span>cups_dinfo_t</a></h3> |
| | 11537 | <p class="description">Destination capability and status information </p> |
| | 11538 | <p class="code"> |
| | 11539 | typedef struct _cups_dinfo_s cups_dinfo_t; |
| | 11540 | </p> |
| | 11541 | <h3 class="typedef"><a id="cups_dir_t">cups_dir_t</a></h3> |
| | 11542 | <p class="description">Directory type</p> |
| | 11543 | <p class="code"> |
| | 11544 | typedef struct _cups_dir_s cups_dir_t; |
| | 11545 | </p> |
| | 11546 | <h3 class="typedef"><a id="cups_dnssd_browse_cb_t">cups_dnssd_browse_cb_t</a></h3> |
| | 11547 | <p class="description">DNS-SD browse callback</p> |
| | 11548 | <p class="code"> |
| | 11549 | typedef void(*)(cups_dnssd_browse_t *browse, void *cb_data, <a href="#cups_dnssd_flags_t">cups_dnssd_flags_t</a> flags, uint32_t if_index, const char *name, const char *regtype, const char *domain)cups_dnssd_browse_cb_t; |
| | 11550 | </p> |
| | 11551 | <h3 class="typedef"><a id="cups_dnssd_error_cb_t">cups_dnssd_error_cb_t</a></h3> |
| | 11552 | <p class="description">DNS-SD error callback</p> |
| | 11553 | <p class="code"> |
| | 11554 | typedef void(*)(void *cb_data, const char *message)cups_dnssd_error_cb_t; |
| | 11555 | </p> |
| | 11556 | <h3 class="typedef"><a id="cups_dnssd_flags_t">cups_dnssd_flags_t</a></h3> |
| | 11557 | <p class="description">DNS-SD callback flag bitmask</p> |
| | 11558 | <p class="code"> |
| | 11559 | typedef unsigned cups_dnssd_flags_t; |
| | 11560 | </p> |
| | 11561 | <h3 class="typedef"><a id="cups_dnssd_query_cb_t">cups_dnssd_query_cb_t</a></h3> |
| | 11562 | <p class="description">DNS-SD query callback</p> |
| | 11563 | <p class="code"> |
| | 11564 | typedef void(*)(cups_dnssd_query_t *query, void *cb_data, <a href="#cups_dnssd_flags_t">cups_dnssd_flags_t</a> flags, uint32_t if_index, const char *fullname, uint16_t rrtype, const void *qdata, uint16_t qlen) cups_dnssd_query_cb_t; |
| | 11565 | </p> |
| | 11566 | <h3 class="typedef"><a id="cups_dnssd_query_t">cups_dnssd_query_t</a></h3> |
| | 11567 | <p class="description">DNS query request</p> |
| | 11568 | <p class="code"> |
| | 11569 | typedef struct _cups_dnssd_query_s cups_dnssd_query_t; |
| | 11570 | </p> |
| | 11571 | <h3 class="typedef"><a id="cups_dnssd_resolve_cb_t">cups_dnssd_resolve_cb_t</a></h3> |
| | 11572 | <p class="description">DNS-SD resolve callback</p> |
| | 11573 | <p class="code"> |
| | 11574 | typedef void(*)(cups_dnssd_resolve_t *res, void *cb_data, <a href="#cups_dnssd_flags_t">cups_dnssd_flags_t</a> flags, uint32_t if_index, const char *fullname, const char *host, uint16_t port, int num_txt, <a href="#cups_option_t">cups_option_t</a> *txt)cups_dnssd_resolve_cb_t; |
| | 11575 | </p> |
| | 11576 | <h3 class="typedef"><a id="cups_dnssd_resolve_t">cups_dnssd_resolve_t</a></h3> |
| | 11577 | <p class="description">DNS resolve request</p> |
| | 11578 | <p class="code"> |
| | 11579 | typedef struct _cups_dnssd_resolve_s cups_dnssd_resolve_t; |
| | 11580 | </p> |
| | 11581 | <h3 class="typedef"><a id="cups_dnssd_browse_t">cups_dnssd_browse_t</a></h3> |
| | 11582 | <p class="description">DNS record type values</p> |
| | 11583 | <p class="code"> |
| | 11584 | typedef typedef struct _cups_dnssd_browse_s cups_dnssd_browse_t; |
| | 11585 | </p> |
| | 11586 | <h3 class="typedef"><a id="cups_dnssd_service_cb_t">cups_dnssd_service_cb_t</a></h3> |
| | 11587 | <p class="description">DNS-SD service registration callback</p> |
| | 11588 | <p class="code"> |
| | 11589 | typedef void(*)(cups_dnssd_service_t *service, void *cb_data, <a href="#cups_dnssd_flags_t">cups_dnssd_flags_t</a> flags) cups_dnssd_service_cb_t; |
| | 11590 | </p> |
| | 11591 | <h3 class="typedef"><a id="cups_dnssd_service_t">cups_dnssd_service_t</a></h3> |
| | 11592 | <p class="description">DNS service registration</p> |
| | 11593 | <p class="code"> |
| | 11594 | typedef struct _cups_dnssd_service_s cups_dnssd_service_t; |
| | 11595 | </p> |
| | 11596 | <h3 class="typedef"><a id="cups_dnssd_t">cups_dnssd_t</a></h3> |
| | 11597 | <p class="description">DNS-SD context</p> |
| | 11598 | <p class="code"> |
| | 11599 | typedef struct _cups_dnssd_s cups_dnssd_t; |
| | 11600 | </p> |
| | 11601 | <h3 class="typedef"><a id="cups_edge_t">cups_edge_t</a></h3> |
| | 11602 | <p class="description">LeadingEdge attribute values</p> |
| | 11603 | <p class="code"> |
| | 11604 | typedef enum <a href="#cups_edge_e">cups_edge_e</a> cups_edge_t; |
| | 11605 | </p> |
| | 11606 | <h3 class="typedef"><a id="cups_file_t">cups_file_t</a></h3> |
| | 11607 | <p class="description">CUPS file type</p> |
| | 11608 | <p class="code"> |
| | 11609 | typedef struct _cups_file_s cups_file_t; |
| | 11610 | </p> |
| | 11611 | <h3 class="typedef"><a id="cups_job_t">cups_job_t</a></h3> |
| | 11612 | <p class="description">Job information</p> |
| | 11613 | <p class="code"> |
| | 11614 | typedef struct <a href="#cups_job_s">cups_job_s</a> cups_job_t; |
| | 11615 | </p> |
| | 11616 | <h3 class="typedef"><a id="cups_jog_t">cups_jog_t</a></h3> |
| | 11617 | <p class="description">Jog attribute values</p> |
| | 11618 | <p class="code"> |
| | 11619 | typedef enum <a href="#cups_jog_e">cups_jog_e</a> cups_jog_t; |
| | 11620 | </p> |
| | 11621 | <h3 class="typedef"><a id="cups_json_t"><span class="info"> CUPS 2.5 </span>cups_json_t</a></h3> |
| | 11622 | <p class="description">JSON node </p> |
| | 11623 | <p class="code"> |
| | 11624 | typedef struct _cups_json_s cups_json_t; |
| | 11625 | </p> |
| | 11626 | <h3 class="typedef"><a id="cups_jtype_t"><span class="info"> CUPS 2.5 </span>cups_jtype_t</a></h3> |
| | 11627 | <p class="description">JSON node type </p> |
| | 11628 | <p class="code"> |
| | 11629 | typedef enum <a href="#cups_jtype_e">cups_jtype_e</a> cups_jtype_t; |
| | 11630 | </p> |
| | 11631 | <h3 class="typedef"><a id="cups_jwa_t"><span class="info"> CUPS 2.5 </span>cups_jwa_t</a></h3> |
| | 11632 | <p class="description">JSON Web Algorithms </p> |
| | 11633 | <p class="code"> |
| | 11634 | typedef enum <a href="#cups_jwa_e">cups_jwa_e</a> cups_jwa_t; |
| | 11635 | </p> |
| | 11636 | <h3 class="typedef"><a id="cups_jws_format_t"><span class="info"> CUPS 2.5 </span>cups_jws_format_t</a></h3> |
| | 11637 | <p class="description">JSON Web Signature Formats </p> |
| | 11638 | <p class="code"> |
| | 11639 | typedef enum <a href="#cups_jws_format_e">cups_jws_format_e</a> cups_jws_format_t; |
| | 11640 | </p> |
| | 11641 | <h3 class="typedef"><a id="cups_jwt_t"><span class="info"> CUPS 2.5 </span>cups_jwt_t</a></h3> |
| | 11642 | <p class="description">JSON Web Token </p> |
| | 11643 | <p class="code"> |
| | 11644 | typedef struct _cups_jwt_s cups_jwt_t; |
| | 11645 | </p> |
| | 11646 | <h3 class="typedef"><a id="cups_lang_t">cups_lang_t</a></h3> |
| | 11647 | <p class="description">Language Cache Structure</p> |
| | 11648 | <p class="code"> |
| | 11649 | typedef struct <a href="#cups_lang_s">cups_lang_s</a> cups_lang_t; |
| | 11650 | </p> |
| | 11651 | <h3 class="typedef"><a id="cups_media_flags_t">cups_media_flags_t</a></h3> |
| | 11652 | <p class="description">Combined flags for <a href="#cupsGetDestMediaByName"><code>cupsGetDestMediaByName</code></a> and <a href="#cupsGetDestMediaBySize"><code>cupsGetDestMediaBySize</code></a></p> |
| | 11653 | <p class="code"> |
| | 11654 | typedef unsigned cups_media_flags_t; |
| | 11655 | </p> |
| | 11656 | <h3 class="typedef"><a id="cups_media_t"><span class="info"> CUPS 2.5 </span>cups_media_t</a></h3> |
| | 11657 | <p class="description">Media information </p> |
| | 11658 | <p class="code"> |
| | 11659 | typedef struct <a href="#cups_media_s">cups_media_s</a> cups_media_t; |
| | 11660 | </p> |
| | 11661 | <h3 class="typedef"><a id="cups_mutex_t">cups_mutex_t</a></h3> |
| | 11662 | <p class="description">Mutual exclusion lock</p> |
| | 11663 | <p class="code"> |
| | 11664 | typedef pthread_mutex_t cups_mutex_t; |
| | 11665 | </p> |
| | 11666 | <h3 class="typedef"><a id="cups_oauth_cb_t"><span class="info"> CUPS 2.4 </span>cups_oauth_cb_t</a></h3> |
| | 11667 | <p class="description">OAuth callback </p> |
| | 11668 | <p class="code"> |
| | 11669 | typedef const char *(*)(http_t *http, const char *realm, const char *scope, const char *resource, void *user_data)cups_oauth_cb_t; |
| | 11670 | </p> |
| | 11671 | <h3 class="typedef"><a id="cups_ogrant_t">cups_ogrant_t</a></h3> |
| | 11672 | <p class="description">OAuth Grant Types</p> |
| | 11673 | <p class="code"> |
| | 11674 | typedef enum <a href="#cups_ogrant_e">cups_ogrant_e</a> cups_ogrant_t; |
| | 11675 | </p> |
| | 11676 | <h3 class="typedef"><a id="cups_option_t">cups_option_t</a></h3> |
| | 11677 | <p class="description">Printer Options</p> |
| | 11678 | <p class="code"> |
| | 11679 | typedef struct <a href="#cups_option_s">cups_option_s</a> cups_option_t; |
| | 11680 | </p> |
| | 11681 | <h3 class="typedef"><a id="cups_order_t">cups_order_t</a></h3> |
| | 11682 | <p class="description">cupsColorOrder attribute values</p> |
| | 11683 | <p class="code"> |
| | 11684 | typedef enum <a href="#cups_order_e">cups_order_e</a> cups_order_t; |
| | 11685 | </p> |
| | 11686 | <h3 class="typedef"><a id="cups_orient_t">cups_orient_t</a></h3> |
| | 11687 | <p class="description">Orientation attribute values</p> |
| | 11688 | <p class="code"> |
| | 11689 | typedef enum <a href="#cups_orient_e">cups_orient_e</a> cups_orient_t; |
| | 11690 | </p> |
| | 11691 | <h3 class="typedef"><a id="cups_page_header2_t"><span class="info"> CUPS 1.2 </span>cups_page_header2_t</a></h3> |
| | 11692 | <p class="description">Version 2 page header </p> |
| | 11693 | <p class="code"> |
| | 11694 | typedef struct <a href="#cups_page_header2_s">cups_page_header2_s</a> cups_page_header2_t; |
| | 11695 | </p> |
| | 11696 | <h3 class="typedef"><a id="cups_page_header_t"><span class="info"> DEPRECATED </span>cups_page_header_t</a></h3> |
| | 11697 | <p class="description">Version 1 page header </p> |
| | 11698 | <p class="code"> |
| | 11699 | typedef struct <a href="#cups_page_header_s">cups_page_header_s</a> cups_page_header_t; |
| | 11700 | </p> |
| | 11701 | <h3 class="typedef"><a id="cups_password_cb2_t"><span class="info"> CUPS 1.4 </span>cups_password_cb2_t</a></h3> |
| | 11702 | <p class="description">New password callback </p> |
| | 11703 | <p class="code"> |
| | 11704 | 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; |
| | 11705 | </p> |
| | 11706 | <h3 class="typedef"><a id="cups_ptype_t">cups_ptype_t</a></h3> |
| | 11707 | <p class="description">Combined printer type/capability flags</p> |
| | 11708 | <p class="code"> |
| | 11709 | typedef unsigned cups_ptype_t; |
| | 11710 | </p> |
| | 11711 | <h3 class="typedef"><a id="cups_raster_cb_t">cups_raster_cb_t</a></h3> |
| | 11712 | <p class="description">cupsRasterOpenIO callback function</p> |
| | 11713 | <p class="code"> |
| | 11714 | typedef ssize_t(*)(void *ctx, unsigned char *buffer, size_t length) cups_raster_cb_t; |
| | 11715 | </p> |
| | 11716 | <h3 class="typedef"><a id="cups_raster_mode_t">cups_raster_mode_t</a></h3> |
| | 11717 | <p class="description">cupsRasterOpen modes</p> |
| | 11718 | <p class="code"> |
| | 11719 | typedef enum <a href="#cups_raster_mode_e">cups_raster_mode_e</a> cups_raster_mode_t; |
| | 11720 | </p> |
| | 11721 | <h3 class="typedef"><a id="cups_raster_t">cups_raster_t</a></h3> |
| | 11722 | <p class="description">Raster stream data</p> |
| | 11723 | <p class="code"> |
| | 11724 | typedef struct _cups_raster_s cups_raster_t; |
| | 11725 | </p> |
| | 11726 | <h3 class="typedef"><a id="cups_rwlock_t">cups_rwlock_t</a></h3> |
| | 11727 | <p class="description">Reader/writer lock</p> |
| | 11728 | <p class="code"> |
| | 11729 | typedef pthread_rwlock_t cups_rwlock_t; |
| | 11730 | </p> |
| | 11731 | <h3 class="typedef"><a id="cups_sbcs_t">cups_sbcs_t</a></h3> |
| | 11732 | <p class="description">SBCS Legacy 8-bit unit</p> |
| | 11733 | <p class="code"> |
| | 11734 | typedef unsigned char cups_sbcs_t; |
| | 11735 | </p> |
| | 11736 | <h3 class="typedef"><a id="cups_server_cert_cb_t"><span class="info"> DEPRECATED </span>cups_server_cert_cb_t</a></h3> |
| | 11737 | <p class="description">Server credentials callback </p> |
| | 11738 | <p class="code"> |
| | 11739 | typedef int(*)(http_t *http, void *tls, <a href="#cups_array_t">cups_array_t</a> *certs, void *user_data)cups_server_cert_cb_t; |
| | 11740 | </p> |
| | 11741 | <h3 class="typedef"><a id="cups_size_t"><span class="info"> DEPRECATED </span>cups_size_t</a></h3> |
| | 11742 | <p class="description">Media Size </p> |
| | 11743 | <p class="code"> |
| | 11744 | typedef struct <a href="#cups_size_s">cups_size_s</a> cups_size_t; |
| | 11745 | </p> |
| | 11746 | <h3 class="typedef"><a id="cups_thread_func_t">cups_thread_func_t</a></h3> |
| | 11747 | <p class="description">Thread function</p> |
| | 11748 | <p class="code"> |
| | 11749 | typedef void *(*)(void *arg)cups_thread_func_t; |
| | 11750 | </p> |
| | 11751 | <h3 class="typedef"><a id="cups_thread_key_t">cups_thread_key_t</a></h3> |
| | 11752 | <p class="description">Thread data key</p> |
| | 11753 | <p class="code"> |
| | 11754 | typedef pthread_key_t cups_thread_key_t; |
| | 11755 | </p> |
| | 11756 | <h3 class="typedef"><a id="cups_thread_t">cups_thread_t</a></h3> |
| | 11757 | <p class="description">Thread identifier</p> |
| | 11758 | <p class="code"> |
| | 11759 | typedef pthread_t cups_thread_t; |
| | 11760 | </p> |
| | 11761 | <h3 class="typedef"><a id="cups_ucs2_t">cups_ucs2_t</a></h3> |
| | 11762 | <p class="description">UCS-2 Unicode/ISO-10646 unit</p> |
| | 11763 | <p class="code"> |
| | 11764 | typedef unsigned short cups_ucs2_t; |
| | 11765 | </p> |
| | 11766 | <h3 class="typedef"><a id="cups_ucs4_t">cups_ucs4_t</a></h3> |
| | 11767 | <p class="description">UCS-4 Unicode/ISO-10646 unit</p> |
| | 11768 | <p class="code"> |
| | 11769 | typedef unsigned long cups_ucs4_t; |
| | 11770 | </p> |
| | 11771 | <h3 class="typedef"><a id="cups_utf32_t">cups_utf32_t</a></h3> |
| | 11772 | <p class="description">UTF-32 Unicode/ISO-10646 unit</p> |
| | 11773 | <p class="code"> |
| | 11774 | typedef unsigned long cups_utf32_t; |
| | 11775 | </p> |
| | 11776 | <h3 class="typedef"><a id="cups_utf8_t">cups_utf8_t</a></h3> |
| | 11777 | <p class="description">UTF-8 Unicode/ISO-10646 unit</p> |
| | 11778 | <p class="code"> |
| | 11779 | typedef unsigned char cups_utf8_t; |
| | 11780 | </p> |
| | 11781 | <h3 class="typedef"><a id="cups_vbcs_t">cups_vbcs_t</a></h3> |
| | 11782 | <p class="description">VBCS Legacy 32-bit unit</p> |
| | 11783 | <p class="code"> |
| | 11784 | typedef unsigned long cups_vbcs_t; |
| | 11785 | </p> |
| | 11786 | <h3 class="typedef"><a id="cups_whichjobs_t">cups_whichjobs_t</a></h3> |
| | 11787 | <p class="description">Which jobs for <a href="#cupsGetJobs"><code>cupsGetJobs</code></a></p> |
| | 11788 | <p class="code"> |
| | 11789 | typedef enum <a href="#cups_whichjobs_e">cups_whichjobs_e</a> cups_whichjobs_t; |
| | 11790 | </p> |
| | 11791 | <h3 class="typedef"><a id="http_addr_t"><span class="info"> CUPS 1.2 </span>http_addr_t</a></h3> |
| | 11792 | <p class="description">Socket address union, which makes using IPv6 and other address types easier and more portable. </p> |
| | 11793 | <p class="code"> |
| | 11794 | typedef union _http_addr_u http_addr_t; |
| | 11795 | </p> |
| | 11796 | <h3 class="typedef"><a id="http_encoding_t">http_encoding_t</a></h3> |
| | 11797 | <p class="description">HTTP transfer encoding values</p> |
| | 11798 | <p class="code"> |
| | 11799 | typedef enum <a href="#http_encoding_e">http_encoding_e</a> http_encoding_t; |
| | 11800 | </p> |
| | 11801 | <h3 class="typedef"><a id="http_encryption_t">http_encryption_t</a></h3> |
| | 11802 | <p class="description">HTTP encryption values</p> |
| | 11803 | <p class="code"> |
| | 11804 | typedef enum <a href="#http_encryption_e">http_encryption_e</a> http_encryption_t; |
| | 11805 | </p> |
| | 11806 | <h3 class="typedef"><a id="http_field_t">http_field_t</a></h3> |
| | 11807 | <p class="description">HTTP field names</p> |
| | 11808 | <p class="code"> |
| | 11809 | typedef enum <a href="#http_field_e">http_field_e</a> http_field_t; |
| | 11810 | </p> |
| | 11811 | <h3 class="typedef"><a id="http_keepalive_t">http_keepalive_t</a></h3> |
| | 11812 | <p class="description">HTTP keep-alive values</p> |
| | 11813 | <p class="code"> |
| | 11814 | typedef enum <a href="#http_keepalive_e">http_keepalive_e</a> http_keepalive_t; |
| | 11815 | </p> |
| | 11816 | <h3 class="typedef"><a id="http_resolve_cb_t"><span class="info"> CUPS 2.5 </span>http_resolve_cb_t</a></h3> |
| | 11817 | <p class="description"><a href="#httpResolveURI"><code>httpResolveURI</code></a> callback </p> |
| | 11818 | <p class="code"> |
| | 11819 | typedef bool(*)(void *data)http_resolve_cb_t; |
| | 11820 | </p> |
| | 11821 | <h3 class="typedef"><a id="http_resolve_t">http_resolve_t</a></h3> |
| | 11822 | <p class="description"><a href="#httpResolveURI"><code>httpResolveURI</code></a> options bitfield</p> |
| | 11823 | <p class="code"> |
| | 11824 | typedef unsigned http_resolve_t; |
| | 11825 | </p> |
| | 11826 | <h3 class="typedef"><a id="http_state_t">http_state_t</a></h3> |
| | 11827 | <p class="description">HTTP state values; states are server-oriented...</p> |
| | 11828 | <p class="code"> |
| | 11829 | typedef enum <a href="#http_state_e">http_state_e</a> http_state_t; |
| | 11830 | </p> |
| | 11831 | <h3 class="typedef"><a id="http_t">http_t</a></h3> |
| | 11832 | <p class="description">HTTP connection type</p> |
| | 11833 | <p class="code"> |
| | 11834 | typedef struct _http_s http_t; |
| | 11835 | </p> |
| | 11836 | <h3 class="typedef"><a id="http_timeout_cb_t"><span class="info"> CUPS 1.5 </span>http_timeout_cb_t</a></h3> |
| | 11837 | <p class="description">HTTP timeout callback </p> |
| | 11838 | <p class="code"> |
| | 11839 | typedef int(*)(http_t *http, void *user_data)http_timeout_cb_t; |
| | 11840 | </p> |
| | 11841 | <h3 class="typedef"><a id="http_trust_t"><span class="info"> CUPS 2.0/OS 10.10 </span>http_trust_t</a></h3> |
| | 11842 | <p class="description">Level of trust for credentials </p> |
| | 11843 | <p class="code"> |
| | 11844 | typedef enum <a href="#http_trust_e">http_trust_e</a> http_trust_t; |
| | 11845 | </p> |
| | 11846 | <h3 class="typedef"><a id="http_uri_coding_t">http_uri_coding_t</a></h3> |
| | 11847 | <p class="description">URI en/decode flags</p> |
| | 11848 | <p class="code"> |
| | 11849 | typedef enum <a href="#http_uri_coding_e">http_uri_coding_e</a> http_uri_coding_t; |
| | 11850 | </p> |
| | 11851 | <h3 class="typedef"><a id="http_uri_status_t"><span class="info"> CUPS 1.2 </span>http_uri_status_t</a></h3> |
| | 11852 | <p class="description">URI separation status </p> |
| | 11853 | <p class="code"> |
| | 11854 | typedef enum <a href="#http_uri_status_e">http_uri_status_e</a> http_uri_status_t; |
| | 11855 | </p> |
| | 11856 | <h3 class="typedef"><a id="ipp_attribute_t">ipp_attribute_t</a></h3> |
| | 11857 | <p class="description">IPP attribute</p> |
| | 11858 | <p class="code"> |
| | 11859 | typedef struct _ipp_attribute_s ipp_attribute_t; |
| | 11860 | </p> |
| | 11861 | <h3 class="typedef"><a id="ipp_copy_cb_t"><span class="info"> CUPS 1.6 </span>ipp_copy_cb_t</a></h3> |
| | 11862 | <p class="description">ippCopyAttributes callback function </p> |
| | 11863 | <p class="code"> |
| | 11864 | typedef int(*)(void *context, <a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr)ipp_copy_cb_t; |
| | 11865 | </p> |
| | 11866 | <h3 class="typedef"><a id="ipp_fattr_cb_t">ipp_fattr_cb_t</a></h3> |
| | 11867 | <p class="description">IPP data file attribute callback</p> |
| | 11868 | <p class="code"> |
| | 11869 | typedef bool(*)(ipp_file_t *file, void *cb_data, const char *name)ipp_fattr_cb_t; |
| | 11870 | </p> |
| | 11871 | <h3 class="typedef"><a id="ipp_ferror_cb_t">ipp_ferror_cb_t</a></h3> |
| | 11872 | <p class="description">IPP data file error callback</p> |
| | 11873 | <p class="code"> |
| | 11874 | typedef bool(*)(ipp_file_t *file, void *cb_data, const char *error)ipp_ferror_cb_t; |
| | 11875 | </p> |
| | 11876 | <h3 class="typedef"><a id="ipp_file_t">ipp_file_t</a></h3> |
| | 11877 | <p class="description">IPP data file</p> |
| | 11878 | <p class="code"> |
| | 11879 | typedef struct _ipp_file_s ipp_file_t; |
| | 11880 | </p> |
| | 11881 | <h3 class="typedef"><a id="ipp_ftoken_cb_t">ipp_ftoken_cb_t</a></h3> |
| | 11882 | <p class="description">IPP data file token callback</p> |
| | 11883 | <p class="code"> |
| | 11884 | typedef bool(*)(ipp_file_t *file, void *cb_data, const char *token)ipp_ftoken_cb_t; |
| | 11885 | </p> |
| | 11886 | <h3 class="typedef"><a id="ipp_io_cb_t"><span class="info"> CUPS 1.2 </span>ipp_io_cb_t</a></h3> |
| | 11887 | <p class="description">ippReadIO/ippWriteIO callback function </p> |
| | 11888 | <p class="code"> |
| | 11889 | typedef ssize_t(*)(void *context, ipp_uchar_t *buffer, size_t bytes) ipp_io_cb_t; |
| | 11890 | </p> |
| | 11891 | <h3 class="typedef"><a id="ipp_jstate_t">ipp_jstate_t</a></h3> |
| | 11892 | <p class="description">Job states</p> |
| | 11893 | <p class="code"> |
| | 11894 | typedef enum <a href="#ipp_jstate_e">ipp_jstate_e</a> ipp_jstate_t; |
| | 11895 | </p> |
| | 11896 | <h3 class="typedef"><a id="ipp_op_t">ipp_op_t</a></h3> |
| | 11897 | <p class="description">IPP operations</p> |
| | 11898 | <p class="code"> |
| | 11899 | typedef enum <a href="#ipp_op_e">ipp_op_e</a> ipp_op_t; |
| | 11900 | </p> |
| | 11901 | <h3 class="typedef"><a id="ipp_orient_t">ipp_orient_t</a></h3> |
| | 11902 | <p class="description">Orientation values</p> |
| | 11903 | <p class="code"> |
| | 11904 | typedef enum <a href="#ipp_orient_e">ipp_orient_e</a> ipp_orient_t; |
| | 11905 | </p> |
| | 11906 | <h3 class="typedef"><a id="ipp_pstate_t">ipp_pstate_t</a></h3> |
| | 11907 | <p class="description">Printer state values</p> |
| | 11908 | <p class="code"> |
| | 11909 | typedef enum <a href="#ipp_pstate_e">ipp_pstate_e</a> ipp_pstate_t; |
| | 11910 | </p> |
| | 11911 | <h3 class="typedef"><a id="ipp_quality_t">ipp_quality_t</a></h3> |
| | 11912 | <p class="description">Print quality values</p> |
| | 11913 | <p class="code"> |
| | 11914 | typedef enum <a href="#ipp_quality_e">ipp_quality_e</a> ipp_quality_t; |
| | 11915 | </p> |
| | 11916 | <h3 class="typedef"><a id="ipp_res_t">ipp_res_t</a></h3> |
| | 11917 | <p class="description">Resolution units</p> |
| | 11918 | <p class="code"> |
| | 11919 | typedef enum <a href="#ipp_res_e">ipp_res_e</a> ipp_res_t; |
| | 11920 | </p> |
| | 11921 | <h3 class="typedef"><a id="ipp_rstate_t">ipp_rstate_t</a></h3> |
| | 11922 | <p class="description">resource-state values</p> |
| | 11923 | <p class="code"> |
| | 11924 | typedef enum <a href="#ipp_rstate_e">ipp_rstate_e</a> ipp_rstate_t; |
| | 11925 | </p> |
| | 11926 | <h3 class="typedef"><a id="ipp_sstate_t">ipp_sstate_t</a></h3> |
| | 11927 | <p class="description">system-state values</p> |
| | 11928 | <p class="code"> |
| | 11929 | typedef enum <a href="#ipp_sstate_e">ipp_sstate_e</a> ipp_sstate_t; |
| | 11930 | </p> |
| | 11931 | <h3 class="typedef"><a id="ipp_state_t">ipp_state_t</a></h3> |
| | 11932 | <p class="description">ipp_t state values</p> |
| | 11933 | <p class="code"> |
| | 11934 | typedef enum <a href="#ipp_state_e">ipp_state_e</a> ipp_state_t; |
| | 11935 | </p> |
| | 11936 | <h3 class="typedef"><a id="ipp_t">ipp_t</a></h3> |
| | 11937 | <p class="description">IPP request/response data</p> |
| | 11938 | <p class="code"> |
| | 11939 | typedef struct _ipp_s ipp_t; |
| | 11940 | </p> |
| | 11941 | <h3 class="typedef"><a id="pwg_media_t">pwg_media_t</a></h3> |
| | 11942 | <p class="description">Common media size data</p> |
| | 11943 | <p class="code"> |
| | 11944 | typedef struct <a href="#pwg_media_s">pwg_media_s</a> pwg_media_t; |
| | 11945 | </p> |
| | 11946 | <h2 class="title"><a id="STRUCTURES">Structures</a></h2> |
| | 11947 | <h3 class="struct"><a id="cups_dentry_s">cups_dentry_s</a></h3> |
| | 11948 | <p class="description">Directory entry type</p> |
| | 11949 | <p class="code"><span class="reserved">struct</span> cups_dentry_s {<br> |
| | 11950 |     <span class="reserved">struct</span> stat fileinfo;<br> |
| | 11951 |     <span class="reserved">char</span> filename[260];<br> |
| | 11952 | };</p> |
| | 11953 | <h4 class="members">Members</h4> |
| | 11954 | <table class="list"><tbody> |
| | 11955 | <tr><th>fileinfo </th> |
| | 11956 | <td class="description">File information</td></tr> |
| | 11957 | <tr><th>filename[260] </th> |
| | 11958 | <td class="description">File name</td></tr> |
| | 11959 | </tbody></table> |
| | 11960 | <h3 class="struct"><a id="cups_dest_s">cups_dest_s</a></h3> |
| | 11961 | <p class="description">Destination</p> |
| | 11962 | <p class="code"><span class="reserved">struct</span> cups_dest_s {<br> |
| | 11963 |     <span class="reserved">char</span> *name, *instance;<br> |
| | 11964 |     <span class="reserved">int</span> is_default;<br> |
| | 11965 |     <span class="reserved">int</span> num_options;<br> |
| | 11966 |     <a href="#cups_option_t">cups_option_t</a> *options;<br> |
| | 11967 | };</p> |
| | 11968 | <h4 class="members">Members</h4> |
| | 11969 | <table class="list"><tbody> |
| | 11970 | <tr><th>instance </th> |
| | 11971 | <td class="description">Local instance name or <code>NULL</code></td></tr> |
| | 11972 | <tr><th>is_default </th> |
| | 11973 | <td class="description">Is this printer the default?</td></tr> |
| | 11974 | <tr><th>num_options </th> |
| | 11975 | <td class="description">Number of options</td></tr> |
| | 11976 | <tr><th>options </th> |
| | 11977 | <td class="description">Options</td></tr> |
| | 11978 | </tbody></table> |
| | 11979 | <h3 class="struct"><a id="cups_job_s">cups_job_s</a></h3> |
| | 11980 | <p class="description">Job information</p> |
| | 11981 | <p class="code"><span class="reserved">struct</span> cups_job_s {<br> |
| | 11982 |     time_t completed_time;<br> |
| | 11983 |     time_t creation_time;<br> |
| | 11984 |     <span class="reserved">char</span> *dest;<br> |
| | 11985 |     <span class="reserved">char</span> *format;<br> |
| | 11986 |     <span class="reserved">int</span> id;<br> |
| | 11987 |     <span class="reserved">int</span> priority;<br> |
| | 11988 |     time_t processing_time;<br> |
| | 11989 |     <span class="reserved">int</span> size;<br> |
| | 11990 |     <a href="#ipp_jstate_t">ipp_jstate_t</a> state;<br> |
| | 11991 |     <span class="reserved">char</span> *title;<br> |
| | 11992 |     <span class="reserved">char</span> *user;<br> |
| | 11993 | };</p> |
| | 11994 | <h4 class="members">Members</h4> |
| | 11995 | <table class="list"><tbody> |
| | 11996 | <tr><th>completed_time </th> |
| | 11997 | <td class="description">Time the job was completed</td></tr> |
| | 11998 | <tr><th>creation_time </th> |
| | 11999 | <td class="description">Time the job was created</td></tr> |
| | 12000 | <tr><th>dest </th> |
| | 12001 | <td class="description">Printer or class name</td></tr> |
| | 12002 | <tr><th>format </th> |
| | 12003 | <td class="description">Document format</td></tr> |
| | 12004 | <tr><th>id </th> |
| | 12005 | <td class="description">The job ID</td></tr> |
| | 12006 | <tr><th>priority </th> |
| | 12007 | <td class="description">Priority (1-100)</td></tr> |
| | 12008 | <tr><th>processing_time </th> |
| | 12009 | <td class="description">Time the job was processed</td></tr> |
| | 12010 | <tr><th>size </th> |
| | 12011 | <td class="description">Size in kilobytes</td></tr> |
| | 12012 | <tr><th>state </th> |
| | 12013 | <td class="description">Job state</td></tr> |
| | 12014 | <tr><th>title </th> |
| | 12015 | <td class="description">Title/job name</td></tr> |
| | 12016 | <tr><th>user </th> |
| | 12017 | <td class="description">User that submitted the job</td></tr> |
| | 12018 | </tbody></table> |
| | 12019 | <h3 class="struct"><a id="cups_lang_s">cups_lang_s</a></h3> |
| | 12020 | <p class="description">Language Cache Structure</p> |
| | 12021 | <p class="code"><span class="reserved">struct</span> cups_lang_s {<br> |
| | 12022 |     <a href="#cups_encoding_t">cups_encoding_t</a> encoding;<br> |
| | 12023 |     <span class="reserved">char</span> language[16];<br> |
| | 12024 |     <span class="reserved">struct</span> <a href="#cups_lang_s">cups_lang_s</a> *next;<br> |
| | 12025 |     <span class="reserved">int</span> used;<br> |
| | 12026 | };</p> |
| | 12027 | <h4 class="members">Members</h4> |
| | 12028 | <table class="list"><tbody> |
| | 12029 | <tr><th>encoding </th> |
| | 12030 | <td class="description">Text encoding</td></tr> |
| | 12031 | <tr><th>language[16] </th> |
| | 12032 | <td class="description">Language/locale name</td></tr> |
| | 12033 | <tr><th>next </th> |
| | 12034 | <td class="description">Next language in cache</td></tr> |
| | 12035 | <tr><th>used </th> |
| | 12036 | <td class="description">Number of times this entry has been used.</td></tr> |
| | 12037 | </tbody></table> |
| | 12038 | <h3 class="struct"><span class="info"> CUPS 2.5 </span><a id="cups_media_s">cups_media_s</a></h3> |
| | 12039 | <p class="description">Media information </p> |
| | 12040 | <p class="code"><span class="reserved">struct</span> cups_media_s {<br> |
| | 12041 |     <span class="reserved">int</span> width, length, bottom, left, right, top;<br> |
| | 12042 |     <span class="reserved">char</span> media[128], color[128], source[128], type[128];<br> |
| | 12043 | };</p> |
| | 12044 | <h4 class="members">Members</h4> |
| | 12045 | <table class="list"><tbody> |
| | 12046 | <tr><th>top </th> |
| | 12047 | <td class="description">Top margin in hundredths of millimeters</td></tr> |
| | 12048 | <tr><th>type[128] </th> |
| | 12049 | <td class="description">Media type (blank for any/auto)</td></tr> |
| | 12050 | </tbody></table> |
| | 12051 | <h3 class="struct"><a id="cups_option_s">cups_option_s</a></h3> |
| | 12052 | <p class="description">Printer Options</p> |
| | 12053 | <p class="code"><span class="reserved">struct</span> cups_option_s {<br> |
| | 12054 |     <span class="reserved">char</span> *name;<br> |
| | 12055 |     <span class="reserved">char</span> *value;<br> |
| | 12056 | };</p> |
| | 12057 | <h4 class="members">Members</h4> |
| | 12058 | <table class="list"><tbody> |
| | 12059 | <tr><th>name </th> |
| | 12060 | <td class="description">Name of option</td></tr> |
| | 12061 | <tr><th>value </th> |
| | 12062 | <td class="description">Value of option</td></tr> |
| | 12063 | </tbody></table> |
| | 12064 | <h3 class="struct"><span class="info"> CUPS 1.2 </span><a id="cups_page_header2_s">cups_page_header2_s</a></h3> |
| | 12065 | <p class="description">Version 2 page header </p> |
| | 12066 | <p class="code"><span class="reserved">struct</span> cups_page_header2_s {<br> |
| | 12067 |     <span class="reserved">unsigned</span> AdvanceDistance;<br> |
| | 12068 |     <a href="#cups_adv_t">cups_adv_t</a> AdvanceMedia;<br> |
| | 12069 |     <a href="#cups_bool_t">cups_bool_t</a> Collate;<br> |
| | 12070 |     <a href="#cups_cut_t">cups_cut_t</a> CutMedia;<br> |
| | 12071 |     <a href="#cups_bool_t">cups_bool_t</a> Duplex;<br> |
| | 12072 |     <span class="reserved">unsigned</span> HWResolution[2];<br> |
| | 12073 |     <span class="reserved">unsigned</span> ImagingBoundingBox[4];<br> |
| | 12074 |     <a href="#cups_bool_t">cups_bool_t</a> InsertSheet;<br> |
| | 12075 |     <a href="#cups_jog_t">cups_jog_t</a> Jog;<br> |
| | 12076 |     <a href="#cups_edge_t">cups_edge_t</a> LeadingEdge;<br> |
| | 12077 |     <a href="#cups_bool_t">cups_bool_t</a> ManualFeed;<br> |
| | 12078 |     <span class="reserved">unsigned</span> Margins[2];<br> |
| | 12079 |     <span class="reserved">char</span> MediaClass[64];<br> |
| | 12080 |     <span class="reserved">char</span> MediaColor[64];<br> |
| | 12081 |     <span class="reserved">unsigned</span> MediaPosition;<br> |
| | 12082 |     <span class="reserved">char</span> MediaType[64];<br> |
| | 12083 |     <span class="reserved">unsigned</span> MediaWeight;<br> |
| | 12084 |     <a href="#cups_bool_t">cups_bool_t</a> MirrorPrint;<br> |
| | 12085 |     <a href="#cups_bool_t">cups_bool_t</a> NegativePrint;<br> |
| | 12086 |     <span class="reserved">unsigned</span> NumCopies;<br> |
| | 12087 |     <a href="#cups_orient_t">cups_orient_t</a> Orientation;<br> |
| | 12088 |     <a href="#cups_bool_t">cups_bool_t</a> OutputFaceUp;<br> |
| | 12089 |     <span class="reserved">char</span> OutputType[64];<br> |
| | 12090 |     <span class="reserved">unsigned</span> PageSize[2];<br> |
| | 12091 |     <a href="#cups_bool_t">cups_bool_t</a> Separations;<br> |
| | 12092 |     <a href="#cups_bool_t">cups_bool_t</a> TraySwitch;<br> |
| | 12093 |     <a href="#cups_bool_t">cups_bool_t</a> Tumble;<br> |
| | 12094 |     <span class="reserved">unsigned</span> cupsBitsPerColor;<br> |
| | 12095 |     <span class="reserved">unsigned</span> cupsBitsPerPixel;<br> |
| | 12096 |     <span class="reserved">float</span> cupsBorderlessScalingFactor;<br> |
| | 12097 |     <span class="reserved">unsigned</span> cupsBytesPerLine;<br> |
| | 12098 |     <a href="#cups_order_t">cups_order_t</a> cupsColorOrder;<br> |
| | 12099 |     <a href="#cups_cspace_t">cups_cspace_t</a> cupsColorSpace;<br> |
| | 12100 |     <span class="reserved">unsigned</span> cupsCompression;<br> |
| | 12101 |     <span class="reserved">unsigned</span> cupsHeight;<br> |
| | 12102 |     <span class="reserved">float</span> cupsImagingBBox[4];<br> |
| | 12103 |     <span class="reserved">unsigned</span> cupsInteger[16];<br> |
| | 12104 |     <span class="reserved">char</span> cupsMarkerType[64];<br> |
| | 12105 |     <span class="reserved">unsigned</span> cupsMediaType;<br> |
| | 12106 |     <span class="reserved">unsigned</span> cupsNumColors;<br> |
| | 12107 |     <span class="reserved">char</span> cupsPageSizeName[64];<br> |
| | 12108 |     <span class="reserved">float</span> cupsPageSize[2];<br> |
| | 12109 |     <span class="reserved">float</span> cupsReal[16];<br> |
| | 12110 |     <span class="reserved">char</span> cupsRenderingIntent[64];<br> |
| | 12111 |     <span class="reserved">unsigned</span> cupsRowCount;<br> |
| | 12112 |     <span class="reserved">unsigned</span> cupsRowFeed;<br> |
| | 12113 |     <span class="reserved">unsigned</span> cupsRowStep;<br> |
| | 12114 |     <span class="reserved">char</span> cupsString[16][64];<br> |
| | 12115 |     <span class="reserved">unsigned</span> cupsWidth;<br> |
| | 12116 | };</p> |
| | 12117 | <h4 class="members">Members</h4> |
| | 12118 | <table class="list"><tbody> |
| | 12119 | <tr><th>AdvanceDistance </th> |
| | 12120 | <td class="description">AdvanceDistance value in points</td></tr> |
| | 12121 | <tr><th>AdvanceMedia </th> |
| | 12122 | <td class="description">AdvanceMedia value (<a href="#cups_adv_t"><code>cups_adv_t</code></a>)</td></tr> |
| | 12123 | <tr><th>Collate </th> |
| | 12124 | <td class="description">Collated copies value</td></tr> |
| | 12125 | <tr><th>CutMedia </th> |
| | 12126 | <td class="description">CutMedia value (<a href="#cups_cut_t"><code>cups_cut_t</code></a>)</td></tr> |
| | 12127 | <tr><th>Duplex </th> |
| | 12128 | <td class="description">Duplexed (double-sided) value</td></tr> |
| | 12129 | <tr><th>HWResolution[2] </th> |
| | 12130 | <td class="description">Resolution in dots-per-inch</td></tr> |
| | 12131 | <tr><th>ImagingBoundingBox[4] </th> |
| | 12132 | <td class="description">Pixel region that is painted (points, left, bottom, right, top)</td></tr> |
| | 12133 | <tr><th>InsertSheet </th> |
| | 12134 | <td class="description">InsertSheet value</td></tr> |
| | 12135 | <tr><th>Jog </th> |
| | 12136 | <td class="description">Jog value (<a href="#cups_jog_t"><code>cups_jog_t</code></a>)</td></tr> |
| | 12137 | <tr><th>LeadingEdge </th> |
| | 12138 | <td class="description">LeadingEdge value (<a href="#cups_edge_t"><code>cups_edge_t</code></a>)</td></tr> |
| | 12139 | <tr><th>ManualFeed </th> |
| | 12140 | <td class="description">ManualFeed value</td></tr> |
| | 12141 | <tr><th>Margins[2] </th> |
| | 12142 | <td class="description">Lower-lefthand margins in points</td></tr> |
| | 12143 | <tr><th>MediaClass[64] </th> |
| | 12144 | <td class="description">MediaClass string</td></tr> |
| | 12145 | <tr><th>MediaColor[64] </th> |
| | 12146 | <td class="description">MediaColor string</td></tr> |
| | 12147 | <tr><th>MediaPosition </th> |
| | 12148 | <td class="description">MediaPosition value</td></tr> |
| | 12149 | <tr><th>MediaType[64] </th> |
| | 12150 | <td class="description">MediaType string</td></tr> |
| | 12151 | <tr><th>MediaWeight </th> |
| | 12152 | <td class="description">MediaWeight value in grams/m^2</td></tr> |
| | 12153 | <tr><th>MirrorPrint </th> |
| | 12154 | <td class="description">MirrorPrint value</td></tr> |
| | 12155 | <tr><th>NegativePrint </th> |
| | 12156 | <td class="description">NegativePrint value</td></tr> |
| | 12157 | <tr><th>NumCopies </th> |
| | 12158 | <td class="description">Number of copies to produce</td></tr> |
| | 12159 | <tr><th>Orientation </th> |
| | 12160 | <td class="description">Orientation value (<a href="#cups_orient_t"><code>cups_orient_t</code></a>)</td></tr> |
| | 12161 | <tr><th>OutputFaceUp </th> |
| | 12162 | <td class="description">OutputFaceUp value</td></tr> |
| | 12163 | <tr><th>OutputType[64] </th> |
| | 12164 | <td class="description">OutputType string</td></tr> |
| | 12165 | <tr><th>PageSize[2] </th> |
| | 12166 | <td class="description">Width and length of page in points</td></tr> |
| | 12167 | <tr><th>Separations </th> |
| | 12168 | <td class="description">Separations value</td></tr> |
| | 12169 | <tr><th>TraySwitch </th> |
| | 12170 | <td class="description">TraySwitch value</td></tr> |
| | 12171 | <tr><th>Tumble </th> |
| | 12172 | <td class="description">Tumble value</td></tr> |
| | 12173 | <tr><th>cupsBitsPerColor </th> |
| | 12174 | <td class="description">Number of bits for each color</td></tr> |
| | 12175 | <tr><th>cupsBitsPerPixel </th> |
| | 12176 | <td class="description">Number of bits for each pixel</td></tr> |
| | 12177 | <tr><th>cupsBorderlessScalingFactor <span class="info"> CUPS 1.2 </span></th> |
| | 12178 | <td class="description">Scaling that was applied to page data </td></tr> |
| | 12179 | <tr><th>cupsBytesPerLine </th> |
| | 12180 | <td class="description">Number of bytes per line</td></tr> |
| | 12181 | <tr><th>cupsColorOrder </th> |
| | 12182 | <td class="description">Order of colors</td></tr> |
| | 12183 | <tr><th>cupsColorSpace </th> |
| | 12184 | <td class="description">True colorspace</td></tr> |
| | 12185 | <tr><th>cupsCompression </th> |
| | 12186 | <td class="description">Device compression to use</td></tr> |
| | 12187 | <tr><th>cupsHeight </th> |
| | 12188 | <td class="description">Height of page image in pixels</td></tr> |
| | 12189 | <tr><th>cupsImagingBBox[4] <span class="info"> CUPS 1.2 </span></th> |
| | 12190 | <td class="description">Floating point ImagingBoundingBox |
| | 12191 | (scaling factor not applied, left, |
| | 12192 | bottom, right, top) </td></tr> |
| | 12193 | <tr><th>cupsInteger[16] <span class="info"> CUPS 1.2 </span></th> |
| | 12194 | <td class="description">User-defined integer values </td></tr> |
| | 12195 | <tr><th>cupsMarkerType[64] <span class="info"> CUPS 1.2 </span></th> |
| | 12196 | <td class="description">Ink/toner type </td></tr> |
| | 12197 | <tr><th>cupsMediaType </th> |
| | 12198 | <td class="description">Media type code</td></tr> |
| | 12199 | <tr><th>cupsNumColors <span class="info"> CUPS 1.2 </span></th> |
| | 12200 | <td class="description">Number of color components </td></tr> |
| | 12201 | <tr><th>cupsPageSizeName[64] <span class="info"> CUPS 1.2 </span></th> |
| | 12202 | <td class="description">PageSize name </td></tr> |
| | 12203 | <tr><th>cupsPageSize[2] <span class="info"> CUPS 1.2 </span></th> |
| | 12204 | <td class="description">Floating point PageSize (scaling * |
| | 12205 | factor not applied) </td></tr> |
| | 12206 | <tr><th>cupsReal[16] <span class="info"> CUPS 1.2 </span></th> |
| | 12207 | <td class="description">User-defined floating-point values </td></tr> |
| | 12208 | <tr><th>cupsRenderingIntent[64] <span class="info"> CUPS 1.2 </span></th> |
| | 12209 | <td class="description">Color rendering intent </td></tr> |
| | 12210 | <tr><th>cupsRowCount </th> |
| | 12211 | <td class="description">Rows per band</td></tr> |
| | 12212 | <tr><th>cupsRowFeed </th> |
| | 12213 | <td class="description">Feed between bands</td></tr> |
| | 12214 | <tr><th>cupsRowStep </th> |
| | 12215 | <td class="description">Spacing between lines</td></tr> |
| | 12216 | <tr><th>cupsString[16][64] <span class="info"> CUPS 1.2 </span></th> |
| | 12217 | <td class="description">User-defined string values </td></tr> |
| | 12218 | <tr><th>cupsWidth </th> |
| | 12219 | <td class="description">Width of page image in pixels</td></tr> |
| | 12220 | </tbody></table> |
| | 12221 | <h3 class="struct"><span class="info"> DEPRECATED </span><a id="cups_page_header_s">cups_page_header_s</a></h3> |
| | 12222 | <p class="description">Version 1 page header </p> |
| | 12223 | <p class="code"><span class="reserved">struct</span> cups_page_header_s {<br> |
| | 12224 |     <span class="reserved">unsigned</span> AdvanceDistance;<br> |
| | 12225 |     <a href="#cups_adv_t">cups_adv_t</a> AdvanceMedia;<br> |
| | 12226 |     <a href="#cups_bool_t">cups_bool_t</a> Collate;<br> |
| | 12227 |     <a href="#cups_cut_t">cups_cut_t</a> CutMedia;<br> |
| | 12228 |     <a href="#cups_bool_t">cups_bool_t</a> Duplex;<br> |
| | 12229 |     <span class="reserved">unsigned</span> HWResolution[2];<br> |
| | 12230 |     <span class="reserved">unsigned</span> ImagingBoundingBox[4];<br> |
| | 12231 |     <a href="#cups_bool_t">cups_bool_t</a> InsertSheet;<br> |
| | 12232 |     <a href="#cups_jog_t">cups_jog_t</a> Jog;<br> |
| | 12233 |     <a href="#cups_edge_t">cups_edge_t</a> LeadingEdge;<br> |
| | 12234 |     <a href="#cups_bool_t">cups_bool_t</a> ManualFeed;<br> |
| | 12235 |     <span class="reserved">unsigned</span> Margins[2];<br> |
| | 12236 |     <span class="reserved">char</span> MediaClass[64];<br> |
| | 12237 |     <span class="reserved">char</span> MediaColor[64];<br> |
| | 12238 |     <span class="reserved">unsigned</span> MediaPosition;<br> |
| | 12239 |     <span class="reserved">char</span> MediaType[64];<br> |
| | 12240 |     <span class="reserved">unsigned</span> MediaWeight;<br> |
| | 12241 |     <a href="#cups_bool_t">cups_bool_t</a> MirrorPrint;<br> |
| | 12242 |     <a href="#cups_bool_t">cups_bool_t</a> NegativePrint;<br> |
| | 12243 |     <span class="reserved">unsigned</span> NumCopies;<br> |
| | 12244 |     <a href="#cups_orient_t">cups_orient_t</a> Orientation;<br> |
| | 12245 |     <a href="#cups_bool_t">cups_bool_t</a> OutputFaceUp;<br> |
| | 12246 |     <span class="reserved">char</span> OutputType[64];<br> |
| | 12247 |     <span class="reserved">unsigned</span> PageSize[2];<br> |
| | 12248 |     <a href="#cups_bool_t">cups_bool_t</a> Separations;<br> |
| | 12249 |     <a href="#cups_bool_t">cups_bool_t</a> TraySwitch;<br> |
| | 12250 |     <a href="#cups_bool_t">cups_bool_t</a> Tumble;<br> |
| | 12251 |     <span class="reserved">unsigned</span> cupsBitsPerColor;<br> |
| | 12252 |     <span class="reserved">unsigned</span> cupsBitsPerPixel;<br> |
| | 12253 |     <span class="reserved">unsigned</span> cupsBytesPerLine;<br> |
| | 12254 |     <a href="#cups_order_t">cups_order_t</a> cupsColorOrder;<br> |
| | 12255 |     <a href="#cups_cspace_t">cups_cspace_t</a> cupsColorSpace;<br> |
| | 12256 |     <span class="reserved">unsigned</span> cupsCompression;<br> |
| | 12257 |     <span class="reserved">unsigned</span> cupsHeight;<br> |
| | 12258 |     <span class="reserved">unsigned</span> cupsMediaType;<br> |
| | 12259 |     <span class="reserved">unsigned</span> cupsRowCount;<br> |
| | 12260 |     <span class="reserved">unsigned</span> cupsRowFeed;<br> |
| | 12261 |     <span class="reserved">unsigned</span> cupsRowStep;<br> |
| | 12262 |     <span class="reserved">unsigned</span> cupsWidth;<br> |
| | 12263 | };</p> |
| | 12264 | <h4 class="members">Members</h4> |
| | 12265 | <table class="list"><tbody> |
| | 12266 | <tr><th>AdvanceDistance </th> |
| | 12267 | <td class="description">AdvanceDistance value in points</td></tr> |
| | 12268 | <tr><th>AdvanceMedia </th> |
| | 12269 | <td class="description">AdvanceMedia value (<a href="#cups_adv_t"><code>cups_adv_t</code></a>)</td></tr> |
| | 12270 | <tr><th>Collate </th> |
| | 12271 | <td class="description">Collated copies value</td></tr> |
| | 12272 | <tr><th>CutMedia </th> |
| | 12273 | <td class="description">CutMedia value (<a href="#cups_cut_t"><code>cups_cut_t</code></a>)</td></tr> |
| | 12274 | <tr><th>Duplex </th> |
| | 12275 | <td class="description">Duplexed (double-sided) value</td></tr> |
| | 12276 | <tr><th>HWResolution[2] </th> |
| | 12277 | <td class="description">Resolution in dots-per-inch</td></tr> |
| | 12278 | <tr><th>ImagingBoundingBox[4] </th> |
| | 12279 | <td class="description">Pixel region that is painted (points, left, bottom, right, top)</td></tr> |
| | 12280 | <tr><th>InsertSheet </th> |
| | 12281 | <td class="description">InsertSheet value</td></tr> |
| | 12282 | <tr><th>Jog </th> |
| | 12283 | <td class="description">Jog value (<a href="#cups_jog_t"><code>cups_jog_t</code></a>)</td></tr> |
| | 12284 | <tr><th>LeadingEdge </th> |
| | 12285 | <td class="description">LeadingEdge value (<a href="#cups_edge_t"><code>cups_edge_t</code></a>)</td></tr> |
| | 12286 | <tr><th>ManualFeed </th> |
| | 12287 | <td class="description">ManualFeed value</td></tr> |
| | 12288 | <tr><th>Margins[2] </th> |
| | 12289 | <td class="description">Lower-lefthand margins in points</td></tr> |
| | 12290 | <tr><th>MediaClass[64] </th> |
| | 12291 | <td class="description">MediaClass string</td></tr> |
| | 12292 | <tr><th>MediaColor[64] </th> |
| | 12293 | <td class="description">MediaColor string</td></tr> |
| | 12294 | <tr><th>MediaPosition </th> |
| | 12295 | <td class="description">MediaPosition value</td></tr> |
| | 12296 | <tr><th>MediaType[64] </th> |
| | 12297 | <td class="description">MediaType string</td></tr> |
| | 12298 | <tr><th>MediaWeight </th> |
| | 12299 | <td class="description">MediaWeight value in grams/m^2</td></tr> |
| | 12300 | <tr><th>MirrorPrint </th> |
| | 12301 | <td class="description">MirrorPrint value</td></tr> |
| | 12302 | <tr><th>NegativePrint </th> |
| | 12303 | <td class="description">NegativePrint value</td></tr> |
| | 12304 | <tr><th>NumCopies </th> |
| | 12305 | <td class="description">Number of copies to produce</td></tr> |
| | 12306 | <tr><th>Orientation </th> |
| | 12307 | <td class="description">Orientation value (<a href="#cups_orient_t"><code>cups_orient_t</code></a>)</td></tr> |
| | 12308 | <tr><th>OutputFaceUp </th> |
| | 12309 | <td class="description">OutputFaceUp value</td></tr> |
| | 12310 | <tr><th>OutputType[64] </th> |
| | 12311 | <td class="description">OutputType string</td></tr> |
| | 12312 | <tr><th>PageSize[2] </th> |
| | 12313 | <td class="description">Width and length of page in points</td></tr> |
| | 12314 | <tr><th>Separations </th> |
| | 12315 | <td class="description">Separations value</td></tr> |
| | 12316 | <tr><th>TraySwitch </th> |
| | 12317 | <td class="description">TraySwitch value</td></tr> |
| | 12318 | <tr><th>Tumble </th> |
| | 12319 | <td class="description">Tumble value</td></tr> |
| | 12320 | <tr><th>cupsBitsPerColor </th> |
| | 12321 | <td class="description">Number of bits for each color</td></tr> |
| | 12322 | <tr><th>cupsBitsPerPixel </th> |
| | 12323 | <td class="description">Number of bits for each pixel</td></tr> |
| | 12324 | <tr><th>cupsBytesPerLine </th> |
| | 12325 | <td class="description">Number of bytes per line</td></tr> |
| | 12326 | <tr><th>cupsColorOrder </th> |
| | 12327 | <td class="description">Order of colors</td></tr> |
| | 12328 | <tr><th>cupsColorSpace </th> |
| | 12329 | <td class="description">True colorspace</td></tr> |
| | 12330 | <tr><th>cupsCompression </th> |
| | 12331 | <td class="description">Device compression to use</td></tr> |
| | 12332 | <tr><th>cupsHeight </th> |
| | 12333 | <td class="description">Height of page image in pixels</td></tr> |
| | 12334 | <tr><th>cupsMediaType </th> |
| | 12335 | <td class="description">Media type code</td></tr> |
| | 12336 | <tr><th>cupsRowCount </th> |
| | 12337 | <td class="description">Rows per band</td></tr> |
| | 12338 | <tr><th>cupsRowFeed </th> |
| | 12339 | <td class="description">Feed between bands</td></tr> |
| | 12340 | <tr><th>cupsRowStep </th> |
| | 12341 | <td class="description">Spacing between lines</td></tr> |
| | 12342 | <tr><th>cupsWidth </th> |
| | 12343 | <td class="description">Width of page image in pixels</td></tr> |
| | 12344 | </tbody></table> |
| | 12345 | <h3 class="struct"><span class="info"> DEPRECATED </span><a id="cups_size_s">cups_size_s</a></h3> |
| | 12346 | <p class="description">Media Size </p> |
| | 12347 | <p class="code"><span class="reserved">struct</span> cups_size_s {<br> |
| | 12348 |     <span class="reserved">char</span> media[128];<br> |
| | 12349 |     <span class="reserved">int</span> width, length, bottom, left, right, top;<br> |
| | 12350 | };</p> |
| | 12351 | <h4 class="members">Members</h4> |
| | 12352 | <table class="list"><tbody> |
| | 12353 | <tr><th>media[128] </th> |
| | 12354 | <td class="description">Media name to use</td></tr> |
| | 12355 | <tr><th>top </th> |
| | 12356 | <td class="description">Top margin in hundredths of millimeters</td></tr> |
| | 12357 | </tbody></table> |
| | 12358 | <h3 class="struct"><a id="pwg_media_s">pwg_media_s</a></h3> |
| | 12359 | <p class="description">Common media size data</p> |
| | 12360 | <p class="code"><span class="reserved">struct</span> pwg_media_s {<br> |
| | 12361 |     <span class="reserved">int</span> width, length;<br> |
| | 12362 |     <span class="reserved">const</span> <span class="reserved">char</span> *pwg, *legacy, *ppd;<br> |
| | 12363 | };</p> |
| | 12364 | <h4 class="members">Members</h4> |
| | 12365 | <table class="list"><tbody> |
| | 12366 | <tr><th>length </th> |
| | 12367 | <td class="description">Length in 2540ths</td></tr> |
| | 12368 | <tr><th>ppd </th> |
| | 12369 | <td class="description">Standard Adobe PPD name</td></tr> |
| | 12370 | </tbody></table> |
| | 12371 | <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> |
| | 12372 | <h3 class="enumeration"><a id="cups_adv_e">cups_adv_e</a></h3> |
| | 12373 | <p class="description">AdvanceMedia attribute values</p> |
| | 12374 | <h4 class="constants">Constants</h4> |
| | 12375 | <table class="list"><tbody> |
| | 12376 | <tr><th>CUPS_ADVANCE_FILE </th><td class="description">Advance the roll after this file</td></tr> |
| | 12377 | <tr><th>CUPS_ADVANCE_JOB </th><td class="description">Advance the roll after this job</td></tr> |
| | 12378 | <tr><th>CUPS_ADVANCE_NONE </th><td class="description">Never advance the roll</td></tr> |
| | 12379 | <tr><th>CUPS_ADVANCE_PAGE </th><td class="description">Advance the roll after this page</td></tr> |
| | 12380 | <tr><th>CUPS_ADVANCE_SET </th><td class="description">Advance the roll after this set</td></tr> |
| | 12381 | </tbody></table> |
| | 12382 | <h3 class="enumeration"><a id="cups_bool_e">cups_bool_e</a></h3> |
| | 12383 | <p class="description">Boolean type</p> |
| | 12384 | <h4 class="constants">Constants</h4> |
| | 12385 | <table class="list"><tbody> |
| | 12386 | <tr><th>CUPS_FALSE </th><td class="description">Logical false</td></tr> |
| | 12387 | <tr><th>CUPS_TRUE </th><td class="description">Logical true</td></tr> |
| | 12388 | </tbody></table> |
| | 12389 | <h3 class="enumeration"><a id="cups_credpurpose_e">cups_credpurpose_e</a></h3> |
| | 12390 | <p class="description">X.509 credential purposes</p> |
| | 12391 | <h4 class="constants">Constants</h4> |
| | 12392 | <table class="list"><tbody> |
| | 12393 | <tr><th>CUPS_CREDPURPOSE_ALL </th><td class="description">All purposes</td></tr> |
| | 12394 | <tr><th>CUPS_CREDPURPOSE_CLIENT_AUTH </th><td class="description">clientAuth</td></tr> |
| | 12395 | <tr><th>CUPS_CREDPURPOSE_CODE_SIGNING </th><td class="description">codeSigning</td></tr> |
| | 12396 | <tr><th>CUPS_CREDPURPOSE_EMAIL_PROTECTION </th><td class="description">emailProtection</td></tr> |
| | 12397 | <tr><th>CUPS_CREDPURPOSE_OCSP_SIGNING </th><td class="description">OCSPSigning</td></tr> |
| | 12398 | <tr><th>CUPS_CREDPURPOSE_SERVER_AUTH </th><td class="description">serverAuth</td></tr> |
| | 12399 | <tr><th>CUPS_CREDPURPOSE_TIME_STAMPING </th><td class="description">timeStamping</td></tr> |
| | 12400 | </tbody></table> |
| | 12401 | <h3 class="enumeration"><a id="cups_credtype_e">cups_credtype_e</a></h3> |
| | 12402 | <p class="description">X.509 credential types for <a href="#cupsCreateCredentials"><code>cupsCreateCredentials</code></a> and <a href="#cupsCreateCredentialsRequest"><code>cupsCreateCredentialsRequest</code></a></p> |
| | 12403 | <h4 class="constants">Constants</h4> |
| | 12404 | <table class="list"><tbody> |
| | 12405 | <tr><th>CUPS_CREDTYPE_DEFAULT </th><td class="description">Default type</td></tr> |
| | 12406 | <tr><th>CUPS_CREDTYPE_ECDSA_P256_SHA256 </th><td class="description">ECDSA using the P-256 curve with SHA-256 hash</td></tr> |
| | 12407 | <tr><th>CUPS_CREDTYPE_ECDSA_P384_SHA256 </th><td class="description">ECDSA using the P-384 curve with SHA-256 hash</td></tr> |
| | 12408 | <tr><th>CUPS_CREDTYPE_ECDSA_P521_SHA256 </th><td class="description">ECDSA using the P-521 curve with SHA-256 hash</td></tr> |
| | 12409 | <tr><th>CUPS_CREDTYPE_RSA_2048_SHA256 </th><td class="description">RSA with 2048-bit keys and SHA-256 hash</td></tr> |
| | 12410 | <tr><th>CUPS_CREDTYPE_RSA_3072_SHA256 </th><td class="description">RSA with 3072-bit keys and SHA-256 hash</td></tr> |
| | 12411 | <tr><th>CUPS_CREDTYPE_RSA_4096_SHA256 </th><td class="description">RSA with 4096-bit keys and SHA-256 hash</td></tr> |
| | 12412 | </tbody></table> |
| | 12413 | <h3 class="enumeration"><a id="cups_credusage_e">cups_credusage_e</a></h3> |
| | 12414 | <p class="description">X.509 keyUsage flags</p> |
| | 12415 | <h4 class="constants">Constants</h4> |
| | 12416 | <table class="list"><tbody> |
| | 12417 | <tr><th>CUPS_CREDUSAGE_ALL </th><td class="description">All keyUsage flags</td></tr> |
| | 12418 | <tr><th>CUPS_CREDUSAGE_CRL_SIGN </th><td class="description">cRLSign</td></tr> |
| | 12419 | <tr><th>CUPS_CREDUSAGE_DATA_ENCIPHERMENT </th><td class="description">dataEncipherment</td></tr> |
| | 12420 | <tr><th>CUPS_CREDUSAGE_DECIPHER_ONLY </th><td class="description">decipherOnly</td></tr> |
| | 12421 | <tr><th>CUPS_CREDUSAGE_DEFAULT_CA </th><td class="description">Defaults for CA certs</td></tr> |
| | 12422 | <tr><th>CUPS_CREDUSAGE_DEFAULT_TLS </th><td class="description">Defaults for TLS certs</td></tr> |
| | 12423 | <tr><th>CUPS_CREDUSAGE_DIGITAL_SIGNATURE </th><td class="description">digitalSignature</td></tr> |
| | 12424 | <tr><th>CUPS_CREDUSAGE_ENCIPHER_ONLY </th><td class="description">encipherOnly</td></tr> |
| | 12425 | <tr><th>CUPS_CREDUSAGE_KEY_AGREEMENT </th><td class="description">keyAgreement</td></tr> |
| | 12426 | <tr><th>CUPS_CREDUSAGE_KEY_CERT_SIGN </th><td class="description">keyCertSign</td></tr> |
| | 12427 | <tr><th>CUPS_CREDUSAGE_KEY_ENCIPHERMENT </th><td class="description">keyEncipherment</td></tr> |
| | 12428 | <tr><th>CUPS_CREDUSAGE_NON_REPUDIATION </th><td class="description">nonRepudiation/contentCommitment</td></tr> |
| | 12429 | </tbody></table> |
| | 12430 | <h3 class="enumeration"><a id="cups_cspace_e">cups_cspace_e</a></h3> |
| | 12431 | <p class="description">cupsColorSpace attribute values</p> |
| | 12432 | <h4 class="constants">Constants</h4> |
| | 12433 | <table class="list"><tbody> |
| | 12434 | <tr><th>CUPS_CSPACE_ADOBERGB <span class="info"> CUPS 1.4.5 </span></th><td class="description">Red, green, blue (Adobe RGB) </td></tr> |
| | 12435 | <tr><th>CUPS_CSPACE_CIELab <span class="info"> CUPS 1.1.19 </span></th><td class="description">CIE Lab </td></tr> |
| | 12436 | <tr><th>CUPS_CSPACE_CIEXYZ <span class="info"> CUPS 1.1.19 </span></th><td class="description">CIE XYZ </td></tr> |
| | 12437 | <tr><th>CUPS_CSPACE_CMY </th><td class="description">Cyan, magenta, yellow (DeviceCMY)</td></tr> |
| | 12438 | <tr><th>CUPS_CSPACE_CMYK </th><td class="description">Cyan, magenta, yellow, black (DeviceCMYK)</td></tr> |
| | 12439 | <tr><th>CUPS_CSPACE_DEVICE1 <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 1 color </td></tr> |
| | 12440 | <tr><th>CUPS_CSPACE_DEVICE2 <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 2 colors </td></tr> |
| | 12441 | <tr><th>CUPS_CSPACE_DEVICE3 <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 3 colors </td></tr> |
| | 12442 | <tr><th>CUPS_CSPACE_DEVICE4 <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 4 colors </td></tr> |
| | 12443 | <tr><th>CUPS_CSPACE_DEVICE5 <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 5 colors </td></tr> |
| | 12444 | <tr><th>CUPS_CSPACE_DEVICE6 <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 6 colors </td></tr> |
| | 12445 | <tr><th>CUPS_CSPACE_DEVICE7 <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 7 colors </td></tr> |
| | 12446 | <tr><th>CUPS_CSPACE_DEVICE8 <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 8 colors </td></tr> |
| | 12447 | <tr><th>CUPS_CSPACE_DEVICE9 <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 9 colors </td></tr> |
| | 12448 | <tr><th>CUPS_CSPACE_DEVICEA <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 10 colors </td></tr> |
| | 12449 | <tr><th>CUPS_CSPACE_DEVICEB <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 11 colors </td></tr> |
| | 12450 | <tr><th>CUPS_CSPACE_DEVICEC <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 12 colors </td></tr> |
| | 12451 | <tr><th>CUPS_CSPACE_DEVICED <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 13 colors </td></tr> |
| | 12452 | <tr><th>CUPS_CSPACE_DEVICEE <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 14 colors </td></tr> |
| | 12453 | <tr><th>CUPS_CSPACE_DEVICEF <span class="info"> CUPS 1.4.5 </span></th><td class="description">DeviceN, 15 colors </td></tr> |
| | 12454 | <tr><th>CUPS_CSPACE_GMCK <span class="info"> DEPRECATED </span></th><td class="description">Gold, magenta, yellow, black </td></tr> |
| | 12455 | <tr><th>CUPS_CSPACE_GMCS <span class="info"> DEPRECATED </span></th><td class="description">Gold, magenta, yellow, silver </td></tr> |
| | 12456 | <tr><th>CUPS_CSPACE_GOLD <span class="info"> DEPRECATED </span></th><td class="description">Gold foil </td></tr> |
| | 12457 | <tr><th>CUPS_CSPACE_ICC1 <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 1 color </td></tr> |
| | 12458 | <tr><th>CUPS_CSPACE_ICC2 <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 2 colors </td></tr> |
| | 12459 | <tr><th>CUPS_CSPACE_ICC3 <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 3 colors </td></tr> |
| | 12460 | <tr><th>CUPS_CSPACE_ICC4 <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 4 colors </td></tr> |
| | 12461 | <tr><th>CUPS_CSPACE_ICC5 <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 5 colors </td></tr> |
| | 12462 | <tr><th>CUPS_CSPACE_ICC6 <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 6 colors </td></tr> |
| | 12463 | <tr><th>CUPS_CSPACE_ICC7 <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 7 colors </td></tr> |
| | 12464 | <tr><th>CUPS_CSPACE_ICC8 <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 8 colors </td></tr> |
| | 12465 | <tr><th>CUPS_CSPACE_ICC9 <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 9 colors </td></tr> |
| | 12466 | <tr><th>CUPS_CSPACE_ICCA <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 10 colors </td></tr> |
| | 12467 | <tr><th>CUPS_CSPACE_ICCB <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 11 colors </td></tr> |
| | 12468 | <tr><th>CUPS_CSPACE_ICCC <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 12 colors </td></tr> |
| | 12469 | <tr><th>CUPS_CSPACE_ICCD <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 13 colors </td></tr> |
| | 12470 | <tr><th>CUPS_CSPACE_ICCE <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 14 colors </td></tr> |
| | 12471 | <tr><th>CUPS_CSPACE_ICCF <span class="info"> CUPS 1.1.19 </span></th><td class="description">ICC-based, 15 colors </td></tr> |
| | 12472 | <tr><th>CUPS_CSPACE_K </th><td class="description">Black (DeviceK)</td></tr> |
| | 12473 | <tr><th>CUPS_CSPACE_KCMY <span class="info"> DEPRECATED </span></th><td class="description">Black, cyan, magenta, yellow </td></tr> |
| | 12474 | <tr><th>CUPS_CSPACE_KCMYcm <span class="info"> DEPRECATED </span></th><td class="description">Black, cyan, magenta, yellow, light-cyan, light-magenta </td></tr> |
| | 12475 | <tr><th>CUPS_CSPACE_RGB </th><td class="description">Red, green, blue (DeviceRGB, sRGB by default)</td></tr> |
| | 12476 | <tr><th>CUPS_CSPACE_RGBA </th><td class="description">Red, green, blue, alpha (DeviceRGB, sRGB by default)</td></tr> |
| | 12477 | <tr><th>CUPS_CSPACE_RGBW <span class="info"> CUPS 1.2 </span></th><td class="description">Red, green, blue, white (DeviceRGB, sRGB by default) </td></tr> |
| | 12478 | <tr><th>CUPS_CSPACE_SILVER <span class="info"> DEPRECATED </span></th><td class="description">Silver foil </td></tr> |
| | 12479 | <tr><th>CUPS_CSPACE_SRGB <span class="info"> CUPS 1.4.5 </span></th><td class="description">Red, green, blue (sRGB) </td></tr> |
| | 12480 | <tr><th>CUPS_CSPACE_SW <span class="info"> CUPS 1.4.5 </span></th><td class="description">Luminance (gamma 2.2) </td></tr> |
| | 12481 | <tr><th>CUPS_CSPACE_W </th><td class="description">Luminance (DeviceGray, gamma 2.2 by default)</td></tr> |
| | 12482 | <tr><th>CUPS_CSPACE_WHITE <span class="info"> DEPRECATED </span></th><td class="description">White ink (as black) </td></tr> |
| | 12483 | <tr><th>CUPS_CSPACE_YMC <span class="info"> DEPRECATED </span></th><td class="description">Yellow, magenta, cyan </td></tr> |
| | 12484 | <tr><th>CUPS_CSPACE_YMCK <span class="info"> DEPRECATED </span></th><td class="description">Yellow, magenta, cyan, black </td></tr> |
| | 12485 | </tbody></table> |
| | 12486 | <h3 class="enumeration"><a id="cups_cut_e">cups_cut_e</a></h3> |
| | 12487 | <p class="description">CutMedia attribute values</p> |
| | 12488 | <h4 class="constants">Constants</h4> |
| | 12489 | <table class="list"><tbody> |
| | 12490 | <tr><th>CUPS_CUT_FILE </th><td class="description">Cut the roll after this file</td></tr> |
| | 12491 | <tr><th>CUPS_CUT_JOB </th><td class="description">Cut the roll after this job</td></tr> |
| | 12492 | <tr><th>CUPS_CUT_NONE </th><td class="description">Never cut the roll</td></tr> |
| | 12493 | <tr><th>CUPS_CUT_PAGE </th><td class="description">Cut the roll after this page</td></tr> |
| | 12494 | <tr><th>CUPS_CUT_SET </th><td class="description">Cut the roll after this set</td></tr> |
| | 12495 | </tbody></table> |
| | 12496 | <h3 class="enumeration"><a id="cups_dest_flags_e">cups_dest_flags_e</a></h3> |
| | 12497 | <p class="description">Flags for <a href="#cupsConnectDest"><code>cupsConnectDest</code></a> and <a href="#cupsEnumDests"><code>cupsEnumDests</code></a></p> |
| | 12498 | <h4 class="constants">Constants</h4> |
| | 12499 | <table class="list"><tbody> |
| | 12500 | <tr><th>CUPS_DEST_FLAGS_CANCELED </th><td class="description">Operation was canceled</td></tr> |
| | 12501 | <tr><th>CUPS_DEST_FLAGS_CONNECTING </th><td class="description">A connection is being established</td></tr> |
| | 12502 | <tr><th>CUPS_DEST_FLAGS_DEVICE </th><td class="description">For <a href="#cupsConnectDest"><code>cupsConnectDest</code></a>: Connect to device</td></tr> |
| | 12503 | <tr><th>CUPS_DEST_FLAGS_ERROR </th><td class="description">An error occurred</td></tr> |
| | 12504 | <tr><th>CUPS_DEST_FLAGS_MORE </th><td class="description">There are more destinations</td></tr> |
| | 12505 | <tr><th>CUPS_DEST_FLAGS_NONE </th><td class="description">No flags are set</td></tr> |
| | 12506 | <tr><th>CUPS_DEST_FLAGS_REMOVED </th><td class="description">The destination has gone away</td></tr> |
| | 12507 | <tr><th>CUPS_DEST_FLAGS_RESOLVING </th><td class="description">The destination address is being resolved</td></tr> |
| | 12508 | <tr><th>CUPS_DEST_FLAGS_UNCONNECTED </th><td class="description">There is no connection</td></tr> |
| | 12509 | </tbody></table> |
| | 12510 | <h3 class="enumeration"><a id="cups_dnssd_flags_e">cups_dnssd_flags_e</a></h3> |
| | 12511 | <p class="description">DNS-SD callback flag values</p> |
| | 12512 | <h4 class="constants">Constants</h4> |
| | 12513 | <table class="list"><tbody> |
| | 12514 | <tr><th>CUPS_DNSSD_FLAGS_ADD </th><td class="description">Added (removed if not set)</td></tr> |
| | 12515 | <tr><th>CUPS_DNSSD_FLAGS_COLLISION </th><td class="description">Collision occurred</td></tr> |
| | 12516 | <tr><th>CUPS_DNSSD_FLAGS_ERROR </th><td class="description">Error occurred</td></tr> |
| | 12517 | <tr><th>CUPS_DNSSD_FLAGS_HOST_CHANGE </th><td class="description">Host name changed</td></tr> |
| | 12518 | <tr><th>CUPS_DNSSD_FLAGS_MORE </th><td class="description">More coming</td></tr> |
| | 12519 | <tr><th>CUPS_DNSSD_FLAGS_NETWORK_CHANGE </th><td class="description">Network connection changed</td></tr> |
| | 12520 | <tr><th>CUPS_DNSSD_FLAGS_NONE </th><td class="description">No flags</td></tr> |
| | 12521 | </tbody></table> |
| | 12522 | <h3 class="enumeration"><a id="cups_dnssd_rrtype_e">cups_dnssd_rrtype_e</a></h3> |
| | 12523 | <p class="description">DNS record type values</p> |
| | 12524 | <h4 class="constants">Constants</h4> |
| | 12525 | <table class="list"><tbody> |
| | 12526 | <tr><th>CUPS_DNSSD_RRTYPE_A </th><td class="description">Host address</td></tr> |
| | 12527 | <tr><th>CUPS_DNSSD_RRTYPE_AAAA </th><td class="description">IPv6 Address.</td></tr> |
| | 12528 | <tr><th>CUPS_DNSSD_RRTYPE_ANY </th><td class="description">Wildcard match</td></tr> |
| | 12529 | <tr><th>CUPS_DNSSD_RRTYPE_CERT </th><td class="description">Certification record</td></tr> |
| | 12530 | <tr><th>CUPS_DNSSD_RRTYPE_CNAME </th><td class="description">Canonical name</td></tr> |
| | 12531 | <tr><th>CUPS_DNSSD_RRTYPE_DHCID </th><td class="description">DHCP Client Identifier</td></tr> |
| | 12532 | <tr><th>CUPS_DNSSD_RRTYPE_DNSKEY </th><td class="description">DNSKEY</td></tr> |
| | 12533 | <tr><th>CUPS_DNSSD_RRTYPE_HTTPS </th><td class="description">HTTPS Service Binding</td></tr> |
| | 12534 | <tr><th>CUPS_DNSSD_RRTYPE_KEY </th><td class="description">Security key</td></tr> |
| | 12535 | <tr><th>CUPS_DNSSD_RRTYPE_KX </th><td class="description">Key Exchange</td></tr> |
| | 12536 | <tr><th>CUPS_DNSSD_RRTYPE_LOC </th><td class="description">Location Information.</td></tr> |
| | 12537 | <tr><th>CUPS_DNSSD_RRTYPE_NS </th><td class="description">Name server</td></tr> |
| | 12538 | <tr><th>CUPS_DNSSD_RRTYPE_PTR </th><td class="description">Domain name pointer</td></tr> |
| | 12539 | <tr><th>CUPS_DNSSD_RRTYPE_RRSIG </th><td class="description">RRSIG</td></tr> |
| | 12540 | <tr><th>CUPS_DNSSD_RRTYPE_RT </th><td class="description">Router</td></tr> |
| | 12541 | <tr><th>CUPS_DNSSD_RRTYPE_SIG </th><td class="description">Security signature</td></tr> |
| | 12542 | <tr><th>CUPS_DNSSD_RRTYPE_SPF </th><td class="description">Sender Policy Framework for E-Mail</td></tr> |
| | 12543 | <tr><th>CUPS_DNSSD_RRTYPE_TXT </th><td class="description">One or more text strings</td></tr> |
| | 12544 | <tr><th>CUPS_DNSSD_RRTYPE_WKS </th><td class="description">Well known service</td></tr> |
| | 12545 | </tbody></table> |
| | 12546 | <h3 class="enumeration"><a id="cups_edge_e">cups_edge_e</a></h3> |
| | 12547 | <p class="description">LeadingEdge attribute values</p> |
| | 12548 | <h4 class="constants">Constants</h4> |
| | 12549 | <table class="list"><tbody> |
| | 12550 | <tr><th>CUPS_EDGE_BOTTOM </th><td class="description">Leading edge is the bottom of the page</td></tr> |
| | 12551 | <tr><th>CUPS_EDGE_LEFT </th><td class="description">Leading edge is the left of the page</td></tr> |
| | 12552 | <tr><th>CUPS_EDGE_RIGHT </th><td class="description">Leading edge is the right of the page</td></tr> |
| | 12553 | <tr><th>CUPS_EDGE_TOP </th><td class="description">Leading edge is the top of the page</td></tr> |
| | 12554 | </tbody></table> |
| | 12555 | <h3 class="enumeration"><a id="cups_jog_e">cups_jog_e</a></h3> |
| | 12556 | <p class="description">Jog attribute values</p> |
| | 12557 | <h4 class="constants">Constants</h4> |
| | 12558 | <table class="list"><tbody> |
| | 12559 | <tr><th>CUPS_JOG_FILE </th><td class="description">Move pages after this file</td></tr> |
| | 12560 | <tr><th>CUPS_JOG_JOB </th><td class="description">Move pages after this job</td></tr> |
| | 12561 | <tr><th>CUPS_JOG_NONE </th><td class="description">Never move pages</td></tr> |
| | 12562 | <tr><th>CUPS_JOG_SET </th><td class="description">Move pages after this set</td></tr> |
| | 12563 | </tbody></table> |
| | 12564 | <h3 class="enumeration"><a id="cups_jtype_e"><span class="info"> CUPS 2.5 </span>cups_jtype_e</a></h3> |
| | 12565 | <p class="description">JSON node type </p> |
| | 12566 | <h4 class="constants">Constants</h4> |
| | 12567 | <table class="list"><tbody> |
| | 12568 | <tr><th>CUPS_JTYPE_ARRAY </th><td class="description">Array value</td></tr> |
| | 12569 | <tr><th>CUPS_JTYPE_FALSE </th><td class="description">Boolean false value</td></tr> |
| | 12570 | <tr><th>CUPS_JTYPE_KEY </th><td class="description">Object key (string)</td></tr> |
| | 12571 | <tr><th>CUPS_JTYPE_NULL </th><td class="description">Null value</td></tr> |
| | 12572 | <tr><th>CUPS_JTYPE_NUMBER </th><td class="description">Number value</td></tr> |
| | 12573 | <tr><th>CUPS_JTYPE_OBJECT </th><td class="description">Object value</td></tr> |
| | 12574 | <tr><th>CUPS_JTYPE_STRING </th><td class="description">String value</td></tr> |
| | 12575 | <tr><th>CUPS_JTYPE_TRUE </th><td class="description">Boolean true value</td></tr> |
| | 12576 | </tbody></table> |
| | 12577 | <h3 class="enumeration"><a id="cups_jwa_e"><span class="info"> CUPS 2.5 </span>cups_jwa_e</a></h3> |
| | 12578 | <p class="description">JSON Web Algorithms </p> |
| | 12579 | <h4 class="constants">Constants</h4> |
| | 12580 | <table class="list"><tbody> |
| | 12581 | <tr><th>CUPS_JWA_ES256 </th><td class="description">ECDSA using P-256 and SHA-256</td></tr> |
| | 12582 | <tr><th>CUPS_JWA_ES384 </th><td class="description">ECDSA using P-384 and SHA-384</td></tr> |
| | 12583 | <tr><th>CUPS_JWA_ES512 </th><td class="description">ECDSA using P-521 and SHA-512</td></tr> |
| | 12584 | <tr><th>CUPS_JWA_HS256 </th><td class="description">HMAC using SHA-256</td></tr> |
| | 12585 | <tr><th>CUPS_JWA_HS384 </th><td class="description">HMAC using SHA-384</td></tr> |
| | 12586 | <tr><th>CUPS_JWA_HS512 </th><td class="description">HMAC using SHA-512</td></tr> |
| | 12587 | <tr><th>CUPS_JWA_NONE </th><td class="description">No algorithm</td></tr> |
| | 12588 | <tr><th>CUPS_JWA_RS256 </th><td class="description">RSASSA-PKCS1-v1_5 using SHA-256</td></tr> |
| | 12589 | <tr><th>CUPS_JWA_RS384 </th><td class="description">RSASSA-PKCS1-v1_5 using SHA-384</td></tr> |
| | 12590 | <tr><th>CUPS_JWA_RS512 </th><td class="description">RSASSA-PKCS1-v1_5 using SHA-512</td></tr> |
| | 12591 | </tbody></table> |
| | 12592 | <h3 class="enumeration"><a id="cups_jws_format_e"><span class="info"> CUPS 2.5 </span>cups_jws_format_e</a></h3> |
| | 12593 | <p class="description">JSON Web Signature Formats </p> |
| | 12594 | <h4 class="constants">Constants</h4> |
| | 12595 | <table class="list"><tbody> |
| | 12596 | <tr><th>CUPS_JWS_FORMAT_COMPACT </th><td class="description">JWS Compact Serialization</td></tr> |
| | 12597 | <tr><th>CUPS_JWS_FORMAT_JSON </th><td class="description">JWS JSON Serialization</td></tr> |
| | 12598 | </tbody></table> |
| | 12599 | <h3 class="enumeration"><a id="cups_media_flags_e">cups_media_flags_e</a></h3> |
| | 12600 | <p class="description">Flags for <a href="#cupsGetDestMediaByName"><code>cupsGetDestMediaByName</code></a> and <a href="#cupsGetDestMediaBySize"><code>cupsGetDestMediaBySize</code></a></p> |
| | 12601 | <h4 class="constants">Constants</h4> |
| | 12602 | <table class="list"><tbody> |
| | 12603 | <tr><th>CUPS_MEDIA_FLAGS_BORDERLESS </th><td class="description">Find a borderless size</td></tr> |
| | 12604 | <tr><th>CUPS_MEDIA_FLAGS_DEFAULT </th><td class="description">Find the closest size supported by the printer</td></tr> |
| | 12605 | <tr><th>CUPS_MEDIA_FLAGS_DUPLEX </th><td class="description">Find a size compatible with 2-sided printing</td></tr> |
| | 12606 | <tr><th>CUPS_MEDIA_FLAGS_EXACT </th><td class="description">Find an exact match for the size</td></tr> |
| | 12607 | <tr><th>CUPS_MEDIA_FLAGS_READY </th><td class="description">If the printer supports media sensing, find the size amongst the "ready" media.</td></tr> |
| | 12608 | </tbody></table> |
| | 12609 | <h3 class="enumeration"><a id="cups_ogrant_e">cups_ogrant_e</a></h3> |
| | 12610 | <p class="description">OAuth Grant Types</p> |
| | 12611 | <h4 class="constants">Constants</h4> |
| | 12612 | <table class="list"><tbody> |
| | 12613 | <tr><th>CUPS_OGRANT_AUTHORIZATION_CODE </th><td class="description">Authorization code</td></tr> |
| | 12614 | <tr><th>CUPS_OGRANT_DEVICE_CODE </th><td class="description">Device code</td></tr> |
| | 12615 | <tr><th>CUPS_OGRANT_REFRESH_TOKEN </th><td class="description">Refresh token</td></tr> |
| | 12616 | </tbody></table> |
| | 12617 | <h3 class="enumeration"><a id="cups_order_e">cups_order_e</a></h3> |
| | 12618 | <p class="description">cupsColorOrder attribute values</p> |
| | 12619 | <h4 class="constants">Constants</h4> |
| | 12620 | <table class="list"><tbody> |
| | 12621 | <tr><th>CUPS_ORDER_BANDED </th><td class="description">CCC MMM YYY KKK ...</td></tr> |
| | 12622 | <tr><th>CUPS_ORDER_CHUNKED </th><td class="description">CMYK CMYK CMYK ...</td></tr> |
| | 12623 | <tr><th>CUPS_ORDER_PLANAR </th><td class="description">CCC ... MMM ... YYY ... KKK ...</td></tr> |
| | 12624 | </tbody></table> |
| | 12625 | <h3 class="enumeration"><a id="cups_orient_e">cups_orient_e</a></h3> |
| | 12626 | <p class="description">Orientation attribute values</p> |
| | 12627 | <h4 class="constants">Constants</h4> |
| | 12628 | <table class="list"><tbody> |
| | 12629 | <tr><th>CUPS_ORIENT_0 </th><td class="description">Don't rotate the page</td></tr> |
| | 12630 | <tr><th>CUPS_ORIENT_180 </th><td class="description">Turn the page upside down</td></tr> |
| | 12631 | <tr><th>CUPS_ORIENT_270 </th><td class="description">Rotate the page clockwise</td></tr> |
| | 12632 | <tr><th>CUPS_ORIENT_90 </th><td class="description">Rotate the page counter-clockwise</td></tr> |
| | 12633 | </tbody></table> |
| | 12634 | <h3 class="enumeration"><a id="cups_ptype_e">cups_ptype_e</a></h3> |
| | 12635 | <p class="description">Printer type/capability flags</p> |
| | 12636 | <h4 class="constants">Constants</h4> |
| | 12637 | <table class="list"><tbody> |
| | 12638 | <tr><th>CUPS_PTYPE_AUTHENTICATED </th><td class="description">Printer requires authentication</td></tr> |
| | 12639 | <tr><th>CUPS_PTYPE_BIND </th><td class="description">Can bind output</td></tr> |
| | 12640 | <tr><th>CUPS_PTYPE_BW </th><td class="description">Can do B&W printing</td></tr> |
| | 12641 | <tr><th>CUPS_PTYPE_CLASS </th><td class="description">Printer class</td></tr> |
| | 12642 | <tr><th>CUPS_PTYPE_COLLATE </th><td class="description">Can quickly collate copies</td></tr> |
| | 12643 | <tr><th>CUPS_PTYPE_COLOR </th><td class="description">Can do color printing</td></tr> |
| | 12644 | <tr><th>CUPS_PTYPE_COMMANDS </th><td class="description">Printer supports maintenance commands</td></tr> |
| | 12645 | <tr><th>CUPS_PTYPE_COPIES </th><td class="description">Can do copies in hardware</td></tr> |
| | 12646 | <tr><th>CUPS_PTYPE_COVER </th><td class="description">Can cover output</td></tr> |
| | 12647 | <tr><th>CUPS_PTYPE_DEFAULT </th><td class="description">Default printer on network</td></tr> |
| | 12648 | <tr><th>CUPS_PTYPE_DISCOVERED </th><td class="description">Printer was discovered</td></tr> |
| | 12649 | <tr><th>CUPS_PTYPE_DUPLEX </th><td class="description">Can do two-sided printing</td></tr> |
| | 12650 | <tr><th>CUPS_PTYPE_FAX </th><td class="description">Fax queue</td></tr> |
| | 12651 | <tr><th>CUPS_PTYPE_FOLD <span class="info"> CUPS 2.5 </span></th><td class="description">Can fold output </td></tr> |
| | 12652 | <tr><th>CUPS_PTYPE_LARGE </th><td class="description">Can print on D/E/A1/A0-size media</td></tr> |
| | 12653 | <tr><th>CUPS_PTYPE_LOCAL </th><td class="description">Local printer or class</td></tr> |
| | 12654 | <tr><th>CUPS_PTYPE_MEDIUM </th><td class="description">Can print on Tabloid/B/C/A3/A2-size media</td></tr> |
| | 12655 | <tr><th>CUPS_PTYPE_MFP </th><td class="description">Printer with scanning capabilities</td></tr> |
| | 12656 | <tr><th>CUPS_PTYPE_NOT_SHARED </th><td class="description">Printer is not shared</td></tr> |
| | 12657 | <tr><th>CUPS_PTYPE_PUNCH </th><td class="description">Can punch output</td></tr> |
| | 12658 | <tr><th>CUPS_PTYPE_REJECTING </th><td class="description">Printer is rejecting jobs</td></tr> |
| | 12659 | <tr><th>CUPS_PTYPE_REMOTE </th><td class="description">Remote printer or class</td></tr> |
| | 12660 | <tr><th>CUPS_PTYPE_SCANNER </th><td class="description">Scanner-only device</td></tr> |
| | 12661 | <tr><th>CUPS_PTYPE_SMALL </th><td class="description">Can print on Letter/Legal/A4-size media</td></tr> |
| | 12662 | <tr><th>CUPS_PTYPE_SORT </th><td class="description">Can sort output</td></tr> |
| | 12663 | <tr><th>CUPS_PTYPE_STAPLE </th><td class="description">Can staple output</td></tr> |
| | 12664 | <tr><th>CUPS_PTYPE_VARIABLE </th><td class="description">Can print on rolls and custom-size media</td></tr> |
| | 12665 | </tbody></table> |
| | 12666 | <h3 class="enumeration"><a id="cups_raster_mode_e">cups_raster_mode_e</a></h3> |
| | 12667 | <p class="description">cupsRasterOpen modes</p> |
| | 12668 | <h4 class="constants">Constants</h4> |
| | 12669 | <table class="list"><tbody> |
| | 12670 | <tr><th>CUPS_RASTER_READ </th><td class="description">Open stream for reading</td></tr> |
| | 12671 | <tr><th>CUPS_RASTER_WRITE </th><td class="description">Open stream for writing</td></tr> |
| | 12672 | <tr><th>CUPS_RASTER_WRITE_COMPRESSED <span class="info"> CUPS 1.3 </span></th><td class="description">Open stream for compressed writing </td></tr> |
| | 12673 | <tr><th>CUPS_RASTER_WRITE_PWG <span class="info"> CUPS 1.5 </span></th><td class="description">Open stream for compressed writing in PWG Raster mode </td></tr> |
| | 12674 | </tbody></table> |
| | 12675 | <h3 class="enumeration"><a id="cups_whichjobs_e">cups_whichjobs_e</a></h3> |
| | 12676 | <p class="description">Which jobs for <a href="#cupsGetJobs"><code>cupsGetJobs</code></a></p> |
| | 12677 | <h4 class="constants">Constants</h4> |
| | 12678 | <table class="list"><tbody> |
| | 12679 | <tr><th>CUPS_WHICHJOBS_ACTIVE </th><td class="description">Pending/held/processing jobs</td></tr> |
| | 12680 | <tr><th>CUPS_WHICHJOBS_ALL </th><td class="description">All jobs</td></tr> |
| | 12681 | <tr><th>CUPS_WHICHJOBS_COMPLETED </th><td class="description">Completed/canceled/aborted jobs</td></tr> |
| | 12682 | </tbody></table> |
| | 12683 | <h3 class="enumeration"><a id="http_encoding_e">http_encoding_e</a></h3> |
| | 12684 | <p class="description">HTTP transfer encoding values</p> |
| | 12685 | <h4 class="constants">Constants</h4> |
| | 12686 | <table class="list"><tbody> |
| | 12687 | <tr><th>HTTP_ENCODING_CHUNKED </th><td class="description">Data is chunked</td></tr> |
| | 12688 | <tr><th>HTTP_ENCODING_FIELDS </th><td class="description">Sending HTTP fields</td></tr> |
| | 12689 | <tr><th>HTTP_ENCODING_LENGTH </th><td class="description">Data is sent with Content-Length</td></tr> |
| | 12690 | </tbody></table> |
| | 12691 | <h3 class="enumeration"><a id="http_encryption_e">http_encryption_e</a></h3> |
| | 12692 | <p class="description">HTTP encryption values</p> |
| | 12693 | <h4 class="constants">Constants</h4> |
| | 12694 | <table class="list"><tbody> |
| | 12695 | <tr><th>HTTP_ENCRYPTION_ALWAYS </th><td class="description">Always encrypt (HTTPS)</td></tr> |
| | 12696 | <tr><th>HTTP_ENCRYPTION_IF_REQUESTED </th><td class="description">Encrypt if requested (TLS upgrade)</td></tr> |
| | 12697 | <tr><th>HTTP_ENCRYPTION_NEVER </th><td class="description">Never encrypt</td></tr> |
| | 12698 | <tr><th>HTTP_ENCRYPTION_REQUIRED </th><td class="description">Encryption is required (TLS upgrade)</td></tr> |
| | 12699 | </tbody></table> |
| | 12700 | <h3 class="enumeration"><a id="http_field_e">http_field_e</a></h3> |
| | 12701 | <p class="description">HTTP field names</p> |
| | 12702 | <h4 class="constants">Constants</h4> |
| | 12703 | <table class="list"><tbody> |
| | 12704 | <tr><th>HTTP_FIELD_ACCEPT <span class="info"> CUPS 2.5 </span></th><td class="description">Accept field </td></tr> |
| | 12705 | <tr><th>HTTP_FIELD_ACCEPT_ENCODING <span class="info"> CUPS 1.7 </span></th><td class="description">Accepting-Encoding field </td></tr> |
| | 12706 | <tr><th>HTTP_FIELD_ACCEPT_LANGUAGE </th><td class="description">Accept-Language field</td></tr> |
| | 12707 | <tr><th>HTTP_FIELD_ACCEPT_RANGES </th><td class="description">Accept-Ranges field</td></tr> |
| | 12708 | <tr><th>HTTP_FIELD_ACCESS_CONTROL_ALLOW_CREDENTIALS <span class="info"> CUPS 2.4 </span></th><td class="description">CORS/Fetch Access-Control-Allow-Credentials field </td></tr> |
| | 12709 | <tr><th>HTTP_FIELD_ACCESS_CONTROL_ALLOW_HEADERS <span class="info"> CUPS 2.4 </span></th><td class="description">CORS/Fetch Access-Control-Allow-Headers field </td></tr> |
| | 12710 | <tr><th>HTTP_FIELD_ACCESS_CONTROL_ALLOW_METHODS <span class="info"> CUPS 2.4 </span></th><td class="description">CORS/Fetch Access-Control-Allow-Methods field </td></tr> |
| | 12711 | <tr><th>HTTP_FIELD_ACCESS_CONTROL_ALLOW_ORIGIN <span class="info"> CUPS 2.4 </span></th><td class="description">CORS/Fetch Access-Control-Allow-Origin field </td></tr> |
| | 12712 | <tr><th>HTTP_FIELD_ACCESS_CONTROL_EXPOSE_HEADERS <span class="info"> CUPS 2.4 </span></th><td class="description">CORS/Fetch Access-Control-Expose-Headers field </td></tr> |
| | 12713 | <tr><th>HTTP_FIELD_ACCESS_CONTROL_MAX_AGE <span class="info"> CUPS 2.4 </span></th><td class="description">CORS/Fetch Access-Control-Max-Age field </td></tr> |
| | 12714 | <tr><th>HTTP_FIELD_ACCESS_CONTROL_REQUEST_HEADERS <span class="info"> CUPS 2.4 </span></th><td class="description">CORS/Fetch Access-Control-Request-Headers field </td></tr> |
| | 12715 | <tr><th>HTTP_FIELD_ACCESS_CONTROL_REQUEST_METHOD <span class="info"> CUPS 2.4 </span></th><td class="description">CORS/Fetch Access-Control-Request-Method field </td></tr> |
| | 12716 | <tr><th>HTTP_FIELD_ALLOW <span class="info"> CUPS 1.7 </span></th><td class="description">Allow field </td></tr> |
| | 12717 | <tr><th>HTTP_FIELD_AUTHENTICATION_INFO <span class="info"> CUPS 2.2.9 </span></th><td class="description">Authentication-Info field </td></tr> |
| | 12718 | <tr><th>HTTP_FIELD_AUTHORIZATION </th><td class="description">Authorization field</td></tr> |
| | 12719 | <tr><th>HTTP_FIELD_CONNECTION </th><td class="description">Connection field</td></tr> |
| | 12720 | <tr><th>HTTP_FIELD_CONTENT_ENCODING </th><td class="description">Content-Encoding field</td></tr> |
| | 12721 | <tr><th>HTTP_FIELD_CONTENT_LANGUAGE </th><td class="description">Content-Language field</td></tr> |
| | 12722 | <tr><th>HTTP_FIELD_CONTENT_LENGTH </th><td class="description">Content-Length field</td></tr> |
| | 12723 | <tr><th>HTTP_FIELD_CONTENT_LOCATION </th><td class="description">Content-Location field</td></tr> |
| | 12724 | <tr><th>HTTP_FIELD_CONTENT_MD5 </th><td class="description">Content-MD5 field</td></tr> |
| | 12725 | <tr><th>HTTP_FIELD_CONTENT_RANGE </th><td class="description">Content-Range field</td></tr> |
| | 12726 | <tr><th>HTTP_FIELD_CONTENT_TYPE </th><td class="description">Content-Type field</td></tr> |
| | 12727 | <tr><th>HTTP_FIELD_CONTENT_VERSION </th><td class="description">Content-Version field</td></tr> |
| | 12728 | <tr><th>HTTP_FIELD_DATE </th><td class="description">Date field</td></tr> |
| | 12729 | <tr><th>HTTP_FIELD_HOST </th><td class="description">Host field</td></tr> |
| | 12730 | <tr><th>HTTP_FIELD_IF_MODIFIED_SINCE </th><td class="description">If-Modified-Since field</td></tr> |
| | 12731 | <tr><th>HTTP_FIELD_IF_UNMODIFIED_SINCE </th><td class="description">If-Unmodified-Since field</td></tr> |
| | 12732 | <tr><th>HTTP_FIELD_KEEP_ALIVE </th><td class="description">Keep-Alive field</td></tr> |
| | 12733 | <tr><th>HTTP_FIELD_LAST_MODIFIED </th><td class="description">Last-Modified field</td></tr> |
| | 12734 | <tr><th>HTTP_FIELD_LINK </th><td class="description">Link field</td></tr> |
| | 12735 | <tr><th>HTTP_FIELD_LOCATION </th><td class="description">Location field</td></tr> |
| | 12736 | <tr><th>HTTP_FIELD_MAX </th><td class="description">Maximum field index</td></tr> |
| | 12737 | <tr><th>HTTP_FIELD_OPTIONAL_WWW_AUTHENTICATE <span class="info"> CUPS 2.4 </span></th><td class="description">RFC 8053 Optional-WWW-Authenticate field </td></tr> |
| | 12738 | <tr><th>HTTP_FIELD_ORIGIN <span class="info"> CUPS 2.4 </span></th><td class="description">RFC 6454 Origin field </td></tr> |
| | 12739 | <tr><th>HTTP_FIELD_OSCORE <span class="info"> CUPS 2.4 </span></th><td class="description">RFC 8613 OSCORE field </td></tr> |
| | 12740 | <tr><th>HTTP_FIELD_RANGE </th><td class="description">Range field</td></tr> |
| | 12741 | <tr><th>HTTP_FIELD_REFERER </th><td class="description">Referer field</td></tr> |
| | 12742 | <tr><th>HTTP_FIELD_RETRY_AFTER </th><td class="description">Retry-After field</td></tr> |
| | 12743 | <tr><th>HTTP_FIELD_SERVER <span class="info"> CUPS 1.7 </span></th><td class="description">Server field </td></tr> |
| | 12744 | <tr><th>HTTP_FIELD_STRICT_TRANSPORT_SECURITY <span class="info"> CUPS 2.4 </span></th><td class="description">HSTS Strict-Transport-Security field </td></tr> |
| | 12745 | <tr><th>HTTP_FIELD_TRANSFER_ENCODING </th><td class="description">Transfer-Encoding field</td></tr> |
| | 12746 | <tr><th>HTTP_FIELD_UNKNOWN </th><td class="description">Unknown field</td></tr> |
| | 12747 | <tr><th>HTTP_FIELD_UPGRADE </th><td class="description">Upgrade field</td></tr> |
| | 12748 | <tr><th>HTTP_FIELD_USER_AGENT </th><td class="description">User-Agent field</td></tr> |
| | 12749 | <tr><th>HTTP_FIELD_WWW_AUTHENTICATE </th><td class="description">WWW-Authenticate field</td></tr> |
| | 12750 | </tbody></table> |
| | 12751 | <h3 class="enumeration"><a id="http_keepalive_e">http_keepalive_e</a></h3> |
| | 12752 | <p class="description">HTTP keep-alive values</p> |
| | 12753 | <h4 class="constants">Constants</h4> |
| | 12754 | <table class="list"><tbody> |
| | 12755 | <tr><th>HTTP_KEEPALIVE_OFF </th><td class="description">No keep alive support</td></tr> |
| | 12756 | <tr><th>HTTP_KEEPALIVE_ON </th><td class="description">Use keep alive</td></tr> |
| | 12757 | </tbody></table> |
| | 12758 | <h3 class="enumeration"><a id="http_resolve_e">http_resolve_e</a></h3> |
| | 12759 | <p class="description"><a href="#httpResolveURI"><code>httpResolveURI</code></a> options bit values</p> |
| | 12760 | <h4 class="constants">Constants</h4> |
| | 12761 | <table class="list"><tbody> |
| | 12762 | <tr><th>HTTP_RESOLVE_DEFAULT </th><td class="description">Resolve with default options</td></tr> |
| | 12763 | <tr><th>HTTP_RESOLVE_FAXOUT </th><td class="description">Resolve FaxOut service instead of Print</td></tr> |
| | 12764 | <tr><th>HTTP_RESOLVE_FQDN </th><td class="description">Resolve to a FQDN</td></tr> |
| | 12765 | </tbody></table> |
| | 12766 | <h3 class="enumeration"><a id="http_state_e">http_state_e</a></h3> |
| | 12767 | <p class="description">HTTP state values; states are server-oriented...</p> |
| | 12768 | <h4 class="constants">Constants</h4> |
| | 12769 | <table class="list"><tbody> |
| | 12770 | <tr><th>HTTP_STATE_CONNECT </th><td class="description">CONNECT command, waiting for blank line</td></tr> |
| | 12771 | <tr><th>HTTP_STATE_DELETE </th><td class="description">DELETE command, waiting for blank line</td></tr> |
| | 12772 | <tr><th>HTTP_STATE_ERROR </th><td class="description">Error on socket</td></tr> |
| | 12773 | <tr><th>HTTP_STATE_GET </th><td class="description">GET command, waiting for blank line</td></tr> |
| | 12774 | <tr><th>HTTP_STATE_GET_SEND </th><td class="description">GET command, sending data</td></tr> |
| | 12775 | <tr><th>HTTP_STATE_HEAD </th><td class="description">HEAD command, waiting for blank line</td></tr> |
| | 12776 | <tr><th>HTTP_STATE_OPTIONS </th><td class="description">OPTIONS command, waiting for blank line</td></tr> |
| | 12777 | <tr><th>HTTP_STATE_POST </th><td class="description">POST command, waiting for blank line</td></tr> |
| | 12778 | <tr><th>HTTP_STATE_POST_RECV </th><td class="description">POST command, receiving data</td></tr> |
| | 12779 | <tr><th>HTTP_STATE_POST_SEND </th><td class="description">POST command, sending data</td></tr> |
| | 12780 | <tr><th>HTTP_STATE_PUT </th><td class="description">PUT command, waiting for blank line</td></tr> |
| | 12781 | <tr><th>HTTP_STATE_PUT_RECV </th><td class="description">PUT command, receiving data</td></tr> |
| | 12782 | <tr><th>HTTP_STATE_STATUS </th><td class="description">Command complete, sending status</td></tr> |
| | 12783 | <tr><th>HTTP_STATE_TRACE </th><td class="description">TRACE command, waiting for blank line</td></tr> |
| | 12784 | <tr><th>HTTP_STATE_UNKNOWN_METHOD <span class="info"> CUPS 1.7 </span></th><td class="description">Unknown request method, waiting for blank line </td></tr> |
| | 12785 | <tr><th>HTTP_STATE_UNKNOWN_VERSION <span class="info"> CUPS 1.7 </span></th><td class="description">Unknown request method, waiting for blank line </td></tr> |
| | 12786 | <tr><th>HTTP_STATE_WAITING </th><td class="description">Waiting for command</td></tr> |
| | 12787 | </tbody></table> |
| | 12788 | <h3 class="enumeration"><a id="http_status_e">http_status_e</a></h3> |
| | 12789 | <p class="description">HTTP status codes</p> |
| | 12790 | <h4 class="constants">Constants</h4> |
| | 12791 | <table class="list"><tbody> |
| | 12792 | <tr><th>HTTP_STATUS_ACCEPTED </th><td class="description">DELETE command was successful</td></tr> |
| | 12793 | <tr><th>HTTP_STATUS_ALREADY_REPORTED </th><td class="description">Already reported (WebDAV)</td></tr> |
| | 12794 | <tr><th>HTTP_STATUS_BAD_GATEWAY </th><td class="description">Bad gateway</td></tr> |
| | 12795 | <tr><th>HTTP_STATUS_BAD_REQUEST </th><td class="description">Bad request</td></tr> |
| | 12796 | <tr><th>HTTP_STATUS_CONFLICT </th><td class="description">Request is self-conflicting</td></tr> |
| | 12797 | <tr><th>HTTP_STATUS_CONTENT_TOO_LARGE </th><td class="description">Content too large</td></tr> |
| | 12798 | <tr><th>HTTP_STATUS_CONTINUE </th><td class="description">Everything OK, keep going...</td></tr> |
| | 12799 | <tr><th>HTTP_STATUS_CREATED </th><td class="description">PUT command was successful</td></tr> |
| | 12800 | <tr><th>HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED <span class="info"> CUPS 1.4 </span></th><td class="description">User canceled authorization </td></tr> |
| | 12801 | <tr><th>HTTP_STATUS_CUPS_PKI_ERROR <span class="info"> CUPS 1.5 </span></th><td class="description">Error negotiating a secure connection </td></tr> |
| | 12802 | <tr><th>HTTP_STATUS_ERROR </th><td class="description">An error response from httpXxxx()</td></tr> |
| | 12803 | <tr><th>HTTP_STATUS_EXPECTATION_FAILED </th><td class="description">The expectation given in an Expect header field was not met</td></tr> |
| | 12804 | <tr><th>HTTP_STATUS_FAILED_DEPENDENCY </th><td class="description">Failed dependency (WebDAV)</td></tr> |
| | 12805 | <tr><th>HTTP_STATUS_FORBIDDEN </th><td class="description">Forbidden to access this URI</td></tr> |
| | 12806 | <tr><th>HTTP_STATUS_FOUND </th><td class="description">Document was found at a different URI</td></tr> |
| | 12807 | <tr><th>HTTP_STATUS_GATEWAY_TIMEOUT </th><td class="description">Gateway connection timed out</td></tr> |
| | 12808 | <tr><th>HTTP_STATUS_GONE </th><td class="description">Server has gone away</td></tr> |
| | 12809 | <tr><th>HTTP_STATUS_INSUFFICIENT_STORAGE </th><td class="description">Insufficient storage (WebDAV)</td></tr> |
| | 12810 | <tr><th>HTTP_STATUS_LENGTH_REQUIRED </th><td class="description">A content length or encoding is required</td></tr> |
| | 12811 | <tr><th>HTTP_STATUS_LOCKED </th><td class="description">Locked (WebDAV)</td></tr> |
| | 12812 | <tr><th>HTTP_STATUS_LOOP_DETECTED </th><td class="description">Loop detected (WebDAV)</td></tr> |
| | 12813 | <tr><th>HTTP_STATUS_METHOD_NOT_ALLOWED </th><td class="description">Method is not allowed</td></tr> |
| | 12814 | <tr><th>HTTP_STATUS_MISDIRECTED_REQUEST </th><td class="description">Misdirected request</td></tr> |
| | 12815 | <tr><th>HTTP_STATUS_MOVED_PERMANENTLY </th><td class="description">Document has moved permanently</td></tr> |
| | 12816 | <tr><th>HTTP_STATUS_MULTIPLE_CHOICES </th><td class="description">Multiple files match request</td></tr> |
| | 12817 | <tr><th>HTTP_STATUS_MULTI_STATUS </th><td class="description">Multiple status codes (WebDAV)</td></tr> |
| | 12818 | <tr><th>HTTP_STATUS_NETWORK_AUTHENTICATION_REQUIRED </th><td class="description">Network Authentication Required (WebDAV)</td></tr> |
| | 12819 | <tr><th>HTTP_STATUS_NONE <span class="info"> CUPS 1.7 </span></th><td class="description">No Expect value </td></tr> |
| | 12820 | <tr><th>HTTP_STATUS_NOT_ACCEPTABLE </th><td class="description">Not Acceptable</td></tr> |
| | 12821 | <tr><th>HTTP_STATUS_NOT_AUTHORITATIVE </th><td class="description">Information isn't authoritative</td></tr> |
| | 12822 | <tr><th>HTTP_STATUS_NOT_FOUND </th><td class="description">URI was not found</td></tr> |
| | 12823 | <tr><th>HTTP_STATUS_NOT_IMPLEMENTED </th><td class="description">Feature not implemented</td></tr> |
| | 12824 | <tr><th>HTTP_STATUS_NOT_MODIFIED </th><td class="description">File not modified</td></tr> |
| | 12825 | <tr><th>HTTP_STATUS_NOT_SUPPORTED </th><td class="description">HTTP version not supported</td></tr> |
| | 12826 | <tr><th>HTTP_STATUS_NO_CONTENT </th><td class="description">Successful command, no new data</td></tr> |
| | 12827 | <tr><th>HTTP_STATUS_OK </th><td class="description">OPTIONS/GET/HEAD/POST/TRACE command was successful</td></tr> |
| | 12828 | <tr><th>HTTP_STATUS_PARTIAL_CONTENT </th><td class="description">Only a partial file was received/sent</td></tr> |
| | 12829 | <tr><th>HTTP_STATUS_PAYMENT_REQUIRED </th><td class="description">Payment required</td></tr> |
| | 12830 | <tr><th>HTTP_STATUS_PERMANENT_REDIRECT </th><td class="description">Permanent redirection</td></tr> |
| | 12831 | <tr><th>HTTP_STATUS_PRECONDITION </th><td class="description">Precondition failed</td></tr> |
| | 12832 | <tr><th>HTTP_STATUS_PRECONDITION_REQUIRED </th><td class="description">Precondition required (WebDAV)</td></tr> |
| | 12833 | <tr><th>HTTP_STATUS_PROXY_AUTHENTICATION </th><td class="description">Proxy Authentication is Required</td></tr> |
| | 12834 | <tr><th>HTTP_STATUS_RANGE_NOT_SATISFIABLE </th><td class="description">The requested range is not satisfiable</td></tr> |
| | 12835 | <tr><th>HTTP_STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE </th><td class="description">Request Header Fields Too Large (WebDAV)</td></tr> |
| | 12836 | <tr><th>HTTP_STATUS_REQUEST_TIMEOUT </th><td class="description">Request timed out</td></tr> |
| | 12837 | <tr><th>HTTP_STATUS_RESET_CONTENT </th><td class="description">Content was reset/recreated</td></tr> |
| | 12838 | <tr><th>HTTP_STATUS_SEE_OTHER </th><td class="description">See this other link</td></tr> |
| | 12839 | <tr><th>HTTP_STATUS_SERVER_ERROR </th><td class="description">Internal server error</td></tr> |
| | 12840 | <tr><th>HTTP_STATUS_SERVICE_UNAVAILABLE </th><td class="description">Service is unavailable</td></tr> |
| | 12841 | <tr><th>HTTP_STATUS_SWITCHING_PROTOCOLS </th><td class="description">HTTP upgrade to TLS/SSL</td></tr> |
| | 12842 | <tr><th>HTTP_STATUS_TEMPORARY_REDIRECT </th><td class="description">Temporary redirection</td></tr> |
| | 12843 | <tr><th>HTTP_STATUS_TOO_EARLY </th><td class="description">Too early (WebDAV)</td></tr> |
| | 12844 | <tr><th>HTTP_STATUS_TOO_MANY_REQUESTS </th><td class="description">Too many requests (WebDAV)</td></tr> |
| | 12845 | <tr><th>HTTP_STATUS_UNAUTHORIZED </th><td class="description">Unauthorized to access host</td></tr> |
| | 12846 | <tr><th>HTTP_STATUS_UNAVAILABLE_FOR_LEGAL_REASONS </th><td class="description">Unavailable For Legal Reasons (RFC 7725)</td></tr> |
| | 12847 | <tr><th>HTTP_STATUS_UNPROCESSABLE_CONTENT </th><td class="description">Unprocessable content</td></tr> |
| | 12848 | <tr><th>HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE </th><td class="description">The requested media type is unsupported</td></tr> |
| | 12849 | <tr><th>HTTP_STATUS_UPGRADE_REQUIRED </th><td class="description">Upgrade to SSL/TLS required</td></tr> |
| | 12850 | <tr><th>HTTP_STATUS_URI_TOO_LONG </th><td class="description">URI too long</td></tr> |
| | 12851 | <tr><th>HTTP_STATUS_USE_PROXY </th><td class="description">Must use a proxy to access this URI</td></tr> |
| | 12852 | </tbody></table> |
| | 12853 | <h3 class="enumeration"><a id="http_trust_e"><span class="info"> CUPS 2.0/OS 10.10 </span>http_trust_e</a></h3> |
| | 12854 | <p class="description">Level of trust for credentials </p> |
| | 12855 | <h4 class="constants">Constants</h4> |
| | 12856 | <table class="list"><tbody> |
| | 12857 | <tr><th>HTTP_TRUST_CHANGED </th><td class="description">Credentials have changed</td></tr> |
| | 12858 | <tr><th>HTTP_TRUST_EXPIRED </th><td class="description">Credentials are expired</td></tr> |
| | 12859 | <tr><th>HTTP_TRUST_INVALID </th><td class="description">Credentials are invalid</td></tr> |
| | 12860 | <tr><th>HTTP_TRUST_OK </th><td class="description">Credentials are OK/trusted</td></tr> |
| | 12861 | <tr><th>HTTP_TRUST_RENEWED </th><td class="description">Credentials have been renewed</td></tr> |
| | 12862 | <tr><th>HTTP_TRUST_UNKNOWN </th><td class="description">Credentials are unknown/new</td></tr> |
| | 12863 | </tbody></table> |
| | 12864 | <h3 class="enumeration"><a id="http_uri_coding_e">http_uri_coding_e</a></h3> |
| | 12865 | <p class="description">URI en/decode flags</p> |
| | 12866 | <h4 class="constants">Constants</h4> |
| | 12867 | <table class="list"><tbody> |
| | 12868 | <tr><th>HTTP_URI_CODING_ALL </th><td class="description">En/decode everything</td></tr> |
| | 12869 | <tr><th>HTTP_URI_CODING_HOSTNAME </th><td class="description">En/decode the hostname portion</td></tr> |
| | 12870 | <tr><th>HTTP_URI_CODING_MOST </th><td class="description">En/decode all but the query</td></tr> |
| | 12871 | <tr><th>HTTP_URI_CODING_NONE </th><td class="description">Don't en/decode anything</td></tr> |
| | 12872 | <tr><th>HTTP_URI_CODING_QUERY </th><td class="description">En/decode the query portion</td></tr> |
| | 12873 | <tr><th>HTTP_URI_CODING_RESOURCE </th><td class="description">En/decode the resource portion</td></tr> |
| | 12874 | <tr><th>HTTP_URI_CODING_RFC6874 </th><td class="description">Use RFC 6874 address format</td></tr> |
| | 12875 | <tr><th>HTTP_URI_CODING_USERNAME </th><td class="description">En/decode the username portion</td></tr> |
| | 12876 | </tbody></table> |
| | 12877 | <h3 class="enumeration"><a id="http_uri_status_e"><span class="info"> CUPS 1.2 </span>http_uri_status_e</a></h3> |
| | 12878 | <p class="description">URI separation status </p> |
| | 12879 | <h4 class="constants">Constants</h4> |
| | 12880 | <table class="list"><tbody> |
| | 12881 | <tr><th>HTTP_URI_STATUS_BAD_ARGUMENTS </th><td class="description">Bad arguments to function (error)</td></tr> |
| | 12882 | <tr><th>HTTP_URI_STATUS_BAD_HOSTNAME </th><td class="description">Bad hostname in URI (error)</td></tr> |
| | 12883 | <tr><th>HTTP_URI_STATUS_BAD_PORT </th><td class="description">Bad port number in URI (error)</td></tr> |
| | 12884 | <tr><th>HTTP_URI_STATUS_BAD_RESOURCE </th><td class="description">Bad resource in URI (error)</td></tr> |
| | 12885 | <tr><th>HTTP_URI_STATUS_BAD_SCHEME </th><td class="description">Bad scheme in URI (error)</td></tr> |
| | 12886 | <tr><th>HTTP_URI_STATUS_BAD_URI </th><td class="description">Bad/empty URI (error)</td></tr> |
| | 12887 | <tr><th>HTTP_URI_STATUS_BAD_USERNAME </th><td class="description">Bad username in URI (error)</td></tr> |
| | 12888 | <tr><th>HTTP_URI_STATUS_MISSING_RESOURCE </th><td class="description">Missing resource in URI (warning)</td></tr> |
| | 12889 | <tr><th>HTTP_URI_STATUS_MISSING_SCHEME </th><td class="description">Missing scheme in URI (warning)</td></tr> |
| | 12890 | <tr><th>HTTP_URI_STATUS_OK </th><td class="description">URI decoded OK</td></tr> |
| | 12891 | <tr><th>HTTP_URI_STATUS_OVERFLOW </th><td class="description">URI buffer for httpAssembleURI is too small</td></tr> |
| | 12892 | <tr><th>HTTP_URI_STATUS_UNKNOWN_SCHEME </th><td class="description">Unknown scheme in URI (warning)</td></tr> |
| | 12893 | </tbody></table> |
| | 12894 | <h3 class="enumeration"><a id="ipp_finishings_e">ipp_finishings_e</a></h3> |
| | 12895 | <p class="description">Finishings values</p> |
| | 12896 | <h4 class="constants">Constants</h4> |
| | 12897 | <table class="list"><tbody> |
| | 12898 | <tr><th>IPP_FINISHINGS_BALE </th><td class="description">Bale (any type)</td></tr> |
| | 12899 | <tr><th>IPP_FINISHINGS_BIND </th><td class="description">Bind</td></tr> |
| | 12900 | <tr><th>IPP_FINISHINGS_BIND_BOTTOM </th><td class="description">Bind on bottom</td></tr> |
| | 12901 | <tr><th>IPP_FINISHINGS_BIND_LEFT </th><td class="description">Bind on left</td></tr> |
| | 12902 | <tr><th>IPP_FINISHINGS_BIND_RIGHT </th><td class="description">Bind on right</td></tr> |
| | 12903 | <tr><th>IPP_FINISHINGS_BIND_TOP </th><td class="description">Bind on top</td></tr> |
| | 12904 | <tr><th>IPP_FINISHINGS_BOOKLET_MAKER </th><td class="description">Fold to make booklet</td></tr> |
| | 12905 | <tr><th>IPP_FINISHINGS_COAT </th><td class="description">Apply protective liquid or powder coating</td></tr> |
| | 12906 | <tr><th>IPP_FINISHINGS_COVER </th><td class="description">Add cover</td></tr> |
| | 12907 | <tr><th>IPP_FINISHINGS_EDGE_STITCH </th><td class="description">Stitch along any side</td></tr> |
| | 12908 | <tr><th>IPP_FINISHINGS_EDGE_STITCH_BOTTOM </th><td class="description">Stitch along bottom edge</td></tr> |
| | 12909 | <tr><th>IPP_FINISHINGS_EDGE_STITCH_LEFT </th><td class="description">Stitch along left side</td></tr> |
| | 12910 | <tr><th>IPP_FINISHINGS_EDGE_STITCH_RIGHT </th><td class="description">Stitch along right side</td></tr> |
| | 12911 | <tr><th>IPP_FINISHINGS_EDGE_STITCH_TOP </th><td class="description">Stitch along top edge</td></tr> |
| | 12912 | <tr><th>IPP_FINISHINGS_FOLD </th><td class="description">Fold (any type)</td></tr> |
| | 12913 | <tr><th>IPP_FINISHINGS_FOLD_ACCORDION </th><td class="description">Accordion-fold the paper vertically into four sections</td></tr> |
| | 12914 | <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> |
| | 12915 | <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> |
| | 12916 | <tr><th>IPP_FINISHINGS_FOLD_GATE </th><td class="description">Fold the top and bottom quarters of the paper towards the midline</td></tr> |
| | 12917 | <tr><th>IPP_FINISHINGS_FOLD_HALF </th><td class="description">Fold the paper in half vertically</td></tr> |
| | 12918 | <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> |
| | 12919 | <tr><th>IPP_FINISHINGS_FOLD_LEFT_GATE </th><td class="description">Fold the top quarter of the paper towards the midline</td></tr> |
| | 12920 | <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> |
| | 12921 | <tr><th>IPP_FINISHINGS_FOLD_PARALLEL </th><td class="description">Fold the paper in half vertically two times, yielding four sections</td></tr> |
| | 12922 | <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> |
| | 12923 | <tr><th>IPP_FINISHINGS_FOLD_RIGHT_GATE </th><td class="description">Fold the bottom quarter of the paper towards the midline</td></tr> |
| | 12924 | <tr><th>IPP_FINISHINGS_FOLD_Z </th><td class="description">Fold the paper vertically into three sections, forming a Z</td></tr> |
| | 12925 | <tr><th>IPP_FINISHINGS_JOG_OFFSET </th><td class="description">Offset for binding (any type)</td></tr> |
| | 12926 | <tr><th>IPP_FINISHINGS_LAMINATE </th><td class="description">Apply protective (solid) material</td></tr> |
| | 12927 | <tr><th>IPP_FINISHINGS_NONE </th><td class="description">No finishing</td></tr> |
| | 12928 | <tr><th>IPP_FINISHINGS_PUNCH </th><td class="description">Punch (any location/count)</td></tr> |
| | 12929 | <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_LEFT </th><td class="description">Punch 1 hole bottom left</td></tr> |
| | 12930 | <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_RIGHT </th><td class="description">Punch 1 hole bottom right</td></tr> |
| | 12931 | <tr><th>IPP_FINISHINGS_PUNCH_DUAL_BOTTOM </th><td class="description">Punch 2 holes bottom edge</td></tr> |
| | 12932 | <tr><th>IPP_FINISHINGS_PUNCH_DUAL_LEFT </th><td class="description">Punch 2 holes left side</td></tr> |
| | 12933 | <tr><th>IPP_FINISHINGS_PUNCH_DUAL_RIGHT </th><td class="description">Punch 2 holes right side</td></tr> |
| | 12934 | <tr><th>IPP_FINISHINGS_PUNCH_DUAL_TOP </th><td class="description">Punch 2 holes top edge</td></tr> |
| | 12935 | <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_BOTTOM </th><td class="description">Punch multiple holes bottom edge</td></tr> |
| | 12936 | <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_LEFT </th><td class="description">Punch multiple holes left side</td></tr> |
| | 12937 | <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_RIGHT </th><td class="description">Punch multiple holes right side</td></tr> |
| | 12938 | <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_TOP </th><td class="description">Punch multiple holes top edge</td></tr> |
| | 12939 | <tr><th>IPP_FINISHINGS_PUNCH_QUAD_BOTTOM </th><td class="description">Punch 4 holes bottom edge</td></tr> |
| | 12940 | <tr><th>IPP_FINISHINGS_PUNCH_QUAD_LEFT </th><td class="description">Punch 4 holes left side</td></tr> |
| | 12941 | <tr><th>IPP_FINISHINGS_PUNCH_QUAD_RIGHT </th><td class="description">Punch 4 holes right side</td></tr> |
| | 12942 | <tr><th>IPP_FINISHINGS_PUNCH_QUAD_TOP </th><td class="description">Punch 4 holes top edge</td></tr> |
| | 12943 | <tr><th>IPP_FINISHINGS_PUNCH_TOP_LEFT </th><td class="description">Punch 1 hole top left</td></tr> |
| | 12944 | <tr><th>IPP_FINISHINGS_PUNCH_TOP_RIGHT </th><td class="description">Punch 1 hole top right</td></tr> |
| | 12945 | <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_BOTTOM </th><td class="description">Punch 3 holes bottom edge</td></tr> |
| | 12946 | <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_LEFT </th><td class="description">Punch 3 holes left side</td></tr> |
| | 12947 | <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_RIGHT </th><td class="description">Punch 3 holes right side</td></tr> |
| | 12948 | <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_TOP </th><td class="description">Punch 3 holes top edge</td></tr> |
| | 12949 | <tr><th>IPP_FINISHINGS_SADDLE_STITCH </th><td class="description">Staple interior</td></tr> |
| | 12950 | <tr><th>IPP_FINISHINGS_STAPLE </th><td class="description">Staple (any location/method)</td></tr> |
| | 12951 | <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_LEFT </th><td class="description">Staple bottom left corner</td></tr> |
| | 12952 | <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT </th><td class="description">Staple bottom right corner</td></tr> |
| | 12953 | <tr><th>IPP_FINISHINGS_STAPLE_DUAL_BOTTOM </th><td class="description">Two staples on bottom</td></tr> |
| | 12954 | <tr><th>IPP_FINISHINGS_STAPLE_DUAL_LEFT </th><td class="description">Two staples on left</td></tr> |
| | 12955 | <tr><th>IPP_FINISHINGS_STAPLE_DUAL_RIGHT </th><td class="description">Two staples on right</td></tr> |
| | 12956 | <tr><th>IPP_FINISHINGS_STAPLE_DUAL_TOP </th><td class="description">Two staples on top</td></tr> |
| | 12957 | <tr><th>IPP_FINISHINGS_STAPLE_TOP_LEFT </th><td class="description">Staple top left corner</td></tr> |
| | 12958 | <tr><th>IPP_FINISHINGS_STAPLE_TOP_RIGHT </th><td class="description">Staple top right corner</td></tr> |
| | 12959 | <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_BOTTOM </th><td class="description">Three staples on bottom</td></tr> |
| | 12960 | <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_LEFT </th><td class="description">Three staples on left</td></tr> |
| | 12961 | <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_RIGHT </th><td class="description">Three staples on right</td></tr> |
| | 12962 | <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_TOP </th><td class="description">Three staples on top</td></tr> |
| | 12963 | <tr><th>IPP_FINISHINGS_TRIM </th><td class="description">Trim (any type)</td></tr> |
| | 12964 | <tr><th>IPP_FINISHINGS_TRIM_AFTER_COPIES </th><td class="description">Trim output after each copy</td></tr> |
| | 12965 | <tr><th>IPP_FINISHINGS_TRIM_AFTER_DOCUMENTS </th><td class="description">Trim output after each document</td></tr> |
| | 12966 | <tr><th>IPP_FINISHINGS_TRIM_AFTER_JOB </th><td class="description">Trim output after job</td></tr> |
| | 12967 | <tr><th>IPP_FINISHINGS_TRIM_AFTER_PAGES </th><td class="description">Trim output after each page</td></tr> |
| | 12968 | </tbody></table> |
| | 12969 | <h3 class="enumeration"><a id="ipp_jstate_e">ipp_jstate_e</a></h3> |
| | 12970 | <p class="description">Job states</p> |
| | 12971 | <h4 class="constants">Constants</h4> |
| | 12972 | <table class="list"><tbody> |
| | 12973 | <tr><th>IPP_JSTATE_ABORTED </th><td class="description">Job has aborted due to error</td></tr> |
| | 12974 | <tr><th>IPP_JSTATE_CANCELED </th><td class="description">Job has been canceled</td></tr> |
| | 12975 | <tr><th>IPP_JSTATE_COMPLETED </th><td class="description">Job has completed successfully</td></tr> |
| | 12976 | <tr><th>IPP_JSTATE_HELD </th><td class="description">Job is held for printing</td></tr> |
| | 12977 | <tr><th>IPP_JSTATE_PENDING </th><td class="description">Job is waiting to be printed</td></tr> |
| | 12978 | <tr><th>IPP_JSTATE_PROCESSING </th><td class="description">Job is currently printing</td></tr> |
| | 12979 | <tr><th>IPP_JSTATE_STOPPED </th><td class="description">Job has been stopped</td></tr> |
| | 12980 | </tbody></table> |
| | 12981 | <h3 class="enumeration"><a id="ipp_op_e">ipp_op_e</a></h3> |
| | 12982 | <p class="description">IPP operations</p> |
| | 12983 | <h4 class="constants">Constants</h4> |
| | 12984 | <table class="list"><tbody> |
| | 12985 | <tr><th>IPP_OP_ALLOCATE_PRINTER_RESOURCES </th><td class="description">Allocate-Printer-Resources: Use resources for a printer.</td></tr> |
| | 12986 | <tr><th>IPP_OP_CANCEL_CURRENT_JOB </th><td class="description">Cancel-Current-Job: Cancel the current job</td></tr> |
| | 12987 | <tr><th>IPP_OP_CANCEL_JOB </th><td class="description">Cancel-Job: Cancel a job</td></tr> |
| | 12988 | <tr><th>IPP_OP_CANCEL_JOBS </th><td class="description">Cancel-Jobs: Cancel all jobs (administrative)</td></tr> |
| | 12989 | <tr><th>IPP_OP_CANCEL_MY_JOBS </th><td class="description">Cancel-My-Jobs: Cancel a user's jobs</td></tr> |
| | 12990 | <tr><th>IPP_OP_CANCEL_RESOURCE </th><td class="description">Cancel-Resource: Uninstall a resource.</td></tr> |
| | 12991 | <tr><th>IPP_OP_CANCEL_SUBSCRIPTION <span class="info"> CUPS 1.2 </span></th><td class="description">Cancel-Subscription: Cancel a subscription </td></tr> |
| | 12992 | <tr><th>IPP_OP_CLOSE_JOB </th><td class="description">Close-Job: Close a job and start printing</td></tr> |
| | 12993 | <tr><th>IPP_OP_CREATE_JOB </th><td class="description">Create-Job: Create an empty print job</td></tr> |
| | 12994 | <tr><th>IPP_OP_CREATE_JOB_SUBSCRIPTIONS <span class="info"> CUPS 1.2 </span></th><td class="description">Create-Job-Subscriptions: Create one of more job subscriptions </td></tr> |
| | 12995 | <tr><th>IPP_OP_CREATE_PRINTER </th><td class="description">Create-Printer: Create a new service.</td></tr> |
| | 12996 | <tr><th>IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS <span class="info"> CUPS 1.2 </span></th><td class="description">Create-Printer-Subscriptions: Create one or more printer subscriptions </td></tr> |
| | 12997 | <tr><th>IPP_OP_CREATE_RESOURCE </th><td class="description">Create-Resource: Create a new (empty) resource.</td></tr> |
| | 12998 | <tr><th>IPP_OP_CREATE_RESOURCE_SUBSCRIPTIONS </th><td class="description">Create-Resource-Subscriptions: Create event subscriptions for a resource.</td></tr> |
| | 12999 | <tr><th>IPP_OP_CREATE_SYSTEM_SUBSCRIPTIONS </th><td class="description">Create-System-Subscriptions: Create event subscriptions for a system.</td></tr> |
| | 13000 | <tr><th>IPP_OP_CUPS_ADD_MODIFY_CLASS </th><td class="description">CUPS-Add-Modify-Class: Add or modify a class</td></tr> |
| | 13001 | <tr><th>IPP_OP_CUPS_ADD_MODIFY_PRINTER </th><td class="description">CUPS-Add-Modify-Printer: Add or modify a printer</td></tr> |
| | 13002 | <tr><th>IPP_OP_CUPS_AUTHENTICATE_JOB <span class="info"> CUPS 1.2 </span></th><td class="description">CUPS-Authenticate-Job: Authenticate a job </td></tr> |
| | 13003 | <tr><th>IPP_OP_CUPS_CREATE_LOCAL_PRINTER <span class="info"> CUPS 2.2 </span></th><td class="description">CUPS-Create-Local-Printer: Create a local (temporary) printer </td></tr> |
| | 13004 | <tr><th>IPP_OP_CUPS_DELETE_CLASS </th><td class="description">CUPS-Delete-Class: Delete a class</td></tr> |
| | 13005 | <tr><th>IPP_OP_CUPS_DELETE_PRINTER </th><td class="description">CUPS-Delete-Printer: Delete a printer</td></tr> |
| | 13006 | <tr><th>IPP_OP_CUPS_GET_DEFAULT </th><td class="description">CUPS-Get-Default: Get the default printer</td></tr> |
| | 13007 | <tr><th>IPP_OP_CUPS_GET_DEVICES <span class="info"> DEPRECATED </span></th><td class="description">CUPS-Get-Devices: Get a list of supported devices </td></tr> |
| | 13008 | <tr><th>IPP_OP_CUPS_GET_DOCUMENT <span class="info"> CUPS 1.4 </span></th><td class="description">CUPS-Get-Document: Get a document file </td></tr> |
| | 13009 | <tr><th>IPP_OP_CUPS_GET_PPD <span class="info"> DEPRECATED </span></th><td class="description">CUPS-Get-PPD: Get a PPD file </td></tr> |
| | 13010 | <tr><th>IPP_OP_CUPS_GET_PPDS <span class="info"> DEPRECATED </span></th><td class="description">CUPS-Get-PPDs: Get a list of supported drivers </td></tr> |
| | 13011 | <tr><th>IPP_OP_CUPS_GET_PRINTERS </th><td class="description">CUPS-Get-Printers: Get a list of printers and/or classes</td></tr> |
| | 13012 | <tr><th>IPP_OP_CUPS_INVALID </th><td class="description">Invalid operation name for <a href="#ippOpValue"><code>ippOpValue</code></a></td></tr> |
| | 13013 | <tr><th>IPP_OP_CUPS_MOVE_JOB </th><td class="description">CUPS-Move-Job: Move a job to a different printer</td></tr> |
| | 13014 | <tr><th>IPP_OP_CUPS_SET_DEFAULT </th><td class="description">CUPS-Set-Default: Set the default printer</td></tr> |
| | 13015 | <tr><th>IPP_OP_DEALLOCATE_PRINTER_RESOURCES </th><td class="description">Deallocate-Printer-Resources: Stop using resources for a printer.</td></tr> |
| | 13016 | <tr><th>IPP_OP_DELETE_PRINTER </th><td class="description">Delete-Printer: Delete an existing service.</td></tr> |
| | 13017 | <tr><th>IPP_OP_DISABLE_ALL_PRINTERS </th><td class="description">Disable-All-Printers: Stop accepting new jobs on all services.</td></tr> |
| | 13018 | <tr><th>IPP_OP_DISABLE_PRINTER </th><td class="description">Disable-Printer: Reject new jobs for a printer</td></tr> |
| | 13019 | <tr><th>IPP_OP_ENABLE_ALL_PRINTERS </th><td class="description">Enable-All-Printers: Start accepting new jobs on all services.</td></tr> |
| | 13020 | <tr><th>IPP_OP_ENABLE_PRINTER </th><td class="description">Enable-Printer: Accept new jobs for a printer</td></tr> |
| | 13021 | <tr><th>IPP_OP_GET_JOBS </th><td class="description">Get-Jobs: Get a list of jobs</td></tr> |
| | 13022 | <tr><th>IPP_OP_GET_JOB_ATTRIBUTES </th><td class="description">Get-Job-Attribute: Get information about a job</td></tr> |
| | 13023 | <tr><th>IPP_OP_GET_NOTIFICATIONS <span class="info"> CUPS 1.2 </span></th><td class="description">Get-Notifications: Get notification events </td></tr> |
| | 13024 | <tr><th>IPP_OP_GET_PRINTERS </th><td class="description">Get-Printers: Get a list of services.</td></tr> |
| | 13025 | <tr><th>IPP_OP_GET_PRINTER_ATTRIBUTES </th><td class="description">Get-Printer-Attributes: Get information about a printer</td></tr> |
| | 13026 | <tr><th>IPP_OP_GET_PRINTER_SUPPORTED_VALUES </th><td class="description">Get-Printer-Supported-Values: Get supported values</td></tr> |
| | 13027 | <tr><th>IPP_OP_GET_SUBSCRIPTIONS <span class="info"> CUPS 1.2 </span></th><td class="description">Get-Subscriptions: Get list of subscriptions </td></tr> |
| | 13028 | <tr><th>IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES <span class="info"> CUPS 1.2 </span></th><td class="description">Get-Subscription-Attributes: Get subscription information </td></tr> |
| | 13029 | <tr><th>IPP_OP_GET_SYSTEM_ATTRIBUTES </th><td class="description">Get-System-Attributes: Get system object attributes.</td></tr> |
| | 13030 | <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> |
| | 13031 | <tr><th>IPP_OP_HOLD_JOB </th><td class="description">Hold-Job: Hold a job for printing</td></tr> |
| | 13032 | <tr><th>IPP_OP_HOLD_NEW_JOBS </th><td class="description">Hold-New-Jobs: Hold new jobs</td></tr> |
| | 13033 | <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> |
| | 13034 | <tr><th>IPP_OP_INSTALL_RESOURCE </th><td class="description">Install-Resource: Install a resource.</td></tr> |
| | 13035 | <tr><th>IPP_OP_PAUSE_ALL_PRINTERS </th><td class="description">Pause-All-Printers: Stop all services immediately.</td></tr> |
| | 13036 | <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> |
| | 13037 | <tr><th>IPP_OP_PAUSE_PRINTER </th><td class="description">Pause-Printer: Stop a printer</td></tr> |
| | 13038 | <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> |
| | 13039 | <tr><th>IPP_OP_PRINT_JOB </th><td class="description">Print-Job: Print a single file</td></tr> |
| | 13040 | <tr><th>IPP_OP_PROMOTE_JOB </th><td class="description">Promote-Job: Promote a job to print sooner</td></tr> |
| | 13041 | <tr><th>IPP_OP_REGISTER_OUTPUT_DEVICE </th><td class="description">Register-Output-Device: Register a remote service.</td></tr> |
| | 13042 | <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> |
| | 13043 | <tr><th>IPP_OP_RELEASE_JOB </th><td class="description">Release-Job: Release a job for printing</td></tr> |
| | 13044 | <tr><th>IPP_OP_RENEW_SUBSCRIPTION <span class="info"> CUPS 1.2 </span></th><td class="description">Renew-Subscription: Renew a printer subscription </td></tr> |
| | 13045 | <tr><th>IPP_OP_RESTART_JOB <span class="info"> DEPRECATED </span></th><td class="description">Restart-Job: Reprint a job </td></tr> |
| | 13046 | <tr><th>IPP_OP_RESTART_SYSTEM </th><td class="description">Restart-System: Restart all services.</td></tr> |
| | 13047 | <tr><th>IPP_OP_RESUME_ALL_PRINTERS </th><td class="description">Resume-All-Printers: Start job processing on all services.</td></tr> |
| | 13048 | <tr><th>IPP_OP_RESUME_JOB </th><td class="description">Resume-Job: Resume the current job</td></tr> |
| | 13049 | <tr><th>IPP_OP_RESUME_PRINTER </th><td class="description">Resume-Printer: Start a printer</td></tr> |
| | 13050 | <tr><th>IPP_OP_SCHEDULE_JOB_AFTER </th><td class="description">Schedule-Job-After: Schedule a job to print after another</td></tr> |
| | 13051 | <tr><th>IPP_OP_SEND_DOCUMENT </th><td class="description">Send-Document: Add a file to a job</td></tr> |
| | 13052 | <tr><th>IPP_OP_SEND_RESOURCE_DATA </th><td class="description">Send-Resource-Data: Upload the data for a resource.</td></tr> |
| | 13053 | <tr><th>IPP_OP_SET_JOB_ATTRIBUTES </th><td class="description">Set-Job-Attributes: Set job values</td></tr> |
| | 13054 | <tr><th>IPP_OP_SET_PRINTER_ATTRIBUTES </th><td class="description">Set-Printer-Attributes: Set printer values</td></tr> |
| | 13055 | <tr><th>IPP_OP_SET_RESOURCE_ATTRIBUTES </th><td class="description">Set-Resource-Attributes: Set resource object attributes.</td></tr> |
| | 13056 | <tr><th>IPP_OP_SET_SYSTEM_ATTRIBUTES </th><td class="description">Set-System-Attributes: Set system object attributes.</td></tr> |
| | 13057 | <tr><th>IPP_OP_SHUTDOWN_ALL_PRINTERS </th><td class="description">Shutdown-All-Printers: Shutdown all services.</td></tr> |
| | 13058 | <tr><th>IPP_OP_SHUTDOWN_ONE_PRINTER </th><td class="description">Shutdown-One-Printer: Shutdown a service.</td></tr> |
| | 13059 | <tr><th>IPP_OP_STARTUP_ALL_PRINTERS </th><td class="description">Startup-All-Printers: Startup all services.</td></tr> |
| | 13060 | <tr><th>IPP_OP_STARTUP_ONE_PRINTER </th><td class="description">Startup-One-Printer: Start a service.</td></tr> |
| | 13061 | <tr><th>IPP_OP_SUSPEND_CURRENT_JOB </th><td class="description">Suspend-Current-Job: Suspend the current job</td></tr> |
| | 13062 | <tr><th>IPP_OP_VALIDATE_JOB </th><td class="description">Validate-Job: Validate job values prior to submission</td></tr> |
| | 13063 | </tbody></table> |
| | 13064 | <h3 class="enumeration"><a id="ipp_orient_e">ipp_orient_e</a></h3> |
| | 13065 | <p class="description">Orientation values</p> |
| | 13066 | <h4 class="constants">Constants</h4> |
| | 13067 | <table class="list"><tbody> |
| | 13068 | <tr><th>IPP_ORIENT_LANDSCAPE </th><td class="description">90 degrees counter-clockwise</td></tr> |
| | 13069 | <tr><th>IPP_ORIENT_NONE </th><td class="description">No rotation</td></tr> |
| | 13070 | <tr><th>IPP_ORIENT_PORTRAIT </th><td class="description">No rotation</td></tr> |
| | 13071 | <tr><th>IPP_ORIENT_REVERSE_LANDSCAPE </th><td class="description">90 degrees clockwise</td></tr> |
| | 13072 | <tr><th>IPP_ORIENT_REVERSE_PORTRAIT </th><td class="description">180 degrees</td></tr> |
| | 13073 | </tbody></table> |
| | 13074 | <h3 class="enumeration"><a id="ipp_pstate_e">ipp_pstate_e</a></h3> |
| | 13075 | <p class="description">Printer state values</p> |
| | 13076 | <h4 class="constants">Constants</h4> |
| | 13077 | <table class="list"><tbody> |
| | 13078 | <tr><th>IPP_PSTATE_IDLE </th><td class="description">Printer is idle</td></tr> |
| | 13079 | <tr><th>IPP_PSTATE_PROCESSING </th><td class="description">Printer is working</td></tr> |
| | 13080 | <tr><th>IPP_PSTATE_STOPPED </th><td class="description">Printer is stopped</td></tr> |
| | 13081 | </tbody></table> |
| | 13082 | <h3 class="enumeration"><a id="ipp_quality_e">ipp_quality_e</a></h3> |
| | 13083 | <p class="description">Print quality values</p> |
| | 13084 | <h4 class="constants">Constants</h4> |
| | 13085 | <table class="list"><tbody> |
| | 13086 | <tr><th>IPP_QUALITY_DRAFT </th><td class="description">Draft quality</td></tr> |
| | 13087 | <tr><th>IPP_QUALITY_HIGH </th><td class="description">High quality</td></tr> |
| | 13088 | <tr><th>IPP_QUALITY_NORMAL </th><td class="description">Normal quality</td></tr> |
| | 13089 | </tbody></table> |
| | 13090 | <h3 class="enumeration"><a id="ipp_res_e">ipp_res_e</a></h3> |
| | 13091 | <p class="description">Resolution units</p> |
| | 13092 | <h4 class="constants">Constants</h4> |
| | 13093 | <table class="list"><tbody> |
| | 13094 | <tr><th>IPP_RES_PER_CM </th><td class="description">Pixels per centimeter</td></tr> |
| | 13095 | <tr><th>IPP_RES_PER_INCH </th><td class="description">Pixels per inch</td></tr> |
| | 13096 | </tbody></table> |
| | 13097 | <h3 class="enumeration"><a id="ipp_rstate_e">ipp_rstate_e</a></h3> |
| | 13098 | <p class="description">resource-state values</p> |
| | 13099 | <h4 class="constants">Constants</h4> |
| | 13100 | <table class="list"><tbody> |
| | 13101 | <tr><th>IPP_RSTATE_ABORTED </th><td class="description">Resource has been aborted and is pending deletion.</td></tr> |
| | 13102 | <tr><th>IPP_RSTATE_AVAILABLE </th><td class="description">Resource is available for installation.</td></tr> |
| | 13103 | <tr><th>IPP_RSTATE_CANCELED </th><td class="description">Resource has been canceled and is pending deletion.</td></tr> |
| | 13104 | <tr><th>IPP_RSTATE_INSTALLED </th><td class="description">Resource is installed.</td></tr> |
| | 13105 | <tr><th>IPP_RSTATE_PENDING </th><td class="description">Resource is created but has no data yet.</td></tr> |
| | 13106 | </tbody></table> |
| | 13107 | <h3 class="enumeration"><a id="ipp_sstate_e">ipp_sstate_e</a></h3> |
| | 13108 | <p class="description">system-state values</p> |
| | 13109 | <h4 class="constants">Constants</h4> |
| | 13110 | <table class="list"><tbody> |
| | 13111 | <tr><th>IPP_SSTATE_IDLE </th><td class="description">At least one printer is idle and none are processing a job.</td></tr> |
| | 13112 | <tr><th>IPP_SSTATE_PROCESSING </th><td class="description">At least one printer is processing a job.</td></tr> |
| | 13113 | <tr><th>IPP_SSTATE_STOPPED </th><td class="description">All printers are stopped.</td></tr> |
| | 13114 | </tbody></table> |
| | 13115 | <h3 class="enumeration"><a id="ipp_state_e">ipp_state_e</a></h3> |
| | 13116 | <p class="description">ipp_t state values</p> |
| | 13117 | <h4 class="constants">Constants</h4> |
| | 13118 | <table class="list"><tbody> |
| | 13119 | <tr><th>IPP_STATE_ATTRIBUTE </th><td class="description">One or more attributes need to be sent/received</td></tr> |
| | 13120 | <tr><th>IPP_STATE_DATA </th><td class="description">IPP request data needs to be sent/received</td></tr> |
| | 13121 | <tr><th>IPP_STATE_ERROR </th><td class="description">An error occurred</td></tr> |
| | 13122 | <tr><th>IPP_STATE_HEADER </th><td class="description">The request header needs to be sent/received</td></tr> |
| | 13123 | <tr><th>IPP_STATE_IDLE </th><td class="description">Nothing is happening/request completed</td></tr> |
| | 13124 | </tbody></table> |
| | 13125 | <h3 class="enumeration"><a id="ipp_status_e">ipp_status_e</a></h3> |
| | 13126 | <p class="description">IPP status code values</p> |
| | 13127 | <h4 class="constants">Constants</h4> |
| | 13128 | <table class="list"><tbody> |
| | 13129 | <tr><th>IPP_STATUS_CUPS_INVALID </th><td class="description">Invalid status name for <a href="#ippErrorValue"><code>ippErrorValue</code></a></td></tr> |
| | 13130 | <tr><th>IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED </th><td class="description">client-error-account-authorization-failed</td></tr> |
| | 13131 | <tr><th>IPP_STATUS_ERROR_ACCOUNT_CLOSED </th><td class="description">client-error-account-closed</td></tr> |
| | 13132 | <tr><th>IPP_STATUS_ERROR_ACCOUNT_INFO_NEEDED </th><td class="description">client-error-account-info-needed</td></tr> |
| | 13133 | <tr><th>IPP_STATUS_ERROR_ACCOUNT_LIMIT_REACHED </th><td class="description">client-error-account-limit-reached</td></tr> |
| | 13134 | <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE </th><td class="description">client-error-attributes-not-settable</td></tr> |
| | 13135 | <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES </th><td class="description">client-error-attributes-or-values-not-supported</td></tr> |
| | 13136 | <tr><th>IPP_STATUS_ERROR_BAD_REQUEST </th><td class="description">client-error-bad-request</td></tr> |
| | 13137 | <tr><th>IPP_STATUS_ERROR_BUSY </th><td class="description">server-error-busy</td></tr> |
| | 13138 | <tr><th>IPP_STATUS_ERROR_CHARSET </th><td class="description">client-error-charset-not-supported</td></tr> |
| | 13139 | <tr><th>IPP_STATUS_ERROR_COMPRESSION_ERROR </th><td class="description">client-error-compression-error</td></tr> |
| | 13140 | <tr><th>IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED </th><td class="description">client-error-compression-not-supported</td></tr> |
| | 13141 | <tr><th>IPP_STATUS_ERROR_CONFLICTING </th><td class="description">client-error-conflicting-attributes</td></tr> |
| | 13142 | <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED <span class="info"> DEPRECATED </span></th><td class="description">cups-error-account-authorization-failed </td></tr> |
| | 13143 | <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED </th><td class="description">cups-error-account-closed @deprecate@</td></tr> |
| | 13144 | <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED <span class="info"> DEPRECATED </span></th><td class="description">cups-error-account-info-needed </td></tr> |
| | 13145 | <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED <span class="info"> DEPRECATED </span></th><td class="description">cups-error-account-limit-reached </td></tr> |
| | 13146 | <tr><th>IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED <span class="info"> CUPS 1.5 </span></th><td class="description">cups-authentication-canceled - Authentication canceled by user </td></tr> |
| | 13147 | <tr><th>IPP_STATUS_ERROR_CUPS_OAUTH </th><td class="description">cups-oauth - OAuth error</td></tr> |
| | 13148 | <tr><th>IPP_STATUS_ERROR_CUPS_PKI <span class="info"> CUPS 1.5 </span></th><td class="description">cups-pki-error - Error negotiating a secure connection </td></tr> |
| | 13149 | <tr><th>IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED <span class="info"> CUPS 1.5 </span></th><td class="description">cups-upgrade-required - TLS upgrade required </td></tr> |
| | 13150 | <tr><th>IPP_STATUS_ERROR_DEVICE </th><td class="description">server-error-device-error</td></tr> |
| | 13151 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_ACCESS </th><td class="description">client-error-document-access-error</td></tr> |
| | 13152 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR </th><td class="description">client-error-document-format-error</td></tr> |
| | 13153 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED </th><td class="description">client-error-document-format-not-supported</td></tr> |
| | 13154 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_PASSWORD </th><td class="description">client-error-document-password-error</td></tr> |
| | 13155 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_PERMISSION </th><td class="description">client-error-document-permission-error</td></tr> |
| | 13156 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_SECURITY </th><td class="description">client-error-document-security-error</td></tr> |
| | 13157 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE </th><td class="description">client-error-document-unprintable-error</td></tr> |
| | 13158 | <tr><th>IPP_STATUS_ERROR_FORBIDDEN </th><td class="description">client-error-forbidden</td></tr> |
| | 13159 | <tr><th>IPP_STATUS_ERROR_GONE </th><td class="description">client-error-gone</td></tr> |
| | 13160 | <tr><th>IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS </th><td class="description">client-error-ignored-all-subscriptions</td></tr> |
| | 13161 | <tr><th>IPP_STATUS_ERROR_INTERNAL </th><td class="description">server-error-internal-error</td></tr> |
| | 13162 | <tr><th>IPP_STATUS_ERROR_JOB_CANCELED </th><td class="description">server-error-job-canceled</td></tr> |
| | 13163 | <tr><th>IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED </th><td class="description">server-error-multiple-document-jobs-not-supported</td></tr> |
| | 13164 | <tr><th>IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS </th><td class="description">server-error-not-accepting-jobs</td></tr> |
| | 13165 | <tr><th>IPP_STATUS_ERROR_NOT_AUTHENTICATED </th><td class="description">client-error-not-authenticated</td></tr> |
| | 13166 | <tr><th>IPP_STATUS_ERROR_NOT_AUTHORIZED </th><td class="description">client-error-not-authorized</td></tr> |
| | 13167 | <tr><th>IPP_STATUS_ERROR_NOT_FETCHABLE </th><td class="description">client-error-not-fetchable</td></tr> |
| | 13168 | <tr><th>IPP_STATUS_ERROR_NOT_FOUND </th><td class="description">client-error-not-found</td></tr> |
| | 13169 | <tr><th>IPP_STATUS_ERROR_NOT_POSSIBLE </th><td class="description">client-error-not-possible</td></tr> |
| | 13170 | <tr><th>IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED </th><td class="description">server-error-operation-not-supported</td></tr> |
| | 13171 | <tr><th>IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED </th><td class="description">server-error-printer-is-deactivated</td></tr> |
| | 13172 | <tr><th>IPP_STATUS_ERROR_REQUEST_ENTITY </th><td class="description">client-error-request-entity-too-large</td></tr> |
| | 13173 | <tr><th>IPP_STATUS_ERROR_REQUEST_VALUE </th><td class="description">client-error-request-value-too-long</td></tr> |
| | 13174 | <tr><th>IPP_STATUS_ERROR_SERVICE_UNAVAILABLE </th><td class="description">server-error-service-unavailable</td></tr> |
| | 13175 | <tr><th>IPP_STATUS_ERROR_TEMPORARY </th><td class="description">server-error-temporary-error</td></tr> |
| | 13176 | <tr><th>IPP_STATUS_ERROR_TIMEOUT </th><td class="description">client-error-timeout</td></tr> |
| | 13177 | <tr><th>IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS </th><td class="description">server-error-too-many-documents</td></tr> |
| | 13178 | <tr><th>IPP_STATUS_ERROR_TOO_MANY_JOBS </th><td class="description">server-error-too-many-jobs</td></tr> |
| | 13179 | <tr><th>IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS </th><td class="description">client-error-too-many-subscriptions</td></tr> |
| | 13180 | <tr><th>IPP_STATUS_ERROR_URI_SCHEME </th><td class="description">client-error-uri-scheme-not-supported</td></tr> |
| | 13181 | <tr><th>IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED </th><td class="description">server-error-version-not-supported</td></tr> |
| | 13182 | <tr><th>IPP_STATUS_OK </th><td class="description">successful-ok</td></tr> |
| | 13183 | <tr><th>IPP_STATUS_OK_CONFLICTING </th><td class="description">successful-ok-conflicting-attributes</td></tr> |
| | 13184 | <tr><th>IPP_STATUS_OK_EVENTS_COMPLETE </th><td class="description">successful-ok-events-complete</td></tr> |
| | 13185 | <tr><th>IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED </th><td class="description">successful-ok-ignored-or-substituted-attributes</td></tr> |
| | 13186 | <tr><th>IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS </th><td class="description">successful-ok-ignored-subscriptions</td></tr> |
| | 13187 | <tr><th>IPP_STATUS_OK_TOO_MANY_EVENTS </th><td class="description">successful-ok-too-many-events</td></tr> |
| | 13188 | </tbody></table> |
| | 13189 | <h3 class="enumeration"><a id="ipp_tag_e">ipp_tag_e</a></h3> |
| | 13190 | <p class="description">Value and group tag values for attributes</p> |
| | 13191 | <h4 class="constants">Constants</h4> |
| | 13192 | <table class="list"><tbody> |
| | 13193 | <tr><th>IPP_TAG_ADMINDEFINE </th><td class="description">Admin-defined value</td></tr> |
| | 13194 | <tr><th>IPP_TAG_BOOLEAN </th><td class="description">Boolean value</td></tr> |
| | 13195 | <tr><th>IPP_TAG_CHARSET </th><td class="description">Character set value</td></tr> |
| | 13196 | <tr><th>IPP_TAG_CUPS_INVALID </th><td class="description">Invalid tag name for <a href="#ippTagValue"><code>ippTagValue</code></a></td></tr> |
| | 13197 | <tr><th>IPP_TAG_DATE </th><td class="description">Date/time value</td></tr> |
| | 13198 | <tr><th>IPP_TAG_DEFAULT </th><td class="description">Default value</td></tr> |
| | 13199 | <tr><th>IPP_TAG_DELETEATTR </th><td class="description">Delete-attribute value</td></tr> |
| | 13200 | <tr><th>IPP_TAG_DOCUMENT </th><td class="description">Document group</td></tr> |
| | 13201 | <tr><th>IPP_TAG_END </th><td class="description">End-of-attributes</td></tr> |
| | 13202 | <tr><th>IPP_TAG_ENUM </th><td class="description">Enumeration value</td></tr> |
| | 13203 | <tr><th>IPP_TAG_EVENT_NOTIFICATION </th><td class="description">Event group</td></tr> |
| | 13204 | <tr><th>IPP_TAG_EXTENSION </th><td class="description">Extension point for 32-bit tags (part of value)</td></tr> |
| | 13205 | <tr><th>IPP_TAG_INTEGER </th><td class="description">Integer value</td></tr> |
| | 13206 | <tr><th>IPP_TAG_JOB </th><td class="description">Job group</td></tr> |
| | 13207 | <tr><th>IPP_TAG_KEYWORD </th><td class="description">Keyword value</td></tr> |
| | 13208 | <tr><th>IPP_TAG_LANGUAGE </th><td class="description">Language value</td></tr> |
| | 13209 | <tr><th>IPP_TAG_MIMETYPE </th><td class="description">MIME media type value</td></tr> |
| | 13210 | <tr><th>IPP_TAG_NAME </th><td class="description">Name value</td></tr> |
| | 13211 | <tr><th>IPP_TAG_NAMELANG </th><td class="description">Name-with-language value</td></tr> |
| | 13212 | <tr><th>IPP_TAG_NOTSETTABLE </th><td class="description">Not-settable value</td></tr> |
| | 13213 | <tr><th>IPP_TAG_NOVALUE </th><td class="description">No-value value</td></tr> |
| | 13214 | <tr><th>IPP_TAG_OPERATION </th><td class="description">Operation group</td></tr> |
| | 13215 | <tr><th>IPP_TAG_PRINTER </th><td class="description">Printer group</td></tr> |
| | 13216 | <tr><th>IPP_TAG_RANGE </th><td class="description">Range value</td></tr> |
| | 13217 | <tr><th>IPP_TAG_RESOLUTION </th><td class="description">Resolution value</td></tr> |
| | 13218 | <tr><th>IPP_TAG_RESOURCE </th><td class="description">Resource group</td></tr> |
| | 13219 | <tr><th>IPP_TAG_STRING </th><td class="description">Octet string value</td></tr> |
| | 13220 | <tr><th>IPP_TAG_SUBSCRIPTION </th><td class="description">Subscription group</td></tr> |
| | 13221 | <tr><th>IPP_TAG_SYSTEM </th><td class="description">System group</td></tr> |
| | 13222 | <tr><th>IPP_TAG_TEXT </th><td class="description">Text value</td></tr> |
| | 13223 | <tr><th>IPP_TAG_TEXTLANG </th><td class="description">Text-with-language value</td></tr> |
| | 13224 | <tr><th>IPP_TAG_UNKNOWN </th><td class="description">Unknown value</td></tr> |
| | 13225 | <tr><th>IPP_TAG_UNSUPPORTED_GROUP </th><td class="description">Unsupported attributes group</td></tr> |
| | 13226 | <tr><th>IPP_TAG_UNSUPPORTED_VALUE </th><td class="description">Unsupported value</td></tr> |
| | 13227 | <tr><th>IPP_TAG_URI </th><td class="description">URI value</td></tr> |
| | 13228 | <tr><th>IPP_TAG_URISCHEME </th><td class="description">URI scheme value</td></tr> |
| | 13229 | <tr><th>IPP_TAG_ZERO </th><td class="description">Zero tag - used for separators</td></tr> |
| | 13230 | </tbody></table> |
| | 13231 | </div> |
| | 13232 | </body> |
| | 13233 | </html> |
projects / thirdparty / cups.git / blame_incremental