]>
Commit | Line | Data |
---|---|---|
73721e3e | 1 | <!DOCTYPE html> |
798d6e29 MS |
2 | <html> |
3 | <!-- SECTION: Programming --> | |
4 | <head> | |
5 | <title>CUPS Programming Manual</title> | |
6 | <meta name="keywords" content="Programming"> | |
7 | <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> | |
73721e3e | 8 | <meta name="creator" content="codedoc v3.1"> |
798d6e29 | 9 | <meta name="author" content="Michael R Sweet"> |
73721e3e | 10 | <meta name="copyright" content="Copyright © 2007-2019 by Apple Inc. All Rights Reserved."> |
ddf2ec73 | 11 | <meta name="version" content="2.3.0"> |
798d6e29 MS |
12 | <style type="text/css"><!-- |
13 | body, p, h1, h2, h3, h4 { | |
14 | font-family: sans-serif; | |
15 | } | |
16 | div.body h1 { | |
17 | font-size: 250%; | |
18 | font-weight: bold; | |
19 | margin: 0; | |
20 | } | |
21 | div.body h2 { | |
22 | font-size: 250%; | |
23 | margin-top: 1.5em; | |
24 | } | |
25 | div.body h3 { | |
26 | font-size: 150%; | |
27 | margin-bottom: 0.5em; | |
28 | margin-top: 1.5em; | |
29 | } | |
30 | div.body h4 { | |
31 | font-size: 110%; | |
32 | margin-bottom: 0.5em; | |
33 | margin-top: 1.5em; | |
34 | } | |
35 | div.body h5 { | |
36 | font-size: 100%; | |
37 | margin-bottom: 0.5em; | |
38 | margin-top: 1.5em; | |
39 | } | |
40 | div.contents { | |
41 | background: #e8e8e8; | |
42 | border: solid thin black; | |
43 | padding: 10px; | |
44 | } | |
45 | div.contents h1 { | |
46 | font-size: 110%; | |
47 | } | |
48 | div.contents h2 { | |
49 | font-size: 100%; | |
50 | } | |
51 | div.contents ul.contents { | |
52 | font-size: 80%; | |
53 | } | |
54 | .class { | |
55 | border-bottom: solid 2px gray; | |
56 | } | |
57 | .constants { | |
58 | } | |
59 | .description { | |
60 | margin-top: 0.5em; | |
61 | } | |
62 | .discussion { | |
63 | } | |
64 | .enumeration { | |
65 | border-bottom: solid 2px gray; | |
66 | } | |
67 | .function { | |
68 | border-bottom: solid 2px gray; | |
69 | margin-bottom: 0; | |
70 | } | |
71 | .members { | |
72 | } | |
73 | .method { | |
74 | } | |
75 | .parameters { | |
76 | } | |
77 | .returnvalue { | |
78 | } | |
79 | .struct { | |
80 | border-bottom: solid 2px gray; | |
81 | } | |
82 | .typedef { | |
83 | border-bottom: solid 2px gray; | |
84 | } | |
85 | .union { | |
86 | border-bottom: solid 2px gray; | |
87 | } | |
88 | .variable { | |
89 | } | |
9c44e2cb MS |
90 | h1, h2, h3, h4, h5, h6 { |
91 | page-break-inside: avoid; | |
92 | } | |
798d6e29 MS |
93 | blockquote { |
94 | border: solid thin gray; | |
95 | box-shadow: 3px 3px 5px rgba(0,0,0,0.5); | |
96 | padding: 0px 10px; | |
97 | page-break-inside: avoid; | |
98 | } | |
99 | p code, li code, p.code, pre, ul.code li { | |
100 | background: rgba(127,127,127,0.1); | |
101 | border: thin dotted gray; | |
102 | font-family: monospace; | |
103 | font-size: 90%; | |
104 | hyphens: manual; | |
105 | -webkit-hyphens: manual; | |
106 | page-break-inside: avoid; | |
107 | } | |
108 | p.code, pre, ul.code li { | |
109 | padding: 10px; | |
110 | } | |
111 | p code, li code { | |
112 | padding: 2px 5px; | |
113 | } | |
114 | a:link, a:visited { | |
115 | text-decoration: none; | |
116 | } | |
117 | span.info { | |
118 | background: black; | |
119 | border: solid thin black; | |
120 | color: white; | |
121 | font-size: 80%; | |
122 | font-style: italic; | |
123 | font-weight: bold; | |
124 | white-space: nowrap; | |
125 | } | |
126 | h3 span.info, h4 span.info { | |
98d88c8d MS |
127 | border-top-left-radius: 10px; |
128 | border-top-right-radius: 10px; | |
798d6e29 | 129 | float: right; |
98d88c8d | 130 | padding: 3px 6px; |
798d6e29 MS |
131 | } |
132 | ul.code, ul.contents, ul.subcontents { | |
133 | list-style-type: none; | |
134 | margin: 0; | |
135 | padding-left: 0; | |
136 | } | |
137 | ul.code li { | |
138 | margin: 0; | |
139 | } | |
140 | ul.contents > li { | |
141 | margin-top: 1em; | |
142 | } | |
143 | ul.contents li ul.code, ul.contents li ul.subcontents { | |
144 | padding-left: 2em; | |
145 | } | |
98d88c8d MS |
146 | table.list { |
147 | border-collapse: collapse; | |
148 | width: 100%; | |
798d6e29 | 149 | } |
98d88c8d MS |
150 | table.list tr:nth-child(even) { |
151 | background: rgba(127,127,127,0.1);]n} | |
152 | table.list th { | |
153 | border-right: 2px solid gray; | |
154 | font-family: monospace; | |
155 | padding: 5px 10px 5px 2px; | |
156 | text-align: right; | |
157 | vertical-align: top; | |
798d6e29 | 158 | } |
98d88c8d MS |
159 | table.list td { |
160 | padding: 5px 2px 5px 10px; | |
161 | text-align: left; | |
162 | vertical-align: top; | |
798d6e29 MS |
163 | } |
164 | h1.title { | |
165 | } | |
166 | h2.title { | |
167 | border-bottom: solid 2px black; | |
168 | } | |
169 | h3.title { | |
170 | border-bottom: solid 2px black; | |
171 | } | |
172 | --></style> | |
173 | </head> | |
174 | <body> | |
175 | <h1 class="title">CUPS Programming Manual</h1> | |
176 | <p>Michael R Sweet</p> | |
73721e3e | 177 | <p>Copyright © 2007-2019 by Apple Inc. All Rights Reserved.</p> |
798d6e29 MS |
178 | <div class="contents"> |
179 | <h2 class="title">Contents</h2> | |
180 | <ul class="contents"> | |
53af7f21 MS |
181 | <li><a href="#introduction">Introduction</a><ul class="subcontents"> |
182 | <li><a href="#guidelines">Guidelines</a></li> | |
183 | <li><a href="#terms-used-in-this-document">Terms Used in This Document</a></li> | |
184 | <li><a href="#compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></li> | |
798d6e29 | 185 | </ul></li> |
53af7f21 MS |
186 | <li><a href="#working-with-destinations">Working with Destinations</a><ul class="subcontents"> |
187 | <li><a href="#finding-available-destinations">Finding Available Destinations</a></li> | |
188 | <li><a href="#basic-destination-information">Basic Destination Information</a></li> | |
189 | <li><a href="#detailed-destination-information">Detailed Destination Information</a></li> | |
190 | <li><a href="#submitting-a-print-job">Submitting a Print Job</a></li> | |
798d6e29 | 191 | </ul></li> |
b0fb2d75 MS |
192 | <li><a href="#sending-ipp-requests">Sending IPP Requests</a><ul class="subcontents"> |
193 | <li><a href="#connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</a></li> | |
194 | <li><a href="#creating-an-ipp-request">Creating an IPP Request</a></li> | |
195 | <li><a href="#sending-the-ipp-request">Sending the IPP Request</a></li> | |
196 | <li><a href="#processing-the-ipp-response">Processing the IPP Response</a></li> | |
197 | <li><a href="#authentication">Authentication</a></li> | |
198 | </ul></li> | |
798d6e29 | 199 | <li><a href="#FUNCTIONS">Functions</a><ul class="subcontents"> |
73721e3e | 200 | <li><a href="#CF_OPTIONS">CF_OPTIONS</a></li> |
798d6e29 | 201 | <li><a href="#cupsAddDest">cupsAddDest</a></li> |
63b75fbe | 202 | <li><a href="#cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></li> |
53af7f21 | 203 | <li><a href="#cupsAddIntegerOption">cupsAddIntegerOption</a></li> |
798d6e29 | 204 | <li><a href="#cupsAddOption">cupsAddOption</a></li> |
798d6e29 | 205 | <li><a href="#cupsCancelDestJob">cupsCancelDestJob</a></li> |
798d6e29 MS |
206 | <li><a href="#cupsCheckDestSupported">cupsCheckDestSupported</a></li> |
207 | <li><a href="#cupsCloseDestJob">cupsCloseDestJob</a></li> | |
208 | <li><a href="#cupsConnectDest">cupsConnectDest</a></li> | |
798d6e29 MS |
209 | <li><a href="#cupsCopyDest">cupsCopyDest</a></li> |
210 | <li><a href="#cupsCopyDestConflicts">cupsCopyDestConflicts</a></li> | |
211 | <li><a href="#cupsCopyDestInfo">cupsCopyDestInfo</a></li> | |
212 | <li><a href="#cupsCreateDestJob">cupsCreateDestJob</a></li> | |
798d6e29 | 213 | <li><a href="#cupsDoAuthentication">cupsDoAuthentication</a></li> |
ddf2ec73 | 214 | <li><a href="#cupsEncodeOption">cupsEncodeOption</a></li> |
798d6e29 MS |
215 | <li><a href="#cupsEncodeOptions">cupsEncodeOptions</a></li> |
216 | <li><a href="#cupsEncodeOptions2">cupsEncodeOptions2</a></li> | |
217 | <li><a href="#cupsEncryption">cupsEncryption</a></li> | |
218 | <li><a href="#cupsEnumDests">cupsEnumDests</a></li> | |
798d6e29 MS |
219 | <li><a href="#cupsFindDestDefault">cupsFindDestDefault</a></li> |
220 | <li><a href="#cupsFindDestReady">cupsFindDestReady</a></li> | |
221 | <li><a href="#cupsFindDestSupported">cupsFindDestSupported</a></li> | |
222 | <li><a href="#cupsFinishDestDocument">cupsFinishDestDocument</a></li> | |
798d6e29 MS |
223 | <li><a href="#cupsFreeDestInfo">cupsFreeDestInfo</a></li> |
224 | <li><a href="#cupsFreeDests">cupsFreeDests</a></li> | |
225 | <li><a href="#cupsFreeJobs">cupsFreeJobs</a></li> | |
226 | <li><a href="#cupsFreeOptions">cupsFreeOptions</a></li> | |
798d6e29 MS |
227 | <li><a href="#cupsGetDest">cupsGetDest</a></li> |
228 | <li><a href="#cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></li> | |
229 | <li><a href="#cupsGetDestMediaByName">cupsGetDestMediaByName</a></li> | |
230 | <li><a href="#cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></li> | |
231 | <li><a href="#cupsGetDestMediaCount">cupsGetDestMediaCount</a></li> | |
232 | <li><a href="#cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></li> | |
233 | <li><a href="#cupsGetDestWithURI">cupsGetDestWithURI</a></li> | |
98d88c8d | 234 | <li><a href="#cupsGetDests2">cupsGetDests2</a></li> |
53af7f21 | 235 | <li><a href="#cupsGetIntegerOption">cupsGetIntegerOption</a></li> |
798d6e29 MS |
236 | <li><a href="#cupsGetJobs2">cupsGetJobs2</a></li> |
237 | <li><a href="#cupsGetNamedDest">cupsGetNamedDest</a></li> | |
238 | <li><a href="#cupsGetOption">cupsGetOption</a></li> | |
798d6e29 | 239 | <li><a href="#cupsGetPassword2">cupsGetPassword2</a></li> |
798d6e29 MS |
240 | <li><a href="#cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></li> |
241 | <li><a href="#cupsLocalizeDestOption">cupsLocalizeDestOption</a></li> | |
242 | <li><a href="#cupsLocalizeDestValue">cupsLocalizeDestValue</a></li> | |
243 | <li><a href="#cupsMakeServerCredentials">cupsMakeServerCredentials</a></li> | |
798d6e29 | 244 | <li><a href="#cupsParseOptions">cupsParseOptions</a></li> |
798d6e29 MS |
245 | <li><a href="#cupsRemoveDest">cupsRemoveDest</a></li> |
246 | <li><a href="#cupsRemoveOption">cupsRemoveOption</a></li> | |
247 | <li><a href="#cupsServer">cupsServer</a></li> | |
248 | <li><a href="#cupsSetClientCertCB">cupsSetClientCertCB</a></li> | |
249 | <li><a href="#cupsSetCredentials">cupsSetCredentials</a></li> | |
250 | <li><a href="#cupsSetDefaultDest">cupsSetDefaultDest</a></li> | |
798d6e29 MS |
251 | <li><a href="#cupsSetDests2">cupsSetDests2</a></li> |
252 | <li><a href="#cupsSetEncryption">cupsSetEncryption</a></li> | |
798d6e29 MS |
253 | <li><a href="#cupsSetPasswordCB2">cupsSetPasswordCB2</a></li> |
254 | <li><a href="#cupsSetServer">cupsSetServer</a></li> | |
255 | <li><a href="#cupsSetServerCertCB">cupsSetServerCertCB</a></li> | |
256 | <li><a href="#cupsSetServerCredentials">cupsSetServerCredentials</a></li> | |
257 | <li><a href="#cupsSetUser">cupsSetUser</a></li> | |
258 | <li><a href="#cupsSetUserAgent">cupsSetUserAgent</a></li> | |
259 | <li><a href="#cupsStartDestDocument">cupsStartDestDocument</a></li> | |
798d6e29 MS |
260 | <li><a href="#cupsUser">cupsUser</a></li> |
261 | <li><a href="#cupsUserAgent">cupsUserAgent</a></li> | |
262 | <li><a href="#httpAcceptConnection">httpAcceptConnection</a></li> | |
263 | <li><a href="#httpAddCredential">httpAddCredential</a></li> | |
264 | <li><a href="#httpAddrAny">httpAddrAny</a></li> | |
265 | <li><a href="#httpAddrClose">httpAddrClose</a></li> | |
798d6e29 MS |
266 | <li><a href="#httpAddrConnect2">httpAddrConnect2</a></li> |
267 | <li><a href="#httpAddrCopyList">httpAddrCopyList</a></li> | |
268 | <li><a href="#httpAddrEqual">httpAddrEqual</a></li> | |
269 | <li><a href="#httpAddrFamily">httpAddrFamily</a></li> | |
270 | <li><a href="#httpAddrFreeList">httpAddrFreeList</a></li> | |
271 | <li><a href="#httpAddrGetList">httpAddrGetList</a></li> | |
272 | <li><a href="#httpAddrLength">httpAddrLength</a></li> | |
273 | <li><a href="#httpAddrListen">httpAddrListen</a></li> | |
274 | <li><a href="#httpAddrLocalhost">httpAddrLocalhost</a></li> | |
275 | <li><a href="#httpAddrLookup">httpAddrLookup</a></li> | |
276 | <li><a href="#httpAddrPort">httpAddrPort</a></li> | |
277 | <li><a href="#httpAddrString">httpAddrString</a></li> | |
278 | <li><a href="#httpAssembleURI">httpAssembleURI</a></li> | |
279 | <li><a href="#httpAssembleURIf">httpAssembleURIf</a></li> | |
280 | <li><a href="#httpAssembleUUID">httpAssembleUUID</a></li> | |
281 | <li><a href="#httpBlocking">httpBlocking</a></li> | |
282 | <li><a href="#httpCheck">httpCheck</a></li> | |
283 | <li><a href="#httpClearCookie">httpClearCookie</a></li> | |
284 | <li><a href="#httpClearFields">httpClearFields</a></li> | |
285 | <li><a href="#httpClose">httpClose</a></li> | |
286 | <li><a href="#httpCompareCredentials">httpCompareCredentials</a></li> | |
798d6e29 | 287 | <li><a href="#httpConnect2">httpConnect2</a></li> |
798d6e29 MS |
288 | <li><a href="#httpCopyCredentials">httpCopyCredentials</a></li> |
289 | <li><a href="#httpCredentialsAreValidForName">httpCredentialsAreValidForName</a></li> | |
290 | <li><a href="#httpCredentialsGetExpiration">httpCredentialsGetExpiration</a></li> | |
291 | <li><a href="#httpCredentialsGetTrust">httpCredentialsGetTrust</a></li> | |
292 | <li><a href="#httpCredentialsString">httpCredentialsString</a></li> | |
798d6e29 MS |
293 | <li><a href="#httpDecode64_2">httpDecode64_2</a></li> |
294 | <li><a href="#httpDelete">httpDelete</a></li> | |
798d6e29 MS |
295 | <li><a href="#httpEncode64_2">httpEncode64_2</a></li> |
296 | <li><a href="#httpEncryption">httpEncryption</a></li> | |
297 | <li><a href="#httpError">httpError</a></li> | |
298 | <li><a href="#httpFieldValue">httpFieldValue</a></li> | |
299 | <li><a href="#httpFlush">httpFlush</a></li> | |
300 | <li><a href="#httpFlushWrite">httpFlushWrite</a></li> | |
301 | <li><a href="#httpFreeCredentials">httpFreeCredentials</a></li> | |
302 | <li><a href="#httpGet">httpGet</a></li> | |
303 | <li><a href="#httpGetActivity">httpGetActivity</a></li> | |
304 | <li><a href="#httpGetAddress">httpGetAddress</a></li> | |
305 | <li><a href="#httpGetAuthString">httpGetAuthString</a></li> | |
306 | <li><a href="#httpGetBlocking">httpGetBlocking</a></li> | |
307 | <li><a href="#httpGetContentEncoding">httpGetContentEncoding</a></li> | |
308 | <li><a href="#httpGetCookie">httpGetCookie</a></li> | |
798d6e29 MS |
309 | <li><a href="#httpGetDateString2">httpGetDateString2</a></li> |
310 | <li><a href="#httpGetDateTime">httpGetDateTime</a></li> | |
311 | <li><a href="#httpGetEncryption">httpGetEncryption</a></li> | |
312 | <li><a href="#httpGetExpect">httpGetExpect</a></li> | |
313 | <li><a href="#httpGetFd">httpGetFd</a></li> | |
314 | <li><a href="#httpGetField">httpGetField</a></li> | |
798d6e29 MS |
315 | <li><a href="#httpGetHostname">httpGetHostname</a></li> |
316 | <li><a href="#httpGetKeepAlive">httpGetKeepAlive</a></li> | |
798d6e29 MS |
317 | <li><a href="#httpGetLength2">httpGetLength2</a></li> |
318 | <li><a href="#httpGetPending">httpGetPending</a></li> | |
319 | <li><a href="#httpGetReady">httpGetReady</a></li> | |
320 | <li><a href="#httpGetRemaining">httpGetRemaining</a></li> | |
321 | <li><a href="#httpGetState">httpGetState</a></li> | |
322 | <li><a href="#httpGetStatus">httpGetStatus</a></li> | |
798d6e29 MS |
323 | <li><a href="#httpGetSubField2">httpGetSubField2</a></li> |
324 | <li><a href="#httpGetVersion">httpGetVersion</a></li> | |
325 | <li><a href="#httpGets">httpGets</a></li> | |
326 | <li><a href="#httpHead">httpHead</a></li> | |
327 | <li><a href="#httpInitialize">httpInitialize</a></li> | |
328 | <li><a href="#httpIsChunked">httpIsChunked</a></li> | |
329 | <li><a href="#httpIsEncrypted">httpIsEncrypted</a></li> | |
330 | <li><a href="#httpLoadCredentials">httpLoadCredentials</a></li> | |
331 | <li><a href="#httpOptions">httpOptions</a></li> | |
332 | <li><a href="#httpPeek">httpPeek</a></li> | |
333 | <li><a href="#httpPost">httpPost</a></li> | |
334 | <li><a href="#httpPut">httpPut</a></li> | |
798d6e29 MS |
335 | <li><a href="#httpRead2">httpRead2</a></li> |
336 | <li><a href="#httpReadRequest">httpReadRequest</a></li> | |
798d6e29 MS |
337 | <li><a href="#httpReconnect2">httpReconnect2</a></li> |
338 | <li><a href="#httpResolveHostname">httpResolveHostname</a></li> | |
339 | <li><a href="#httpSaveCredentials">httpSaveCredentials</a></li> | |
798d6e29 MS |
340 | <li><a href="#httpSeparateURI">httpSeparateURI</a></li> |
341 | <li><a href="#httpSetAuthString">httpSetAuthString</a></li> | |
342 | <li><a href="#httpSetCookie">httpSetCookie</a></li> | |
343 | <li><a href="#httpSetCredentials">httpSetCredentials</a></li> | |
344 | <li><a href="#httpSetDefaultField">httpSetDefaultField</a></li> | |
345 | <li><a href="#httpSetExpect">httpSetExpect</a></li> | |
346 | <li><a href="#httpSetField">httpSetField</a></li> | |
347 | <li><a href="#httpSetKeepAlive">httpSetKeepAlive</a></li> | |
348 | <li><a href="#httpSetLength">httpSetLength</a></li> | |
349 | <li><a href="#httpSetTimeout">httpSetTimeout</a></li> | |
350 | <li><a href="#httpShutdown">httpShutdown</a></li> | |
351 | <li><a href="#httpStateString">httpStateString</a></li> | |
352 | <li><a href="#httpStatus">httpStatus</a></li> | |
798d6e29 MS |
353 | <li><a href="#httpURIStatusString">httpURIStatusString</a></li> |
354 | <li><a href="#httpUpdate">httpUpdate</a></li> | |
355 | <li><a href="#httpWait">httpWait</a></li> | |
798d6e29 MS |
356 | <li><a href="#httpWrite2">httpWrite2</a></li> |
357 | <li><a href="#httpWriteResponse">httpWriteResponse</a></li> | |
358 | <li><a href="#ippAddBoolean">ippAddBoolean</a></li> | |
359 | <li><a href="#ippAddBooleans">ippAddBooleans</a></li> | |
360 | <li><a href="#ippAddCollection">ippAddCollection</a></li> | |
361 | <li><a href="#ippAddCollections">ippAddCollections</a></li> | |
362 | <li><a href="#ippAddDate">ippAddDate</a></li> | |
363 | <li><a href="#ippAddInteger">ippAddInteger</a></li> | |
364 | <li><a href="#ippAddIntegers">ippAddIntegers</a></li> | |
365 | <li><a href="#ippAddOctetString">ippAddOctetString</a></li> | |
366 | <li><a href="#ippAddOutOfBand">ippAddOutOfBand</a></li> | |
367 | <li><a href="#ippAddRange">ippAddRange</a></li> | |
368 | <li><a href="#ippAddRanges">ippAddRanges</a></li> | |
369 | <li><a href="#ippAddResolution">ippAddResolution</a></li> | |
370 | <li><a href="#ippAddResolutions">ippAddResolutions</a></li> | |
371 | <li><a href="#ippAddSeparator">ippAddSeparator</a></li> | |
372 | <li><a href="#ippAddString">ippAddString</a></li> | |
373 | <li><a href="#ippAddStringf">ippAddStringf</a></li> | |
374 | <li><a href="#ippAddStringfv">ippAddStringfv</a></li> | |
375 | <li><a href="#ippAddStrings">ippAddStrings</a></li> | |
376 | <li><a href="#ippAttributeString">ippAttributeString</a></li> | |
377 | <li><a href="#ippContainsInteger">ippContainsInteger</a></li> | |
378 | <li><a href="#ippContainsString">ippContainsString</a></li> | |
379 | <li><a href="#ippCopyAttribute">ippCopyAttribute</a></li> | |
380 | <li><a href="#ippCopyAttributes">ippCopyAttributes</a></li> | |
381 | <li><a href="#ippCreateRequestedArray">ippCreateRequestedArray</a></li> | |
382 | <li><a href="#ippDateToTime">ippDateToTime</a></li> | |
383 | <li><a href="#ippDelete">ippDelete</a></li> | |
384 | <li><a href="#ippDeleteAttribute">ippDeleteAttribute</a></li> | |
385 | <li><a href="#ippDeleteValues">ippDeleteValues</a></li> | |
386 | <li><a href="#ippEnumString">ippEnumString</a></li> | |
387 | <li><a href="#ippEnumValue">ippEnumValue</a></li> | |
388 | <li><a href="#ippErrorString">ippErrorString</a></li> | |
389 | <li><a href="#ippErrorValue">ippErrorValue</a></li> | |
390 | <li><a href="#ippFindAttribute">ippFindAttribute</a></li> | |
391 | <li><a href="#ippFindNextAttribute">ippFindNextAttribute</a></li> | |
392 | <li><a href="#ippFirstAttribute">ippFirstAttribute</a></li> | |
393 | <li><a href="#ippGetBoolean">ippGetBoolean</a></li> | |
394 | <li><a href="#ippGetCollection">ippGetCollection</a></li> | |
395 | <li><a href="#ippGetCount">ippGetCount</a></li> | |
396 | <li><a href="#ippGetDate">ippGetDate</a></li> | |
397 | <li><a href="#ippGetGroupTag">ippGetGroupTag</a></li> | |
398 | <li><a href="#ippGetInteger">ippGetInteger</a></li> | |
399 | <li><a href="#ippGetName">ippGetName</a></li> | |
400 | <li><a href="#ippGetOctetString">ippGetOctetString</a></li> | |
401 | <li><a href="#ippGetOperation">ippGetOperation</a></li> | |
402 | <li><a href="#ippGetRange">ippGetRange</a></li> | |
403 | <li><a href="#ippGetRequestId">ippGetRequestId</a></li> | |
404 | <li><a href="#ippGetResolution">ippGetResolution</a></li> | |
405 | <li><a href="#ippGetState">ippGetState</a></li> | |
406 | <li><a href="#ippGetStatusCode">ippGetStatusCode</a></li> | |
407 | <li><a href="#ippGetString">ippGetString</a></li> | |
408 | <li><a href="#ippGetValueTag">ippGetValueTag</a></li> | |
409 | <li><a href="#ippGetVersion">ippGetVersion</a></li> | |
410 | <li><a href="#ippLength">ippLength</a></li> | |
411 | <li><a href="#ippNew">ippNew</a></li> | |
412 | <li><a href="#ippNewRequest">ippNewRequest</a></li> | |
413 | <li><a href="#ippNewResponse">ippNewResponse</a></li> | |
414 | <li><a href="#ippNextAttribute">ippNextAttribute</a></li> | |
415 | <li><a href="#ippOpString">ippOpString</a></li> | |
416 | <li><a href="#ippOpValue">ippOpValue</a></li> | |
417 | <li><a href="#ippPort">ippPort</a></li> | |
418 | <li><a href="#ippRead">ippRead</a></li> | |
419 | <li><a href="#ippReadFile">ippReadFile</a></li> | |
420 | <li><a href="#ippReadIO">ippReadIO</a></li> | |
421 | <li><a href="#ippSetBoolean">ippSetBoolean</a></li> | |
422 | <li><a href="#ippSetCollection">ippSetCollection</a></li> | |
423 | <li><a href="#ippSetDate">ippSetDate</a></li> | |
424 | <li><a href="#ippSetGroupTag">ippSetGroupTag</a></li> | |
425 | <li><a href="#ippSetInteger">ippSetInteger</a></li> | |
426 | <li><a href="#ippSetName">ippSetName</a></li> | |
427 | <li><a href="#ippSetOctetString">ippSetOctetString</a></li> | |
428 | <li><a href="#ippSetOperation">ippSetOperation</a></li> | |
429 | <li><a href="#ippSetPort">ippSetPort</a></li> | |
430 | <li><a href="#ippSetRange">ippSetRange</a></li> | |
431 | <li><a href="#ippSetRequestId">ippSetRequestId</a></li> | |
432 | <li><a href="#ippSetResolution">ippSetResolution</a></li> | |
433 | <li><a href="#ippSetState">ippSetState</a></li> | |
434 | <li><a href="#ippSetStatusCode">ippSetStatusCode</a></li> | |
435 | <li><a href="#ippSetString">ippSetString</a></li> | |
436 | <li><a href="#ippSetStringf">ippSetStringf</a></li> | |
437 | <li><a href="#ippSetStringfv">ippSetStringfv</a></li> | |
438 | <li><a href="#ippSetValueTag">ippSetValueTag</a></li> | |
439 | <li><a href="#ippSetVersion">ippSetVersion</a></li> | |
440 | <li><a href="#ippStateString">ippStateString</a></li> | |
441 | <li><a href="#ippTagString">ippTagString</a></li> | |
442 | <li><a href="#ippTagValue">ippTagValue</a></li> | |
443 | <li><a href="#ippTimeToDate">ippTimeToDate</a></li> | |
444 | <li><a href="#ippValidateAttribute">ippValidateAttribute</a></li> | |
445 | <li><a href="#ippValidateAttributes">ippValidateAttributes</a></li> | |
446 | <li><a href="#ippWrite">ippWrite</a></li> | |
447 | <li><a href="#ippWriteFile">ippWriteFile</a></li> | |
448 | <li><a href="#ippWriteIO">ippWriteIO</a></li> | |
798d6e29 MS |
449 | </ul></li> |
450 | <li><a href="#TYPES">Data Types</a><ul class="subcontents"> | |
798d6e29 | 451 | <li><a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a></li> |
798d6e29 MS |
452 | <li><a href="#cups_dest_cb_t">cups_dest_cb_t</a></li> |
453 | <li><a href="#cups_dest_t">cups_dest_t</a></li> | |
454 | <li><a href="#cups_dinfo_t">cups_dinfo_t</a></li> | |
798d6e29 | 455 | <li><a href="#cups_job_t">cups_job_t</a></li> |
798d6e29 MS |
456 | <li><a href="#cups_option_t">cups_option_t</a></li> |
457 | <li><a href="#cups_password_cb2_t">cups_password_cb2_t</a></li> | |
798d6e29 MS |
458 | <li><a href="#cups_ptype_t">cups_ptype_t</a></li> |
459 | <li><a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a></li> | |
460 | <li><a href="#cups_size_t">cups_size_t</a></li> | |
798d6e29 | 461 | <li><a href="#http_addr_t">http_addr_t</a></li> |
798d6e29 MS |
462 | <li><a href="#http_encoding_t">http_encoding_t</a></li> |
463 | <li><a href="#http_encryption_t">http_encryption_t</a></li> | |
464 | <li><a href="#http_field_t">http_field_t</a></li> | |
465 | <li><a href="#http_keepalive_t">http_keepalive_t</a></li> | |
466 | <li><a href="#http_state_t">http_state_t</a></li> | |
467 | <li><a href="#http_t">http_t</a></li> | |
468 | <li><a href="#http_timeout_cb_t">http_timeout_cb_t</a></li> | |
469 | <li><a href="#http_trust_t">http_trust_t</a></li> | |
470 | <li><a href="#http_uri_coding_t">http_uri_coding_t</a></li> | |
471 | <li><a href="#http_uri_status_t">http_uri_status_t</a></li> | |
798d6e29 MS |
472 | <li><a href="#ipp_attribute_t">ipp_attribute_t</a></li> |
473 | <li><a href="#ipp_copycb_t">ipp_copycb_t</a></li> | |
798d6e29 | 474 | <li><a href="#ipp_iocb_t">ipp_iocb_t</a></li> |
798d6e29 MS |
475 | <li><a href="#ipp_orient_t">ipp_orient_t</a></li> |
476 | <li><a href="#ipp_pstate_t">ipp_pstate_t</a></li> | |
477 | <li><a href="#ipp_quality_t">ipp_quality_t</a></li> | |
478 | <li><a href="#ipp_res_t">ipp_res_t</a></li> | |
06a5a4d3 MS |
479 | <li><a href="#ipp_rstate_t">ipp_rstate_t</a></li> |
480 | <li><a href="#ipp_sstate_t">ipp_sstate_t</a></li> | |
798d6e29 MS |
481 | <li><a href="#ipp_state_t">ipp_state_t</a></li> |
482 | <li><a href="#ipp_t">ipp_t</a></li> | |
798d6e29 MS |
483 | </ul></li> |
484 | <li><a href="#STRUCTURES">Structures</a><ul class="subcontents"> | |
798d6e29 MS |
485 | <li><a href="#cups_dest_s">cups_dest_s</a></li> |
486 | <li><a href="#cups_job_s">cups_job_s</a></li> | |
798d6e29 MS |
487 | <li><a href="#cups_option_s">cups_option_s</a></li> |
488 | <li><a href="#cups_size_s">cups_size_s</a></li> | |
798d6e29 | 489 | </ul></li> |
73721e3e MS |
490 | <li><a href="#VARIABLES">Variables</a><ul class="subcontents"> |
491 | <li><a href="#kSecOidOrganizationalUnit">kSecOidOrganizationalUnit</a></li> | |
492 | </ul></li> | |
798d6e29 | 493 | <li><a href="#ENUMERATIONS">Enumerations</a><ul class="subcontents"> |
798d6e29 | 494 | <li><a href="#cups_ptype_e">cups_ptype_e</a></li> |
798d6e29 MS |
495 | <li><a href="#http_encoding_e">http_encoding_e</a></li> |
496 | <li><a href="#http_encryption_e">http_encryption_e</a></li> | |
497 | <li><a href="#http_field_e">http_field_e</a></li> | |
498 | <li><a href="#http_keepalive_e">http_keepalive_e</a></li> | |
499 | <li><a href="#http_state_e">http_state_e</a></li> | |
500 | <li><a href="#http_status_e">http_status_e</a></li> | |
501 | <li><a href="#http_trust_e">http_trust_e</a></li> | |
502 | <li><a href="#http_uri_coding_e">http_uri_coding_e</a></li> | |
503 | <li><a href="#http_uri_status_e">http_uri_status_e</a></li> | |
798d6e29 | 504 | <li><a href="#ipp_finishings_e">ipp_finishings_e</a></li> |
798d6e29 MS |
505 | <li><a href="#ipp_jstate_e">ipp_jstate_e</a></li> |
506 | <li><a href="#ipp_op_e">ipp_op_e</a></li> | |
507 | <li><a href="#ipp_orient_e">ipp_orient_e</a></li> | |
508 | <li><a href="#ipp_pstate_e">ipp_pstate_e</a></li> | |
509 | <li><a href="#ipp_quality_e">ipp_quality_e</a></li> | |
510 | <li><a href="#ipp_res_e">ipp_res_e</a></li> | |
06a5a4d3 MS |
511 | <li><a href="#ipp_rstate_e">ipp_rstate_e</a></li> |
512 | <li><a href="#ipp_sstate_e">ipp_sstate_e</a></li> | |
798d6e29 MS |
513 | <li><a href="#ipp_state_e">ipp_state_e</a></li> |
514 | <li><a href="#ipp_status_e">ipp_status_e</a></li> | |
515 | <li><a href="#ipp_tag_e">ipp_tag_e</a></li> | |
516 | </ul></li> | |
517 | </ul> | |
518 | </div> | |
519 | <div class="body"> | |
520 | <blockquote> | |
1da024d1 | 521 | <p>Please <a href="https://github.com/apple/cups/issues">file issues on Github</a> to provide feedback on this document.</p> |
798d6e29 | 522 | </blockquote> |
53af7f21 | 523 | <h2><a id="introduction">Introduction</a></h2> |
798d6e29 MS |
524 | <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> |
525 | <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> | |
53af7f21 | 526 | <h3><a id="guidelines">Guidelines</a></h3> |
73721e3e | 527 | <p>When writing software (other than printer drivers) that uses the "cups" library:</p> |
798d6e29 MS |
528 | <ul> |
529 | <li>Do not use undocumented or deprecated APIs,</li> | |
530 | <li>Do not rely on pre-configured printers,</li> | |
531 | <li>Do not assume that printers support specific features or formats, and</li> | |
532 | <li>Do not rely on implementation details (PPDs, etc.)</li> | |
533 | </ul> | |
534 | <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> | |
535 | <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> | |
73721e3e MS |
536 | <blockquote> |
537 | <p><strong>Note:</strong></p> | |
538 | <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 <a href="https://www.cups.org/documentation.html">CUPS.org</a> for more information.</p> | |
539 | </blockquote> | |
53af7f21 | 540 | <h3><a id="terms-used-in-this-document">Terms Used in This Document</a></h3> |
73721e3e | 541 | <p>A <em>Destination</em> is a printer or print queue that accepts print jobs. A <em>Print</em> <em>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> |
53af7f21 | 542 | <h3><a id="compiling-programs-that-use-the-cups-api">Compiling Programs That Use the CUPS API</a></h3> |
798d6e29 MS |
543 | <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> |
544 | <p>The following simple program lists the available destinations:</p> | |
545 | <pre><code>#include <stdio.h> | |
546 | #include <cups/cups.h> | |
547 | ||
548 | int print_dest(void *user_data, unsigned flags, cups_dest_t *dest) | |
549 | { | |
550 | if (dest->instance) | |
551 | printf("%s/%s\n", dest->name, dest->instance); | |
552 | else | |
553 | puts(dest->name); | |
554 | ||
555 | return (1); | |
556 | } | |
557 | ||
558 | int main(void) | |
559 | { | |
560 | cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, 0, 0, print_dest, NULL); | |
561 | ||
562 | return (0); | |
563 | } | |
564 | </code></pre> | |
53af7f21 | 565 | <h4><a id="compiling-with-xcode">Compiling with Xcode</a></h4> |
9c44e2cb MS |
566 | <p>In Xcode, choose <em>New</em> <em>Project...</em> from the <em>File</em> menu (or press SHIFT+CMD+N), then select the <em>Command</em> <em>Line</em> <em>Tool</em> under the macOS Application project type. Click <em>Next</em> and enter a name for the project, for example "firstcups". Click <em>Next</em> and choose a project directory. The click <em>Next</em> to create the project.</p> |
567 | <p>In the project window, click on the <em>Build</em> <em>Phases</em> group and expand the <em>Link</em> <em>Binary</em> <em>with</em> <em>Libraries</em> section. Click <em>+</em>, type "libcups" to show the library, and then double-click on <code>libcups.tbd</code>.</p> | |
798d6e29 | 568 | <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> |
53af7f21 | 569 | <h4><a id="compiling-with-gcc">Compiling with GCC</a></h4> |
798d6e29 MS |
570 | <p>From the command-line, create a file called <code>sample.c</code> using your favorite editor, copy the example to this file, and save. Then run the following command to compile it with GCC and run it:</p> |
571 | <pre><code>gcc -o simple `cups-config --cflags` simple.c `cups-config --libs` | |
572 | ./simple | |
573 | </code></pre> | |
9c44e2cb | 574 | <p>The <code>cups-config</code> command provides the compiler flags (<code>cups-config --cflags</code>) and libraries (<code>cups-config --libs</code>) needed for the local system.</p> |
53af7f21 | 575 | <h2><a id="working-with-destinations">Working with Destinations</a></h2> |
9c44e2cb | 576 | <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> |
798d6e29 | 577 | <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> |
53af7f21 | 578 | <h3><a id="finding-available-destinations">Finding Available Destinations</a></h3> |
798d6e29 MS |
579 | <p>The <code>cupsEnumDests</code> function finds all of the available destinations:</p> |
580 | <pre><code> int | |
581 | cupsEnumDests(unsigned flags, int msec, int *cancel, | |
582 | cups_ptype_t type, cups_ptype_t mask, | |
583 | cups_dest_cb_t cb, void *user_data) | |
584 | </code></pre> | |
585 | <p>The <code>flags</code> argument specifies enumeration options, which at present must be <code>CUPS_DEST_FLAGS_NONE</code>.</p> | |
586 | <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> | |
587 | <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> | |
53af7f21 | 588 | <p>The <code>type</code> and <code>mask</code> arguments are bitfields that allow the caller to filter the destinations based on categories and/or capabilities. The destination's "printer-type" value is masked by the <code>mask</code> value and compared to the <code>type</code> value when filtering. For example, to only enumerate destinations that are hosted on the local system, pass <code>CUPS_PRINTER_LOCAL</code> for the <code>type</code> argument and <code>CUPS_PRINTER_DISCOVERED</code> for the <code>mask</code> argument. The following constants can be used for filtering:</p> |
798d6e29 MS |
589 | <ul> |
590 | <li><code>CUPS_PRINTER_CLASS</code>: A collection of destinations.</li> | |
591 | <li><code>CUPS_PRINTER_FAX</code>: A facsimile device.</li> | |
53af7f21 MS |
592 | <li><code>CUPS_PRINTER_LOCAL</code>: A local printer or class. This constant has the value 0 (no bits set) and is only used for the <code>type</code> argument and is paired with the <code>CUPS_PRINTER_REMOTE</code> or <code>CUPS_PRINTER_DISCOVERED</code> constant passed in the <code>mask</code> argument.</li> |
593 | <li><code>CUPS_PRINTER_REMOTE</code>: A remote (shared) printer or class.</li> | |
594 | <li><code>CUPS_PRINTER_DISCOVERED</code>: An available network printer or class.</li> | |
798d6e29 MS |
595 | <li><code>CUPS_PRINTER_BW</code>: Can do B&W printing.</li> |
596 | <li><code>CUPS_PRINTER_COLOR</code>: Can do color printing.</li> | |
597 | <li><code>CUPS_PRINTER_DUPLEX</code>: Can do two-sided printing.</li> | |
598 | <li><code>CUPS_PRINTER_STAPLE</code>: Can staple output.</li> | |
599 | <li><code>CUPS_PRINTER_COLLATE</code>: Can quickly collate copies.</li> | |
600 | <li><code>CUPS_PRINTER_PUNCH</code>: Can punch output.</li> | |
601 | <li><code>CUPS_PRINTER_COVER</code>: Can cover output.</li> | |
602 | <li><code>CUPS_PRINTER_BIND</code>: Can bind output.</li> | |
603 | <li><code>CUPS_PRINTER_SORT</code>: Can sort output (mailboxes, etc.)</li> | |
604 | <li><code>CUPS_PRINTER_SMALL</code>: Can print on Letter/Legal/A4-size media.</li> | |
605 | <li><code>CUPS_PRINTER_MEDIUM</code>: Can print on Tabloid/B/C/A3/A2-size media.</li> | |
606 | <li><code>CUPS_PRINTER_LARGE</code>: Can print on D/E/A1/A0-size media.</li> | |
607 | <li><code>CUPS_PRINTER_VARIABLE</code>: Can print on rolls and custom-size media.</li> | |
608 | </ul> | |
609 | <p>The <code>cb</code> argument specifies a function to call for every destination that is found:</p> | |
610 | <pre><code>typedef int (*cups_dest_cb_t)(void *user_data, | |
611 | unsigned flags, | |
612 | cups_dest_t *dest); | |
613 | </code></pre> | |
9c44e2cb | 614 | <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> |
798d6e29 MS |
615 | <ul> |
616 | <li><code>CUPS_DEST_FLAGS_MORE</code>: There are more destinations coming.</li> | |
617 | <li><code>CUPS_DEST_FLAGS_REMOVED</code>: The destination has gone away and should be removed from the list of destinations a user can select.</li> | |
618 | <li><code>CUPS_DEST_FLAGS_ERROR</code>: An error occurred. The reason for the error can be found by calling the <code>cupsLastError</code> and/or <code>cupsLastErrorString</code> functions.</li> | |
619 | </ul> | |
620 | <p>The callback function returns 0 to stop enumeration or 1 to continue.</p> | |
718ee2ff | 621 | <blockquote> |
73721e3e MS |
622 | <p><strong>Note:</strong></p> |
623 | <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> | |
718ee2ff | 624 | </blockquote> |
798d6e29 MS |
625 | <p>The following example shows how to use <code>cupsEnumDests</code> to get a filtered array of destinations:</p> |
626 | <pre><code>typedef struct | |
627 | { | |
628 | int num_dests; | |
629 | cups_dest_t *dests; | |
630 | } my_user_data_t; | |
631 | ||
632 | int | |
633 | my_dest_cb(my_user_data_t *user_data, unsigned flags, | |
634 | cups_dest_t *dest) | |
635 | { | |
636 | if (flags & CUPS_DEST_FLAGS_REMOVED) | |
637 | { | |
638 | /* | |
639 | * Remove destination from array... | |
640 | */ | |
641 | ||
642 | user_data->num_dests = | |
643 | cupsRemoveDest(dest->name, dest->instance, | |
644 | user_data->num_dests, | |
645 | &(user_data->dests)); | |
646 | } | |
647 | else | |
648 | { | |
649 | /* | |
650 | * Add destination to array... | |
651 | */ | |
652 | ||
653 | user_data->num_dests = | |
654 | cupsCopyDest(dest, user_data->num_dests, | |
655 | &(user_data->dests)); | |
656 | } | |
657 | ||
658 | return (1); | |
659 | } | |
660 | ||
661 | int | |
662 | my_get_dests(cups_ptype_t type, cups_ptype_t mask, | |
663 | cups_dest_t **dests) | |
664 | { | |
665 | my_user_data_t user_data = { 0, NULL }; | |
666 | ||
667 | if (!cupsEnumDests(CUPS_DEST_FLAGS_NONE, 1000, NULL, type, | |
668 | mask, (cups_dest_cb_t)my_dest_cb, | |
669 | &user_data)) | |
670 | { | |
671 | /* | |
672 | * An error occurred, free all of the destinations and | |
673 | * return... | |
674 | */ | |
675 | ||
676 | cupsFreeDests(user_data.num_dests, user_dasta.dests); | |
677 | ||
678 | *dests = NULL; | |
679 | ||
680 | return (0); | |
681 | } | |
682 | ||
683 | /* | |
684 | * Return the destination array... | |
685 | */ | |
686 | ||
687 | *dests = user_data.dests; | |
688 | ||
689 | return (user_data.num_dests); | |
690 | } | |
691 | </code></pre> | |
53af7f21 | 692 | <h3><a id="basic-destination-information">Basic Destination Information</a></h3> |
798d6e29 MS |
693 | <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> |
694 | <ul> | |
695 | <li>"auth-info-required": The type of authentication required for printing to this destination: "none", "username,password", "domain,username,password", or "negotiate" (Kerberos).</li> | |
696 | <li>"printer-info": The human-readable description of the destination such as "My Laser Printer".</li> | |
697 | <li>"printer-is-accepting-jobs": "true" if the destination is accepting new jobs, "false" otherwise.</li> | |
698 | <li>"printer-is-shared": "true" if the destination is being shared with other computers, "false" otherwise.</li> | |
699 | <li>"printer-location": The human-readable location of the destination such as "Lab 4".</li> | |
700 | <li>"printer-make-and-model": The human-readable make and model of the destination such as "ExampleCorp LaserPrinter 4000 Series".</li> | |
701 | <li>"printer-state": "3" if the destination is idle, "4" if the destination is printing a job, and "5" if the destination is stopped.</li> | |
702 | <li>"printer-state-change-time": The UNIX time when the destination entered the current state.</li> | |
703 | <li>"printer-state-reasons": Additional comma-delimited state keywords for the destination such as "media-tray-empty-error" and "toner-low-warning".</li> | |
704 | <li>"printer-type": The <code>cups_ptype_t</code> value associated with the destination.</li> | |
53af7f21 | 705 | <li>"printer-uri-supported": The URI associated with the destination; if not set, this destination was discovered but is not yet setup as a local printer.</li> |
798d6e29 MS |
706 | </ul> |
707 | <p>Use the <code>cupsGetOption</code> function to retrieve the value. For example, the following code gets the make and model of a destination:</p> | |
708 | <pre><code>const char *model = cupsGetOption("printer-make-and-model", | |
709 | dest->num_options, | |
710 | dest->options); | |
711 | </code></pre> | |
53af7f21 | 712 | <h3><a id="detailed-destination-information">Detailed Destination Information</a></h3> |
798d6e29 MS |
713 | <p>Once a destination has been chosen, the <code>cupsCopyDestInfo</code> function can be used to gather detailed information about the destination:</p> |
714 | <pre><code>cups_dinfo_t * | |
715 | cupsCopyDestInfo(http_t *http, cups_dest_t *dest); | |
716 | </code></pre> | |
717 | <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> | |
718 | <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> | |
53af7f21 | 719 | <h4><a id="getting-supported-options-and-values">Getting Supported Options and Values</a></h4> |
798d6e29 MS |
720 | <p>The <code>cupsCheckDestSupported</code> function can be used to test whether a particular option or option and value is supported:</p> |
721 | <pre><code>int | |
722 | cupsCheckDestSupported(http_t *http, cups_dest_t *dest, | |
723 | cups_dinfo_t *info, | |
724 | const char *option, | |
725 | const char *value); | |
726 | </code></pre> | |
727 | <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> | |
728 | <ul> | |
729 | <li><code>CUPS_COPIES</code>: Controls the number of copies that are produced.</li> | |
730 | <li><code>CUPS_FINISHINGS</code>: A comma-delimited list of integer constants that control the finishing processes that are applied to the job, including stapling, punching, and folding.</li> | |
731 | <li><code>CUPS_MEDIA</code>: Controls the media size that is used, typically one of the following: <code>CUPS_MEDIA_3X5</code>, <code>CUPS_MEDIA_4X6</code>, <code>CUPS_MEDIA_5X7</code>, <code>CUPS_MEDIA_8X10</code>, <code>CUPS_MEDIA_A3</code>, <code>CUPS_MEDIA_A4</code>, <code>CUPS_MEDIA_A5</code>, <code>CUPS_MEDIA_A6</code>, <code>CUPS_MEDIA_ENV10</code>, <code>CUPS_MEDIA_ENVDL</code>, <code>CUPS_MEDIA_LEGAL</code>, <code>CUPS_MEDIA_LETTER</code>, <code>CUPS_MEDIA_PHOTO_L</code>, <code>CUPS_MEDIA_SUPERBA3</code>, or <code>CUPS_MEDIA_TABLOID</code>.</li> | |
732 | <li><code>CUPS_MEDIA_SOURCE</code>: Controls where the media is pulled from, typically either <code>CUPS_MEDIA_SOURCE_AUTO</code> or <code>CUPS_MEDIA_SOURCE_MANUAL</code>.</li> | |
733 | <li><code>CUPS_MEDIA_TYPE</code>: Controls the type of media that is used, typically one of the following: <code>CUPS_MEDIA_TYPE_AUTO</code>, <code>CUPS_MEDIA_TYPE_ENVELOPE</code>, <code>CUPS_MEDIA_TYPE_LABELS</code>, <code>CUPS_MEDIA_TYPE_LETTERHEAD</code>, <code>CUPS_MEDIA_TYPE_PHOTO</code>, <code>CUPS_MEDIA_TYPE_PHOTO_GLOSSY</code>, <code>CUPS_MEDIA_TYPE_PHOTO_MATTE</code>, <code>CUPS_MEDIA_TYPE_PLAIN</code>, or <code>CUPS_MEDIA_TYPE_TRANSPARENCY</code>.</li> | |
734 | <li><code>CUPS_NUMBER_UP</code>: Controls the number of document pages that are placed on each media side.</li> | |
735 | <li><code>CUPS_ORIENTATION</code>: Controls the orientation of document pages placed on the media: <code>CUPS_ORIENTATION_PORTRAIT</code> or <code>CUPS_ORIENTATION_LANDSCAPE</code>.</li> | |
9c44e2cb | 736 | <li><code>CUPS_PRINT_COLOR_MODE</code>: Controls whether the output is in color (<code>CUPS_PRINT_COLOR_MODE_COLOR</code>), grayscale (<code>CUPS_PRINT_COLOR_MODE_MONOCHROME</code>), or either (<code>CUPS_PRINT_COLOR_MODE_AUTO</code>).</li> |
798d6e29 MS |
737 | <li><code>CUPS_PRINT_QUALITY</code>: Controls the generate quality of the output: <code>CUPS_PRINT_QUALITY_DRAFT</code>, <code>CUPS_PRINT_QUALITY_NORMAL</code>, or <code>CUPS_PRINT_QUALITY_HIGH</code>.</li> |
738 | <li><code>CUPS_SIDES</code>: Controls whether prints are placed on one or both sides of the media: <code>CUPS_SIDES_ONE_SIDED</code>, <code>CUPS_SIDES_TWO_SIDED_PORTRAIT</code>, or <code>CUPS_SIDES_TWO_SIDED_LANDSCAPE</code>.</li> | |
739 | </ul> | |
740 | <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> | |
741 | <p>The <code>cupsFindDestSupported</code> function returns the IPP attribute containing the supported values for a given option:</p> | |
742 | <pre><code> ipp_attribute_t * | |
743 | cupsFindDestSupported(http_t *http, cups_dest_t *dest, | |
744 | cups_dinfo_t *dinfo, | |
745 | const char *option); | |
746 | </code></pre> | |
747 | <p>For example, the following code prints the supported finishing processes for a destination, if any, to the standard output:</p> | |
748 | <pre><code>cups_dinfo_t *info = cupsCopyDestInfo(CUPS_HTTP_DEFAULT, | |
749 | dest); | |
750 | ||
751 | if (cupsCheckDestSupported(CUPS_HTTP_DEFAULT, dest, info, | |
752 | CUPS_FINISHINGS, NULL)) | |
753 | { | |
754 | ipp_attribute_t *finishings = | |
755 | cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, | |
756 | CUPS_FINISHINGS); | |
757 | int i, count = ippGetCount(finishings); | |
758 | ||
759 | puts("finishings supported:"); | |
760 | for (i = 0; i < count; i ++) | |
761 | printf(" %d\n", ippGetInteger(finishings, i)); | |
762 | } | |
763 | else | |
764 | puts("finishings not supported."); | |
765 | </code></pre> | |
766 | <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> | |
767 | <pre><code>ipp_attribute_t *attrs = | |
768 | cupsFindDestSupported(CUPS_HTTP_DEFAULT, dest, info, | |
769 | "job-creation-attributes"); | |
770 | int i, count = ippGetCount(attrs); | |
771 | ||
772 | for (i = 0; i < count; i ++) | |
773 | puts(ippGetString(attrs, i, NULL)); | |
774 | </code></pre> | |
53af7f21 | 775 | <h4><a id="getting-default-values">Getting Default Values</a></h4> |
798d6e29 MS |
776 | <p>There are two sets of default values - user defaults that are available via the <code>num_options</code> and <code>options</code> members of the <code>cups_dest_t</code> structure, and destination defaults that available via the <code>cups_dinfo_t</code> structure and the <code>cupsFindDestDefault</code> function which returns the IPP attribute containing the default value(s) for a given option:</p> |
777 | <pre><code>ipp_attribute_t * | |
778 | cupsFindDestDefault(http_t *http, cups_dest_t *dest, | |
779 | cups_dinfo_t *dinfo, | |
780 | const char *option); | |
781 | </code></pre> | |
782 | <p>The user defaults from <code>cupsGetOption</code> should always take preference over the destination defaults. For example, the following code prints the default finishings value(s) to the standard output:</p> | |
783 | <pre><code>const char *def_value = | |
784 | cupsGetOption(CUPS_FINISHINGS, dest->num_options, | |
785 | dest->options); | |
786 | ipp_attribute_t *def_attr = | |
787 | cupsFindDestDefault(CUPS_HTTP_DEFAULT, dest, info, | |
788 | CUPS_FINISHINGS); | |
789 | ||
790 | if (def_value != NULL) | |
791 | { | |
792 | printf("Default finishings: %s\n", def_value); | |
793 | } | |
794 | else | |
795 | { | |
796 | int i, count = ippGetCount(def_attr); | |
797 | ||
798 | printf("Default finishings: %d", | |
799 | ippGetInteger(def_attr, 0)); | |
800 | for (i = 1; i < count; i ++) | |
801 | printf(",%d", ippGetInteger(def_attr, i)); | |
802 | putchar('\n'); | |
803 | } | |
804 | </code></pre> | |
53af7f21 | 805 | <h4><a id="getting-ready-loaded-values">Getting Ready (Loaded) Values</a></h4> |
798d6e29 MS |
806 | <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> |
807 | <p>The <code>cupsFindDestReady</code> function finds the IPP attribute containing the ready values for a given option:</p> | |
808 | <pre><code>ipp_attribute_t * | |
809 | cupsFindDestReady(http_t *http, cups_dest_t *dest, | |
810 | cups_dinfo_t *dinfo, const char *option); | |
811 | </code></pre> | |
812 | <p>For example, the following code lists the ready finishing processes:</p> | |
813 | <pre><code>ipp_attribute_t *ready_finishings = | |
814 | cupsFindDestReady(CUPS_HTTP_DEFAULT, dest, info, | |
815 | CUPS_FINISHINGS); | |
816 | ||
817 | if (ready_finishings != NULL) | |
818 | { | |
819 | int i, count = ippGetCount(ready_finishings); | |
820 | ||
821 | puts("finishings ready:"); | |
822 | for (i = 0; i < count; i ++) | |
823 | printf(" %d\n", ippGetInteger(ready_finishings, i)); | |
824 | } | |
825 | else | |
826 | puts("no finishings are ready."); | |
827 | </code></pre> | |
53af7f21 | 828 | <h4><a id="media-size-options">Media Size Options</a></h4> |
798d6e29 MS |
829 | <p>CUPS provides functions for querying the dimensions and margins for each of the supported media size options. The <code>cups_size_t</code> structure is used to describe a media size:</p> |
830 | <pre><code>typedef struct cups_size_s | |
831 | { | |
832 | char media[128]; | |
833 | int width, length; | |
834 | int bottom, left, right, top; | |
835 | } cups_size_t; | |
836 | </code></pre> | |
837 | <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> | |
838 | <p>The <code>cupsGetDestMediaByName</code> and <code>cupsGetDestMediaBySize</code> functions lookup the media size information using a standard media size name or dimensions in hundredths of millimeters:</p> | |
839 | <pre><code>int | |
840 | cupsGetDestMediaByName(http_t *http, cups_dest_t *dest, | |
841 | cups_dinfo_t *dinfo, | |
842 | const char *media, | |
843 | unsigned flags, cups_size_t *size); | |
844 | ||
845 | int | |
846 | cupsGetDestMediaBySize(http_t *http, cups_dest_t *dest, | |
847 | cups_dinfo_t *dinfo, | |
848 | int width, int length, | |
849 | unsigned flags, cups_size_t *size); | |
850 | </code></pre> | |
851 | <p>The <code>media</code>, <code>width</code>, and <code>length</code> arguments specify the size to lookup. The <code>flags</code> argument specifies a bitfield controlling various lookup options:</p> | |
852 | <ul> | |
853 | <li><code>CUPS_MEDIA_FLAGS_DEFAULT</code>: Find the closest size supported by the printer.</li> | |
854 | <li><code>CUPS_MEDIA_FLAGS_BORDERLESS</code>: Find a borderless size.</li> | |
855 | <li><code>CUPS_MEDIA_FLAGS_DUPLEX</code>: Find a size compatible with two-sided printing.</li> | |
856 | <li><code>CUPS_MEDIA_FLAGS_EXACT</code>: Find an exact match for the size.</li> | |
857 | <li><code>CUPS_MEDIA_FLAGS_READY</code>: If the printer supports media sensing or configuration of the media in each tray/source, find the size amongst the "ready" media.</li> | |
858 | </ul> | |
859 | <p>If a matching size is found for the destination, the size information is stored in the structure pointed to by the <code>size</code> argument and 1 is returned. Otherwise 0 is returned.</p> | |
860 | <p>For example, the following code prints the margins for two-sided printing on US Letter media:</p> | |
861 | <pre><code>cups_size_t size; | |
862 | ||
863 | if (cupsGetDestMediaByName(CUPS_HTTP_DEFAULT, dest, info, | |
864 | CUPS_MEDIA_LETTER, | |
865 | CUPS_MEDIA_FLAGS_DUPLEX, &size)) | |
866 | { | |
867 | puts("Margins for duplex US Letter:"); | |
868 | printf(" Bottom: %.2fin\n", size.bottom / 2540.0); | |
869 | printf(" Left: %.2fin\n", size.left / 2540.0); | |
870 | printf(" Right: %.2fin\n", size.right / 2540.0); | |
871 | printf(" Top: %.2fin\n", size.top / 2540.0); | |
872 | } | |
873 | else | |
874 | puts("Margins for duplex US Letter are not available."); | |
875 | </code></pre> | |
876 | <p>You can also enumerate all of the sizes that match a given <code>flags</code> value using the <code>cupsGetDestMediaByIndex</code> and <code>cupsGetDestMediaCount</code> functions:</p> | |
877 | <pre><code>int | |
878 | cupsGetDestMediaByIndex(http_t *http, cups_dest_t *dest, | |
879 | cups_dinfo_t *dinfo, int n, | |
880 | unsigned flags, cups_size_t *size); | |
881 | ||
882 | int | |
883 | cupsGetDestMediaCount(http_t *http, cups_dest_t *dest, | |
884 | cups_dinfo_t *dinfo, unsigned flags); | |
885 | </code></pre> | |
886 | <p>For example, the following code prints the list of ready media and corresponding margins:</p> | |
887 | <pre><code>cups_size_t size; | |
888 | int i; | |
889 | int count = cupsGetDestMediaCount(CUPS_HTTP_DEFAULT, | |
890 | dest, info, | |
891 | CUPS_MEDIA_FLAGS_READY); | |
892 | ||
893 | for (i = 0; i < count; i ++) | |
894 | { | |
895 | if (cupsGetDestMediaByIndex(CUPS_HTTP_DEFAULT, dest, info, | |
896 | i, CUPS_MEDIA_FLAGS_READY, | |
897 | &size)) | |
898 | { | |
899 | printf("%s:\n", size.name); | |
900 | printf(" Width: %.2fin\n", size.width / 2540.0); | |
901 | printf(" Length: %.2fin\n", size.length / 2540.0); | |
902 | printf(" Bottom: %.2fin\n", size.bottom / 2540.0); | |
903 | printf(" Left: %.2fin\n", size.left / 2540.0); | |
904 | printf(" Right: %.2fin\n", size.right / 2540.0); | |
905 | printf(" Top: %.2fin\n", size.top / 2540.0); | |
906 | } | |
907 | } | |
908 | </code></pre> | |
909 | <p>Finally, the <code>cupsGetDestMediaDefault</code> function returns the default media size:</p> | |
910 | <pre><code>int | |
911 | cupsGetDestMediaDefault(http_t *http, cups_dest_t *dest, | |
912 | cups_dinfo_t *dinfo, unsigned flags, | |
913 | cups_size_t *size); | |
914 | </code></pre> | |
53af7f21 | 915 | <h4><a id="localizing-options-and-values">Localizing Options and Values</a></h4> |
6ad44eeb | 916 | <p>CUPS provides three functions to get localized, human-readable strings in the user's current locale for options and values: <code>cupsLocalizeDestMedia</code>, <code>cupsLocalizeDestOption</code>, and <code>cupsLocalizeDestValue</code>:</p> |
798d6e29 MS |
917 | <pre><code>const char * |
918 | cupsLocalizeDestMedia(http_t *http, cups_dest_t *dest, | |
919 | cups_dinfo_t *info, unsigned flags, | |
920 | cups_size_t *size); | |
921 | ||
922 | const char * | |
923 | cupsLocalizeDestOption(http_t *http, cups_dest_t *dest, | |
924 | cups_dinfo_t *info, | |
925 | const char *option); | |
926 | ||
927 | const char * | |
928 | cupsLocalizeDestValue(http_t *http, cups_dest_t *dest, | |
929 | cups_dinfo_t *info, | |
930 | const char *option, const char *value); | |
931 | </code></pre> | |
53af7f21 | 932 | <h3><a id="submitting-a-print-job">Submitting a Print Job</a></h3> |
798d6e29 MS |
933 | <p>Once you are ready to submit a print job, you create a job using the <code>cupsCreateDestJob</code> function:</p> |
934 | <pre><code>ipp_status_t | |
935 | cupsCreateDestJob(http_t *http, cups_dest_t *dest, | |
936 | cups_dinfo_t *info, int *job_id, | |
937 | const char *title, int num_options, | |
938 | cups_option_t *options); | |
939 | </code></pre> | |
940 | <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> | |
941 | <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> | |
942 | <p>For example, the following code creates a new job that will print 42 copies of a two-sided US Letter document:</p> | |
943 | <pre><code>int job_id = 0; | |
944 | int num_options = 0; | |
945 | cups_option_t *options = NULL; | |
946 | ||
947 | num_options = cupsAddOption(CUPS_COPIES, "42", | |
948 | num_options, &options); | |
949 | num_options = cupsAddOption(CUPS_MEDIA, CUPS_MEDIA_LETTER, | |
950 | num_options, &options); | |
951 | num_options = cupsAddOption(CUPS_SIDES, | |
952 | CUPS_SIDES_TWO_SIDED_PORTRAIT, | |
953 | num_options, &options); | |
954 | ||
955 | if (cupsCreateDestJob(CUPS_HTTP_DEFAULT, dest, info, | |
956 | &job_id, "My Document", num_options, | |
957 | options) == IPP_STATUS_OK) | |
958 | printf("Created job: %d\n", job_id); | |
959 | else | |
960 | printf("Unable to create job: %s\n", | |
961 | cupsLastErrorString()); | |
962 | </code></pre> | |
963 | <p>Once the job is created, you submit documents for the job using the <code>cupsStartDestDocument</code>, <code>cupsWriteRequestData</code>, and <code>cupsFinishDestDocument</code> functions:</p> | |
964 | <pre><code>http_status_t | |
965 | cupsStartDestDocument(http_t *http, cups_dest_t *dest, | |
966 | cups_dinfo_t *info, int job_id, | |
967 | const char *docname, | |
968 | const char *format, | |
969 | int num_options, | |
970 | cups_option_t *options, | |
971 | int last_document); | |
972 | ||
973 | http_status_t | |
974 | cupsWriteRequestData(http_t *http, const char *buffer, | |
975 | size_t length); | |
976 | ||
977 | ipp_status_t | |
978 | cupsFinishDestDocument(http_t *http, cups_dest_t *dest, | |
979 | cups_dinfo_t *info); | |
980 | </code></pre> | |
981 | <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> | |
982 | <ul> | |
983 | <li><code>CUPS_FORMAT_JPEG</code>: "image/jpeg"</li> | |
984 | <li><code>CUPS_FORMAT_PDF</code>: "application/pdf"</li> | |
985 | <li><code>CUPS_FORMAT_POSTSCRIPT</code>: "application/postscript"</li> | |
986 | <li><code>CUPS_FORMAT_TEXT</code>: "text/plain"</li> | |
987 | </ul> | |
988 | <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> | |
989 | <p>For example, the following code submits a PDF file to the job that was just created:</p> | |
990 | <pre><code>FILE *fp = fopen("filename.pdf", "rb"); | |
991 | size_t bytes; | |
992 | char buffer[65536]; | |
993 | ||
994 | if (cupsStartDestDocument(CUPS_HTTP_DEFAULT, dest, info, | |
995 | job_id, "filename.pdf", 0, NULL, | |
996 | 1) == HTTP_STATUS_CONTINUE) | |
997 | { | |
998 | while ((bytes = fread(buffer, 1, sizeof(buffer), fp)) > 0) | |
999 | if (cupsWriteRequestData(CUPS_HTTP_DEFAULT, buffer, | |
1000 | bytes) != HTTP_STATUS_CONTINUE) | |
1001 | break; | |
1002 | ||
1003 | if (cupsFinishDestDocument(CUPS_HTTP_DEFAULT, dest, | |
1004 | info) == IPP_STATUS_OK) | |
1005 | puts("Document send succeeded."); | |
1006 | else | |
1007 | printf("Document send failed: %s\n", | |
1008 | cupsLastErrorString()); | |
1009 | } | |
1010 | ||
1011 | fclose(fp); | |
1012 | </code></pre> | |
b0fb2d75 MS |
1013 | <h2><a id="sending-ipp-requests">Sending IPP Requests</a></h2> |
1014 | <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> | |
1015 | <h3><a id="connecting-to-the-scheduler-or-printer">Connecting to the Scheduler or Printer</a></h3> | |
1016 | <p>The connection to the scheduler or printer is represented by the HTTP connection type <code>http_t</code>. The <code>cupsConnectDest</code> function connects to the scheduler or printer associated with the destination:</p> | |
1017 | <pre><code>http_t * | |
1018 | cupsConnectDest(cups_dest_t *dest, unsigned flags, int msec, | |
1019 | int *cancel, char *resource, | |
1020 | size_t resourcesize, cups_dest_cb_t cb, | |
1021 | void *user_data); | |
1022 | </code></pre> | |
1023 | <p>The <code>dest</code> argument specifies the destination to connect to.</p> | |
1024 | <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> | |
1025 | <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> | |
1026 | <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> | |
1027 | <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> | |
1028 | <p>The <code>cb</code> and <code>user_data</code> arguments specify a destination callback function that returns 1 to continue connecting or 0 to stop. The destination callback work the same way as the one used for the <code>cupsEnumDests</code> function.</p> | |
1029 | <p>On success, a HTTP connection is returned that can be used to send IPP requests and get IPP responses.</p> | |
1030 | <p>For example, the following code connects to the printer associated with a destination with a 30 second timeout:</p> | |
1031 | <pre><code>char resource[256]; | |
1032 | http_t *http = cupsConnectDest(dest, CUPS_DEST_FLAGS_DEVICE, | |
1033 | 30000, NULL, resource, | |
1034 | sizeof(resource), NULL, NULL); | |
1035 | </code></pre> | |
1036 | <h3><a id="creating-an-ipp-request">Creating an IPP Request</a></h3> | |
1037 | <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> | |
1038 | <p>The <code>ippNewRequest</code> function creates a new IPP request:</p> | |
1039 | <pre><code>ipp_t * | |
1040 | ippNewRequest(ipp_op_t op); | |
1041 | </code></pre> | |
1042 | <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> | |
1043 | <pre><code>ipp_t *request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES); | |
1044 | </code></pre> | |
1045 | <p>The request identifier is automatically set to a unique value for the current process.</p> | |
1046 | <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> | |
1047 | <pre><code>const char *printer_uri = cupsGetOption("device-uri", | |
1048 | dest->num_options, | |
1049 | dest->options); | |
1050 | ||
1051 | ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, | |
1052 | "printer-uri", NULL, printer_uri); | |
1053 | </code></pre> | |
1054 | <blockquote> | |
73721e3e MS |
1055 | <p><strong>Note:</strong></p> |
1056 | <p>If we wanted to query the scheduler instead of the device, we would look up the "printer-uri-supported" option instead of the "device-uri" value.</p> | |
b0fb2d75 MS |
1057 | </blockquote> |
1058 | <p>The <code>ippAddString</code> function adds the "printer-uri" attribute the the IPP request. The <code>IPP_TAG_OPERATION</code> argument specifies that the attribute is part of the operation. The <code>IPP_TAG_URI</code> argument specifies that the value is a Universal Resource Identifier (URI) string. The <code>NULL</code> argument specifies there is no language (English, French, Japanese, etc.) associated with the string, and the <code>printer_uri</code> argument specifies the string value.</p> | |
1059 | <p>The IPP Get-Printer-Attributes request also supports an IPP attribute called "requested-attributes" that lists the attributes and values you are interested in. For example, the following code requests the printer state attributes:</p> | |
1060 | <pre><code>static const char * const requested_attributes[] = | |
1061 | { | |
1062 | "printer-state", | |
1063 | "printer-state-message", | |
1064 | "printer-state-reasons" | |
1065 | }; | |
1066 | ||
1067 | ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD, | |
1068 | "requested-attributes", 3, NULL, | |
1069 | requested_attributes); | |
1070 | </code></pre> | |
1071 | <p>The <code>ippAddStrings</code> function adds an attribute with one or more strings, in this case three. The <code>IPP_TAG_KEYWORD</code> argument specifies that the strings are keyword values, which are used for attribute names. All strings use the same language (<code>NULL</code>), and the attribute will contain the three strings in the array <code>requested_attributes</code>.</p> | |
1072 | <p>CUPS provides many functions to adding attributes of different types:</p> | |
1073 | <ul> | |
1074 | <li><code>ippAddBoolean</code> adds a boolean (<code>IPP_TAG_BOOLEAN</code>) attribute with one value.</li> | |
1075 | <li><code>ippAddInteger</code> adds an enum (<code>IPP_TAG_ENUM</code>) or integer (<code>IPP_TAG_INTEGER</code>) attribute with one value.</li> | |
1076 | <li><code>ippAddIntegers</code> adds an enum or integer attribute with one or more values.</li> | |
1077 | <li><code>ippAddOctetString</code> adds an octetString attribute with one value.</li> | |
1078 | <li><code>ippAddOutOfBand</code> adds a admin-defined (<code>IPP_TAG_ADMINDEFINE</code>), default (<code>IPP_TAG_DEFAULT</code>), delete-attribute (<code>IPP_TAG_DELETEATTR</code>), no-value (<code>IPP_TAG_NOVALUE</code>), not-settable (<code>IPP_TAG_NOTSETTABLE</code>), unknown (<code>IPP_TAG_UNKNOWN</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_VALUE</code>) out-of-band attribute.</li> | |
1079 | <li><code>ippAddRange</code> adds a rangeOfInteger attribute with one range.</li> | |
1080 | <li><code>ippAddRanges</code> adds a rangeOfInteger attribute with one or more ranges.</li> | |
1081 | <li><code>ippAddResolution</code> adds a resolution attribute with one resolution.</li> | |
1082 | <li><code>ippAddResolutions</code> adds a resolution attribute with one or more resolutions.</li> | |
1083 | <li><code>ippAddString</code> adds a charset (<code>IPP_TAG_CHARSET</code>), keyword (<code>IPP_TAG_KEYWORD</code>), mimeMediaType (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code> and <code>IPP_TAG_NAMELANG</code>), naturalLanguage (<code>IPP_TAG_NATURAL_LANGUAGE</code>), text (<code>IPP_TAG_TEXT</code> and <code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), or uriScheme (<code>IPP_TAG_URISCHEME</code>) attribute with one value.</li> | |
1084 | <li><code>ippAddStrings</code> adds a charset, keyword, mimeMediaType, name, naturalLanguage, text, uri, or uriScheme attribute with one or more values.</li> | |
1085 | </ul> | |
1086 | <h3><a id="sending-the-ipp-request">Sending the IPP Request</a></h3> | |
1087 | <p>Once you have created the IPP request, you can send it using the <code>cupsDoRequest</code> function. For example, the following code sends the IPP Get-Printer-Attributes request to the destination and saves the response:</p> | |
1088 | <pre><code>ipp_t *response = cupsDoRequest(http, request, resource); | |
1089 | </code></pre> | |
1090 | <p>For requests like Send-Document that include a file, the <code>cupsDoFileRequest</code> function should be used:</p> | |
1091 | <pre><code>ipp_t *response = cupsDoFileRequest(http, request, resource, | |
1092 | filename); | |
1093 | </code></pre> | |
1094 | <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> | |
1095 | <p>The status from the most recent request can be queried using the <code>cupsLastError</code> function, for example:</p> | |
1096 | <pre><code>if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST) | |
1097 | { | |
1098 | /* request failed */ | |
1099 | } | |
1100 | </code></pre> | |
1101 | <p>A human-readable error message is also available using the <code>cupsLastErrorString</code> function:</p> | |
1102 | <pre><code>if (cupsLastError() >= IPP_STATUS_ERROR_BAD_REQUEST) | |
1103 | { | |
1104 | /* request failed */ | |
1105 | printf("Request failed: %s\n", cupsLastErrorString()); | |
1106 | } | |
1107 | </code></pre> | |
1108 | <h3><a id="processing-the-ipp-response">Processing the IPP Response</a></h3> | |
1109 | <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> | |
1110 | <p>For example, the following code finds the printer state attributes and prints their values:</p> | |
1111 | <pre><code>ipp_attribute_t *attr; | |
1112 | ||
1113 | if ((attr = ippFindAttribute(response, "printer-state", | |
1114 | IPP_TAG_ENUM)) != NULL) | |
1115 | { | |
1116 | printf("printer-state=%s\n", | |
db5424ea | 1117 | ippEnumString("printer-state", ippGetInteger(attr, 0))); |
b0fb2d75 MS |
1118 | } |
1119 | else | |
1120 | puts("printer-state=unknown"); | |
1121 | ||
1122 | if ((attr = ippFindAttribute(response, "printer-state-message", | |
1123 | IPP_TAG_TEXT)) != NULL) | |
1124 | { | |
1125 | printf("printer-state-message=\"%s\"\n", | |
1126 | ippGetString(attr, 0, NULL))); | |
1127 | } | |
1128 | ||
1129 | if ((attr = ippFindAttribute(response, "printer-state-reasons", | |
1130 | IPP_TAG_KEYWORD)) != NULL) | |
1131 | { | |
1132 | int i, count = ippGetCount(attr); | |
1133 | ||
1134 | puts("printer-state-reasons="); | |
1135 | for (i = 0; i < count; i ++) | |
1136 | printf(" %s\n", ippGetString(attr, i, NULL))); | |
1137 | } | |
1138 | </code></pre> | |
1139 | <p>The <code>ippGetCount</code> function returns the number of values in an attribute.</p> | |
1140 | <p>The <code>ippGetInteger</code> and <code>ippGetString</code> functions return a single integer or string value from an attribute.</p> | |
db5424ea | 1141 | <p>The <code>ippEnumString</code> function converts a enum value to its keyword (string) equivalent.</p> |
b0fb2d75 MS |
1142 | <p>Once you are done using the IPP response message, free it using the <code>ippDelete</code> function:</p> |
1143 | <pre><code>ippDelete(response); | |
1144 | </code></pre> | |
1145 | <h3><a id="authentication">Authentication</a></h3> | |
1146 | <p>CUPS normally handles authentication through the console. GUI applications should set a password callback using the <code>cupsSetPasswordCB2</code> function:</p> | |
1147 | <pre><code>void | |
1148 | cupsSetPasswordCB2(cups_password_cb2_t cb, void *user_data); | |
1149 | </code></pre> | |
1150 | <p>The password callback will be called when needed and is responsible for setting the current user name using <code>cupsSetUser</code> and returning a string:</p> | |
1151 | <pre><code>const char * | |
1152 | cups_password_cb2(const char *prompt, http_t *http, | |
1153 | const char *method, const char *resource, | |
1154 | void *user_data); | |
1155 | </code></pre> | |
1156 | <p>The <code>prompt</code> argument is a string from CUPS that should be displayed to the user.</p> | |
1157 | <p>The <code>http</code> argument is the connection hosting the request that is being authenticated. The password callback can call the <code>httpGetField</code> and <code>httpGetSubField</code> functions to look for additional details concerning the authentication challenge.</p> | |
1158 | <p>The <code>method</code> argument specifies the HTTP method used for the request and is typically "POST".</p> | |
1159 | <p>The <code>resource</code> argument specifies the path used for the request.</p> | |
1160 | <p>The <code>user_data</code> argument provides the user data pointer from the <code>cupsSetPasswordCB2</code> call.</p> | |
798d6e29 | 1161 | <h2 class="title"><a id="FUNCTIONS">Functions</a></h2> |
73721e3e MS |
1162 | <h3 class="function"><a id="CF_OPTIONS">CF_OPTIONS</a></h3> |
1163 | <p class="description"></p> | |
1164 | <p class="code"> | |
1165 | typedef CF_OPTIONS(uint32_t, SecKeyUsage);</p> | |
1166 | <h4 class="parameters">Parameters</h4> | |
1167 | <table class="list"><tbody> | |
1168 | <tr><th>uint32_t</th> | |
1169 | </tr> | |
1170 | <tr><th>SecKeyUsage</th> | |
1171 | </tr> | |
1172 | </tbody></table> | |
1173 | <h4 class="returnvalue">Return Value</h4> | |
1174 | <p class="description"></p> | |
798d6e29 MS |
1175 | <h3 class="function"><a id="cupsAddDest">cupsAddDest</a></h3> |
1176 | <p class="description">Add a destination to the list of destinations.</p> | |
1177 | <p class="code"> | |
98d88c8d MS |
1178 | int cupsAddDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
1179 | <h4 class="parameters">Parameters</h4> | |
1180 | <table class="list"><tbody> | |
1181 | <tr><th>name</th> | |
1182 | <td class="description">Destination name</td></tr> | |
1183 | <tr><th>instance</th> | |
1184 | <td class="description">Instance name or <code>NULL</code> for none/primary</td></tr> | |
1185 | <tr><th>num_dests</th> | |
1186 | <td class="description">Number of destinations</td></tr> | |
1187 | <tr><th>dests</th> | |
1188 | <td class="description">Destinations</td></tr> | |
1189 | </tbody></table> | |
798d6e29 MS |
1190 | <h4 class="returnvalue">Return Value</h4> |
1191 | <p class="description">New number of destinations</p> | |
1192 | <h4 class="discussion">Discussion</h4> | |
1193 | <p class="discussion">This function cannot be used to add a new class or printer queue, | |
1194 | it only adds a new container of saved options for the named | |
1195 | destination or instance.<br> | |
1196 | <br> | |
1197 | If the named destination already exists, the destination list is | |
1198 | returned unchanged. Adding a new instance of a destination creates | |
1199 | a copy of that destination's options.<br> | |
1200 | <br> | |
1201 | Use the <a href="#cupsSaveDests"><code>cupsSaveDests</code></a> function to save the updated list of | |
1202 | destinations to the user's lpoptions file.</p> | |
63b75fbe MS |
1203 | <h3 class="function"><span class="info"> CUPS 2.3 </span><a id="cupsAddDestMediaOptions">cupsAddDestMediaOptions</a></h3> |
1204 | <p class="description">Add the option corresponding to the specified media size.</p> | |
1205 | <p class="code"> | |
1206 | int cupsAddDestMediaOptions(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> | |
1207 | <h4 class="parameters">Parameters</h4> | |
1208 | <table class="list"><tbody> | |
1209 | <tr><th>http</th> | |
1210 | <td class="description">Connection to destination</td></tr> | |
1211 | <tr><th>dest</th> | |
1212 | <td class="description">Destination</td></tr> | |
1213 | <tr><th>dinfo</th> | |
1214 | <td class="description">Destination information</td></tr> | |
1215 | <tr><th>flags</th> | |
1216 | <td class="description">Media matching flags</td></tr> | |
1217 | <tr><th>size</th> | |
1218 | <td class="description">Media size</td></tr> | |
1219 | <tr><th>num_options</th> | |
1220 | <td class="description">Current number of options</td></tr> | |
1221 | <tr><th>options</th> | |
1222 | <td class="description">Options</td></tr> | |
1223 | </tbody></table> | |
1224 | <h4 class="returnvalue">Return Value</h4> | |
1225 | <p class="description">New number of options</p> | |
98d88c8d | 1226 | <h3 class="function"><span class="info"> CUPS 2.2.4/macOS 10.13 </span><a id="cupsAddIntegerOption">cupsAddIntegerOption</a></h3> |
53af7f21 | 1227 | <p class="description">Add an integer option to an option array.</p> |
798d6e29 | 1228 | <p class="code"> |
98d88c8d MS |
1229 | int cupsAddIntegerOption(const char *name, int value, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
1230 | <h4 class="parameters">Parameters</h4> | |
1231 | <table class="list"><tbody> | |
1232 | <tr><th>name</th> | |
1233 | <td class="description">Name of option</td></tr> | |
1234 | <tr><th>value</th> | |
1235 | <td class="description">Value of option</td></tr> | |
1236 | <tr><th>num_options</th> | |
1237 | <td class="description">Number of options</td></tr> | |
1238 | <tr><th>options</th> | |
1239 | <td class="description">Pointer to options</td></tr> | |
1240 | </tbody></table> | |
798d6e29 MS |
1241 | <h4 class="returnvalue">Return Value</h4> |
1242 | <p class="description">Number of options</p> | |
1243 | <h4 class="discussion">Discussion</h4> | |
1244 | <p class="discussion">New option arrays can be initialized simply by passing 0 for the | |
53af7f21 | 1245 | "num_options" parameter. |
798d6e29 MS |
1246 | |
1247 | </p> | |
53af7f21 MS |
1248 | <h3 class="function"><a id="cupsAddOption">cupsAddOption</a></h3> |
1249 | <p class="description">Add an option to an option array.</p> | |
798d6e29 | 1250 | <p class="code"> |
98d88c8d MS |
1251 | int cupsAddOption(const char *name, const char *value, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
1252 | <h4 class="parameters">Parameters</h4> | |
1253 | <table class="list"><tbody> | |
1254 | <tr><th>name</th> | |
1255 | <td class="description">Name of option</td></tr> | |
1256 | <tr><th>value</th> | |
1257 | <td class="description">Value of option</td></tr> | |
1258 | <tr><th>num_options</th> | |
1259 | <td class="description">Number of options</td></tr> | |
1260 | <tr><th>options</th> | |
1261 | <td class="description">Pointer to options</td></tr> | |
1262 | </tbody></table> | |
798d6e29 | 1263 | <h4 class="returnvalue">Return Value</h4> |
53af7f21 | 1264 | <p class="description">Number of options</p> |
798d6e29 | 1265 | <h4 class="discussion">Discussion</h4> |
53af7f21 MS |
1266 | <p class="discussion">New option arrays can be initialized simply by passing 0 for the |
1267 | "num_options" parameter.</p> | |
98d88c8d | 1268 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCancelDestJob">cupsCancelDestJob</a></h3> |
798d6e29 | 1269 | <p class="description">Cancel a job on a destination.</p> |
98d88c8d MS |
1270 | <p class="code"> |
1271 | ipp_status_t cupsCancelDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, int job_id);</p> | |
1272 | <h4 class="parameters">Parameters</h4> | |
1273 | <table class="list"><tbody> | |
1274 | <tr><th>http</th> | |
1275 | <td class="description">Connection to destination</td></tr> | |
1276 | <tr><th>dest</th> | |
1277 | <td class="description">Destination</td></tr> | |
1278 | <tr><th>job_id</th> | |
1279 | <td class="description">Job ID</td></tr> | |
1280 | </tbody></table> | |
1281 | <h4 class="returnvalue">Return Value</h4> | |
1282 | <p class="description">Status of cancel operation</p> | |
1283 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
1284 | <p class="discussion">The "job_id" is the number returned by cupsCreateDestJob.<br> |
1285 | <br> | |
1286 | Returns <code>IPP_STATUS_OK</code> on success and | |
98d88c8d | 1287 | <code>IPP_STATUS_ERROR_NOT_AUTHORIZED</code> or |
798d6e29 MS |
1288 | <code>IPP_STATUS_ERROR_FORBIDDEN</code> on failure. |
1289 | ||
798d6e29 MS |
1290 | </p> |
1291 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCheckDestSupported">cupsCheckDestSupported</a></h3> | |
1292 | <p class="description">Check that the option and value are supported | |
1293 | by the destination.</p> | |
1294 | <p class="code"> | |
98d88c8d MS |
1295 | int cupsCheckDestSupported(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option, const char *value);</p> |
1296 | <h4 class="parameters">Parameters</h4> | |
1297 | <table class="list"><tbody> | |
1298 | <tr><th>http</th> | |
1299 | <td class="description">Connection to destination</td></tr> | |
1300 | <tr><th>dest</th> | |
1301 | <td class="description">Destination</td></tr> | |
1302 | <tr><th>dinfo</th> | |
1303 | <td class="description">Destination information</td></tr> | |
1304 | <tr><th>option</th> | |
1305 | <td class="description">Option</td></tr> | |
1306 | <tr><th>value</th> | |
b0fb2d75 | 1307 | <td class="description">Value or <code>NULL</code></td></tr> |
98d88c8d | 1308 | </tbody></table> |
798d6e29 MS |
1309 | <h4 class="returnvalue">Return Value</h4> |
1310 | <p class="description">1 if supported, 0 otherwise</p> | |
1311 | <h4 class="discussion">Discussion</h4> | |
1312 | <p class="discussion">Returns 1 if supported, 0 otherwise. | |
1313 | ||
1314 | </p> | |
1315 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCloseDestJob">cupsCloseDestJob</a></h3> | |
1316 | <p class="description">Close a job and start printing.</p> | |
1317 | <p class="code"> | |
98d88c8d MS |
1318 | ipp_status_t cupsCloseDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info, int job_id);</p> |
1319 | <h4 class="parameters">Parameters</h4> | |
1320 | <table class="list"><tbody> | |
1321 | <tr><th>http</th> | |
1322 | <td class="description">Connection to destination</td></tr> | |
1323 | <tr><th>dest</th> | |
1324 | <td class="description">Destination</td></tr> | |
1325 | <tr><th>info</th> | |
1326 | <td class="description">Destination information</td></tr> | |
1327 | <tr><th>job_id</th> | |
1328 | <td class="description">Job ID</td></tr> | |
1329 | </tbody></table> | |
798d6e29 MS |
1330 | <h4 class="returnvalue">Return Value</h4> |
1331 | <p class="description">IPP status code</p> | |
1332 | <h4 class="discussion">Discussion</h4> | |
1333 | <p class="discussion">Use when the last call to cupsStartDocument passed 0 for "last_document". | |
1334 | "job_id" is the job ID returned by cupsCreateDestJob. Returns <code>IPP_STATUS_OK</code> | |
1335 | on success. | |
1336 | ||
1337 | </p> | |
1338 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsConnectDest">cupsConnectDest</a></h3> | |
699fe020 | 1339 | <p class="description">Open a connection to the destination.</p> |
98d88c8d MS |
1340 | <p class="code"> |
1341 | <a href="#http_t">http_t</a> *cupsConnectDest(<a href="#cups_dest_t">cups_dest_t</a> *dest, unsigned flags, int msec, int *cancel, char *resource, size_t resourcesize, <a href="#cups_dest_cb_t">cups_dest_cb_t</a> cb, void *user_data);</p> | |
1342 | <h4 class="parameters">Parameters</h4> | |
1343 | <table class="list"><tbody> | |
1344 | <tr><th>dest</th> | |
1345 | <td class="description">Destination</td></tr> | |
1346 | <tr><th>flags</th> | |
1347 | <td class="description">Connection flags</td></tr> | |
1348 | <tr><th>msec</th> | |
1349 | <td class="description">Timeout in milliseconds</td></tr> | |
1350 | <tr><th>cancel</th> | |
1351 | <td class="description">Pointer to "cancel" variable</td></tr> | |
1352 | <tr><th>resource</th> | |
1353 | <td class="description">Resource buffer</td></tr> | |
1354 | <tr><th>resourcesize</th> | |
1355 | <td class="description">Size of resource buffer</td></tr> | |
1356 | <tr><th>cb</th> | |
1357 | <td class="description">Callback function</td></tr> | |
1358 | <tr><th>user_data</th> | |
1359 | <td class="description">User data pointer</td></tr> | |
1360 | </tbody></table> | |
1361 | <h4 class="returnvalue">Return Value</h4> | |
1362 | <p class="description">Connection to destination or <code>NULL</code></p> | |
1363 | <h4 class="discussion">Discussion</h4> | |
1364 | <p class="discussion">Connect to the destination, returning a new <code>http_t</code> connection object | |
1365 | and optionally the resource path to use for the destination. These calls | |
1366 | will block until a connection is made, the timeout expires, the integer | |
1367 | pointed to by "cancel" is non-zero, or the callback function (or block) | |
1368 | returns 0. The caller is responsible for calling <a href="#httpClose"><code>httpClose</code></a> on the | |
b0fb2d75 MS |
1369 | returned connection.<br> |
1370 | <br> | |
699fe020 | 1371 | Starting with CUPS 2.2.4, the caller can pass <code>CUPS_DEST_FLAGS_DEVICE</code> |
b0fb2d75 MS |
1372 | for the "flags" argument to connect directly to the device associated with |
1373 | the destination. Otherwise, the connection is made to the CUPS scheduler | |
1374 | associated with the destination. | |
798d6e29 MS |
1375 | |
1376 | </p> | |
53af7f21 MS |
1377 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCopyDest">cupsCopyDest</a></h3> |
1378 | <p class="description">Copy a destination.</p> | |
798d6e29 | 1379 | <p class="code"> |
98d88c8d MS |
1380 | int cupsCopyDest(<a href="#cups_dest_t">cups_dest_t</a> *dest, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
1381 | <h4 class="parameters">Parameters</h4> | |
1382 | <table class="list"><tbody> | |
1383 | <tr><th>dest</th> | |
1384 | <td class="description">Destination to copy</td></tr> | |
1385 | <tr><th>num_dests</th> | |
1386 | <td class="description">Number of destinations</td></tr> | |
1387 | <tr><th>dests</th> | |
1388 | <td class="description">Destination array</td></tr> | |
1389 | </tbody></table> | |
798d6e29 MS |
1390 | <h4 class="returnvalue">Return Value</h4> |
1391 | <p class="description">New number of destinations</p> | |
1392 | <h4 class="discussion">Discussion</h4> | |
1393 | <p class="discussion">Make a copy of the destination to an array of destinations (or just a single | |
1394 | copy) - for use with the cupsEnumDests* functions. The caller is responsible | |
1395 | for calling cupsFreeDests() on the returned object(s). | |
1396 | ||
1397 | </p> | |
1398 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCopyDestConflicts">cupsCopyDestConflicts</a></h3> | |
1399 | <p class="description">Get conflicts and resolutions for a new | |
1400 | option/value pair.</p> | |
1401 | <p class="code"> | |
98d88c8d MS |
1402 | int cupsCopyDestConflicts(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, int num_options, <a href="#cups_option_t">cups_option_t</a> *options, const char *new_option, const char *new_value, int *num_conflicts, <a href="#cups_option_t">cups_option_t</a> **conflicts, int *num_resolved, <a href="#cups_option_t">cups_option_t</a> **resolved);</p> |
1403 | <h4 class="parameters">Parameters</h4> | |
1404 | <table class="list"><tbody> | |
1405 | <tr><th>http</th> | |
1406 | <td class="description">Connection to destination</td></tr> | |
1407 | <tr><th>dest</th> | |
1408 | <td class="description">Destination</td></tr> | |
1409 | <tr><th>dinfo</th> | |
1410 | <td class="description">Destination information</td></tr> | |
1411 | <tr><th>num_options</th> | |
1412 | <td class="description">Number of current options</td></tr> | |
1413 | <tr><th>options</th> | |
1414 | <td class="description">Current options</td></tr> | |
1415 | <tr><th>new_option</th> | |
1416 | <td class="description">New option</td></tr> | |
1417 | <tr><th>new_value</th> | |
1418 | <td class="description">New value</td></tr> | |
1419 | <tr><th>num_conflicts</th> | |
1420 | <td class="description">Number of conflicting options</td></tr> | |
1421 | <tr><th>conflicts</th> | |
1422 | <td class="description">Conflicting options</td></tr> | |
1423 | <tr><th>num_resolved</th> | |
1424 | <td class="description">Number of options to resolve</td></tr> | |
1425 | <tr><th>resolved</th> | |
1426 | <td class="description">Resolved options</td></tr> | |
1427 | </tbody></table> | |
798d6e29 MS |
1428 | <h4 class="returnvalue">Return Value</h4> |
1429 | <p class="description">1 if there is a conflict, 0 if none, -1 on error</p> | |
1430 | <h4 class="discussion">Discussion</h4> | |
1431 | <p class="discussion">"num_options" and "options" represent the currently selected options by the | |
1432 | user. "new_option" and "new_value" are the setting the user has just | |
1433 | changed.<br> | |
1434 | <br> | |
1435 | Returns 1 if there is a conflict, 0 if there are no conflicts, and -1 if | |
1436 | there was an unrecoverable error such as a resolver loop.<br> | |
1437 | <br> | |
1438 | If "num_conflicts" and "conflicts" are not <code>NULL</code>, they are set to | |
1439 | contain the list of conflicting option/value pairs. Similarly, if | |
1440 | "num_resolved" and "resolved" are not <code>NULL</code> they will be set to the | |
1441 | list of changes needed to resolve the conflict.<br> | |
1442 | <br> | |
1443 | If cupsCopyDestConflicts returns 1 but "num_resolved" and "resolved" are set | |
1444 | to 0 and <code>NULL</code>, respectively, then the conflict cannot be resolved. | |
1445 | ||
1446 | </p> | |
1447 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCopyDestInfo">cupsCopyDestInfo</a></h3> | |
1448 | <p class="description">Get the supported values/capabilities for the | |
1449 | destination.</p> | |
1450 | <p class="code"> | |
98d88c8d | 1451 | <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> |
798d6e29 | 1452 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
1453 | <table class="list"><tbody> |
1454 | <tr><th>http</th> | |
1455 | <td class="description">Connection to destination</td></tr> | |
1456 | <tr><th>dest</th> | |
1457 | <td class="description">Destination</td></tr> | |
1458 | </tbody></table> | |
798d6e29 MS |
1459 | <h4 class="returnvalue">Return Value</h4> |
1460 | <p class="description">Destination information</p> | |
1461 | <h4 class="discussion">Discussion</h4> | |
1462 | <p class="discussion">The caller is responsible for calling <a href="#cupsFreeDestInfo"><code>cupsFreeDestInfo</code></a> on the return | |
1463 | value. <code>NULL</code> is returned on error. | |
1464 | ||
1465 | </p> | |
1466 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsCreateDestJob">cupsCreateDestJob</a></h3> | |
1467 | <p class="description">Create a job on a destination.</p> | |
1468 | <p class="code"> | |
98d88c8d MS |
1469 | ipp_status_t cupsCreateDestJob(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info, int *job_id, const char *title, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
1470 | <h4 class="parameters">Parameters</h4> | |
1471 | <table class="list"><tbody> | |
1472 | <tr><th>http</th> | |
1473 | <td class="description">Connection to destination</td></tr> | |
1474 | <tr><th>dest</th> | |
1475 | <td class="description">Destination</td></tr> | |
1476 | <tr><th>info</th> | |
1477 | <td class="description">Destination information</td></tr> | |
1478 | <tr><th>job_id</th> | |
1479 | <td class="description">Job ID or 0 on error</td></tr> | |
1480 | <tr><th>title</th> | |
1481 | <td class="description">Job name</td></tr> | |
1482 | <tr><th>num_options</th> | |
1483 | <td class="description">Number of job options</td></tr> | |
1484 | <tr><th>options</th> | |
1485 | <td class="description">Job options</td></tr> | |
1486 | </tbody></table> | |
798d6e29 MS |
1487 | <h4 class="returnvalue">Return Value</h4> |
1488 | <p class="description">IPP status code</p> | |
1489 | <h4 class="discussion">Discussion</h4> | |
1490 | <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success, saving the job ID | |
1491 | in the variable pointed to by "job_id". | |
1492 | ||
1493 | </p> | |
798d6e29 MS |
1494 | <h3 class="function"><span class="info"> CUPS 1.1.20/macOS 10.4 </span><a id="cupsDoAuthentication">cupsDoAuthentication</a></h3> |
1495 | <p class="description">Authenticate a request.</p> | |
1496 | <p class="code"> | |
98d88c8d MS |
1497 | int cupsDoAuthentication(<a href="#http_t">http_t</a> *http, const char *method, const char *resource);</p> |
1498 | <h4 class="parameters">Parameters</h4> | |
1499 | <table class="list"><tbody> | |
1500 | <tr><th>http</th> | |
1501 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> | |
1502 | <tr><th>method</th> | |
1503 | <td class="description">Request method ("GET", "POST", "PUT")</td></tr> | |
1504 | <tr><th>resource</th> | |
1505 | <td class="description">Resource path</td></tr> | |
1506 | </tbody></table> | |
798d6e29 MS |
1507 | <h4 class="returnvalue">Return Value</h4> |
1508 | <p class="description">0 on success, -1 on error</p> | |
1509 | <h4 class="discussion">Discussion</h4> | |
1510 | <p class="discussion">This function should be called in response to a <code>HTTP_STATUS_UNAUTHORIZED</code> | |
1511 | status, prior to resubmitting your request. | |
1512 | ||
1513 | </p> | |
ddf2ec73 MS |
1514 | <h3 class="function"><span class="info"> CUPS 2.3 </span><a id="cupsEncodeOption">cupsEncodeOption</a></h3> |
1515 | <p class="description">Encode a single option into an IPP attribute.</p> | |
1516 | <p class="code"> | |
1517 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsEncodeOption(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group_tag, const char *name, const char *value);</p> | |
1518 | <h4 class="parameters">Parameters</h4> | |
1519 | <table class="list"><tbody> | |
1520 | <tr><th>ipp</th> | |
1521 | <td class="description">IPP request/response</td></tr> | |
1522 | <tr><th>group_tag</th> | |
1523 | <td class="description">Attribute group</td></tr> | |
1524 | <tr><th>name</th> | |
1525 | <td class="description">Option name</td></tr> | |
1526 | <tr><th>value</th> | |
1527 | <td class="description">Option string value</td></tr> | |
1528 | </tbody></table> | |
1529 | <h4 class="returnvalue">Return Value</h4> | |
1530 | <p class="description">New attribute or <code>NULL</code> on error</p> | |
798d6e29 | 1531 | <h3 class="function"><a id="cupsEncodeOptions">cupsEncodeOptions</a></h3> |
53af7f21 | 1532 | <p class="description">Encode printer options into IPP attributes.</p> |
98d88c8d MS |
1533 | <p class="code"> |
1534 | void cupsEncodeOptions(<a href="#ipp_t">ipp_t</a> *ipp, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> | |
1535 | <h4 class="parameters">Parameters</h4> | |
1536 | <table class="list"><tbody> | |
1537 | <tr><th>ipp</th> | |
ddf2ec73 | 1538 | <td class="description">IPP request/response</td></tr> |
98d88c8d MS |
1539 | <tr><th>num_options</th> |
1540 | <td class="description">Number of options</td></tr> | |
1541 | <tr><th>options</th> | |
1542 | <td class="description">Options</td></tr> | |
1543 | </tbody></table> | |
1544 | <h4 class="discussion">Discussion</h4> | |
798d6e29 | 1545 | <p class="discussion">This function adds operation, job, and then subscription attributes, |
98d88c8d MS |
1546 | in that order. Use the <a href="#cupsEncodeOptions2"><code>cupsEncodeOptions2</code></a> function to add attributes |
1547 | for a single group.</p> | |
1548 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsEncodeOptions2">cupsEncodeOptions2</a></h3> | |
53af7f21 | 1549 | <p class="description">Encode printer options into IPP attributes for a group.</p> |
98d88c8d MS |
1550 | <p class="code"> |
1551 | void cupsEncodeOptions2(<a href="#ipp_t">ipp_t</a> *ipp, int num_options, <a href="#cups_option_t">cups_option_t</a> *options, ipp_tag_t group_tag);</p> | |
1552 | <h4 class="parameters">Parameters</h4> | |
1553 | <table class="list"><tbody> | |
1554 | <tr><th>ipp</th> | |
ddf2ec73 | 1555 | <td class="description">IPP request/response</td></tr> |
98d88c8d MS |
1556 | <tr><th>num_options</th> |
1557 | <td class="description">Number of options</td></tr> | |
1558 | <tr><th>options</th> | |
1559 | <td class="description">Options</td></tr> | |
1560 | <tr><th>group_tag</th> | |
1561 | <td class="description">Group to encode</td></tr> | |
1562 | </tbody></table> | |
1563 | <h4 class="discussion">Discussion</h4> | |
798d6e29 | 1564 | <p class="discussion">This function only adds attributes for a single group. Call this |
98d88c8d | 1565 | function multiple times for each group, or use <a href="#cupsEncodeOptions"><code>cupsEncodeOptions</code></a> |
798d6e29 MS |
1566 | to add the standard groups. |
1567 | ||
1568 | </p> | |
1569 | <h3 class="function"><a id="cupsEncryption">cupsEncryption</a></h3> | |
1570 | <p class="description">Get the current encryption settings.</p> | |
1571 | <p class="code"> | |
98d88c8d | 1572 | <a href="#http_encryption_t">http_encryption_t</a> cupsEncryption(void);</p> |
798d6e29 MS |
1573 | <h4 class="returnvalue">Return Value</h4> |
1574 | <p class="description">Encryption settings</p> | |
1575 | <h4 class="discussion">Discussion</h4> | |
1576 | <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION | |
1577 | environment variable, then the ~/.cups/client.conf file, and finally the | |
1578 | /etc/cups/client.conf file. If not set, the default is | |
1579 | <code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> | |
1580 | <br> | |
1581 | Note: The current encryption setting is tracked separately for each thread | |
1582 | in a program. Multi-threaded programs that override the setting via the | |
1583 | <a href="#cupsSetEncryption"><code>cupsSetEncryption</code></a> function need to do so in each thread for the same | |
1584 | setting to be used.</p> | |
1585 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsEnumDests">cupsEnumDests</a></h3> | |
1586 | <p class="description">Enumerate available destinations with a callback function.</p> | |
1587 | <p class="code"> | |
98d88c8d MS |
1588 | int cupsEnumDests(unsigned flags, int msec, int *cancel, <a href="#cups_ptype_t">cups_ptype_t</a> type, <a href="#cups_ptype_t">cups_ptype_t</a> mask, <a href="#cups_dest_cb_t">cups_dest_cb_t</a> cb, void *user_data);</p> |
1589 | <h4 class="parameters">Parameters</h4> | |
1590 | <table class="list"><tbody> | |
1591 | <tr><th>flags</th> | |
1592 | <td class="description">Enumeration flags</td></tr> | |
1593 | <tr><th>msec</th> | |
1594 | <td class="description">Timeout in milliseconds, -1 for indefinite</td></tr> | |
1595 | <tr><th>cancel</th> | |
1596 | <td class="description">Pointer to "cancel" variable</td></tr> | |
1597 | <tr><th>type</th> | |
1598 | <td class="description">Printer type bits</td></tr> | |
1599 | <tr><th>mask</th> | |
1600 | <td class="description">Mask for printer type bits</td></tr> | |
1601 | <tr><th>cb</th> | |
1602 | <td class="description">Callback function</td></tr> | |
1603 | <tr><th>user_data</th> | |
1604 | <td class="description">User data</td></tr> | |
1605 | </tbody></table> | |
798d6e29 MS |
1606 | <h4 class="returnvalue">Return Value</h4> |
1607 | <p class="description">1 on success, 0 on failure</p> | |
1608 | <h4 class="discussion">Discussion</h4> | |
53af7f21 MS |
1609 | <p class="discussion">Destinations are enumerated from one or more sources. The callback function |
1610 | receives the <code>user_data</code> pointer and the destination pointer which can | |
1611 | be used as input to the <a href="#cupsCopyDest"><code>cupsCopyDest</code></a> function. The function must | |
1612 | return 1 to continue enumeration or 0 to stop.<br> | |
798d6e29 | 1613 | <br> |
53af7f21 MS |
1614 | The <code>type</code> and <code>mask</code> arguments allow the caller to filter the |
1615 | destinations that are enumerated. Passing 0 for both will enumerate all | |
1616 | printers. The constant <code>CUPS_PRINTER_DISCOVERED</code> is used to filter on | |
1617 | destinations that are available but have not yet been added locally.<br> | |
798d6e29 MS |
1618 | <br> |
1619 | Enumeration happens on the current thread and does not return until all | |
718ee2ff MS |
1620 | destinations have been enumerated or the callback function returns 0.<br> |
1621 | <br> | |
1622 | Note: The callback function will likely receive multiple updates for the same | |
1623 | destinations - it is up to the caller to suppress any duplicate destinations. | |
798d6e29 MS |
1624 | |
1625 | </p> | |
798d6e29 MS |
1626 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestDefault">cupsFindDestDefault</a></h3> |
1627 | <p class="description">Find the default value(s) for the given option.</p> | |
1628 | <p class="code"> | |
98d88c8d MS |
1629 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsFindDestDefault(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> |
1630 | <h4 class="parameters">Parameters</h4> | |
1631 | <table class="list"><tbody> | |
1632 | <tr><th>http</th> | |
1633 | <td class="description">Connection to destination</td></tr> | |
1634 | <tr><th>dest</th> | |
1635 | <td class="description">Destination</td></tr> | |
1636 | <tr><th>dinfo</th> | |
1637 | <td class="description">Destination information</td></tr> | |
1638 | <tr><th>option</th> | |
1639 | <td class="description">Option/attribute name</td></tr> | |
1640 | </tbody></table> | |
798d6e29 MS |
1641 | <h4 class="returnvalue">Return Value</h4> |
1642 | <p class="description">Default attribute or <code>NULL</code> for none</p> | |
1643 | <h4 class="discussion">Discussion</h4> | |
1644 | <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, | |
1645 | <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, | |
1646 | <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, | |
1647 | <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> | |
1648 | functions to inspect the default value(s) as needed. | |
1649 | ||
1650 | </p> | |
1651 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestReady">cupsFindDestReady</a></h3> | |
1652 | <p class="description">Find the default value(s) for the given option.</p> | |
1653 | <p class="code"> | |
98d88c8d MS |
1654 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsFindDestReady(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> |
1655 | <h4 class="parameters">Parameters</h4> | |
1656 | <table class="list"><tbody> | |
1657 | <tr><th>http</th> | |
1658 | <td class="description">Connection to destination</td></tr> | |
1659 | <tr><th>dest</th> | |
1660 | <td class="description">Destination</td></tr> | |
1661 | <tr><th>dinfo</th> | |
1662 | <td class="description">Destination information</td></tr> | |
1663 | <tr><th>option</th> | |
1664 | <td class="description">Option/attribute name</td></tr> | |
1665 | </tbody></table> | |
798d6e29 MS |
1666 | <h4 class="returnvalue">Return Value</h4> |
1667 | <p class="description">Default attribute or <code>NULL</code> for none</p> | |
1668 | <h4 class="discussion">Discussion</h4> | |
1669 | <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, | |
1670 | <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, | |
1671 | <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, | |
1672 | <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> | |
1673 | functions to inspect the default value(s) as needed. | |
1674 | ||
1675 | </p> | |
1676 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsFindDestSupported">cupsFindDestSupported</a></h3> | |
1677 | <p class="description">Find the default value(s) for the given option.</p> | |
1678 | <p class="code"> | |
98d88c8d MS |
1679 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *cupsFindDestSupported(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> |
1680 | <h4 class="parameters">Parameters</h4> | |
1681 | <table class="list"><tbody> | |
1682 | <tr><th>http</th> | |
1683 | <td class="description">Connection to destination</td></tr> | |
1684 | <tr><th>dest</th> | |
1685 | <td class="description">Destination</td></tr> | |
1686 | <tr><th>dinfo</th> | |
1687 | <td class="description">Destination information</td></tr> | |
1688 | <tr><th>option</th> | |
1689 | <td class="description">Option/attribute name</td></tr> | |
1690 | </tbody></table> | |
798d6e29 MS |
1691 | <h4 class="returnvalue">Return Value</h4> |
1692 | <p class="description">Default attribute or <code>NULL</code> for none</p> | |
1693 | <h4 class="discussion">Discussion</h4> | |
1694 | <p class="discussion">The returned value is an IPP attribute. Use the <code>ippGetBoolean</code>, | |
1695 | <code>ippGetCollection</code>, <code>ippGetCount</code>, <code>ippGetDate</code>, | |
1696 | <code>ippGetInteger</code>, <code>ippGetOctetString</code>, <code>ippGetRange</code>, | |
1697 | <code>ippGetResolution</code>, <code>ippGetString</code>, and <code>ippGetValueTag</code> | |
1698 | functions to inspect the default value(s) as needed. | |
1699 | ||
1700 | </p> | |
1701 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsFinishDestDocument">cupsFinishDestDocument</a></h3> | |
1702 | <p class="description">Finish the current document.</p> | |
1703 | <p class="code"> | |
98d88c8d MS |
1704 | 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> |
1705 | <h4 class="parameters">Parameters</h4> | |
1706 | <table class="list"><tbody> | |
1707 | <tr><th>http</th> | |
1708 | <td class="description">Connection to destination</td></tr> | |
1709 | <tr><th>dest</th> | |
1710 | <td class="description">Destination</td></tr> | |
1711 | <tr><th>info</th> | |
1712 | <td class="description">Destination information</td></tr> | |
1713 | </tbody></table> | |
798d6e29 MS |
1714 | <h4 class="returnvalue">Return Value</h4> |
1715 | <p class="description">Status of document submission</p> | |
1716 | <h4 class="discussion">Discussion</h4> | |
1717 | <p class="discussion">Returns <code>IPP_STATUS_OK</code> or <code>IPP_STATUS_OK_SUBST</code> on success. | |
1718 | ||
798d6e29 | 1719 | </p> |
98d88c8d | 1720 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsFreeDestInfo">cupsFreeDestInfo</a></h3> |
53af7f21 MS |
1721 | <p class="description">Free destination information obtained using |
1722 | <a href="#cupsCopyDestInfo"><code>cupsCopyDestInfo</code></a>.</p> | |
798d6e29 | 1723 | <p class="code"> |
98d88c8d | 1724 | void cupsFreeDestInfo(<a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo);</p> |
798d6e29 | 1725 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
1726 | <table class="list"><tbody> |
1727 | <tr><th>dinfo</th> | |
1728 | <td class="description">Destination information</td></tr> | |
1729 | </tbody></table> | |
1730 | <h3 class="function"><a id="cupsFreeDests">cupsFreeDests</a></h3> | |
53af7f21 | 1731 | <p class="description">Free the memory used by the list of destinations.</p> |
798d6e29 | 1732 | <p class="code"> |
98d88c8d | 1733 | void cupsFreeDests(int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
798d6e29 | 1734 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
1735 | <table class="list"><tbody> |
1736 | <tr><th>num_dests</th> | |
1737 | <td class="description">Number of destinations</td></tr> | |
1738 | <tr><th>dests</th> | |
1739 | <td class="description">Destinations</td></tr> | |
1740 | </tbody></table> | |
1741 | <h3 class="function"><a id="cupsFreeJobs">cupsFreeJobs</a></h3> | |
53af7f21 | 1742 | <p class="description">Free memory used by job data.</p> |
798d6e29 | 1743 | <p class="code"> |
98d88c8d | 1744 | void cupsFreeJobs(int num_jobs, <a href="#cups_job_t">cups_job_t</a> *jobs);</p> |
798d6e29 | 1745 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
1746 | <table class="list"><tbody> |
1747 | <tr><th>num_jobs</th> | |
1748 | <td class="description">Number of jobs</td></tr> | |
1749 | <tr><th>jobs</th> | |
1750 | <td class="description">Jobs</td></tr> | |
1751 | </tbody></table> | |
1752 | <h3 class="function"><a id="cupsFreeOptions">cupsFreeOptions</a></h3> | |
53af7f21 | 1753 | <p class="description">Free all memory used by options.</p> |
98d88c8d MS |
1754 | <p class="code"> |
1755 | void cupsFreeOptions(int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> | |
1756 | <h4 class="parameters">Parameters</h4> | |
1757 | <table class="list"><tbody> | |
1758 | <tr><th>num_options</th> | |
1759 | <td class="description">Number of options</td></tr> | |
1760 | <tr><th>options</th> | |
1761 | <td class="description">Pointer to options</td></tr> | |
1762 | </tbody></table> | |
798d6e29 MS |
1763 | <h3 class="function"><a id="cupsGetDest">cupsGetDest</a></h3> |
1764 | <p class="description">Get the named destination from the list.</p> | |
1765 | <p class="code"> | |
98d88c8d MS |
1766 | <a href="#cups_dest_t">cups_dest_t</a> *cupsGetDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
1767 | <h4 class="parameters">Parameters</h4> | |
1768 | <table class="list"><tbody> | |
1769 | <tr><th>name</th> | |
1770 | <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr> | |
1771 | <tr><th>instance</th> | |
1772 | <td class="description">Instance name or <code>NULL</code></td></tr> | |
1773 | <tr><th>num_dests</th> | |
1774 | <td class="description">Number of destinations</td></tr> | |
1775 | <tr><th>dests</th> | |
1776 | <td class="description">Destinations</td></tr> | |
1777 | </tbody></table> | |
798d6e29 MS |
1778 | <h4 class="returnvalue">Return Value</h4> |
1779 | <p class="description">Destination pointer or <code>NULL</code></p> | |
1780 | <h4 class="discussion">Discussion</h4> | |
98d88c8d | 1781 | <p class="discussion">Use the <a href="#cupsEnumDests"><code>cupsEnumDests</code></a> or <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> functions to get a |
798d6e29 MS |
1782 | list of supported destinations for the current user.</p> |
1783 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsGetDestMediaByIndex">cupsGetDestMediaByIndex</a></h3> | |
1784 | <p class="description">Get a media name, dimension, and margins for a | |
1785 | specific size.</p> | |
1786 | <p class="code"> | |
98d88c8d MS |
1787 | int cupsGetDestMediaByIndex(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, int n, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
1788 | <h4 class="parameters">Parameters</h4> | |
1789 | <table class="list"><tbody> | |
1790 | <tr><th>http</th> | |
1791 | <td class="description">Connection to destination</td></tr> | |
1792 | <tr><th>dest</th> | |
1793 | <td class="description">Destination</td></tr> | |
1794 | <tr><th>dinfo</th> | |
1795 | <td class="description">Destination information</td></tr> | |
1796 | <tr><th>n</th> | |
1797 | <td class="description">Media size number (0-based)</td></tr> | |
1798 | <tr><th>flags</th> | |
1799 | <td class="description">Media flags</td></tr> | |
1800 | <tr><th>size</th> | |
1801 | <td class="description">Media size information</td></tr> | |
1802 | </tbody></table> | |
798d6e29 MS |
1803 | <h4 class="returnvalue">Return Value</h4> |
1804 | <p class="description">1 on success, 0 on failure</p> | |
1805 | <h4 class="discussion">Discussion</h4> | |
1806 | <p class="discussion">The <code>flags</code> parameter determines which set of media are indexed. For | |
1807 | example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will get the Nth | |
1808 | borderless size supported by the printer. | |
1809 | ||
1810 | </p> | |
1811 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsGetDestMediaByName">cupsGetDestMediaByName</a></h3> | |
1812 | <p class="description">Get media names, dimensions, and margins.</p> | |
1813 | <p class="code"> | |
98d88c8d MS |
1814 | int cupsGetDestMediaByName(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *media, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
1815 | <h4 class="parameters">Parameters</h4> | |
1816 | <table class="list"><tbody> | |
1817 | <tr><th>http</th> | |
1818 | <td class="description">Connection to destination</td></tr> | |
1819 | <tr><th>dest</th> | |
1820 | <td class="description">Destination</td></tr> | |
1821 | <tr><th>dinfo</th> | |
1822 | <td class="description">Destination information</td></tr> | |
1823 | <tr><th>media</th> | |
1824 | <td class="description">Media name</td></tr> | |
1825 | <tr><th>flags</th> | |
1826 | <td class="description">Media matching flags</td></tr> | |
1827 | <tr><th>size</th> | |
1828 | <td class="description">Media size information</td></tr> | |
1829 | </tbody></table> | |
798d6e29 MS |
1830 | <h4 class="returnvalue">Return Value</h4> |
1831 | <p class="description">1 on match, 0 on failure</p> | |
1832 | <h4 class="discussion">Discussion</h4> | |
1833 | <p class="discussion">The "media" string is a PWG media name. "Flags" provides some matching | |
1834 | guidance (multiple flags can be combined):<br> | |
1835 | <br> | |
1836 | CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, | |
1837 | CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, | |
1838 | CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, | |
1839 | CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and | |
1840 | CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the | |
1841 | size amongst the "ready" media.<br> | |
1842 | <br> | |
1843 | The matching result (if any) is returned in the "cups_size_t" structure.<br> | |
1844 | <br> | |
1845 | Returns 1 when there is a match and 0 if there is not a match. | |
1846 | ||
1847 | </p> | |
1848 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsGetDestMediaBySize">cupsGetDestMediaBySize</a></h3> | |
1849 | <p class="description">Get media names, dimensions, and margins.</p> | |
1850 | <p class="code"> | |
98d88c8d MS |
1851 | int cupsGetDestMediaBySize(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, int width, int length, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
1852 | <h4 class="parameters">Parameters</h4> | |
1853 | <table class="list"><tbody> | |
1854 | <tr><th>http</th> | |
1855 | <td class="description">Connection to destination</td></tr> | |
1856 | <tr><th>dest</th> | |
1857 | <td class="description">Destination</td></tr> | |
1858 | <tr><th>dinfo</th> | |
1859 | <td class="description">Destination information</td></tr> | |
1860 | <tr><th>width</th> | |
1861 | <td class="description">Media width in hundredths of | |
1862 | of millimeters</td></tr> | |
1863 | <tr><th>length</th> | |
1864 | <td class="description">Media length in hundredths of | |
1865 | of millimeters</td></tr> | |
1866 | <tr><th>flags</th> | |
1867 | <td class="description">Media matching flags</td></tr> | |
1868 | <tr><th>size</th> | |
1869 | <td class="description">Media size information</td></tr> | |
1870 | </tbody></table> | |
798d6e29 MS |
1871 | <h4 class="returnvalue">Return Value</h4> |
1872 | <p class="description">1 on match, 0 on failure</p> | |
1873 | <h4 class="discussion">Discussion</h4> | |
1874 | <p class="discussion">"Width" and "length" are the dimensions in hundredths of millimeters. | |
1875 | "Flags" provides some matching guidance (multiple flags can be combined):<br> | |
1876 | <br> | |
1877 | CUPS_MEDIA_FLAGS_DEFAULT = find the closest size supported by the printer, | |
1878 | CUPS_MEDIA_FLAGS_BORDERLESS = find a borderless size, | |
1879 | CUPS_MEDIA_FLAGS_DUPLEX = find a size compatible with 2-sided printing, | |
1880 | CUPS_MEDIA_FLAGS_EXACT = find an exact match for the size, and | |
1881 | CUPS_MEDIA_FLAGS_READY = if the printer supports media sensing, find the | |
1882 | size amongst the "ready" media.<br> | |
1883 | <br> | |
1884 | The matching result (if any) is returned in the "cups_size_t" structure.<br> | |
1885 | <br> | |
1886 | Returns 1 when there is a match and 0 if there is not a match. | |
1887 | ||
1888 | </p> | |
1889 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsGetDestMediaCount">cupsGetDestMediaCount</a></h3> | |
1890 | <p class="description">Get the number of sizes supported by a | |
1891 | destination.</p> | |
1892 | <p class="code"> | |
98d88c8d MS |
1893 | int cupsGetDestMediaCount(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags);</p> |
1894 | <h4 class="parameters">Parameters</h4> | |
1895 | <table class="list"><tbody> | |
1896 | <tr><th>http</th> | |
1897 | <td class="description">Connection to destination</td></tr> | |
1898 | <tr><th>dest</th> | |
1899 | <td class="description">Destination</td></tr> | |
1900 | <tr><th>dinfo</th> | |
1901 | <td class="description">Destination information</td></tr> | |
1902 | <tr><th>flags</th> | |
1903 | <td class="description">Media flags</td></tr> | |
1904 | </tbody></table> | |
798d6e29 MS |
1905 | <h4 class="returnvalue">Return Value</h4> |
1906 | <p class="description">Number of sizes</p> | |
1907 | <h4 class="discussion">Discussion</h4> | |
1908 | <p class="discussion">The <code>flags</code> parameter determines the set of media sizes that are | |
1909 | counted. For example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return | |
1910 | the number of borderless sizes. | |
1911 | ||
1912 | </p> | |
1913 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsGetDestMediaDefault">cupsGetDestMediaDefault</a></h3> | |
1914 | <p class="description">Get the default size for a destination.</p> | |
1915 | <p class="code"> | |
98d88c8d MS |
1916 | int cupsGetDestMediaDefault(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
1917 | <h4 class="parameters">Parameters</h4> | |
1918 | <table class="list"><tbody> | |
1919 | <tr><th>http</th> | |
1920 | <td class="description">Connection to destination</td></tr> | |
1921 | <tr><th>dest</th> | |
1922 | <td class="description">Destination</td></tr> | |
1923 | <tr><th>dinfo</th> | |
1924 | <td class="description">Destination information</td></tr> | |
1925 | <tr><th>flags</th> | |
1926 | <td class="description">Media flags</td></tr> | |
1927 | <tr><th>size</th> | |
1928 | <td class="description">Media size information</td></tr> | |
1929 | </tbody></table> | |
798d6e29 MS |
1930 | <h4 class="returnvalue">Return Value</h4> |
1931 | <p class="description">1 on success, 0 on failure</p> | |
1932 | <h4 class="discussion">Discussion</h4> | |
1933 | <p class="discussion">The <code>flags</code> parameter determines which default size is returned. For | |
1934 | example, passing <code>CUPS_MEDIA_FLAGS_BORDERLESS</code> will return the default | |
1935 | borderless size, typically US Letter or A4, but sometimes 4x6 photo media. | |
1936 | ||
1937 | </p> | |
1938 | <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="cupsGetDestWithURI">cupsGetDestWithURI</a></h3> | |
1939 | <p class="description">Get a destination associated with a URI.</p> | |
1940 | <p class="code"> | |
98d88c8d | 1941 | <a href="#cups_dest_t">cups_dest_t</a> *cupsGetDestWithURI(const char *name, const char *uri);</p> |
798d6e29 | 1942 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
1943 | <table class="list"><tbody> |
1944 | <tr><th>name</th> | |
1945 | <td class="description">Desired printer name or <code>NULL</code></td></tr> | |
1946 | <tr><th>uri</th> | |
1947 | <td class="description">URI for the printer</td></tr> | |
1948 | </tbody></table> | |
798d6e29 MS |
1949 | <h4 class="returnvalue">Return Value</h4> |
1950 | <p class="description">Destination or <code>NULL</code></p> | |
1951 | <h4 class="discussion">Discussion</h4> | |
1952 | <p class="discussion">"name" is the desired name for the printer. If <code>NULL</code>, a name will be | |
1953 | created using the URI.<br> | |
1954 | <br> | |
1955 | "uri" is the "ipp" or "ipps" URI for the printer. | |
1956 | ||
1957 | </p> | |
98d88c8d MS |
1958 | <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsGetDests2">cupsGetDests2</a></h3> |
1959 | <p class="description">Get the list of destinations from the specified server.</p> | |
1960 | <p class="code"> | |
1961 | int cupsGetDests2(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> | |
1962 | <h4 class="parameters">Parameters</h4> | |
1963 | <table class="list"><tbody> | |
1964 | <tr><th>http</th> | |
1965 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> | |
1966 | <tr><th>dests</th> | |
1967 | <td class="description">Destinations</td></tr> | |
1968 | </tbody></table> | |
1969 | <h4 class="returnvalue">Return Value</h4> | |
1970 | <p class="description">Number of destinations</p> | |
1971 | <h4 class="discussion">Discussion</h4> | |
1972 | <p class="discussion">Starting with CUPS 1.2, the returned list of destinations include the | |
1973 | "printer-info", "printer-is-accepting-jobs", "printer-is-shared", | |
1974 | "printer-make-and-model", "printer-state", "printer-state-change-time", | |
1975 | "printer-state-reasons", "printer-type", and "printer-uri-supported" | |
1976 | attributes as options.<br> | |
1977 | <br> | |
1978 | CUPS 1.4 adds the "marker-change-time", "marker-colors", | |
1979 | "marker-high-levels", "marker-levels", "marker-low-levels", "marker-message", | |
1980 | "marker-names", "marker-types", and "printer-commands" attributes as options.<br> | |
1981 | <br> | |
1982 | CUPS 2.2 adds accessible IPP printers to the list of destinations that can | |
1983 | be used. The "printer-uri-supported" option will be present for those IPP | |
1984 | printers that have been recently used.<br> | |
1985 | <br> | |
1986 | Use the <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> function to free the destination list and | |
1987 | the <a href="#cupsGetDest"><code>cupsGetDest</code></a> function to find a particular destination. | |
1988 | ||
1989 | </p> | |
1990 | <h3 class="function"><span class="info"> CUPS 2.2.4/macOS 10.13 </span><a id="cupsGetIntegerOption">cupsGetIntegerOption</a></h3> | |
53af7f21 | 1991 | <p class="description">Get an integer option value.</p> |
798d6e29 | 1992 | <p class="code"> |
98d88c8d MS |
1993 | int cupsGetIntegerOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
1994 | <h4 class="parameters">Parameters</h4> | |
1995 | <table class="list"><tbody> | |
1996 | <tr><th>name</th> | |
1997 | <td class="description">Name of option</td></tr> | |
1998 | <tr><th>num_options</th> | |
1999 | <td class="description">Number of options</td></tr> | |
2000 | <tr><th>options</th> | |
2001 | <td class="description">Options</td></tr> | |
2002 | </tbody></table> | |
798d6e29 | 2003 | <h4 class="returnvalue">Return Value</h4> |
53af7f21 | 2004 | <p class="description">Option value or <code>INT_MIN</code></p> |
798d6e29 | 2005 | <h4 class="discussion">Discussion</h4> |
53af7f21 MS |
2006 | <p class="discussion">INT_MIN is returned when the option does not exist, is not an integer, or |
2007 | exceeds the range of values for the "int" type. | |
2008 | ||
2009 | </p> | |
798d6e29 MS |
2010 | <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsGetJobs2">cupsGetJobs2</a></h3> |
2011 | <p class="description">Get the jobs from the specified server.</p> | |
2012 | <p class="code"> | |
98d88c8d MS |
2013 | int cupsGetJobs2(<a href="#http_t">http_t</a> *http, <a href="#cups_job_t">cups_job_t</a> **jobs, const char *name, int myjobs, int whichjobs);</p> |
2014 | <h4 class="parameters">Parameters</h4> | |
2015 | <table class="list"><tbody> | |
2016 | <tr><th>http</th> | |
2017 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> | |
2018 | <tr><th>jobs</th> | |
2019 | <td class="description">Job data</td></tr> | |
2020 | <tr><th>name</th> | |
2021 | <td class="description"><code>NULL</code> = all destinations, otherwise show jobs for named destination</td></tr> | |
2022 | <tr><th>myjobs</th> | |
2023 | <td class="description">0 = all users, 1 = mine</td></tr> | |
2024 | <tr><th>whichjobs</th> | |
2025 | <td class="description"><code>CUPS_WHICHJOBS_ALL</code>, <code>CUPS_WHICHJOBS_ACTIVE</code>, or <code>CUPS_WHICHJOBS_COMPLETED</code></td></tr> | |
2026 | </tbody></table> | |
798d6e29 MS |
2027 | <h4 class="returnvalue">Return Value</h4> |
2028 | <p class="description">Number of jobs</p> | |
2029 | <h4 class="discussion">Discussion</h4> | |
2030 | <p class="discussion">A "whichjobs" value of <code>CUPS_WHICHJOBS_ALL</code> returns all jobs regardless | |
2031 | of state, while <code>CUPS_WHICHJOBS_ACTIVE</code> returns jobs that are | |
2032 | pending, processing, or held and <code>CUPS_WHICHJOBS_COMPLETED</code> returns | |
2033 | jobs that are stopped, canceled, aborted, or completed. | |
2034 | ||
2035 | </p> | |
2036 | <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsGetNamedDest">cupsGetNamedDest</a></h3> | |
2037 | <p class="description">Get options for the named destination.</p> | |
2038 | <p class="code"> | |
98d88c8d MS |
2039 | <a href="#cups_dest_t">cups_dest_t</a> *cupsGetNamedDest(<a href="#http_t">http_t</a> *http, const char *name, const char *instance);</p> |
2040 | <h4 class="parameters">Parameters</h4> | |
2041 | <table class="list"><tbody> | |
2042 | <tr><th>http</th> | |
2043 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> | |
2044 | <tr><th>name</th> | |
2045 | <td class="description">Destination name or <code>NULL</code> for the default destination</td></tr> | |
2046 | <tr><th>instance</th> | |
2047 | <td class="description">Instance name or <code>NULL</code></td></tr> | |
2048 | </tbody></table> | |
798d6e29 MS |
2049 | <h4 class="returnvalue">Return Value</h4> |
2050 | <p class="description">Destination or <code>NULL</code></p> | |
2051 | <h4 class="discussion">Discussion</h4> | |
2052 | <p class="discussion">This function is optimized for retrieving a single destination and should | |
98d88c8d MS |
2053 | be used instead of <a href="#cupsGetDests2"><code>cupsGetDests2</code></a> and <a href="#cupsGetDest"><code>cupsGetDest</code></a> when you |
2054 | either know the name of the destination or want to print to the default | |
2055 | destination. If <code>NULL</code> is returned, the destination does not exist or | |
2056 | there is no default destination.<br> | |
798d6e29 MS |
2057 | <br> |
2058 | If "http" is <code>CUPS_HTTP_DEFAULT</code>, the connection to the default print | |
2059 | server will be used.<br> | |
2060 | <br> | |
2061 | If "name" is <code>NULL</code>, the default printer for the current user will be | |
2062 | returned.<br> | |
2063 | <br> | |
2064 | The returned destination must be freed using <a href="#cupsFreeDests"><code>cupsFreeDests</code></a> with a | |
2065 | "num_dests" value of 1. | |
2066 | ||
2067 | </p> | |
2068 | <h3 class="function"><a id="cupsGetOption">cupsGetOption</a></h3> | |
2069 | <p class="description">Get an option value.</p> | |
2070 | <p class="code"> | |
98d88c8d MS |
2071 | const char *cupsGetOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> *options);</p> |
2072 | <h4 class="parameters">Parameters</h4> | |
2073 | <table class="list"><tbody> | |
2074 | <tr><th>name</th> | |
2075 | <td class="description">Name of option</td></tr> | |
2076 | <tr><th>num_options</th> | |
2077 | <td class="description">Number of options</td></tr> | |
2078 | <tr><th>options</th> | |
2079 | <td class="description">Options</td></tr> | |
2080 | </tbody></table> | |
798d6e29 MS |
2081 | <h4 class="returnvalue">Return Value</h4> |
2082 | <p class="description">Option value or <code>NULL</code></p> | |
798d6e29 | 2083 | <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsGetPassword2">cupsGetPassword2</a></h3> |
98d88c8d | 2084 | <p class="description">Get a password from the user using the current |
798d6e29 MS |
2085 | password callback.</p> |
2086 | <p class="code"> | |
98d88c8d MS |
2087 | const char *cupsGetPassword2(const char *prompt, <a href="#http_t">http_t</a> *http, const char *method, const char *resource);</p> |
2088 | <h4 class="parameters">Parameters</h4> | |
2089 | <table class="list"><tbody> | |
2090 | <tr><th>prompt</th> | |
2091 | <td class="description">Prompt string</td></tr> | |
2092 | <tr><th>http</th> | |
2093 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> | |
2094 | <tr><th>method</th> | |
2095 | <td class="description">Request method ("GET", "POST", "PUT")</td></tr> | |
2096 | <tr><th>resource</th> | |
2097 | <td class="description">Resource path</td></tr> | |
2098 | </tbody></table> | |
798d6e29 MS |
2099 | <h4 class="returnvalue">Return Value</h4> |
2100 | <p class="description">Password</p> | |
2101 | <h4 class="discussion">Discussion</h4> | |
2102 | <p class="discussion">Uses the current password callback function. Returns <code>NULL</code> if the | |
2103 | user does not provide a password.<br> | |
2104 | <br> | |
2105 | Note: The current password callback function is tracked separately for each | |
2106 | thread in a program. Multi-threaded programs that override the setting via | |
98d88c8d MS |
2107 | the <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a> function need to do so in each thread for the |
2108 | same function to be used. | |
798d6e29 | 2109 | |
798d6e29 | 2110 | </p> |
798d6e29 MS |
2111 | <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="cupsLocalizeDestMedia">cupsLocalizeDestMedia</a></h3> |
2112 | <p class="description">Get the localized string for a destination media | |
2113 | size.</p> | |
2114 | <p class="code"> | |
98d88c8d MS |
2115 | const char *cupsLocalizeDestMedia(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, unsigned flags, <a href="#cups_size_t">cups_size_t</a> *size);</p> |
2116 | <h4 class="parameters">Parameters</h4> | |
2117 | <table class="list"><tbody> | |
2118 | <tr><th>http</th> | |
2119 | <td class="description">Connection to destination</td></tr> | |
2120 | <tr><th>dest</th> | |
2121 | <td class="description">Destination</td></tr> | |
2122 | <tr><th>dinfo</th> | |
2123 | <td class="description">Destination information</td></tr> | |
2124 | <tr><th>flags</th> | |
2125 | <td class="description">Media flags</td></tr> | |
2126 | <tr><th>size</th> | |
2127 | <td class="description">Media size</td></tr> | |
2128 | </tbody></table> | |
798d6e29 MS |
2129 | <h4 class="returnvalue">Return Value</h4> |
2130 | <p class="description">Localized string</p> | |
2131 | <h4 class="discussion">Discussion</h4> | |
2132 | <p class="discussion">The returned string is stored in the destination information and will become | |
2133 | invalid if the destination information is deleted. | |
2134 | ||
2135 | </p> | |
2136 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsLocalizeDestOption">cupsLocalizeDestOption</a></h3> | |
2137 | <p class="description">Get the localized string for a destination | |
2138 | option.</p> | |
2139 | <p class="code"> | |
98d88c8d MS |
2140 | const char *cupsLocalizeDestOption(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option);</p> |
2141 | <h4 class="parameters">Parameters</h4> | |
2142 | <table class="list"><tbody> | |
2143 | <tr><th>http</th> | |
2144 | <td class="description">Connection to destination</td></tr> | |
2145 | <tr><th>dest</th> | |
2146 | <td class="description">Destination</td></tr> | |
2147 | <tr><th>dinfo</th> | |
2148 | <td class="description">Destination information</td></tr> | |
2149 | <tr><th>option</th> | |
2150 | <td class="description">Option to localize</td></tr> | |
2151 | </tbody></table> | |
798d6e29 MS |
2152 | <h4 class="returnvalue">Return Value</h4> |
2153 | <p class="description">Localized string</p> | |
2154 | <h4 class="discussion">Discussion</h4> | |
2155 | <p class="discussion">The returned string is stored in the destination information and will become | |
2156 | invalid if the destination information is deleted. | |
2157 | ||
2158 | </p> | |
2159 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsLocalizeDestValue">cupsLocalizeDestValue</a></h3> | |
2160 | <p class="description">Get the localized string for a destination | |
2161 | option+value pair.</p> | |
2162 | <p class="code"> | |
98d88c8d MS |
2163 | const char *cupsLocalizeDestValue(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *dinfo, const char *option, const char *value);</p> |
2164 | <h4 class="parameters">Parameters</h4> | |
2165 | <table class="list"><tbody> | |
2166 | <tr><th>http</th> | |
2167 | <td class="description">Connection to destination</td></tr> | |
2168 | <tr><th>dest</th> | |
2169 | <td class="description">Destination</td></tr> | |
2170 | <tr><th>dinfo</th> | |
2171 | <td class="description">Destination information</td></tr> | |
2172 | <tr><th>option</th> | |
2173 | <td class="description">Option to localize</td></tr> | |
2174 | <tr><th>value</th> | |
2175 | <td class="description">Value to localize</td></tr> | |
2176 | </tbody></table> | |
798d6e29 MS |
2177 | <h4 class="returnvalue">Return Value</h4> |
2178 | <p class="description">Localized string</p> | |
2179 | <h4 class="discussion">Discussion</h4> | |
2180 | <p class="discussion">The returned string is stored in the destination information and will become | |
2181 | invalid if the destination information is deleted. | |
2182 | ||
2183 | </p> | |
2184 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="cupsMakeServerCredentials">cupsMakeServerCredentials</a></h3> | |
2185 | <p class="description">Make a self-signed certificate and private key pair.</p> | |
2186 | <p class="code"> | |
98d88c8d MS |
2187 | int cupsMakeServerCredentials(const char *path, const char *common_name, int num_alt_names, const char **alt_names, time_t expiration_date);</p> |
2188 | <h4 class="parameters">Parameters</h4> | |
2189 | <table class="list"><tbody> | |
2190 | <tr><th>path</th> | |
2191 | <td class="description">Keychain path or <code>NULL</code> for default</td></tr> | |
2192 | <tr><th>common_name</th> | |
2193 | <td class="description">Common name</td></tr> | |
2194 | <tr><th>num_alt_names</th> | |
2195 | <td class="description">Number of subject alternate names</td></tr> | |
2196 | <tr><th>alt_names</th> | |
2197 | <td class="description">Subject Alternate Names</td></tr> | |
2198 | <tr><th>expiration_date</th> | |
2199 | <td class="description">Expiration date</td></tr> | |
2200 | </tbody></table> | |
798d6e29 MS |
2201 | <h4 class="returnvalue">Return Value</h4> |
2202 | <p class="description">1 on success, 0 on failure</p> | |
798d6e29 MS |
2203 | <h3 class="function"><a id="cupsParseOptions">cupsParseOptions</a></h3> |
2204 | <p class="description">Parse options from a command-line argument.</p> | |
2205 | <p class="code"> | |
98d88c8d MS |
2206 | int cupsParseOptions(const char *arg, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
2207 | <h4 class="parameters">Parameters</h4> | |
2208 | <table class="list"><tbody> | |
2209 | <tr><th>arg</th> | |
2210 | <td class="description">Argument to parse</td></tr> | |
2211 | <tr><th>num_options</th> | |
2212 | <td class="description">Number of options</td></tr> | |
2213 | <tr><th>options</th> | |
2214 | <td class="description">Options found</td></tr> | |
2215 | </tbody></table> | |
798d6e29 MS |
2216 | <h4 class="returnvalue">Return Value</h4> |
2217 | <p class="description">Number of options found</p> | |
2218 | <h4 class="discussion">Discussion</h4> | |
2219 | <p class="discussion">This function converts space-delimited name/value pairs according | |
2220 | to the PAPI text option ABNF specification. Collection values | |
2221 | ("name={a=... b=... c=...}") are stored with the curley brackets | |
2222 | intact - use <code>cupsParseOptions</code> on the value to extract the | |
2223 | collection attributes.</p> | |
798d6e29 MS |
2224 | <h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsRemoveDest">cupsRemoveDest</a></h3> |
2225 | <p class="description">Remove a destination from the destination list.</p> | |
2226 | <p class="code"> | |
98d88c8d MS |
2227 | int cupsRemoveDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> **dests);</p> |
2228 | <h4 class="parameters">Parameters</h4> | |
2229 | <table class="list"><tbody> | |
2230 | <tr><th>name</th> | |
2231 | <td class="description">Destination name</td></tr> | |
2232 | <tr><th>instance</th> | |
2233 | <td class="description">Instance name or <code>NULL</code></td></tr> | |
2234 | <tr><th>num_dests</th> | |
2235 | <td class="description">Number of destinations</td></tr> | |
2236 | <tr><th>dests</th> | |
2237 | <td class="description">Destinations</td></tr> | |
2238 | </tbody></table> | |
798d6e29 MS |
2239 | <h4 class="returnvalue">Return Value</h4> |
2240 | <p class="description">New number of destinations</p> | |
2241 | <h4 class="discussion">Discussion</h4> | |
2242 | <p class="discussion">Removing a destination/instance does not delete the class or printer | |
2243 | queue, merely the lpoptions for that destination/instance. Use the | |
2244 | <a href="#cupsSetDests"><code>cupsSetDests</code></a> or <a href="#cupsSetDests2"><code>cupsSetDests2</code></a> functions to save the new | |
2245 | options for the user. | |
2246 | ||
2247 | </p> | |
2248 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="cupsRemoveOption">cupsRemoveOption</a></h3> | |
2249 | <p class="description">Remove an option from an option array.</p> | |
2250 | <p class="code"> | |
98d88c8d MS |
2251 | int cupsRemoveOption(const char *name, int num_options, <a href="#cups_option_t">cups_option_t</a> **options);</p> |
2252 | <h4 class="parameters">Parameters</h4> | |
2253 | <table class="list"><tbody> | |
2254 | <tr><th>name</th> | |
2255 | <td class="description">Option name</td></tr> | |
2256 | <tr><th>num_options</th> | |
2257 | <td class="description">Current number of options</td></tr> | |
2258 | <tr><th>options</th> | |
2259 | <td class="description">Options</td></tr> | |
2260 | </tbody></table> | |
798d6e29 MS |
2261 | <h4 class="returnvalue">Return Value</h4> |
2262 | <p class="description">New number of options</p> | |
2263 | <h3 class="function"><a id="cupsServer">cupsServer</a></h3> | |
2264 | <p class="description">Return the hostname/address of the current server.</p> | |
2265 | <p class="code"> | |
98d88c8d | 2266 | const char *cupsServer(void);</p> |
798d6e29 MS |
2267 | <h4 class="returnvalue">Return Value</h4> |
2268 | <p class="description">Server name</p> | |
2269 | <h4 class="discussion">Discussion</h4> | |
2270 | <p class="discussion">The default server comes from the CUPS_SERVER environment variable, then the | |
2271 | ~/.cups/client.conf file, and finally the /etc/cups/client.conf file. If not | |
2272 | set, the default is the local system - either "localhost" or a domain socket | |
2273 | path.<br> | |
2274 | <br> | |
2275 | The returned value can be a fully-qualified hostname, a numeric IPv4 or IPv6 | |
2276 | address, or a domain socket pathname.<br> | |
2277 | <br> | |
2278 | Note: The current server is tracked separately for each thread in a program. | |
2279 | Multi-threaded programs that override the server via the | |
2280 | <a href="#cupsSetServer"><code>cupsSetServer</code></a> function need to do so in each thread for the same | |
2281 | server to be used.</p> | |
98d88c8d MS |
2282 | <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="cupsSetClientCertCB">cupsSetClientCertCB</a></h3> |
2283 | <p class="description">Set the client certificate callback.</p> | |
798d6e29 | 2284 | <p class="code"> |
98d88c8d | 2285 | void cupsSetClientCertCB(<a href="#cups_client_cert_cb_t">cups_client_cert_cb_t</a> cb, void *user_data);</p> |
798d6e29 | 2286 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2287 | <table class="list"><tbody> |
2288 | <tr><th>cb</th> | |
2289 | <td class="description">Callback function</td></tr> | |
2290 | <tr><th>user_data</th> | |
2291 | <td class="description">User data pointer</td></tr> | |
2292 | </tbody></table> | |
2293 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
2294 | <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> |
2295 | <br> | |
2296 | Note: The current certificate callback is tracked separately for each thread | |
2297 | in a program. Multi-threaded programs that override the callback need to do | |
2298 | so in each thread for the same callback to be used. | |
2299 | ||
2300 | </p> | |
2301 | <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="cupsSetCredentials">cupsSetCredentials</a></h3> | |
2302 | <p class="description">Set the default credentials to be used for SSL/TLS | |
2303 | connections.</p> | |
2304 | <p class="code"> | |
98d88c8d | 2305 | int cupsSetCredentials(cups_array_t *credentials);</p> |
798d6e29 | 2306 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2307 | <table class="list"><tbody> |
2308 | <tr><th>credentials</th> | |
2309 | <td class="description">Array of credentials</td></tr> | |
2310 | </tbody></table> | |
798d6e29 MS |
2311 | <h4 class="returnvalue">Return Value</h4> |
2312 | <p class="description">Status of call (0 = success)</p> | |
2313 | <h4 class="discussion">Discussion</h4> | |
2314 | <p class="discussion">Note: The default credentials are tracked separately for each thread in a | |
2315 | program. Multi-threaded programs that override the setting need to do so in | |
2316 | each thread for the same setting to be used. | |
2317 | ||
2318 | </p> | |
98d88c8d | 2319 | <h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="cupsSetDefaultDest">cupsSetDefaultDest</a></h3> |
53af7f21 | 2320 | <p class="description">Set the default destination.</p> |
98d88c8d MS |
2321 | <p class="code"> |
2322 | void cupsSetDefaultDest(const char *name, const char *instance, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> | |
2323 | <h4 class="parameters">Parameters</h4> | |
2324 | <table class="list"><tbody> | |
2325 | <tr><th>name</th> | |
2326 | <td class="description">Destination name</td></tr> | |
2327 | <tr><th>instance</th> | |
2328 | <td class="description">Instance name or <code>NULL</code></td></tr> | |
2329 | <tr><th>num_dests</th> | |
2330 | <td class="description">Number of destinations</td></tr> | |
2331 | <tr><th>dests</th> | |
2332 | <td class="description">Destinations</td></tr> | |
2333 | </tbody></table> | |
798d6e29 MS |
2334 | <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="cupsSetDests2">cupsSetDests2</a></h3> |
2335 | <p class="description">Save the list of destinations for the specified server.</p> | |
2336 | <p class="code"> | |
98d88c8d MS |
2337 | int cupsSetDests2(<a href="#http_t">http_t</a> *http, int num_dests, <a href="#cups_dest_t">cups_dest_t</a> *dests);</p> |
2338 | <h4 class="parameters">Parameters</h4> | |
2339 | <table class="list"><tbody> | |
2340 | <tr><th>http</th> | |
2341 | <td class="description">Connection to server or <code>CUPS_HTTP_DEFAULT</code></td></tr> | |
2342 | <tr><th>num_dests</th> | |
2343 | <td class="description">Number of destinations</td></tr> | |
2344 | <tr><th>dests</th> | |
2345 | <td class="description">Destinations</td></tr> | |
2346 | </tbody></table> | |
798d6e29 MS |
2347 | <h4 class="returnvalue">Return Value</h4> |
2348 | <p class="description">0 on success, -1 on error</p> | |
2349 | <h4 class="discussion">Discussion</h4> | |
2350 | <p class="discussion">This function saves the destinations to /etc/cups/lpoptions when run | |
2351 | as root and ~/.cups/lpoptions when run as a normal user. | |
2352 | ||
2353 | </p> | |
2354 | <h3 class="function"><a id="cupsSetEncryption">cupsSetEncryption</a></h3> | |
98d88c8d | 2355 | <p class="description">Set the encryption preference.</p> |
798d6e29 | 2356 | <p class="code"> |
98d88c8d | 2357 | void cupsSetEncryption(<a href="#http_encryption_t">http_encryption_t</a> e);</p> |
798d6e29 | 2358 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2359 | <table class="list"><tbody> |
2360 | <tr><th>e</th> | |
2361 | <td class="description">New encryption preference</td></tr> | |
2362 | </tbody></table> | |
2363 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
2364 | <p class="discussion">The default encryption setting comes from the CUPS_ENCRYPTION |
2365 | environment variable, then the ~/.cups/client.conf file, and finally the | |
2366 | /etc/cups/client.conf file. If not set, the default is | |
2367 | <code>HTTP_ENCRYPTION_IF_REQUESTED</code>.<br> | |
2368 | <br> | |
2369 | Note: The current encryption setting is tracked separately for each thread | |
2370 | in a program. Multi-threaded programs that override the setting need to do | |
2371 | so in each thread for the same setting to be used.</p> | |
98d88c8d MS |
2372 | <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="cupsSetPasswordCB2">cupsSetPasswordCB2</a></h3> |
2373 | <p class="description">Set the advanced password callback for CUPS.</p> | |
798d6e29 | 2374 | <p class="code"> |
98d88c8d | 2375 | void cupsSetPasswordCB2(<a href="#cups_password_cb2_t">cups_password_cb2_t</a> cb, void *user_data);</p> |
798d6e29 | 2376 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2377 | <table class="list"><tbody> |
2378 | <tr><th>cb</th> | |
2379 | <td class="description">Callback function</td></tr> | |
2380 | <tr><th>user_data</th> | |
2381 | <td class="description">User data pointer</td></tr> | |
2382 | </tbody></table> | |
2383 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
2384 | <p class="discussion">Pass <code>NULL</code> to restore the default (console) password callback, which |
2385 | reads the password from the console. Programs should call either this | |
2386 | function or <a href="#cupsSetPasswordCB2"><code>cupsSetPasswordCB2</code></a>, as only one callback can be registered | |
2387 | by a program per thread.<br> | |
2388 | <br> | |
2389 | Note: The current password callback is tracked separately for each thread | |
2390 | in a program. Multi-threaded programs that override the callback need to do | |
2391 | so in each thread for the same callback to be used. | |
2392 | ||
2393 | </p> | |
2394 | <h3 class="function"><a id="cupsSetServer">cupsSetServer</a></h3> | |
98d88c8d | 2395 | <p class="description">Set the default server name and port.</p> |
798d6e29 | 2396 | <p class="code"> |
98d88c8d | 2397 | void cupsSetServer(const char *server);</p> |
798d6e29 | 2398 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2399 | <table class="list"><tbody> |
2400 | <tr><th>server</th> | |
2401 | <td class="description">Server name</td></tr> | |
2402 | </tbody></table> | |
2403 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
2404 | <p class="discussion">The "server" string can be a fully-qualified hostname, a numeric |
2405 | IPv4 or IPv6 address, or a domain socket pathname. Hostnames and numeric IP | |
2406 | addresses can be optionally followed by a colon and port number to override | |
2407 | the default port 631, e.g. "hostname:8631". Pass <code>NULL</code> to restore the | |
2408 | default server name and port.<br> | |
2409 | <br> | |
2410 | Note: The current server is tracked separately for each thread in a program. | |
2411 | Multi-threaded programs that override the server need to do so in each | |
2412 | thread for the same server to be used.</p> | |
98d88c8d MS |
2413 | <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="cupsSetServerCertCB">cupsSetServerCertCB</a></h3> |
2414 | <p class="description">Set the server certificate callback.</p> | |
798d6e29 | 2415 | <p class="code"> |
98d88c8d | 2416 | void cupsSetServerCertCB(<a href="#cups_server_cert_cb_t">cups_server_cert_cb_t</a> cb, void *user_data);</p> |
798d6e29 | 2417 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2418 | <table class="list"><tbody> |
2419 | <tr><th>cb</th> | |
2420 | <td class="description">Callback function</td></tr> | |
2421 | <tr><th>user_data</th> | |
2422 | <td class="description">User data pointer</td></tr> | |
2423 | </tbody></table> | |
2424 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
2425 | <p class="discussion">Pass <code>NULL</code> to restore the default callback.<br> |
2426 | <br> | |
2427 | Note: The current credentials callback is tracked separately for each thread | |
2428 | in a program. Multi-threaded programs that override the callback need to do | |
2429 | so in each thread for the same callback to be used. | |
2430 | ||
2431 | </p> | |
2432 | <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="cupsSetServerCredentials">cupsSetServerCredentials</a></h3> | |
2433 | <p class="description">Set the default server credentials.</p> | |
2434 | <p class="code"> | |
98d88c8d MS |
2435 | int cupsSetServerCredentials(const char *path, const char *common_name, int auto_create);</p> |
2436 | <h4 class="parameters">Parameters</h4> | |
2437 | <table class="list"><tbody> | |
2438 | <tr><th>path</th> | |
2439 | <td class="description">Keychain path or <code>NULL</code> for default</td></tr> | |
2440 | <tr><th>common_name</th> | |
2441 | <td class="description">Default common name for server</td></tr> | |
2442 | <tr><th>auto_create</th> | |
2443 | <td class="description">1 = automatically create self-signed certificates</td></tr> | |
2444 | </tbody></table> | |
798d6e29 MS |
2445 | <h4 class="returnvalue">Return Value</h4> |
2446 | <p class="description">1 on success, 0 on failure</p> | |
2447 | <h4 class="discussion">Discussion</h4> | |
2448 | <p class="discussion">Note: The server credentials are used by all threads in the running process. | |
2449 | This function is threadsafe. | |
2450 | ||
2451 | </p> | |
2452 | <h3 class="function"><a id="cupsSetUser">cupsSetUser</a></h3> | |
98d88c8d | 2453 | <p class="description">Set the default user name.</p> |
798d6e29 | 2454 | <p class="code"> |
98d88c8d | 2455 | void cupsSetUser(const char *user);</p> |
798d6e29 | 2456 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2457 | <table class="list"><tbody> |
2458 | <tr><th>user</th> | |
2459 | <td class="description">User name</td></tr> | |
2460 | </tbody></table> | |
2461 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
2462 | <p class="discussion">Pass <code>NULL</code> to restore the default user name.<br> |
2463 | <br> | |
2464 | Note: The current user name is tracked separately for each thread in a | |
2465 | program. Multi-threaded programs that override the user name need to do so | |
2466 | in each thread for the same user name to be used.</p> | |
98d88c8d MS |
2467 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsSetUserAgent">cupsSetUserAgent</a></h3> |
2468 | <p class="description">Set the default HTTP User-Agent string.</p> | |
798d6e29 | 2469 | <p class="code"> |
98d88c8d | 2470 | void cupsSetUserAgent(const char *user_agent);</p> |
798d6e29 | 2471 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2472 | <table class="list"><tbody> |
2473 | <tr><th>user_agent</th> | |
2474 | <td class="description">User-Agent string or <code>NULL</code></td></tr> | |
2475 | </tbody></table> | |
2476 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
2477 | <p class="discussion">Setting the string to NULL forces the default value containing the CUPS |
2478 | version, IPP version, and operating system version and architecture. | |
2479 | ||
2480 | </p> | |
2481 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cupsStartDestDocument">cupsStartDestDocument</a></h3> | |
2482 | <p class="description">Start a new document.</p> | |
2483 | <p class="code"> | |
98d88c8d MS |
2484 | http_status_t cupsStartDestDocument(<a href="#http_t">http_t</a> *http, <a href="#cups_dest_t">cups_dest_t</a> *dest, <a href="#cups_dinfo_t">cups_dinfo_t</a> *info, int job_id, const char *docname, const char *format, int num_options, <a href="#cups_option_t">cups_option_t</a> *options, int last_document);</p> |
2485 | <h4 class="parameters">Parameters</h4> | |
2486 | <table class="list"><tbody> | |
2487 | <tr><th>http</th> | |
2488 | <td class="description">Connection to destination</td></tr> | |
2489 | <tr><th>dest</th> | |
2490 | <td class="description">Destination</td></tr> | |
2491 | <tr><th>info</th> | |
2492 | <td class="description">Destination information</td></tr> | |
2493 | <tr><th>job_id</th> | |
2494 | <td class="description">Job ID</td></tr> | |
2495 | <tr><th>docname</th> | |
2496 | <td class="description">Document name</td></tr> | |
2497 | <tr><th>format</th> | |
2498 | <td class="description">Document format</td></tr> | |
2499 | <tr><th>num_options</th> | |
2500 | <td class="description">Number of document options</td></tr> | |
2501 | <tr><th>options</th> | |
2502 | <td class="description">Document options</td></tr> | |
2503 | <tr><th>last_document</th> | |
2504 | <td class="description">1 if this is the last document</td></tr> | |
2505 | </tbody></table> | |
798d6e29 MS |
2506 | <h4 class="returnvalue">Return Value</h4> |
2507 | <p class="description">Status of document creation</p> | |
2508 | <h4 class="discussion">Discussion</h4> | |
2509 | <p class="discussion">"job_id" is the job ID returned by cupsCreateDestJob. "docname" is the name | |
2510 | of the document/file being printed, "format" is the MIME media type for the | |
2511 | document (see CUPS_FORMAT_xxx constants), and "num_options" and "options" | |
2512 | are the options do be applied to the document. "last_document" should be 1 | |
2513 | if this is the last document to be submitted in the job. Returns | |
2514 | <code>HTTP_CONTINUE</code> on success. | |
2515 | ||
798d6e29 MS |
2516 | </p> |
2517 | <h3 class="function"><a id="cupsUser">cupsUser</a></h3> | |
2518 | <p class="description">Return the current user's name.</p> | |
2519 | <p class="code"> | |
98d88c8d | 2520 | const char *cupsUser(void);</p> |
798d6e29 MS |
2521 | <h4 class="returnvalue">Return Value</h4> |
2522 | <p class="description">User name</p> | |
2523 | <h4 class="discussion">Discussion</h4> | |
2524 | <p class="discussion">Note: The current user name is tracked separately for each thread in a | |
2525 | program. Multi-threaded programs that override the user name with the | |
2526 | <a href="#cupsSetUser"><code>cupsSetUser</code></a> function need to do so in each thread for the same user | |
2527 | name to be used.</p> | |
2528 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="cupsUserAgent">cupsUserAgent</a></h3> | |
2529 | <p class="description">Return the default HTTP User-Agent string.</p> | |
2530 | <p class="code"> | |
98d88c8d | 2531 | const char *cupsUserAgent(void);</p> |
798d6e29 MS |
2532 | <h4 class="returnvalue">Return Value</h4> |
2533 | <p class="description">User-Agent string</p> | |
2534 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAcceptConnection">httpAcceptConnection</a></h3> | |
2535 | <p class="description">Accept a new HTTP client connection from the | |
2536 | specified listening socket.</p> | |
2537 | <p class="code"> | |
98d88c8d | 2538 | <a href="#http_t">http_t</a> *httpAcceptConnection(int fd, int blocking);</p> |
798d6e29 | 2539 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2540 | <table class="list"><tbody> |
2541 | <tr><th>fd</th> | |
2542 | <td class="description">Listen socket file descriptor</td></tr> | |
2543 | <tr><th>blocking</th> | |
2544 | <td class="description">1 if the connection should be | |
2545 | blocking, 0 otherwise</td></tr> | |
2546 | </tbody></table> | |
798d6e29 MS |
2547 | <h4 class="returnvalue">Return Value</h4> |
2548 | <p class="description">HTTP connection or <code>NULL</code></p> | |
2549 | <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpAddCredential">httpAddCredential</a></h3> | |
2550 | <p class="description">Allocates and adds a single credential to an array.</p> | |
2551 | <p class="code"> | |
98d88c8d MS |
2552 | int httpAddCredential(cups_array_t *credentials, const void *data, size_t datalen);</p> |
2553 | <h4 class="parameters">Parameters</h4> | |
2554 | <table class="list"><tbody> | |
2555 | <tr><th>credentials</th> | |
2556 | <td class="description">Credentials array</td></tr> | |
2557 | <tr><th>data</th> | |
2558 | <td class="description">PEM-encoded X.509 data</td></tr> | |
2559 | <tr><th>datalen</th> | |
2560 | <td class="description">Length of data</td></tr> | |
2561 | </tbody></table> | |
798d6e29 MS |
2562 | <h4 class="returnvalue">Return Value</h4> |
2563 | <p class="description">0 on success, -1 on error</p> | |
2564 | <h4 class="discussion">Discussion</h4> | |
2565 | <p class="discussion">Use <code>cupsArrayNew(NULL, NULL)</code> to create a credentials array. | |
2566 | ||
2567 | </p> | |
2568 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrAny">httpAddrAny</a></h3> | |
2569 | <p class="description">Check for the "any" address.</p> | |
2570 | <p class="code"> | |
98d88c8d | 2571 | int httpAddrAny(const <a href="#http_addr_t">http_addr_t</a> *addr);</p> |
798d6e29 | 2572 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2573 | <table class="list"><tbody> |
2574 | <tr><th>addr</th> | |
2575 | <td class="description">Address to check</td></tr> | |
2576 | </tbody></table> | |
798d6e29 MS |
2577 | <h4 class="returnvalue">Return Value</h4> |
2578 | <p class="description">1 if "any", 0 otherwise</p> | |
2579 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpAddrClose">httpAddrClose</a></h3> | |
2580 | <p class="description">Close a socket created by <a href="#httpAddrConnect"><code>httpAddrConnect</code></a> or | |
2581 | <a href="#httpAddrListen"><code>httpAddrListen</code></a>.</p> | |
2582 | <p class="code"> | |
98d88c8d | 2583 | int httpAddrClose(<a href="#http_addr_t">http_addr_t</a> *addr, int fd);</p> |
798d6e29 | 2584 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2585 | <table class="list"><tbody> |
2586 | <tr><th>addr</th> | |
2587 | <td class="description">Listen address or <code>NULL</code></td></tr> | |
2588 | <tr><th>fd</th> | |
2589 | <td class="description">Socket file descriptor</td></tr> | |
2590 | </tbody></table> | |
798d6e29 MS |
2591 | <h4 class="returnvalue">Return Value</h4> |
2592 | <p class="description">0 on success, -1 on failure</p> | |
2593 | <h4 class="discussion">Discussion</h4> | |
98d88c8d MS |
2594 | <p class="discussion">Pass <code>NULL</code> for sockets created with <a href="#httpAddrConnect2"><code>httpAddrConnect2</code></a> and the |
2595 | listen address for sockets created with <a href="#httpAddrListen"><code>httpAddrListen</code></a>. This function | |
2596 | ensures that domain sockets are removed when closed. | |
798d6e29 MS |
2597 | |
2598 | </p> | |
798d6e29 MS |
2599 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrConnect2">httpAddrConnect2</a></h3> |
2600 | <p class="description">Connect to any of the addresses in the list with a | |
2601 | timeout and optional cancel.</p> | |
2602 | <p class="code"> | |
98d88c8d MS |
2603 | <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrConnect2(<a href="#http_addrlist_t">http_addrlist_t</a> *addrlist, int *sock, int msec, int *cancel);</p> |
2604 | <h4 class="parameters">Parameters</h4> | |
2605 | <table class="list"><tbody> | |
2606 | <tr><th>addrlist</th> | |
2607 | <td class="description">List of potential addresses</td></tr> | |
2608 | <tr><th>sock</th> | |
2609 | <td class="description">Socket</td></tr> | |
2610 | <tr><th>msec</th> | |
2611 | <td class="description">Timeout in milliseconds</td></tr> | |
2612 | <tr><th>cancel</th> | |
2613 | <td class="description">Pointer to "cancel" variable</td></tr> | |
2614 | </tbody></table> | |
798d6e29 MS |
2615 | <h4 class="returnvalue">Return Value</h4> |
2616 | <p class="description">Connected address or NULL on failure</p> | |
2617 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrCopyList">httpAddrCopyList</a></h3> | |
2618 | <p class="description">Copy an address list.</p> | |
2619 | <p class="code"> | |
98d88c8d | 2620 | <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrCopyList(<a href="#http_addrlist_t">http_addrlist_t</a> *src);</p> |
798d6e29 | 2621 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2622 | <table class="list"><tbody> |
2623 | <tr><th>src</th> | |
2624 | <td class="description">Source address list</td></tr> | |
2625 | </tbody></table> | |
798d6e29 MS |
2626 | <h4 class="returnvalue">Return Value</h4> |
2627 | <p class="description">New address list or <code>NULL</code> on error</p> | |
2628 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrEqual">httpAddrEqual</a></h3> | |
2629 | <p class="description">Compare two addresses.</p> | |
2630 | <p class="code"> | |
98d88c8d | 2631 | int httpAddrEqual(const <a href="#http_addr_t">http_addr_t</a> *addr1, const <a href="#http_addr_t">http_addr_t</a> *addr2);</p> |
798d6e29 | 2632 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2633 | <table class="list"><tbody> |
2634 | <tr><th>addr1</th> | |
2635 | <td class="description">First address</td></tr> | |
2636 | <tr><th>addr2</th> | |
2637 | <td class="description">Second address</td></tr> | |
2638 | </tbody></table> | |
798d6e29 MS |
2639 | <h4 class="returnvalue">Return Value</h4> |
2640 | <p class="description">1 if equal, 0 if not</p> | |
2641 | <h3 class="function"><a id="httpAddrFamily">httpAddrFamily</a></h3> | |
2642 | <p class="description">Get the address family of an address.</p> | |
2643 | <p class="code"> | |
98d88c8d | 2644 | int httpAddrFamily(<a href="#http_addr_t">http_addr_t</a> *addr);</p> |
798d6e29 | 2645 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2646 | <table class="list"><tbody> |
2647 | <tr><th>addr</th> | |
2648 | <td class="description">Address</td></tr> | |
2649 | </tbody></table> | |
798d6e29 MS |
2650 | <h4 class="returnvalue">Return Value</h4> |
2651 | <p class="description">Address family</p> | |
98d88c8d MS |
2652 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrFreeList">httpAddrFreeList</a></h3> |
2653 | <p class="description">Free an address list.</p> | |
798d6e29 | 2654 | <p class="code"> |
98d88c8d | 2655 | void httpAddrFreeList(<a href="#http_addrlist_t">http_addrlist_t</a> *addrlist);</p> |
798d6e29 | 2656 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2657 | <table class="list"><tbody> |
2658 | <tr><th>addrlist</th> | |
2659 | <td class="description">Address list to free</td></tr> | |
2660 | </tbody></table> | |
798d6e29 MS |
2661 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrGetList">httpAddrGetList</a></h3> |
2662 | <p class="description">Get a list of addresses for a hostname.</p> | |
2663 | <p class="code"> | |
98d88c8d MS |
2664 | <a href="#http_addrlist_t">http_addrlist_t</a> *httpAddrGetList(const char *hostname, int family, const char *service);</p> |
2665 | <h4 class="parameters">Parameters</h4> | |
2666 | <table class="list"><tbody> | |
2667 | <tr><th>hostname</th> | |
2668 | <td class="description">Hostname, IP address, or NULL for passive listen address</td></tr> | |
2669 | <tr><th>family</th> | |
2670 | <td class="description">Address family or AF_UNSPEC</td></tr> | |
2671 | <tr><th>service</th> | |
2672 | <td class="description">Service name or port number</td></tr> | |
2673 | </tbody></table> | |
798d6e29 MS |
2674 | <h4 class="returnvalue">Return Value</h4> |
2675 | <p class="description">List of addresses or NULL</p> | |
2676 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrLength">httpAddrLength</a></h3> | |
2677 | <p class="description">Return the length of the address in bytes.</p> | |
2678 | <p class="code"> | |
98d88c8d | 2679 | int httpAddrLength(const <a href="#http_addr_t">http_addr_t</a> *addr);</p> |
798d6e29 | 2680 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2681 | <table class="list"><tbody> |
2682 | <tr><th>addr</th> | |
2683 | <td class="description">Address</td></tr> | |
2684 | </tbody></table> | |
798d6e29 MS |
2685 | <h4 class="returnvalue">Return Value</h4> |
2686 | <p class="description">Length in bytes</p> | |
2687 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrListen">httpAddrListen</a></h3> | |
2688 | <p class="description">Create a listening socket bound to the specified | |
2689 | address and port.</p> | |
2690 | <p class="code"> | |
98d88c8d | 2691 | int httpAddrListen(<a href="#http_addr_t">http_addr_t</a> *addr, int port);</p> |
798d6e29 | 2692 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2693 | <table class="list"><tbody> |
2694 | <tr><th>addr</th> | |
2695 | <td class="description">Address to bind to</td></tr> | |
2696 | <tr><th>port</th> | |
2697 | <td class="description">Port number to bind to</td></tr> | |
2698 | </tbody></table> | |
798d6e29 MS |
2699 | <h4 class="returnvalue">Return Value</h4> |
2700 | <p class="description">Socket or -1 on error</p> | |
2701 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrLocalhost">httpAddrLocalhost</a></h3> | |
2702 | <p class="description">Check for the local loopback address.</p> | |
2703 | <p class="code"> | |
98d88c8d | 2704 | int httpAddrLocalhost(const <a href="#http_addr_t">http_addr_t</a> *addr);</p> |
798d6e29 | 2705 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2706 | <table class="list"><tbody> |
2707 | <tr><th>addr</th> | |
2708 | <td class="description">Address to check</td></tr> | |
2709 | </tbody></table> | |
798d6e29 MS |
2710 | <h4 class="returnvalue">Return Value</h4> |
2711 | <p class="description">1 if local host, 0 otherwise</p> | |
2712 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrLookup">httpAddrLookup</a></h3> | |
2713 | <p class="description">Lookup the hostname associated with the address.</p> | |
2714 | <p class="code"> | |
98d88c8d MS |
2715 | char *httpAddrLookup(const <a href="#http_addr_t">http_addr_t</a> *addr, char *name, int namelen);</p> |
2716 | <h4 class="parameters">Parameters</h4> | |
2717 | <table class="list"><tbody> | |
2718 | <tr><th>addr</th> | |
2719 | <td class="description">Address to lookup</td></tr> | |
2720 | <tr><th>name</th> | |
2721 | <td class="description">Host name buffer</td></tr> | |
2722 | <tr><th>namelen</th> | |
2723 | <td class="description">Size of name buffer</td></tr> | |
2724 | </tbody></table> | |
798d6e29 MS |
2725 | <h4 class="returnvalue">Return Value</h4> |
2726 | <p class="description">Host name</p> | |
2727 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAddrPort">httpAddrPort</a></h3> | |
2728 | <p class="description">Get the port number associated with an address.</p> | |
2729 | <p class="code"> | |
98d88c8d | 2730 | int httpAddrPort(<a href="#http_addr_t">http_addr_t</a> *addr);</p> |
798d6e29 | 2731 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2732 | <table class="list"><tbody> |
2733 | <tr><th>addr</th> | |
2734 | <td class="description">Address</td></tr> | |
2735 | </tbody></table> | |
798d6e29 MS |
2736 | <h4 class="returnvalue">Return Value</h4> |
2737 | <p class="description">Port number</p> | |
2738 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAddrString">httpAddrString</a></h3> | |
2739 | <p class="description">Convert an address to a numeric string.</p> | |
2740 | <p class="code"> | |
98d88c8d MS |
2741 | char *httpAddrString(const <a href="#http_addr_t">http_addr_t</a> *addr, char *s, int slen);</p> |
2742 | <h4 class="parameters">Parameters</h4> | |
2743 | <table class="list"><tbody> | |
2744 | <tr><th>addr</th> | |
2745 | <td class="description">Address to convert</td></tr> | |
2746 | <tr><th>s</th> | |
2747 | <td class="description">String buffer</td></tr> | |
2748 | <tr><th>slen</th> | |
2749 | <td class="description">Length of string</td></tr> | |
2750 | </tbody></table> | |
798d6e29 MS |
2751 | <h4 class="returnvalue">Return Value</h4> |
2752 | <p class="description">Numeric address string</p> | |
2753 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAssembleURI">httpAssembleURI</a></h3> | |
2754 | <p class="description">Assemble a uniform resource identifier from its | |
2755 | components.</p> | |
2756 | <p class="code"> | |
98d88c8d MS |
2757 | <a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURI(<a href="#http_uri_coding_t">http_uri_coding_t</a> encoding, char *uri, int urilen, const char *scheme, const char *username, const char *host, int port, const char *resource);</p> |
2758 | <h4 class="parameters">Parameters</h4> | |
2759 | <table class="list"><tbody> | |
2760 | <tr><th>encoding</th> | |
2761 | <td class="description">Encoding flags</td></tr> | |
2762 | <tr><th>uri</th> | |
2763 | <td class="description">URI buffer</td></tr> | |
2764 | <tr><th>urilen</th> | |
2765 | <td class="description">Size of URI buffer</td></tr> | |
2766 | <tr><th>scheme</th> | |
2767 | <td class="description">Scheme name</td></tr> | |
2768 | <tr><th>username</th> | |
2769 | <td class="description">Username</td></tr> | |
2770 | <tr><th>host</th> | |
2771 | <td class="description">Hostname or address</td></tr> | |
2772 | <tr><th>port</th> | |
2773 | <td class="description">Port number</td></tr> | |
2774 | <tr><th>resource</th> | |
2775 | <td class="description">Resource</td></tr> | |
2776 | </tbody></table> | |
798d6e29 MS |
2777 | <h4 class="returnvalue">Return Value</h4> |
2778 | <p class="description">URI status</p> | |
2779 | <h4 class="discussion">Discussion</h4> | |
2780 | <p class="discussion">This function escapes reserved characters in the URI depending on the | |
2781 | value of the "encoding" argument. You should use this function in | |
2782 | place of traditional string functions whenever you need to create a | |
2783 | URI string. | |
2784 | ||
2785 | </p> | |
2786 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpAssembleURIf">httpAssembleURIf</a></h3> | |
2787 | <p class="description">Assemble a uniform resource identifier from its | |
2788 | components with a formatted resource.</p> | |
2789 | <p class="code"> | |
98d88c8d MS |
2790 | <a href="#http_uri_status_t">http_uri_status_t</a> httpAssembleURIf(<a href="#http_uri_coding_t">http_uri_coding_t</a> encoding, char *uri, int urilen, const char *scheme, const char *username, const char *host, int port, const char *resourcef, ...);</p> |
2791 | <h4 class="parameters">Parameters</h4> | |
2792 | <table class="list"><tbody> | |
2793 | <tr><th>encoding</th> | |
2794 | <td class="description">Encoding flags</td></tr> | |
2795 | <tr><th>uri</th> | |
2796 | <td class="description">URI buffer</td></tr> | |
2797 | <tr><th>urilen</th> | |
2798 | <td class="description">Size of URI buffer</td></tr> | |
2799 | <tr><th>scheme</th> | |
2800 | <td class="description">Scheme name</td></tr> | |
2801 | <tr><th>username</th> | |
2802 | <td class="description">Username</td></tr> | |
2803 | <tr><th>host</th> | |
2804 | <td class="description">Hostname or address</td></tr> | |
2805 | <tr><th>port</th> | |
2806 | <td class="description">Port number</td></tr> | |
2807 | <tr><th>resourcef</th> | |
2808 | <td class="description">Printf-style resource</td></tr> | |
2809 | <tr><th>...</th> | |
2810 | <td class="description">Additional arguments as needed</td></tr> | |
2811 | </tbody></table> | |
798d6e29 MS |
2812 | <h4 class="returnvalue">Return Value</h4> |
2813 | <p class="description">URI status</p> | |
2814 | <h4 class="discussion">Discussion</h4> | |
2815 | <p class="discussion">This function creates a formatted version of the resource string | |
2816 | argument "resourcef" and escapes reserved characters in the URI | |
2817 | depending on the value of the "encoding" argument. You should use | |
2818 | this function in place of traditional string functions whenever | |
2819 | you need to create a URI string. | |
2820 | ||
2821 | </p> | |
2822 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpAssembleUUID">httpAssembleUUID</a></h3> | |
2823 | <p class="description">Assemble a name-based UUID URN conforming to RFC 4122.</p> | |
2824 | <p class="code"> | |
98d88c8d MS |
2825 | char *httpAssembleUUID(const char *server, int port, const char *name, int number, char *buffer, size_t bufsize);</p> |
2826 | <h4 class="parameters">Parameters</h4> | |
2827 | <table class="list"><tbody> | |
2828 | <tr><th>server</th> | |
2829 | <td class="description">Server name</td></tr> | |
2830 | <tr><th>port</th> | |
2831 | <td class="description">Port number</td></tr> | |
2832 | <tr><th>name</th> | |
2833 | <td class="description">Object name or NULL</td></tr> | |
2834 | <tr><th>number</th> | |
2835 | <td class="description">Object number or 0</td></tr> | |
2836 | <tr><th>buffer</th> | |
2837 | <td class="description">String buffer</td></tr> | |
2838 | <tr><th>bufsize</th> | |
2839 | <td class="description">Size of buffer</td></tr> | |
2840 | </tbody></table> | |
798d6e29 MS |
2841 | <h4 class="returnvalue">Return Value</h4> |
2842 | <p class="description">UUID string</p> | |
2843 | <h4 class="discussion">Discussion</h4> | |
2844 | <p class="discussion">This function creates a unique 128-bit identifying number using the server | |
2845 | name, port number, random data, and optionally an object name and/or object | |
2846 | number. The result is formatted as a UUID URN as defined in RFC 4122.<br> | |
2847 | <br> | |
2848 | The buffer needs to be at least 46 bytes in size. | |
2849 | ||
2850 | </p> | |
2851 | <h3 class="function"><a id="httpBlocking">httpBlocking</a></h3> | |
98d88c8d | 2852 | <p class="description">Set blocking/non-blocking behavior on a connection.</p> |
798d6e29 | 2853 | <p class="code"> |
98d88c8d | 2854 | void httpBlocking(<a href="#http_t">http_t</a> *http, int b);</p> |
798d6e29 | 2855 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2856 | <table class="list"><tbody> |
2857 | <tr><th>http</th> | |
2858 | <td class="description">HTTP connection</td></tr> | |
2859 | <tr><th>b</th> | |
2860 | <td class="description">1 = blocking, 0 = non-blocking</td></tr> | |
2861 | </tbody></table> | |
798d6e29 MS |
2862 | <h3 class="function"><a id="httpCheck">httpCheck</a></h3> |
2863 | <p class="description">Check to see if there is a pending response from the server.</p> | |
2864 | <p class="code"> | |
98d88c8d | 2865 | int httpCheck(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 2866 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2867 | <table class="list"><tbody> |
2868 | <tr><th>http</th> | |
2869 | <td class="description">HTTP connection</td></tr> | |
2870 | </tbody></table> | |
798d6e29 MS |
2871 | <h4 class="returnvalue">Return Value</h4> |
2872 | <p class="description">0 = no data, 1 = data available</p> | |
98d88c8d MS |
2873 | <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpClearCookie">httpClearCookie</a></h3> |
2874 | <p class="description">Clear the cookie value(s).</p> | |
798d6e29 | 2875 | <p class="code"> |
98d88c8d | 2876 | void httpClearCookie(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 2877 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2878 | <table class="list"><tbody> |
2879 | <tr><th>http</th> | |
2880 | <td class="description">HTTP connection</td></tr> | |
2881 | </tbody></table> | |
798d6e29 | 2882 | <h3 class="function"><a id="httpClearFields">httpClearFields</a></h3> |
98d88c8d | 2883 | <p class="description">Clear HTTP request fields.</p> |
798d6e29 | 2884 | <p class="code"> |
98d88c8d | 2885 | void httpClearFields(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 2886 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2887 | <table class="list"><tbody> |
2888 | <tr><th>http</th> | |
2889 | <td class="description">HTTP connection</td></tr> | |
2890 | </tbody></table> | |
798d6e29 | 2891 | <h3 class="function"><a id="httpClose">httpClose</a></h3> |
98d88c8d | 2892 | <p class="description">Close an HTTP connection.</p> |
798d6e29 | 2893 | <p class="code"> |
98d88c8d | 2894 | void httpClose(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 2895 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2896 | <table class="list"><tbody> |
2897 | <tr><th>http</th> | |
2898 | <td class="description">HTTP connection</td></tr> | |
2899 | </tbody></table> | |
798d6e29 MS |
2900 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpCompareCredentials">httpCompareCredentials</a></h3> |
2901 | <p class="description">Compare two sets of X.509 credentials.</p> | |
2902 | <p class="code"> | |
98d88c8d | 2903 | int httpCompareCredentials(cups_array_t *cred1, cups_array_t *cred2);</p> |
798d6e29 | 2904 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2905 | <table class="list"><tbody> |
2906 | <tr><th>cred1</th> | |
2907 | <td class="description">First set of X.509 credentials</td></tr> | |
2908 | <tr><th>cred2</th> | |
2909 | <td class="description">Second set of X.509 credentials</td></tr> | |
2910 | </tbody></table> | |
53af7f21 MS |
2911 | <h4 class="returnvalue">Return Value</h4> |
2912 | <p class="description">1 if they match, 0 if they do not</p> | |
798d6e29 MS |
2913 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpConnect2">httpConnect2</a></h3> |
2914 | <p class="description">Connect to a HTTP server.</p> | |
2915 | <p class="code"> | |
98d88c8d MS |
2916 | <a href="#http_t">http_t</a> *httpConnect2(const char *host, int port, <a href="#http_addrlist_t">http_addrlist_t</a> *addrlist, int family, <a href="#http_encryption_t">http_encryption_t</a> encryption, int blocking, int msec, int *cancel);</p> |
2917 | <h4 class="parameters">Parameters</h4> | |
2918 | <table class="list"><tbody> | |
2919 | <tr><th>host</th> | |
2920 | <td class="description">Host to connect to</td></tr> | |
2921 | <tr><th>port</th> | |
2922 | <td class="description">Port number</td></tr> | |
2923 | <tr><th>addrlist</th> | |
65bebeac | 2924 | <td class="description">List of addresses or <code>NULL</code> to lookup</td></tr> |
98d88c8d MS |
2925 | <tr><th>family</th> |
2926 | <td class="description">Address family to use or <code>AF_UNSPEC</code> for any</td></tr> | |
2927 | <tr><th>encryption</th> | |
2928 | <td class="description">Type of encryption to use</td></tr> | |
2929 | <tr><th>blocking</th> | |
2930 | <td class="description">1 for blocking connection, 0 for non-blocking</td></tr> | |
2931 | <tr><th>msec</th> | |
2932 | <td class="description">Connection timeout in milliseconds, 0 means don't connect</td></tr> | |
2933 | <tr><th>cancel</th> | |
2934 | <td class="description">Pointer to "cancel" variable</td></tr> | |
2935 | </tbody></table> | |
798d6e29 MS |
2936 | <h4 class="returnvalue">Return Value</h4> |
2937 | <p class="description">New HTTP connection</p> | |
798d6e29 MS |
2938 | <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpCopyCredentials">httpCopyCredentials</a></h3> |
2939 | <p class="description">Copy the credentials associated with the peer in | |
2940 | an encrypted connection.</p> | |
2941 | <p class="code"> | |
98d88c8d | 2942 | int httpCopyCredentials(<a href="#http_t">http_t</a> *http, cups_array_t **credentials);</p> |
798d6e29 | 2943 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2944 | <table class="list"><tbody> |
2945 | <tr><th>http</th> | |
2946 | <td class="description">Connection to server</td></tr> | |
2947 | <tr><th>credentials</th> | |
2948 | <td class="description">Array of credentials</td></tr> | |
2949 | </tbody></table> | |
798d6e29 MS |
2950 | <h4 class="returnvalue">Return Value</h4> |
2951 | <p class="description">Status of call (0 = success)</p> | |
2952 | <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsAreValidForName">httpCredentialsAreValidForName</a></h3> | |
2953 | <p class="description">Return whether the credentials are valid for the given name.</p> | |
2954 | <p class="code"> | |
98d88c8d | 2955 | int httpCredentialsAreValidForName(cups_array_t *credentials, const char *common_name);</p> |
798d6e29 | 2956 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2957 | <table class="list"><tbody> |
2958 | <tr><th>credentials</th> | |
2959 | <td class="description">Credentials</td></tr> | |
2960 | <tr><th>common_name</th> | |
2961 | <td class="description">Name to check</td></tr> | |
2962 | </tbody></table> | |
798d6e29 MS |
2963 | <h4 class="returnvalue">Return Value</h4> |
2964 | <p class="description">1 if valid, 0 otherwise</p> | |
2965 | <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsGetExpiration">httpCredentialsGetExpiration</a></h3> | |
2966 | <p class="description">Return the expiration date of the credentials.</p> | |
2967 | <p class="code"> | |
98d88c8d | 2968 | time_t httpCredentialsGetExpiration(cups_array_t *credentials);</p> |
798d6e29 | 2969 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2970 | <table class="list"><tbody> |
2971 | <tr><th>credentials</th> | |
2972 | <td class="description">Credentials</td></tr> | |
2973 | </tbody></table> | |
798d6e29 MS |
2974 | <h4 class="returnvalue">Return Value</h4> |
2975 | <p class="description">Expiration date of credentials</p> | |
2976 | <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsGetTrust">httpCredentialsGetTrust</a></h3> | |
2977 | <p class="description">Return the trust of credentials.</p> | |
2978 | <p class="code"> | |
98d88c8d | 2979 | <a href="#http_trust_t">http_trust_t</a> httpCredentialsGetTrust(cups_array_t *credentials, const char *common_name);</p> |
798d6e29 | 2980 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
2981 | <table class="list"><tbody> |
2982 | <tr><th>credentials</th> | |
2983 | <td class="description">Credentials</td></tr> | |
2984 | <tr><th>common_name</th> | |
2985 | <td class="description">Common name for trust lookup</td></tr> | |
2986 | </tbody></table> | |
798d6e29 MS |
2987 | <h4 class="returnvalue">Return Value</h4> |
2988 | <p class="description">Level of trust</p> | |
2989 | <h3 class="function"><span class="info"> CUPS 2.0/macOS 10.10 </span><a id="httpCredentialsString">httpCredentialsString</a></h3> | |
2990 | <p class="description">Return a string representing the credentials.</p> | |
2991 | <p class="code"> | |
98d88c8d MS |
2992 | size_t httpCredentialsString(cups_array_t *credentials, char *buffer, size_t bufsize);</p> |
2993 | <h4 class="parameters">Parameters</h4> | |
2994 | <table class="list"><tbody> | |
2995 | <tr><th>credentials</th> | |
2996 | <td class="description">Credentials</td></tr> | |
2997 | <tr><th>buffer</th> | |
2998 | <td class="description">Buffer or <code>NULL</code></td></tr> | |
2999 | <tr><th>bufsize</th> | |
3000 | <td class="description">Size of buffer</td></tr> | |
3001 | </tbody></table> | |
798d6e29 MS |
3002 | <h4 class="returnvalue">Return Value</h4> |
3003 | <p class="description">Total size of credentials string</p> | |
798d6e29 MS |
3004 | <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="httpDecode64_2">httpDecode64_2</a></h3> |
3005 | <p class="description">Base64-decode a string.</p> | |
3006 | <p class="code"> | |
98d88c8d MS |
3007 | char *httpDecode64_2(char *out, int *outlen, const char *in);</p> |
3008 | <h4 class="parameters">Parameters</h4> | |
3009 | <table class="list"><tbody> | |
3010 | <tr><th>out</th> | |
3011 | <td class="description">String to write to</td></tr> | |
3012 | <tr><th>outlen</th> | |
3013 | <td class="description">Size of output string</td></tr> | |
3014 | <tr><th>in</th> | |
3015 | <td class="description">String to read from</td></tr> | |
3016 | </tbody></table> | |
798d6e29 MS |
3017 | <h4 class="returnvalue">Return Value</h4> |
3018 | <p class="description">Decoded string</p> | |
98d88c8d MS |
3019 | <h4 class="discussion">Discussion</h4> |
3020 | <p class="discussion">The caller must initialize "outlen" to the maximum size of the decoded | |
65bebeac | 3021 | string before calling <code>httpDecode64_2</code>. On return "outlen" contains the |
98d88c8d MS |
3022 | decoded length of the string. |
3023 | ||
3024 | </p> | |
798d6e29 MS |
3025 | <h3 class="function"><a id="httpDelete">httpDelete</a></h3> |
3026 | <p class="description">Send a DELETE request to the server.</p> | |
3027 | <p class="code"> | |
98d88c8d | 3028 | int httpDelete(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
798d6e29 | 3029 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3030 | <table class="list"><tbody> |
3031 | <tr><th>http</th> | |
3032 | <td class="description">HTTP connection</td></tr> | |
3033 | <tr><th>uri</th> | |
3034 | <td class="description">URI to delete</td></tr> | |
3035 | </tbody></table> | |
798d6e29 MS |
3036 | <h4 class="returnvalue">Return Value</h4> |
3037 | <p class="description">Status of call (0 = success)</p> | |
798d6e29 MS |
3038 | <h3 class="function"><span class="info"> CUPS 1.1.21/macOS 10.4 </span><a id="httpEncode64_2">httpEncode64_2</a></h3> |
3039 | <p class="description">Base64-encode a string.</p> | |
3040 | <p class="code"> | |
98d88c8d MS |
3041 | char *httpEncode64_2(char *out, int outlen, const char *in, int inlen);</p> |
3042 | <h4 class="parameters">Parameters</h4> | |
3043 | <table class="list"><tbody> | |
3044 | <tr><th>out</th> | |
3045 | <td class="description">String to write to</td></tr> | |
3046 | <tr><th>outlen</th> | |
3047 | <td class="description">Maximum size of output string</td></tr> | |
3048 | <tr><th>in</th> | |
3049 | <td class="description">String to read from</td></tr> | |
3050 | <tr><th>inlen</th> | |
3051 | <td class="description">Size of input string</td></tr> | |
3052 | </tbody></table> | |
798d6e29 MS |
3053 | <h4 class="returnvalue">Return Value</h4> |
3054 | <p class="description">Encoded string</p> | |
3055 | <h3 class="function"><a id="httpEncryption">httpEncryption</a></h3> | |
3056 | <p class="description">Set the required encryption on the link.</p> | |
3057 | <p class="code"> | |
98d88c8d | 3058 | int httpEncryption(<a href="#http_t">http_t</a> *http, <a href="#http_encryption_t">http_encryption_t</a> e);</p> |
798d6e29 | 3059 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3060 | <table class="list"><tbody> |
3061 | <tr><th>http</th> | |
3062 | <td class="description">HTTP connection</td></tr> | |
3063 | <tr><th>e</th> | |
3064 | <td class="description">New encryption preference</td></tr> | |
3065 | </tbody></table> | |
798d6e29 MS |
3066 | <h4 class="returnvalue">Return Value</h4> |
3067 | <p class="description">-1 on error, 0 on success</p> | |
3068 | <h3 class="function"><a id="httpError">httpError</a></h3> | |
3069 | <p class="description">Get the last error on a connection.</p> | |
3070 | <p class="code"> | |
98d88c8d | 3071 | int httpError(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3072 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3073 | <table class="list"><tbody> |
3074 | <tr><th>http</th> | |
3075 | <td class="description">HTTP connection</td></tr> | |
3076 | </tbody></table> | |
798d6e29 MS |
3077 | <h4 class="returnvalue">Return Value</h4> |
3078 | <p class="description">Error code (errno) value</p> | |
3079 | <h3 class="function"><a id="httpFieldValue">httpFieldValue</a></h3> | |
3080 | <p class="description">Return the HTTP field enumeration value for a field | |
3081 | name.</p> | |
3082 | <p class="code"> | |
98d88c8d | 3083 | <a href="#http_field_t">http_field_t</a> httpFieldValue(const char *name);</p> |
798d6e29 | 3084 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3085 | <table class="list"><tbody> |
3086 | <tr><th>name</th> | |
3087 | <td class="description">String name</td></tr> | |
3088 | </tbody></table> | |
798d6e29 MS |
3089 | <h4 class="returnvalue">Return Value</h4> |
3090 | <p class="description">Field index</p> | |
3091 | <h3 class="function"><a id="httpFlush">httpFlush</a></h3> | |
65bebeac | 3092 | <p class="description">Flush data read from a HTTP connection.</p> |
798d6e29 | 3093 | <p class="code"> |
98d88c8d | 3094 | void httpFlush(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3095 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3096 | <table class="list"><tbody> |
3097 | <tr><th>http</th> | |
3098 | <td class="description">HTTP connection</td></tr> | |
3099 | </tbody></table> | |
798d6e29 | 3100 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpFlushWrite">httpFlushWrite</a></h3> |
65bebeac | 3101 | <p class="description">Flush data written to a HTTP connection.</p> |
798d6e29 | 3102 | <p class="code"> |
98d88c8d | 3103 | int httpFlushWrite(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3104 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3105 | <table class="list"><tbody> |
3106 | <tr><th>http</th> | |
3107 | <td class="description">HTTP connection</td></tr> | |
3108 | </tbody></table> | |
798d6e29 MS |
3109 | <h4 class="returnvalue">Return Value</h4> |
3110 | <p class="description">Bytes written or -1 on error</p> | |
3111 | <h3 class="function"><a id="httpFreeCredentials">httpFreeCredentials</a></h3> | |
98d88c8d | 3112 | <p class="description">Free an array of credentials.</p> |
798d6e29 | 3113 | <p class="code"> |
98d88c8d | 3114 | void httpFreeCredentials(cups_array_t *credentials);</p> |
798d6e29 | 3115 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3116 | <table class="list"><tbody> |
3117 | <tr><th>credentials</th> | |
3118 | <td class="description">Array of credentials</td></tr> | |
3119 | </tbody></table> | |
798d6e29 MS |
3120 | <h3 class="function"><a id="httpGet">httpGet</a></h3> |
3121 | <p class="description">Send a GET request to the server.</p> | |
3122 | <p class="code"> | |
98d88c8d | 3123 | int httpGet(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
798d6e29 | 3124 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3125 | <table class="list"><tbody> |
3126 | <tr><th>http</th> | |
3127 | <td class="description">HTTP connection</td></tr> | |
3128 | <tr><th>uri</th> | |
3129 | <td class="description">URI to get</td></tr> | |
3130 | </tbody></table> | |
798d6e29 MS |
3131 | <h4 class="returnvalue">Return Value</h4> |
3132 | <p class="description">Status of call (0 = success)</p> | |
3133 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetActivity">httpGetActivity</a></h3> | |
3134 | <p class="description">Get the most recent activity for a connection.</p> | |
3135 | <p class="code"> | |
98d88c8d | 3136 | time_t httpGetActivity(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3137 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3138 | <table class="list"><tbody> |
3139 | <tr><th>http</th> | |
3140 | <td class="description">HTTP connection</td></tr> | |
3141 | </tbody></table> | |
798d6e29 MS |
3142 | <h4 class="returnvalue">Return Value</h4> |
3143 | <p class="description">Time of last read or write</p> | |
3144 | <h4 class="discussion">Discussion</h4> | |
65bebeac | 3145 | <p class="discussion">The return value is the time in seconds of the last read or write. |
798d6e29 MS |
3146 | |
3147 | </p> | |
3148 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetAddress">httpGetAddress</a></h3> | |
3149 | <p class="description">Get the address of the connected peer of a connection.</p> | |
3150 | <p class="code"> | |
98d88c8d | 3151 | <a href="#http_addr_t">http_addr_t</a> *httpGetAddress(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3152 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3153 | <table class="list"><tbody> |
3154 | <tr><th>http</th> | |
3155 | <td class="description">HTTP connection</td></tr> | |
3156 | </tbody></table> | |
798d6e29 MS |
3157 | <h4 class="returnvalue">Return Value</h4> |
3158 | <p class="description">Connected address or <code>NULL</code></p> | |
3159 | <h4 class="discussion">Discussion</h4> | |
65bebeac MS |
3160 | <p class="discussion">For connections created with <a href="#httpConnect2"><code>httpConnect2</code></a>, the address is for the |
3161 | server. For connections created with <a href="#httpAccept"><code>httpAccept</code></a>, the address is for | |
3162 | the client.<br> | |
3163 | <br> | |
3164 | Returns <code>NULL</code> if the socket is currently unconnected. | |
798d6e29 MS |
3165 | |
3166 | </p> | |
3167 | <h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="httpGetAuthString">httpGetAuthString</a></h3> | |
3168 | <p class="description">Get the current authorization string.</p> | |
3169 | <p class="code"> | |
98d88c8d | 3170 | char *httpGetAuthString(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3171 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3172 | <table class="list"><tbody> |
3173 | <tr><th>http</th> | |
3174 | <td class="description">HTTP connection</td></tr> | |
3175 | </tbody></table> | |
798d6e29 MS |
3176 | <h4 class="returnvalue">Return Value</h4> |
3177 | <p class="description">Authorization string</p> | |
3178 | <h4 class="discussion">Discussion</h4> | |
65bebeac MS |
3179 | <p class="discussion">The authorization string is set by <a href="#cupsDoAuthentication"><code>cupsDoAuthentication</code></a> and |
3180 | <a href="#httpSetAuthString"><code>httpSetAuthString</code></a>. Use <a href="#httpGetAuthString"><code>httpGetAuthString</code></a> to retrieve the | |
3181 | string to use with <a href="#httpSetField"><code>httpSetField</code></a> for the | |
3182 | <code>HTTP_FIELD_AUTHORIZATION</code> value. | |
798d6e29 MS |
3183 | |
3184 | </p> | |
3185 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetBlocking">httpGetBlocking</a></h3> | |
3186 | <p class="description">Get the blocking/non-block state of a connection.</p> | |
3187 | <p class="code"> | |
98d88c8d | 3188 | int httpGetBlocking(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3189 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3190 | <table class="list"><tbody> |
3191 | <tr><th>http</th> | |
3192 | <td class="description">HTTP connection</td></tr> | |
3193 | </tbody></table> | |
798d6e29 MS |
3194 | <h4 class="returnvalue">Return Value</h4> |
3195 | <p class="description">1 if blocking, 0 if non-blocking</p> | |
3196 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpGetContentEncoding">httpGetContentEncoding</a></h3> | |
3197 | <p class="description">Get a common content encoding, if any, between | |
3198 | the client and server.</p> | |
3199 | <p class="code"> | |
98d88c8d | 3200 | const char *httpGetContentEncoding(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3201 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3202 | <table class="list"><tbody> |
3203 | <tr><th>http</th> | |
3204 | <td class="description">HTTP connection</td></tr> | |
3205 | </tbody></table> | |
798d6e29 MS |
3206 | <h4 class="returnvalue">Return Value</h4> |
3207 | <p class="description">Content-Coding value or | |
3208 | <code>NULL</code> for the identity | |
3209 | coding.</p> | |
3210 | <h4 class="discussion">Discussion</h4> | |
3211 | <p class="discussion">This function uses the value of the Accepts-Encoding HTTP header and must be | |
3212 | called after receiving a response from the server or a request from the | |
3213 | client. The value returned can be use in subsequent requests (for clients) | |
3214 | or in the response (for servers) in order to compress the content stream. | |
3215 | ||
3216 | </p> | |
3217 | <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpGetCookie">httpGetCookie</a></h3> | |
3218 | <p class="description">Get any cookie data from the response.</p> | |
3219 | <p class="code"> | |
98d88c8d | 3220 | const char *httpGetCookie(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3221 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3222 | <table class="list"><tbody> |
3223 | <tr><th>http</th> | |
3224 | <td class="description">HTTP connection</td></tr> | |
3225 | </tbody></table> | |
798d6e29 | 3226 | <h4 class="returnvalue">Return Value</h4> |
65bebeac | 3227 | <p class="description">Cookie data or <code>NULL</code></p> |
798d6e29 MS |
3228 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetDateString2">httpGetDateString2</a></h3> |
3229 | <p class="description">Get a formatted date/time string from a time value.</p> | |
3230 | <p class="code"> | |
98d88c8d MS |
3231 | const char *httpGetDateString2(time_t t, char *s, int slen);</p> |
3232 | <h4 class="parameters">Parameters</h4> | |
3233 | <table class="list"><tbody> | |
3234 | <tr><th>t</th> | |
65bebeac | 3235 | <td class="description">Time in seconds</td></tr> |
98d88c8d MS |
3236 | <tr><th>s</th> |
3237 | <td class="description">String buffer</td></tr> | |
3238 | <tr><th>slen</th> | |
3239 | <td class="description">Size of string buffer</td></tr> | |
3240 | </tbody></table> | |
798d6e29 MS |
3241 | <h4 class="returnvalue">Return Value</h4> |
3242 | <p class="description">Date/time string</p> | |
3243 | <h3 class="function"><a id="httpGetDateTime">httpGetDateTime</a></h3> | |
3244 | <p class="description">Get a time value from a formatted date/time string.</p> | |
3245 | <p class="code"> | |
98d88c8d | 3246 | time_t httpGetDateTime(const char *s);</p> |
798d6e29 | 3247 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3248 | <table class="list"><tbody> |
3249 | <tr><th>s</th> | |
3250 | <td class="description">Date/time string</td></tr> | |
3251 | </tbody></table> | |
798d6e29 | 3252 | <h4 class="returnvalue">Return Value</h4> |
65bebeac | 3253 | <p class="description">Time in seconds</p> |
798d6e29 MS |
3254 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetEncryption">httpGetEncryption</a></h3> |
3255 | <p class="description">Get the current encryption mode of a connection.</p> | |
3256 | <p class="code"> | |
98d88c8d | 3257 | <a href="#http_encryption_t">http_encryption_t</a> httpGetEncryption(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3258 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3259 | <table class="list"><tbody> |
3260 | <tr><th>http</th> | |
3261 | <td class="description">HTTP connection</td></tr> | |
3262 | </tbody></table> | |
798d6e29 MS |
3263 | <h4 class="returnvalue">Return Value</h4> |
3264 | <p class="description">Current encryption mode</p> | |
3265 | <h4 class="discussion">Discussion</h4> | |
3266 | <p class="discussion">This function returns the encryption mode for the connection. Use the | |
3267 | <a href="#httpIsEncrypted"><code>httpIsEncrypted</code></a> function to determine whether a TLS session has | |
3268 | been established. | |
3269 | ||
3270 | </p> | |
3271 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpGetExpect">httpGetExpect</a></h3> | |
3272 | <p class="description">Get the value of the Expect header, if any.</p> | |
3273 | <p class="code"> | |
98d88c8d | 3274 | http_status_t httpGetExpect(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3275 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3276 | <table class="list"><tbody> |
3277 | <tr><th>http</th> | |
3278 | <td class="description">HTTP connection</td></tr> | |
3279 | </tbody></table> | |
798d6e29 MS |
3280 | <h4 class="returnvalue">Return Value</h4> |
3281 | <p class="description">Expect: status, if any</p> | |
3282 | <h4 class="discussion">Discussion</h4> | |
3283 | <p class="discussion">Returns <code>HTTP_STATUS_NONE</code> if there is no Expect header, otherwise | |
3284 | returns the expected HTTP status code, typically <code>HTTP_STATUS_CONTINUE</code>. | |
3285 | ||
3286 | </p> | |
3287 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetFd">httpGetFd</a></h3> | |
3288 | <p class="description">Get the file descriptor associated with a connection.</p> | |
3289 | <p class="code"> | |
98d88c8d | 3290 | int httpGetFd(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3291 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3292 | <table class="list"><tbody> |
3293 | <tr><th>http</th> | |
3294 | <td class="description">HTTP connection</td></tr> | |
3295 | </tbody></table> | |
798d6e29 MS |
3296 | <h4 class="returnvalue">Return Value</h4> |
3297 | <p class="description">File descriptor or -1 if none</p> | |
3298 | <h3 class="function"><a id="httpGetField">httpGetField</a></h3> | |
3299 | <p class="description">Get a field value from a request/response.</p> | |
3300 | <p class="code"> | |
98d88c8d | 3301 | const char *httpGetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field);</p> |
798d6e29 | 3302 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3303 | <table class="list"><tbody> |
3304 | <tr><th>http</th> | |
3305 | <td class="description">HTTP connection</td></tr> | |
3306 | <tr><th>field</th> | |
3307 | <td class="description">Field to get</td></tr> | |
3308 | </tbody></table> | |
798d6e29 MS |
3309 | <h4 class="returnvalue">Return Value</h4> |
3310 | <p class="description">Field value</p> | |
798d6e29 MS |
3311 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetHostname">httpGetHostname</a></h3> |
3312 | <p class="description">Get the FQDN for the connection or local system.</p> | |
3313 | <p class="code"> | |
98d88c8d MS |
3314 | const char *httpGetHostname(<a href="#http_t">http_t</a> *http, char *s, int slen);</p> |
3315 | <h4 class="parameters">Parameters</h4> | |
3316 | <table class="list"><tbody> | |
3317 | <tr><th>http</th> | |
3318 | <td class="description">HTTP connection or NULL</td></tr> | |
3319 | <tr><th>s</th> | |
3320 | <td class="description">String buffer for name</td></tr> | |
3321 | <tr><th>slen</th> | |
3322 | <td class="description">Size of buffer</td></tr> | |
3323 | </tbody></table> | |
798d6e29 MS |
3324 | <h4 class="returnvalue">Return Value</h4> |
3325 | <p class="description">FQDN for connection or system</p> | |
3326 | <h4 class="discussion">Discussion</h4> | |
3327 | <p class="discussion">When "http" points to a connected socket, return the hostname or | |
3328 | address that was used in the call to httpConnect() or httpConnectEncrypt(), | |
3329 | or the address of the client for the connection from httpAcceptConnection(). | |
3330 | Otherwise, return the FQDN for the local system using both gethostname() | |
3331 | and gethostbyname() to get the local hostname with domain. | |
3332 | ||
3333 | </p> | |
3334 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetKeepAlive">httpGetKeepAlive</a></h3> | |
3335 | <p class="description">Get the current Keep-Alive state of the connection.</p> | |
3336 | <p class="code"> | |
98d88c8d | 3337 | <a href="#http_keepalive_t">http_keepalive_t</a> httpGetKeepAlive(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3338 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3339 | <table class="list"><tbody> |
3340 | <tr><th>http</th> | |
3341 | <td class="description">HTTP connection</td></tr> | |
3342 | </tbody></table> | |
798d6e29 MS |
3343 | <h4 class="returnvalue">Return Value</h4> |
3344 | <p class="description">Keep-Alive state</p> | |
798d6e29 MS |
3345 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetLength2">httpGetLength2</a></h3> |
3346 | <p class="description">Get the amount of data remaining from the | |
3347 | content-length or transfer-encoding fields.</p> | |
3348 | <p class="code"> | |
98d88c8d | 3349 | off_t httpGetLength2(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3350 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3351 | <table class="list"><tbody> |
3352 | <tr><th>http</th> | |
3353 | <td class="description">HTTP connection</td></tr> | |
3354 | </tbody></table> | |
798d6e29 MS |
3355 | <h4 class="returnvalue">Return Value</h4> |
3356 | <p class="description">Content length</p> | |
3357 | <h4 class="discussion">Discussion</h4> | |
3358 | <p class="discussion">This function returns the complete content length, even for | |
3359 | content larger than 2^31 - 1. | |
3360 | ||
3361 | </p> | |
3362 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetPending">httpGetPending</a></h3> | |
3363 | <p class="description">Get the number of bytes that are buffered for writing.</p> | |
3364 | <p class="code"> | |
98d88c8d | 3365 | size_t httpGetPending(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3366 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3367 | <table class="list"><tbody> |
3368 | <tr><th>http</th> | |
3369 | <td class="description">HTTP connection</td></tr> | |
3370 | </tbody></table> | |
798d6e29 MS |
3371 | <h4 class="returnvalue">Return Value</h4> |
3372 | <p class="description">Number of bytes buffered</p> | |
3373 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetReady">httpGetReady</a></h3> | |
3374 | <p class="description">Get the number of bytes that can be read without blocking.</p> | |
3375 | <p class="code"> | |
98d88c8d | 3376 | size_t httpGetReady(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3377 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3378 | <table class="list"><tbody> |
3379 | <tr><th>http</th> | |
3380 | <td class="description">HTTP connection</td></tr> | |
3381 | </tbody></table> | |
798d6e29 MS |
3382 | <h4 class="returnvalue">Return Value</h4> |
3383 | <p class="description">Number of bytes available</p> | |
3384 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpGetRemaining">httpGetRemaining</a></h3> | |
3385 | <p class="description">Get the number of remaining bytes in the message | |
3386 | body or current chunk.</p> | |
3387 | <p class="code"> | |
98d88c8d | 3388 | size_t httpGetRemaining(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3389 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3390 | <table class="list"><tbody> |
3391 | <tr><th>http</th> | |
3392 | <td class="description">HTTP connection</td></tr> | |
3393 | </tbody></table> | |
798d6e29 MS |
3394 | <h4 class="returnvalue">Return Value</h4> |
3395 | <p class="description">Remaining bytes</p> | |
3396 | <h4 class="discussion">Discussion</h4> | |
3397 | <p class="discussion">The <a href="#httpIsChunked"><code>httpIsChunked</code></a> function can be used to determine whether the | |
3398 | message body is chunked or fixed-length. | |
3399 | ||
3400 | </p> | |
3401 | <h3 class="function"><a id="httpGetState">httpGetState</a></h3> | |
3402 | <p class="description">Get the current state of the HTTP request.</p> | |
3403 | <p class="code"> | |
98d88c8d | 3404 | <a href="#http_state_t">http_state_t</a> httpGetState(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3405 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3406 | <table class="list"><tbody> |
3407 | <tr><th>http</th> | |
3408 | <td class="description">HTTP connection</td></tr> | |
3409 | </tbody></table> | |
798d6e29 MS |
3410 | <h4 class="returnvalue">Return Value</h4> |
3411 | <p class="description">HTTP state</p> | |
3412 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetStatus">httpGetStatus</a></h3> | |
3413 | <p class="description">Get the status of the last HTTP request.</p> | |
3414 | <p class="code"> | |
98d88c8d | 3415 | http_status_t httpGetStatus(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3416 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3417 | <table class="list"><tbody> |
3418 | <tr><th>http</th> | |
3419 | <td class="description">HTTP connection</td></tr> | |
3420 | </tbody></table> | |
798d6e29 MS |
3421 | <h4 class="returnvalue">Return Value</h4> |
3422 | <p class="description">HTTP status</p> | |
798d6e29 MS |
3423 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpGetSubField2">httpGetSubField2</a></h3> |
3424 | <p class="description">Get a sub-field value.</p> | |
3425 | <p class="code"> | |
98d88c8d MS |
3426 | char *httpGetSubField2(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *name, char *value, int valuelen);</p> |
3427 | <h4 class="parameters">Parameters</h4> | |
3428 | <table class="list"><tbody> | |
3429 | <tr><th>http</th> | |
3430 | <td class="description">HTTP connection</td></tr> | |
3431 | <tr><th>field</th> | |
3432 | <td class="description">Field index</td></tr> | |
3433 | <tr><th>name</th> | |
3434 | <td class="description">Name of sub-field</td></tr> | |
3435 | <tr><th>value</th> | |
3436 | <td class="description">Value string</td></tr> | |
3437 | <tr><th>valuelen</th> | |
3438 | <td class="description">Size of value buffer</td></tr> | |
3439 | </tbody></table> | |
798d6e29 | 3440 | <h4 class="returnvalue">Return Value</h4> |
65bebeac | 3441 | <p class="description">Value or <code>NULL</code></p> |
798d6e29 MS |
3442 | <h3 class="function"><a id="httpGetVersion">httpGetVersion</a></h3> |
3443 | <p class="description">Get the HTTP version at the other end.</p> | |
3444 | <p class="code"> | |
98d88c8d | 3445 | <a href="#http_version_t">http_version_t</a> httpGetVersion(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3446 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3447 | <table class="list"><tbody> |
3448 | <tr><th>http</th> | |
3449 | <td class="description">HTTP connection</td></tr> | |
3450 | </tbody></table> | |
798d6e29 MS |
3451 | <h4 class="returnvalue">Return Value</h4> |
3452 | <p class="description">Version number</p> | |
3453 | <h3 class="function"><a id="httpGets">httpGets</a></h3> | |
3454 | <p class="description">Get a line of text from a HTTP connection.</p> | |
3455 | <p class="code"> | |
98d88c8d MS |
3456 | char *httpGets(char *line, int length, <a href="#http_t">http_t</a> *http);</p> |
3457 | <h4 class="parameters">Parameters</h4> | |
3458 | <table class="list"><tbody> | |
3459 | <tr><th>line</th> | |
3460 | <td class="description">Line to read into</td></tr> | |
3461 | <tr><th>length</th> | |
3462 | <td class="description">Max length of buffer</td></tr> | |
3463 | <tr><th>http</th> | |
3464 | <td class="description">HTTP connection</td></tr> | |
3465 | </tbody></table> | |
798d6e29 | 3466 | <h4 class="returnvalue">Return Value</h4> |
65bebeac | 3467 | <p class="description">Line or <code>NULL</code></p> |
798d6e29 MS |
3468 | <h3 class="function"><a id="httpHead">httpHead</a></h3> |
3469 | <p class="description">Send a HEAD request to the server.</p> | |
3470 | <p class="code"> | |
98d88c8d | 3471 | int httpHead(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
798d6e29 | 3472 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3473 | <table class="list"><tbody> |
3474 | <tr><th>http</th> | |
3475 | <td class="description">HTTP connection</td></tr> | |
3476 | <tr><th>uri</th> | |
3477 | <td class="description">URI for head</td></tr> | |
3478 | </tbody></table> | |
798d6e29 MS |
3479 | <h4 class="returnvalue">Return Value</h4> |
3480 | <p class="description">Status of call (0 = success)</p> | |
3481 | <h3 class="function"><a id="httpInitialize">httpInitialize</a></h3> | |
53af7f21 MS |
3482 | <p class="description">Initialize the HTTP interface library and set the |
3483 | default HTTP proxy (if any).</p> | |
98d88c8d MS |
3484 | <p class="code"> |
3485 | void httpInitialize(void);</p> | |
798d6e29 MS |
3486 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpIsChunked">httpIsChunked</a></h3> |
3487 | <p class="description">Report whether a message body is chunked.</p> | |
3488 | <p class="code"> | |
98d88c8d | 3489 | int httpIsChunked(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3490 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3491 | <table class="list"><tbody> |
3492 | <tr><th>http</th> | |
3493 | <td class="description">HTTP connection</td></tr> | |
3494 | </tbody></table> | |
798d6e29 MS |
3495 | <h4 class="returnvalue">Return Value</h4> |
3496 | <p class="description">1 if chunked, 0 if not</p> | |
3497 | <h4 class="discussion">Discussion</h4> | |
3498 | <p class="discussion">This function returns non-zero if the message body is composed of | |
3499 | variable-length chunks. | |
3500 | ||
3501 | </p> | |
3502 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpIsEncrypted">httpIsEncrypted</a></h3> | |
3503 | <p class="description">Report whether a connection is encrypted.</p> | |
3504 | <p class="code"> | |
98d88c8d | 3505 | int httpIsEncrypted(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3506 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3507 | <table class="list"><tbody> |
3508 | <tr><th>http</th> | |
3509 | <td class="description">HTTP connection</td></tr> | |
3510 | </tbody></table> | |
798d6e29 MS |
3511 | <h4 class="returnvalue">Return Value</h4> |
3512 | <p class="description">1 if encrypted, 0 if not</p> | |
3513 | <h4 class="discussion">Discussion</h4> | |
3514 | <p class="discussion">This function returns non-zero if the connection is currently encrypted. | |
3515 | ||
3516 | </p> | |
3517 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpLoadCredentials">httpLoadCredentials</a></h3> | |
3518 | <p class="description">Load X.509 credentials from a keychain file.</p> | |
3519 | <p class="code"> | |
98d88c8d MS |
3520 | int httpLoadCredentials(const char *path, cups_array_t **credentials, const char *common_name);</p> |
3521 | <h4 class="parameters">Parameters</h4> | |
3522 | <table class="list"><tbody> | |
3523 | <tr><th>path</th> | |
3524 | <td class="description">Keychain path or <code>NULL</code> for default</td></tr> | |
3525 | <tr><th>credentials</th> | |
3526 | <td class="description">Credentials</td></tr> | |
3527 | <tr><th>common_name</th> | |
3528 | <td class="description">Common name for credentials</td></tr> | |
3529 | </tbody></table> | |
798d6e29 MS |
3530 | <h4 class="returnvalue">Return Value</h4> |
3531 | <p class="description">0 on success, -1 on error</p> | |
3532 | <h3 class="function"><a id="httpOptions">httpOptions</a></h3> | |
3533 | <p class="description">Send an OPTIONS request to the server.</p> | |
3534 | <p class="code"> | |
98d88c8d | 3535 | int httpOptions(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
798d6e29 | 3536 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3537 | <table class="list"><tbody> |
3538 | <tr><th>http</th> | |
3539 | <td class="description">HTTP connection</td></tr> | |
3540 | <tr><th>uri</th> | |
3541 | <td class="description">URI for options</td></tr> | |
3542 | </tbody></table> | |
798d6e29 MS |
3543 | <h4 class="returnvalue">Return Value</h4> |
3544 | <p class="description">Status of call (0 = success)</p> | |
3545 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpPeek">httpPeek</a></h3> | |
3546 | <p class="description">Peek at data from a HTTP connection.</p> | |
3547 | <p class="code"> | |
98d88c8d MS |
3548 | ssize_t httpPeek(<a href="#http_t">http_t</a> *http, char *buffer, size_t length);</p> |
3549 | <h4 class="parameters">Parameters</h4> | |
3550 | <table class="list"><tbody> | |
3551 | <tr><th>http</th> | |
3552 | <td class="description">HTTP connection</td></tr> | |
3553 | <tr><th>buffer</th> | |
3554 | <td class="description">Buffer for data</td></tr> | |
3555 | <tr><th>length</th> | |
3556 | <td class="description">Maximum number of bytes</td></tr> | |
3557 | </tbody></table> | |
798d6e29 MS |
3558 | <h4 class="returnvalue">Return Value</h4> |
3559 | <p class="description">Number of bytes copied</p> | |
3560 | <h4 class="discussion">Discussion</h4> | |
3561 | <p class="discussion">This function copies available data from the given HTTP connection, reading | |
3562 | a buffer as needed. The data is still available for reading using | |
65bebeac | 3563 | <a href="#httpRead2"><code>httpRead2</code></a>.<br> |
798d6e29 MS |
3564 | <br> |
3565 | For non-blocking connections the usual timeouts apply. | |
3566 | ||
3567 | </p> | |
3568 | <h3 class="function"><a id="httpPost">httpPost</a></h3> | |
3569 | <p class="description">Send a POST request to the server.</p> | |
3570 | <p class="code"> | |
98d88c8d | 3571 | int httpPost(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
798d6e29 | 3572 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3573 | <table class="list"><tbody> |
3574 | <tr><th>http</th> | |
3575 | <td class="description">HTTP connection</td></tr> | |
3576 | <tr><th>uri</th> | |
3577 | <td class="description">URI for post</td></tr> | |
3578 | </tbody></table> | |
798d6e29 MS |
3579 | <h4 class="returnvalue">Return Value</h4> |
3580 | <p class="description">Status of call (0 = success)</p> | |
3581 | <h3 class="function"><a id="httpPut">httpPut</a></h3> | |
3582 | <p class="description">Send a PUT request to the server.</p> | |
3583 | <p class="code"> | |
98d88c8d | 3584 | int httpPut(<a href="#http_t">http_t</a> *http, const char *uri);</p> |
798d6e29 | 3585 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3586 | <table class="list"><tbody> |
3587 | <tr><th>http</th> | |
3588 | <td class="description">HTTP connection</td></tr> | |
3589 | <tr><th>uri</th> | |
3590 | <td class="description">URI to put</td></tr> | |
3591 | </tbody></table> | |
798d6e29 MS |
3592 | <h4 class="returnvalue">Return Value</h4> |
3593 | <p class="description">Status of call (0 = success)</p> | |
798d6e29 MS |
3594 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpRead2">httpRead2</a></h3> |
3595 | <p class="description">Read data from a HTTP connection.</p> | |
3596 | <p class="code"> | |
98d88c8d MS |
3597 | ssize_t httpRead2(<a href="#http_t">http_t</a> *http, char *buffer, size_t length);</p> |
3598 | <h4 class="parameters">Parameters</h4> | |
3599 | <table class="list"><tbody> | |
3600 | <tr><th>http</th> | |
3601 | <td class="description">HTTP connection</td></tr> | |
3602 | <tr><th>buffer</th> | |
3603 | <td class="description">Buffer for data</td></tr> | |
3604 | <tr><th>length</th> | |
3605 | <td class="description">Maximum number of bytes</td></tr> | |
3606 | </tbody></table> | |
798d6e29 MS |
3607 | <h4 class="returnvalue">Return Value</h4> |
3608 | <p class="description">Number of bytes read</p> | |
3609 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpReadRequest">httpReadRequest</a></h3> | |
3610 | <p class="description">Read a HTTP request from a connection.</p> | |
3611 | <p class="code"> | |
98d88c8d MS |
3612 | <a href="#http_state_t">http_state_t</a> httpReadRequest(<a href="#http_t">http_t</a> *http, char *uri, size_t urilen);</p> |
3613 | <h4 class="parameters">Parameters</h4> | |
3614 | <table class="list"><tbody> | |
3615 | <tr><th>http</th> | |
3616 | <td class="description">HTTP connection</td></tr> | |
3617 | <tr><th>uri</th> | |
3618 | <td class="description">URI buffer</td></tr> | |
3619 | <tr><th>urilen</th> | |
3620 | <td class="description">Size of URI buffer</td></tr> | |
3621 | </tbody></table> | |
798d6e29 MS |
3622 | <h4 class="returnvalue">Return Value</h4> |
3623 | <p class="description">New state of connection</p> | |
798d6e29 MS |
3624 | <h3 class="function"><a id="httpReconnect2">httpReconnect2</a></h3> |
3625 | <p class="description">Reconnect to a HTTP server with timeout and optional | |
3626 | cancel.</p> | |
3627 | <p class="code"> | |
98d88c8d MS |
3628 | int httpReconnect2(<a href="#http_t">http_t</a> *http, int msec, int *cancel);</p> |
3629 | <h4 class="parameters">Parameters</h4> | |
3630 | <table class="list"><tbody> | |
3631 | <tr><th>http</th> | |
3632 | <td class="description">HTTP connection</td></tr> | |
3633 | <tr><th>msec</th> | |
3634 | <td class="description">Timeout in milliseconds</td></tr> | |
3635 | <tr><th>cancel</th> | |
3636 | <td class="description">Pointer to "cancel" variable</td></tr> | |
3637 | </tbody></table> | |
798d6e29 MS |
3638 | <h4 class="returnvalue">Return Value</h4> |
3639 | <p class="description">0 on success, non-zero on failure</p> | |
3640 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpResolveHostname">httpResolveHostname</a></h3> | |
3641 | <p class="description">Resolve the hostname of the HTTP connection | |
3642 | address.</p> | |
3643 | <p class="code"> | |
98d88c8d MS |
3644 | const char *httpResolveHostname(<a href="#http_t">http_t</a> *http, char *buffer, size_t bufsize);</p> |
3645 | <h4 class="parameters">Parameters</h4> | |
3646 | <table class="list"><tbody> | |
3647 | <tr><th>http</th> | |
3648 | <td class="description">HTTP connection</td></tr> | |
3649 | <tr><th>buffer</th> | |
3650 | <td class="description">Hostname buffer</td></tr> | |
3651 | <tr><th>bufsize</th> | |
3652 | <td class="description">Size of buffer</td></tr> | |
3653 | </tbody></table> | |
798d6e29 MS |
3654 | <h4 class="returnvalue">Return Value</h4> |
3655 | <p class="description">Resolved hostname or <code>NULL</code></p> | |
3656 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpSaveCredentials">httpSaveCredentials</a></h3> | |
3657 | <p class="description">Save X.509 credentials to a keychain file.</p> | |
3658 | <p class="code"> | |
98d88c8d MS |
3659 | int httpSaveCredentials(const char *path, cups_array_t *credentials, const char *common_name);</p> |
3660 | <h4 class="parameters">Parameters</h4> | |
3661 | <table class="list"><tbody> | |
3662 | <tr><th>path</th> | |
3663 | <td class="description">Keychain path or <code>NULL</code> for default</td></tr> | |
3664 | <tr><th>credentials</th> | |
3665 | <td class="description">Credentials</td></tr> | |
3666 | <tr><th>common_name</th> | |
3667 | <td class="description">Common name for credentials</td></tr> | |
3668 | </tbody></table> | |
798d6e29 MS |
3669 | <h4 class="returnvalue">Return Value</h4> |
3670 | <p class="description">-1 on error, 0 on success</p> | |
798d6e29 MS |
3671 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpSeparateURI">httpSeparateURI</a></h3> |
3672 | <p class="description">Separate a Universal Resource Identifier into its | |
3673 | components.</p> | |
3674 | <p class="code"> | |
98d88c8d MS |
3675 | <a href="#http_uri_status_t">http_uri_status_t</a> httpSeparateURI(<a href="#http_uri_coding_t">http_uri_coding_t</a> decoding, const char *uri, char *scheme, int schemelen, char *username, int usernamelen, char *host, int hostlen, int *port, char *resource, int resourcelen);</p> |
3676 | <h4 class="parameters">Parameters</h4> | |
3677 | <table class="list"><tbody> | |
3678 | <tr><th>decoding</th> | |
3679 | <td class="description">Decoding flags</td></tr> | |
3680 | <tr><th>uri</th> | |
3681 | <td class="description">Universal Resource Identifier</td></tr> | |
3682 | <tr><th>scheme</th> | |
3683 | <td class="description">Scheme (http, https, etc.)</td></tr> | |
3684 | <tr><th>schemelen</th> | |
3685 | <td class="description">Size of scheme buffer</td></tr> | |
3686 | <tr><th>username</th> | |
3687 | <td class="description">Username</td></tr> | |
3688 | <tr><th>usernamelen</th> | |
3689 | <td class="description">Size of username buffer</td></tr> | |
3690 | <tr><th>host</th> | |
3691 | <td class="description">Hostname</td></tr> | |
3692 | <tr><th>hostlen</th> | |
3693 | <td class="description">Size of hostname buffer</td></tr> | |
3694 | <tr><th>port</th> | |
3695 | <td class="description">Port number to use</td></tr> | |
3696 | <tr><th>resource</th> | |
3697 | <td class="description">Resource/filename</td></tr> | |
3698 | <tr><th>resourcelen</th> | |
3699 | <td class="description">Size of resource buffer</td></tr> | |
3700 | </tbody></table> | |
798d6e29 MS |
3701 | <h4 class="returnvalue">Return Value</h4> |
3702 | <p class="description">Result of separation</p> | |
98d88c8d | 3703 | <h3 class="function"><span class="info"> CUPS 1.3/macOS 10.5 </span><a id="httpSetAuthString">httpSetAuthString</a></h3> |
53af7f21 | 3704 | <p class="description">Set the current authorization string.</p> |
98d88c8d MS |
3705 | <p class="code"> |
3706 | void httpSetAuthString(<a href="#http_t">http_t</a> *http, const char *scheme, const char *data);</p> | |
3707 | <h4 class="parameters">Parameters</h4> | |
3708 | <table class="list"><tbody> | |
3709 | <tr><th>http</th> | |
3710 | <td class="description">HTTP connection</td></tr> | |
3711 | <tr><th>scheme</th> | |
3712 | <td class="description">Auth scheme (NULL to clear it)</td></tr> | |
3713 | <tr><th>data</th> | |
3714 | <td class="description">Auth data (NULL for none)</td></tr> | |
3715 | </tbody></table> | |
3716 | <h4 class="discussion">Discussion</h4> | |
798d6e29 | 3717 | <p class="discussion">This function just stores a copy of the current authorization string in |
65bebeac MS |
3718 | the HTTP connection object. You must still call <a href="#httpSetField"><code>httpSetField</code></a> to set |
3719 | <code>HTTP_FIELD_AUTHORIZATION</code> prior to issuing a HTTP request using | |
3720 | <a href="#httpGet"><code>httpGet</code></a>, <a href="#httpHead"><code>httpHead</code></a>, <a href="#httpOptions"><code>httpOptions</code></a>, <a href="#httpPost"><code>httpPost</code></a>, or | |
3721 | <a href="#httpPut"><code>httpPut</code></a>. | |
798d6e29 MS |
3722 | |
3723 | </p> | |
98d88c8d MS |
3724 | <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpSetCookie">httpSetCookie</a></h3> |
3725 | <p class="description">Set the cookie value(s).</p> | |
798d6e29 | 3726 | <p class="code"> |
98d88c8d | 3727 | void httpSetCookie(<a href="#http_t">http_t</a> *http, const char *cookie);</p> |
798d6e29 | 3728 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3729 | <table class="list"><tbody> |
3730 | <tr><th>http</th> | |
3731 | <td class="description">Connection</td></tr> | |
3732 | <tr><th>cookie</th> | |
3733 | <td class="description">Cookie string</td></tr> | |
3734 | </tbody></table> | |
798d6e29 MS |
3735 | <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpSetCredentials">httpSetCredentials</a></h3> |
3736 | <p class="description">Set the credentials associated with an encrypted | |
3737 | connection.</p> | |
3738 | <p class="code"> | |
98d88c8d | 3739 | int httpSetCredentials(<a href="#http_t">http_t</a> *http, cups_array_t *credentials);</p> |
798d6e29 | 3740 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3741 | <table class="list"><tbody> |
3742 | <tr><th>http</th> | |
3743 | <td class="description">HTTP connection</td></tr> | |
3744 | <tr><th>credentials</th> | |
3745 | <td class="description">Array of credentials</td></tr> | |
3746 | </tbody></table> | |
798d6e29 MS |
3747 | <h4 class="returnvalue">Return Value</h4> |
3748 | <p class="description">Status of call (0 = success)</p> | |
98d88c8d | 3749 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpSetDefaultField">httpSetDefaultField</a></h3> |
53af7f21 | 3750 | <p class="description">Set the default value of an HTTP header.</p> |
98d88c8d MS |
3751 | <p class="code"> |
3752 | void httpSetDefaultField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *value);</p> | |
3753 | <h4 class="parameters">Parameters</h4> | |
3754 | <table class="list"><tbody> | |
3755 | <tr><th>http</th> | |
3756 | <td class="description">HTTP connection</td></tr> | |
3757 | <tr><th>field</th> | |
3758 | <td class="description">Field index</td></tr> | |
3759 | <tr><th>value</th> | |
3760 | <td class="description">Value</td></tr> | |
3761 | </tbody></table> | |
3762 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
3763 | <p class="discussion">Currently only <code>HTTP_FIELD_ACCEPT_ENCODING</code>, <code>HTTP_FIELD_SERVER</code>, |
3764 | and <code>HTTP_FIELD_USER_AGENT</code> can be set. | |
3765 | ||
3766 | </p> | |
98d88c8d MS |
3767 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpSetExpect">httpSetExpect</a></h3> |
3768 | <p class="description">Set the Expect: header in a request.</p> | |
798d6e29 | 3769 | <p class="code"> |
98d88c8d | 3770 | void httpSetExpect(<a href="#http_t">http_t</a> *http, http_status_t expect);</p> |
798d6e29 | 3771 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3772 | <table class="list"><tbody> |
3773 | <tr><th>http</th> | |
3774 | <td class="description">HTTP connection</td></tr> | |
3775 | <tr><th>expect</th> | |
3776 | <td class="description">HTTP status to expect | |
3777 | (<code>HTTP_STATUS_CONTINUE</code>)</td></tr> | |
3778 | </tbody></table> | |
3779 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
3780 | <p class="discussion">Currently only <code>HTTP_STATUS_CONTINUE</code> is supported for the "expect" |
3781 | argument. | |
3782 | ||
3783 | </p> | |
3784 | <h3 class="function"><a id="httpSetField">httpSetField</a></h3> | |
53af7f21 | 3785 | <p class="description">Set the value of an HTTP header.</p> |
798d6e29 | 3786 | <p class="code"> |
98d88c8d MS |
3787 | void httpSetField(<a href="#http_t">http_t</a> *http, <a href="#http_field_t">http_field_t</a> field, const char *value);</p> |
3788 | <h4 class="parameters">Parameters</h4> | |
3789 | <table class="list"><tbody> | |
3790 | <tr><th>http</th> | |
3791 | <td class="description">HTTP connection</td></tr> | |
3792 | <tr><th>field</th> | |
3793 | <td class="description">Field index</td></tr> | |
3794 | <tr><th>value</th> | |
3795 | <td class="description">Value</td></tr> | |
3796 | </tbody></table> | |
3797 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpSetKeepAlive">httpSetKeepAlive</a></h3> | |
53af7f21 | 3798 | <p class="description">Set the current Keep-Alive state of a connection.</p> |
98d88c8d MS |
3799 | <p class="code"> |
3800 | void httpSetKeepAlive(<a href="#http_t">http_t</a> *http, <a href="#http_keepalive_t">http_keepalive_t</a> keep_alive);</p> | |
3801 | <h4 class="parameters">Parameters</h4> | |
3802 | <table class="list"><tbody> | |
3803 | <tr><th>http</th> | |
3804 | <td class="description">HTTP connection</td></tr> | |
3805 | <tr><th>keep_alive</th> | |
3806 | <td class="description">New Keep-Alive value</td></tr> | |
3807 | </tbody></table> | |
3808 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpSetLength">httpSetLength</a></h3> | |
53af7f21 | 3809 | <p class="description">Set the content-length and content-encoding.</p> |
98d88c8d MS |
3810 | <p class="code"> |
3811 | void httpSetLength(<a href="#http_t">http_t</a> *http, size_t length);</p> | |
3812 | <h4 class="parameters">Parameters</h4> | |
3813 | <table class="list"><tbody> | |
3814 | <tr><th>http</th> | |
3815 | <td class="description">HTTP connection</td></tr> | |
3816 | <tr><th>length</th> | |
3817 | <td class="description">Length (0 for chunked)</td></tr> | |
3818 | </tbody></table> | |
3819 | <h3 class="function"><span class="info"> CUPS 1.5/macOS 10.7 </span><a id="httpSetTimeout">httpSetTimeout</a></h3> | |
53af7f21 | 3820 | <p class="description">Set read/write timeouts and an optional callback.</p> |
98d88c8d MS |
3821 | <p class="code"> |
3822 | void httpSetTimeout(<a href="#http_t">http_t</a> *http, double timeout, <a href="#http_timeout_cb_t">http_timeout_cb_t</a> cb, void *user_data);</p> | |
3823 | <h4 class="parameters">Parameters</h4> | |
3824 | <table class="list"><tbody> | |
3825 | <tr><th>http</th> | |
3826 | <td class="description">HTTP connection</td></tr> | |
3827 | <tr><th>timeout</th> | |
3828 | <td class="description">Number of seconds for timeout, | |
3829 | must be greater than 0</td></tr> | |
3830 | <tr><th>cb</th> | |
65bebeac | 3831 | <td class="description">Callback function or <code>NULL</code></td></tr> |
98d88c8d MS |
3832 | <tr><th>user_data</th> |
3833 | <td class="description">User data pointer</td></tr> | |
3834 | </tbody></table> | |
3835 | <h4 class="discussion">Discussion</h4> | |
798d6e29 MS |
3836 | <p class="discussion">The optional timeout callback receives both the HTTP connection and a user |
3837 | data pointer and must return 1 to continue or 0 to error (time) out. | |
3838 | ||
3839 | </p> | |
98d88c8d MS |
3840 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpShutdown">httpShutdown</a></h3> |
3841 | <p class="description">Shutdown one side of an HTTP connection.</p> | |
798d6e29 | 3842 | <p class="code"> |
98d88c8d | 3843 | void httpShutdown(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3844 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3845 | <table class="list"><tbody> |
3846 | <tr><th>http</th> | |
3847 | <td class="description">HTTP connection</td></tr> | |
3848 | </tbody></table> | |
798d6e29 MS |
3849 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpStateString">httpStateString</a></h3> |
3850 | <p class="description">Return the string describing a HTTP state value.</p> | |
3851 | <p class="code"> | |
98d88c8d | 3852 | const char *httpStateString(<a href="#http_state_t">http_state_t</a> state);</p> |
798d6e29 | 3853 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3854 | <table class="list"><tbody> |
3855 | <tr><th>state</th> | |
3856 | <td class="description">HTTP state value</td></tr> | |
3857 | </tbody></table> | |
798d6e29 MS |
3858 | <h4 class="returnvalue">Return Value</h4> |
3859 | <p class="description">State string</p> | |
3860 | <h3 class="function"><a id="httpStatus">httpStatus</a></h3> | |
3861 | <p class="description">Return a short string describing a HTTP status code.</p> | |
3862 | <p class="code"> | |
98d88c8d | 3863 | const char *httpStatus(http_status_t status);</p> |
798d6e29 | 3864 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3865 | <table class="list"><tbody> |
3866 | <tr><th>status</th> | |
3867 | <td class="description">HTTP status code</td></tr> | |
3868 | </tbody></table> | |
798d6e29 MS |
3869 | <h4 class="returnvalue">Return Value</h4> |
3870 | <p class="description">Localized status string</p> | |
3871 | <h4 class="discussion">Discussion</h4> | |
3872 | <p class="discussion">The returned string is localized to the current POSIX locale and is based | |
65bebeac | 3873 | on the status strings defined in RFC 7231.</p> |
798d6e29 MS |
3874 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="httpURIStatusString">httpURIStatusString</a></h3> |
3875 | <p class="description">Return a string describing a URI status code.</p> | |
3876 | <p class="code"> | |
98d88c8d | 3877 | const char *httpURIStatusString(<a href="#http_uri_status_t">http_uri_status_t</a> status);</p> |
798d6e29 | 3878 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3879 | <table class="list"><tbody> |
3880 | <tr><th>status</th> | |
3881 | <td class="description">URI status code</td></tr> | |
3882 | </tbody></table> | |
798d6e29 MS |
3883 | <h4 class="returnvalue">Return Value</h4> |
3884 | <p class="description">Localized status string</p> | |
3885 | <h3 class="function"><a id="httpUpdate">httpUpdate</a></h3> | |
3886 | <p class="description">Update the current HTTP state for incoming data.</p> | |
3887 | <p class="code"> | |
98d88c8d | 3888 | http_status_t httpUpdate(<a href="#http_t">http_t</a> *http);</p> |
798d6e29 | 3889 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3890 | <table class="list"><tbody> |
3891 | <tr><th>http</th> | |
3892 | <td class="description">HTTP connection</td></tr> | |
3893 | </tbody></table> | |
798d6e29 MS |
3894 | <h4 class="returnvalue">Return Value</h4> |
3895 | <p class="description">HTTP status</p> | |
3896 | <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="httpWait">httpWait</a></h3> | |
3897 | <p class="description">Wait for data available on a connection.</p> | |
3898 | <p class="code"> | |
98d88c8d | 3899 | int httpWait(<a href="#http_t">http_t</a> *http, int msec);</p> |
798d6e29 | 3900 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3901 | <table class="list"><tbody> |
3902 | <tr><th>http</th> | |
3903 | <td class="description">HTTP connection</td></tr> | |
3904 | <tr><th>msec</th> | |
3905 | <td class="description">Milliseconds to wait</td></tr> | |
3906 | </tbody></table> | |
798d6e29 MS |
3907 | <h4 class="returnvalue">Return Value</h4> |
3908 | <p class="description">1 if data is available, 0 otherwise</p> | |
798d6e29 MS |
3909 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="httpWrite2">httpWrite2</a></h3> |
3910 | <p class="description">Write data to a HTTP connection.</p> | |
3911 | <p class="code"> | |
98d88c8d MS |
3912 | ssize_t httpWrite2(<a href="#http_t">http_t</a> *http, const char *buffer, size_t length);</p> |
3913 | <h4 class="parameters">Parameters</h4> | |
3914 | <table class="list"><tbody> | |
3915 | <tr><th>http</th> | |
3916 | <td class="description">HTTP connection</td></tr> | |
3917 | <tr><th>buffer</th> | |
3918 | <td class="description">Buffer for data</td></tr> | |
3919 | <tr><th>length</th> | |
3920 | <td class="description">Number of bytes to write</td></tr> | |
3921 | </tbody></table> | |
798d6e29 MS |
3922 | <h4 class="returnvalue">Return Value</h4> |
3923 | <p class="description">Number of bytes written</p> | |
3924 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="httpWriteResponse">httpWriteResponse</a></h3> | |
3925 | <p class="description">Write a HTTP response to a client connection.</p> | |
3926 | <p class="code"> | |
98d88c8d | 3927 | int httpWriteResponse(<a href="#http_t">http_t</a> *http, http_status_t status);</p> |
798d6e29 | 3928 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
3929 | <table class="list"><tbody> |
3930 | <tr><th>http</th> | |
3931 | <td class="description">HTTP connection</td></tr> | |
3932 | <tr><th>status</th> | |
3933 | <td class="description">Status code</td></tr> | |
3934 | </tbody></table> | |
798d6e29 MS |
3935 | <h4 class="returnvalue">Return Value</h4> |
3936 | <p class="description">0 on success, -1 on error</p> | |
3937 | <h3 class="function"><a id="ippAddBoolean">ippAddBoolean</a></h3> | |
3938 | <p class="description">Add a boolean attribute to an IPP message.</p> | |
3939 | <p class="code"> | |
98d88c8d MS |
3940 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBoolean(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, char value);</p> |
3941 | <h4 class="parameters">Parameters</h4> | |
3942 | <table class="list"><tbody> | |
3943 | <tr><th>ipp</th> | |
3944 | <td class="description">IPP message</td></tr> | |
3945 | <tr><th>group</th> | |
3946 | <td class="description">IPP group</td></tr> | |
3947 | <tr><th>name</th> | |
3948 | <td class="description">Name of attribute</td></tr> | |
3949 | <tr><th>value</th> | |
3950 | <td class="description">Value of attribute</td></tr> | |
3951 | </tbody></table> | |
798d6e29 MS |
3952 | <h4 class="returnvalue">Return Value</h4> |
3953 | <p class="description">New attribute</p> | |
3954 | <h4 class="discussion">Discussion</h4> | |
3955 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
3956 | 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> | |
3957 | <br> | |
3958 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
3959 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
3960 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
3961 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
3962 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> | |
3963 | <h3 class="function"><a id="ippAddBooleans">ippAddBooleans</a></h3> | |
3964 | <p class="description">Add an array of boolean values.</p> | |
3965 | <p class="code"> | |
98d88c8d MS |
3966 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddBooleans(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, const char *values);</p> |
3967 | <h4 class="parameters">Parameters</h4> | |
3968 | <table class="list"><tbody> | |
3969 | <tr><th>ipp</th> | |
3970 | <td class="description">IPP message</td></tr> | |
3971 | <tr><th>group</th> | |
3972 | <td class="description">IPP group</td></tr> | |
3973 | <tr><th>name</th> | |
3974 | <td class="description">Name of attribute</td></tr> | |
3975 | <tr><th>num_values</th> | |
3976 | <td class="description">Number of values</td></tr> | |
3977 | <tr><th>values</th> | |
3978 | <td class="description">Values</td></tr> | |
3979 | </tbody></table> | |
798d6e29 MS |
3980 | <h4 class="returnvalue">Return Value</h4> |
3981 | <p class="description">New attribute</p> | |
3982 | <h4 class="discussion">Discussion</h4> | |
3983 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
3984 | 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> | |
3985 | <br> | |
3986 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
3987 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
3988 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
3989 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
3990 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> | |
3991 | <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippAddCollection">ippAddCollection</a></h3> | |
3992 | <p class="description">Add a collection value.</p> | |
3993 | <p class="code"> | |
98d88c8d MS |
3994 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollection(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, <a href="#ipp_t">ipp_t</a> *value);</p> |
3995 | <h4 class="parameters">Parameters</h4> | |
3996 | <table class="list"><tbody> | |
3997 | <tr><th>ipp</th> | |
3998 | <td class="description">IPP message</td></tr> | |
3999 | <tr><th>group</th> | |
4000 | <td class="description">IPP group</td></tr> | |
4001 | <tr><th>name</th> | |
4002 | <td class="description">Name of attribute</td></tr> | |
4003 | <tr><th>value</th> | |
4004 | <td class="description">Value</td></tr> | |
4005 | </tbody></table> | |
798d6e29 MS |
4006 | <h4 class="returnvalue">Return Value</h4> |
4007 | <p class="description">New attribute</p> | |
4008 | <h4 class="discussion">Discussion</h4> | |
4009 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4010 | 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> | |
4011 | <br> | |
4012 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4013 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4014 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4015 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4016 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). | |
4017 | ||
4018 | </p> | |
4019 | <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippAddCollections">ippAddCollections</a></h3> | |
4020 | <p class="description">Add an array of collection values.</p> | |
4021 | <p class="code"> | |
98d88c8d MS |
4022 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddCollections(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, const <a href="#ipp_t">ipp_t</a> **values);</p> |
4023 | <h4 class="parameters">Parameters</h4> | |
4024 | <table class="list"><tbody> | |
4025 | <tr><th>ipp</th> | |
4026 | <td class="description">IPP message</td></tr> | |
4027 | <tr><th>group</th> | |
4028 | <td class="description">IPP group</td></tr> | |
4029 | <tr><th>name</th> | |
4030 | <td class="description">Name of attribute</td></tr> | |
4031 | <tr><th>num_values</th> | |
4032 | <td class="description">Number of values</td></tr> | |
4033 | <tr><th>values</th> | |
4034 | <td class="description">Values</td></tr> | |
4035 | </tbody></table> | |
798d6e29 MS |
4036 | <h4 class="returnvalue">Return Value</h4> |
4037 | <p class="description">New attribute</p> | |
4038 | <h4 class="discussion">Discussion</h4> | |
4039 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4040 | 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> | |
4041 | <br> | |
4042 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4043 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4044 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4045 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4046 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). | |
4047 | ||
4048 | </p> | |
4049 | <h3 class="function"><a id="ippAddDate">ippAddDate</a></h3> | |
65bebeac | 4050 | <p class="description">Add a dateTime attribute to an IPP message.</p> |
798d6e29 | 4051 | <p class="code"> |
98d88c8d MS |
4052 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddDate(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, const <a href="#ipp_uchar_t">ipp_uchar_t</a> *value);</p> |
4053 | <h4 class="parameters">Parameters</h4> | |
4054 | <table class="list"><tbody> | |
4055 | <tr><th>ipp</th> | |
4056 | <td class="description">IPP message</td></tr> | |
4057 | <tr><th>group</th> | |
4058 | <td class="description">IPP group</td></tr> | |
4059 | <tr><th>name</th> | |
4060 | <td class="description">Name of attribute</td></tr> | |
4061 | <tr><th>value</th> | |
4062 | <td class="description">Value</td></tr> | |
4063 | </tbody></table> | |
798d6e29 MS |
4064 | <h4 class="returnvalue">Return Value</h4> |
4065 | <p class="description">New attribute</p> | |
4066 | <h4 class="discussion">Discussion</h4> | |
4067 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4068 | 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> | |
4069 | <br> | |
4070 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4071 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4072 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4073 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4074 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> | |
4075 | <h3 class="function"><a id="ippAddInteger">ippAddInteger</a></h3> | |
4076 | <p class="description">Add a integer attribute to an IPP message.</p> | |
4077 | <p class="code"> | |
98d88c8d MS |
4078 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddInteger(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, int value);</p> |
4079 | <h4 class="parameters">Parameters</h4> | |
4080 | <table class="list"><tbody> | |
4081 | <tr><th>ipp</th> | |
4082 | <td class="description">IPP message</td></tr> | |
4083 | <tr><th>group</th> | |
4084 | <td class="description">IPP group</td></tr> | |
4085 | <tr><th>value_tag</th> | |
4086 | <td class="description">Type of attribute</td></tr> | |
4087 | <tr><th>name</th> | |
4088 | <td class="description">Name of attribute</td></tr> | |
4089 | <tr><th>value</th> | |
4090 | <td class="description">Value of attribute</td></tr> | |
4091 | </tbody></table> | |
798d6e29 MS |
4092 | <h4 class="returnvalue">Return Value</h4> |
4093 | <p class="description">New attribute</p> | |
4094 | <h4 class="discussion">Discussion</h4> | |
4095 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4096 | 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> | |
4097 | <br> | |
4098 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4099 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4100 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4101 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4102 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> | |
4103 | <br> | |
4104 | Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer | |
4105 | (<code>IPP_TAG_INTEGER</code>).</p> | |
4106 | <h3 class="function"><a id="ippAddIntegers">ippAddIntegers</a></h3> | |
4107 | <p class="description">Add an array of integer values.</p> | |
4108 | <p class="code"> | |
98d88c8d MS |
4109 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddIntegers(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, int num_values, const int *values);</p> |
4110 | <h4 class="parameters">Parameters</h4> | |
4111 | <table class="list"><tbody> | |
4112 | <tr><th>ipp</th> | |
4113 | <td class="description">IPP message</td></tr> | |
4114 | <tr><th>group</th> | |
4115 | <td class="description">IPP group</td></tr> | |
4116 | <tr><th>value_tag</th> | |
4117 | <td class="description">Type of attribute</td></tr> | |
4118 | <tr><th>name</th> | |
4119 | <td class="description">Name of attribute</td></tr> | |
4120 | <tr><th>num_values</th> | |
4121 | <td class="description">Number of values</td></tr> | |
4122 | <tr><th>values</th> | |
4123 | <td class="description">Values</td></tr> | |
4124 | </tbody></table> | |
798d6e29 MS |
4125 | <h4 class="returnvalue">Return Value</h4> |
4126 | <p class="description">New attribute</p> | |
4127 | <h4 class="discussion">Discussion</h4> | |
4128 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4129 | 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> | |
4130 | <br> | |
4131 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4132 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4133 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4134 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4135 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> | |
4136 | <br> | |
4137 | Supported values include enum (<code>IPP_TAG_ENUM</code>) and integer | |
4138 | (<code>IPP_TAG_INTEGER</code>).</p> | |
4139 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippAddOctetString">ippAddOctetString</a></h3> | |
4140 | <p class="description">Add an octetString value to an IPP message.</p> | |
4141 | <p class="code"> | |
98d88c8d MS |
4142 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddOctetString(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, const void *data, int datalen);</p> |
4143 | <h4 class="parameters">Parameters</h4> | |
4144 | <table class="list"><tbody> | |
4145 | <tr><th>ipp</th> | |
4146 | <td class="description">IPP message</td></tr> | |
4147 | <tr><th>group</th> | |
4148 | <td class="description">IPP group</td></tr> | |
4149 | <tr><th>name</th> | |
4150 | <td class="description">Name of attribute</td></tr> | |
4151 | <tr><th>data</th> | |
4152 | <td class="description">octetString data</td></tr> | |
4153 | <tr><th>datalen</th> | |
4154 | <td class="description">Length of data in bytes</td></tr> | |
4155 | </tbody></table> | |
798d6e29 MS |
4156 | <h4 class="returnvalue">Return Value</h4> |
4157 | <p class="description">New attribute</p> | |
4158 | <h4 class="discussion">Discussion</h4> | |
4159 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4160 | 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> | |
4161 | <br> | |
4162 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4163 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4164 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4165 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4166 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). | |
4167 | ||
4168 | </p> | |
4169 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippAddOutOfBand">ippAddOutOfBand</a></h3> | |
4170 | <p class="description">Add an out-of-band value to an IPP message.</p> | |
4171 | <p class="code"> | |
98d88c8d MS |
4172 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddOutOfBand(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name);</p> |
4173 | <h4 class="parameters">Parameters</h4> | |
4174 | <table class="list"><tbody> | |
4175 | <tr><th>ipp</th> | |
4176 | <td class="description">IPP message</td></tr> | |
4177 | <tr><th>group</th> | |
4178 | <td class="description">IPP group</td></tr> | |
4179 | <tr><th>value_tag</th> | |
4180 | <td class="description">Type of attribute</td></tr> | |
4181 | <tr><th>name</th> | |
4182 | <td class="description">Name of attribute</td></tr> | |
4183 | </tbody></table> | |
798d6e29 MS |
4184 | <h4 class="returnvalue">Return Value</h4> |
4185 | <p class="description">New attribute</p> | |
4186 | <h4 class="discussion">Discussion</h4> | |
4187 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4188 | 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> | |
4189 | <br> | |
4190 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4191 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4192 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4193 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4194 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> | |
4195 | <br> | |
4196 | Supported out-of-band values include unsupported-value | |
4197 | (<code>IPP_TAG_UNSUPPORTED_VALUE</code>), default (<code>IPP_TAG_DEFAULT</code>), unknown | |
4198 | (<code>IPP_TAG_UNKNOWN</code>), no-value (<code>IPP_TAG_NOVALUE</code>), not-settable | |
4199 | (<code>IPP_TAG_NOTSETTABLE</code>), delete-attribute (<code>IPP_TAG_DELETEATTR</code>), and | |
4200 | admin-define (<code>IPP_TAG_ADMINDEFINE</code>). | |
4201 | ||
4202 | </p> | |
4203 | <h3 class="function"><a id="ippAddRange">ippAddRange</a></h3> | |
4204 | <p class="description">Add a range of values to an IPP message.</p> | |
4205 | <p class="code"> | |
98d88c8d MS |
4206 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRange(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int lower, int upper);</p> |
4207 | <h4 class="parameters">Parameters</h4> | |
4208 | <table class="list"><tbody> | |
4209 | <tr><th>ipp</th> | |
4210 | <td class="description">IPP message</td></tr> | |
4211 | <tr><th>group</th> | |
4212 | <td class="description">IPP group</td></tr> | |
4213 | <tr><th>name</th> | |
4214 | <td class="description">Name of attribute</td></tr> | |
4215 | <tr><th>lower</th> | |
4216 | <td class="description">Lower value</td></tr> | |
4217 | <tr><th>upper</th> | |
4218 | <td class="description">Upper value</td></tr> | |
4219 | </tbody></table> | |
798d6e29 MS |
4220 | <h4 class="returnvalue">Return Value</h4> |
4221 | <p class="description">New attribute</p> | |
4222 | <h4 class="discussion">Discussion</h4> | |
4223 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4224 | 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> | |
4225 | <br> | |
4226 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4227 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4228 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4229 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4230 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> | |
4231 | <br> | |
4232 | The <code>lower</code> parameter must be less than or equal to the <code>upper</code> parameter.</p> | |
4233 | <h3 class="function"><a id="ippAddRanges">ippAddRanges</a></h3> | |
4234 | <p class="description">Add ranges of values to an IPP message.</p> | |
4235 | <p class="code"> | |
98d88c8d MS |
4236 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddRanges(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, const int *lower, const int *upper);</p> |
4237 | <h4 class="parameters">Parameters</h4> | |
4238 | <table class="list"><tbody> | |
4239 | <tr><th>ipp</th> | |
4240 | <td class="description">IPP message</td></tr> | |
4241 | <tr><th>group</th> | |
4242 | <td class="description">IPP group</td></tr> | |
4243 | <tr><th>name</th> | |
4244 | <td class="description">Name of attribute</td></tr> | |
4245 | <tr><th>num_values</th> | |
4246 | <td class="description">Number of values</td></tr> | |
4247 | <tr><th>lower</th> | |
4248 | <td class="description">Lower values</td></tr> | |
4249 | <tr><th>upper</th> | |
4250 | <td class="description">Upper values</td></tr> | |
4251 | </tbody></table> | |
798d6e29 MS |
4252 | <h4 class="returnvalue">Return Value</h4> |
4253 | <p class="description">New attribute</p> | |
4254 | <h4 class="discussion">Discussion</h4> | |
4255 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4256 | 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> | |
4257 | <br> | |
4258 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4259 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4260 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4261 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4262 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> | |
4263 | <h3 class="function"><a id="ippAddResolution">ippAddResolution</a></h3> | |
4264 | <p class="description">Add a resolution value to an IPP message.</p> | |
4265 | <p class="code"> | |
98d88c8d MS |
4266 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolution(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, <a href="#ipp_res_t">ipp_res_t</a> units, int xres, int yres);</p> |
4267 | <h4 class="parameters">Parameters</h4> | |
4268 | <table class="list"><tbody> | |
4269 | <tr><th>ipp</th> | |
4270 | <td class="description">IPP message</td></tr> | |
4271 | <tr><th>group</th> | |
4272 | <td class="description">IPP group</td></tr> | |
4273 | <tr><th>name</th> | |
4274 | <td class="description">Name of attribute</td></tr> | |
4275 | <tr><th>units</th> | |
4276 | <td class="description">Units for resolution</td></tr> | |
4277 | <tr><th>xres</th> | |
4278 | <td class="description">X resolution</td></tr> | |
4279 | <tr><th>yres</th> | |
4280 | <td class="description">Y resolution</td></tr> | |
4281 | </tbody></table> | |
798d6e29 MS |
4282 | <h4 class="returnvalue">Return Value</h4> |
4283 | <p class="description">New attribute</p> | |
4284 | <h4 class="discussion">Discussion</h4> | |
4285 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4286 | 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> | |
4287 | <br> | |
4288 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4289 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4290 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4291 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4292 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> | |
4293 | <h3 class="function"><a id="ippAddResolutions">ippAddResolutions</a></h3> | |
4294 | <p class="description">Add resolution values to an IPP message.</p> | |
4295 | <p class="code"> | |
98d88c8d MS |
4296 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddResolutions(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, const char *name, int num_values, <a href="#ipp_res_t">ipp_res_t</a> units, const int *xres, const int *yres);</p> |
4297 | <h4 class="parameters">Parameters</h4> | |
4298 | <table class="list"><tbody> | |
4299 | <tr><th>ipp</th> | |
4300 | <td class="description">IPP message</td></tr> | |
4301 | <tr><th>group</th> | |
4302 | <td class="description">IPP group</td></tr> | |
4303 | <tr><th>name</th> | |
4304 | <td class="description">Name of attribute</td></tr> | |
4305 | <tr><th>num_values</th> | |
4306 | <td class="description">Number of values</td></tr> | |
4307 | <tr><th>units</th> | |
4308 | <td class="description">Units for resolution</td></tr> | |
4309 | <tr><th>xres</th> | |
4310 | <td class="description">X resolutions</td></tr> | |
4311 | <tr><th>yres</th> | |
4312 | <td class="description">Y resolutions</td></tr> | |
4313 | </tbody></table> | |
798d6e29 MS |
4314 | <h4 class="returnvalue">Return Value</h4> |
4315 | <p class="description">New attribute</p> | |
4316 | <h4 class="discussion">Discussion</h4> | |
4317 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4318 | 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> | |
4319 | <br> | |
4320 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4321 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4322 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4323 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4324 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).</p> | |
4325 | <h3 class="function"><a id="ippAddSeparator">ippAddSeparator</a></h3> | |
4326 | <p class="description">Add a group separator to an IPP message.</p> | |
4327 | <p class="code"> | |
98d88c8d | 4328 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddSeparator(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 4329 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4330 | <table class="list"><tbody> |
4331 | <tr><th>ipp</th> | |
4332 | <td class="description">IPP message</td></tr> | |
4333 | </tbody></table> | |
798d6e29 MS |
4334 | <h4 class="returnvalue">Return Value</h4> |
4335 | <p class="description">New attribute</p> | |
4336 | <h4 class="discussion">Discussion</h4> | |
4337 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4338 | 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> | |
4339 | <h3 class="function"><a id="ippAddString">ippAddString</a></h3> | |
4340 | <p class="description">Add a language-encoded string to an IPP message.</p> | |
4341 | <p class="code"> | |
98d88c8d MS |
4342 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddString(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, const char *language, const char *value);</p> |
4343 | <h4 class="parameters">Parameters</h4> | |
4344 | <table class="list"><tbody> | |
4345 | <tr><th>ipp</th> | |
4346 | <td class="description">IPP message</td></tr> | |
4347 | <tr><th>group</th> | |
4348 | <td class="description">IPP group</td></tr> | |
4349 | <tr><th>value_tag</th> | |
4350 | <td class="description">Type of attribute</td></tr> | |
4351 | <tr><th>name</th> | |
4352 | <td class="description">Name of attribute</td></tr> | |
4353 | <tr><th>language</th> | |
4354 | <td class="description">Language code</td></tr> | |
4355 | <tr><th>value</th> | |
4356 | <td class="description">Value</td></tr> | |
4357 | </tbody></table> | |
798d6e29 MS |
4358 | <h4 class="returnvalue">Return Value</h4> |
4359 | <p class="description">New attribute</p> | |
4360 | <h4 class="discussion">Discussion</h4> | |
4361 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4362 | 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> | |
4363 | <br> | |
4364 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4365 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4366 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4367 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4368 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> | |
4369 | <br> | |
4370 | Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword | |
4371 | (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType | |
4372 | (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage | |
4373 | (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage | |
4374 | (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme | |
4375 | (<code>IPP_TAG_URISCHEME</code>).<br> | |
4376 | <br> | |
4377 | The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and | |
4378 | textWithLanguage string values and must be <code>NULL</code> for all other string values.</p> | |
4379 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippAddStringf">ippAddStringf</a></h3> | |
4380 | <p class="description">Add a formatted string to an IPP message.</p> | |
4381 | <p class="code"> | |
98d88c8d MS |
4382 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStringf(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, const char *language, const char *format, ...);</p> |
4383 | <h4 class="parameters">Parameters</h4> | |
4384 | <table class="list"><tbody> | |
4385 | <tr><th>ipp</th> | |
4386 | <td class="description">IPP message</td></tr> | |
4387 | <tr><th>group</th> | |
4388 | <td class="description">IPP group</td></tr> | |
4389 | <tr><th>value_tag</th> | |
4390 | <td class="description">Type of attribute</td></tr> | |
4391 | <tr><th>name</th> | |
4392 | <td class="description">Name of attribute</td></tr> | |
4393 | <tr><th>language</th> | |
4394 | <td class="description">Language code (<code>NULL</code> for default)</td></tr> | |
4395 | <tr><th>format</th> | |
4396 | <td class="description">Printf-style format string</td></tr> | |
4397 | <tr><th>...</th> | |
4398 | <td class="description">Additional arguments as needed</td></tr> | |
4399 | </tbody></table> | |
798d6e29 MS |
4400 | <h4 class="returnvalue">Return Value</h4> |
4401 | <p class="description">New attribute</p> | |
4402 | <h4 class="discussion">Discussion</h4> | |
4403 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4404 | 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> | |
4405 | <br> | |
4406 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4407 | (<code>IPP_TAG_ZERO</code>, for member attributes), document | |
4408 | (<code>IPP_TAG_DOCUMENT</code>), event notification | |
4409 | (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), | |
4410 | printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), | |
4411 | or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> | |
4412 | <br> | |
4413 | Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword | |
4414 | (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType | |
4415 | (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage | |
4416 | (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage | |
4417 | (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme | |
4418 | (<code>IPP_TAG_URISCHEME</code>).<br> | |
4419 | <br> | |
4420 | The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage | |
4421 | and textWithLanguage string values and must be <code>NULL</code> for all other | |
4422 | string values.<br> | |
4423 | <br> | |
4424 | The <code>format</code> parameter uses formatting characters compatible with the | |
4425 | printf family of standard functions. Additional arguments follow it as | |
4426 | needed. The formatted string is truncated as needed to the maximum length of | |
4427 | the corresponding value type. | |
4428 | ||
4429 | </p> | |
4430 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippAddStringfv">ippAddStringfv</a></h3> | |
4431 | <p class="description">Add a formatted string to an IPP message.</p> | |
4432 | <p class="code"> | |
98d88c8d MS |
4433 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStringfv(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, const char *language, const char *format, va_list ap);</p> |
4434 | <h4 class="parameters">Parameters</h4> | |
4435 | <table class="list"><tbody> | |
4436 | <tr><th>ipp</th> | |
4437 | <td class="description">IPP message</td></tr> | |
4438 | <tr><th>group</th> | |
4439 | <td class="description">IPP group</td></tr> | |
4440 | <tr><th>value_tag</th> | |
4441 | <td class="description">Type of attribute</td></tr> | |
4442 | <tr><th>name</th> | |
4443 | <td class="description">Name of attribute</td></tr> | |
4444 | <tr><th>language</th> | |
4445 | <td class="description">Language code (<code>NULL</code> for default)</td></tr> | |
4446 | <tr><th>format</th> | |
4447 | <td class="description">Printf-style format string</td></tr> | |
4448 | <tr><th>ap</th> | |
4449 | <td class="description">Additional arguments</td></tr> | |
4450 | </tbody></table> | |
798d6e29 MS |
4451 | <h4 class="returnvalue">Return Value</h4> |
4452 | <p class="description">New attribute</p> | |
4453 | <h4 class="discussion">Discussion</h4> | |
4454 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4455 | 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> | |
4456 | <br> | |
4457 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4458 | (<code>IPP_TAG_ZERO</code>, for member attributes), document | |
4459 | (<code>IPP_TAG_DOCUMENT</code>), event notification | |
4460 | (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation (<code>IPP_TAG_OPERATION</code>), | |
4461 | printer (<code>IPP_TAG_PRINTER</code>), subscription (<code>IPP_TAG_SUBSCRIPTION</code>), | |
4462 | or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> | |
4463 | <br> | |
4464 | Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword | |
4465 | (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType | |
4466 | (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage | |
4467 | (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage | |
4468 | (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme | |
4469 | (<code>IPP_TAG_URISCHEME</code>).<br> | |
4470 | <br> | |
4471 | The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage | |
4472 | and textWithLanguage string values and must be <code>NULL</code> for all other | |
4473 | string values.<br> | |
4474 | <br> | |
4475 | The <code>format</code> parameter uses formatting characters compatible with the | |
4476 | printf family of standard functions. Additional arguments are passed in the | |
4477 | stdarg pointer <code>ap</code>. The formatted string is truncated as needed to the | |
4478 | maximum length of the corresponding value type. | |
4479 | ||
4480 | </p> | |
4481 | <h3 class="function"><a id="ippAddStrings">ippAddStrings</a></h3> | |
4482 | <p class="description">Add language-encoded strings to an IPP message.</p> | |
4483 | <p class="code"> | |
98d88c8d MS |
4484 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippAddStrings(<a href="#ipp_t">ipp_t</a> *ipp, ipp_tag_t group, ipp_tag_t value_tag, const char *name, int num_values, const char *language, const char *const *values);</p> |
4485 | <h4 class="parameters">Parameters</h4> | |
4486 | <table class="list"><tbody> | |
4487 | <tr><th>ipp</th> | |
4488 | <td class="description">IPP message</td></tr> | |
4489 | <tr><th>group</th> | |
4490 | <td class="description">IPP group</td></tr> | |
4491 | <tr><th>value_tag</th> | |
4492 | <td class="description">Type of attribute</td></tr> | |
4493 | <tr><th>name</th> | |
4494 | <td class="description">Name of attribute</td></tr> | |
4495 | <tr><th>num_values</th> | |
4496 | <td class="description">Number of values</td></tr> | |
4497 | <tr><th>language</th> | |
4498 | <td class="description">Language code (<code>NULL</code> for default)</td></tr> | |
4499 | <tr><th>values</th> | |
4500 | <td class="description">Values</td></tr> | |
4501 | </tbody></table> | |
798d6e29 MS |
4502 | <h4 class="returnvalue">Return Value</h4> |
4503 | <p class="description">New attribute</p> | |
4504 | <h4 class="discussion">Discussion</h4> | |
4505 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
4506 | 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> | |
4507 | <br> | |
4508 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
4509 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
4510 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
4511 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
4512 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>).<br> | |
4513 | <br> | |
4514 | Supported string values include charset (<code>IPP_TAG_CHARSET</code>), keyword | |
4515 | (<code>IPP_TAG_KEYWORD</code>), language (<code>IPP_TAG_LANGUAGE</code>), mimeMediaType | |
4516 | (<code>IPP_TAG_MIMETYPE</code>), name (<code>IPP_TAG_NAME</code>), nameWithLanguage | |
4517 | (<code>IPP_TAG_NAMELANG), text (</code>code IPP_TAG_TEXT@), textWithLanguage | |
4518 | (<code>IPP_TAG_TEXTLANG</code>), uri (<code>IPP_TAG_URI</code>), and uriScheme | |
4519 | (<code>IPP_TAG_URISCHEME</code>).<br> | |
4520 | <br> | |
4521 | The <code>language</code> parameter must be non-<code>NULL</code> for nameWithLanguage and | |
4522 | textWithLanguage string values and must be <code>NULL</code> for all other string values.</p> | |
4523 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippAttributeString">ippAttributeString</a></h3> | |
4524 | <p class="description">Convert the attribute's value to a string.</p> | |
4525 | <p class="code"> | |
98d88c8d MS |
4526 | size_t ippAttributeString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, char *buffer, size_t bufsize);</p> |
4527 | <h4 class="parameters">Parameters</h4> | |
4528 | <table class="list"><tbody> | |
4529 | <tr><th>attr</th> | |
4530 | <td class="description">Attribute</td></tr> | |
4531 | <tr><th>buffer</th> | |
4532 | <td class="description">String buffer or NULL</td></tr> | |
4533 | <tr><th>bufsize</th> | |
4534 | <td class="description">Size of string buffer</td></tr> | |
4535 | </tbody></table> | |
798d6e29 MS |
4536 | <h4 class="returnvalue">Return Value</h4> |
4537 | <p class="description">Number of bytes less nul</p> | |
4538 | <h4 class="discussion">Discussion</h4> | |
4539 | <p class="discussion">Returns the number of bytes that would be written, not including the | |
4540 | trailing nul. The buffer pointer can be NULL to get the required length, | |
4541 | just like (v)snprintf. | |
4542 | ||
4543 | </p> | |
4544 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippContainsInteger">ippContainsInteger</a></h3> | |
4545 | <p class="description">Determine whether an attribute contains the | |
4546 | specified value or is within the list of ranges.</p> | |
4547 | <p class="code"> | |
98d88c8d | 4548 | int ippContainsInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int value);</p> |
798d6e29 | 4549 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4550 | <table class="list"><tbody> |
4551 | <tr><th>attr</th> | |
4552 | <td class="description">Attribute</td></tr> | |
4553 | <tr><th>value</th> | |
4554 | <td class="description">Integer/enum value</td></tr> | |
4555 | </tbody></table> | |
798d6e29 MS |
4556 | <h4 class="returnvalue">Return Value</h4> |
4557 | <p class="description">1 on a match, 0 on no match</p> | |
4558 | <h4 class="discussion">Discussion</h4> | |
4559 | <p class="discussion">Returns non-zero when the attribute contains either a matching integer or | |
4560 | enum value, or the value falls within one of the rangeOfInteger values for | |
4561 | the attribute. | |
4562 | ||
4563 | </p> | |
4564 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippContainsString">ippContainsString</a></h3> | |
4565 | <p class="description">Determine whether an attribute contains the | |
4566 | specified string value.</p> | |
4567 | <p class="code"> | |
98d88c8d | 4568 | int ippContainsString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, const char *value);</p> |
798d6e29 | 4569 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4570 | <table class="list"><tbody> |
4571 | <tr><th>attr</th> | |
4572 | <td class="description">Attribute</td></tr> | |
4573 | <tr><th>value</th> | |
4574 | <td class="description">String value</td></tr> | |
4575 | </tbody></table> | |
798d6e29 MS |
4576 | <h4 class="returnvalue">Return Value</h4> |
4577 | <p class="description">1 on a match, 0 on no match</p> | |
4578 | <h4 class="discussion">Discussion</h4> | |
4579 | <p class="discussion">Returns non-zero when the attribute contains a matching charset, keyword, | |
65bebeac | 4580 | naturalLanguage, mimeMediaType, name, text, uri, or uriScheme value. |
798d6e29 MS |
4581 | |
4582 | </p> | |
4583 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippCopyAttribute">ippCopyAttribute</a></h3> | |
4584 | <p class="description">Copy an attribute.</p> | |
4585 | <p class="code"> | |
98d88c8d MS |
4586 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippCopyAttribute(<a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_attribute_t">ipp_attribute_t</a> *srcattr, int quickcopy);</p> |
4587 | <h4 class="parameters">Parameters</h4> | |
4588 | <table class="list"><tbody> | |
4589 | <tr><th>dst</th> | |
4590 | <td class="description">Destination IPP message</td></tr> | |
4591 | <tr><th>srcattr</th> | |
4592 | <td class="description">Attribute to copy</td></tr> | |
4593 | <tr><th>quickcopy</th> | |
4594 | <td class="description">1 for a referenced copy, 0 for normal</td></tr> | |
4595 | </tbody></table> | |
798d6e29 MS |
4596 | <h4 class="returnvalue">Return Value</h4> |
4597 | <p class="description">New attribute</p> | |
4598 | <h4 class="discussion">Discussion</h4> | |
4599 | <p class="discussion">The specified attribute, <code>attr</code>, is copied to the destination IPP message. | |
4600 | When <code>quickcopy</code> is non-zero, a "shallow" reference copy of the attribute is | |
4601 | created - this should only be done as long as the original source IPP message will | |
4602 | not be freed for the life of the destination. | |
4603 | ||
4604 | </p> | |
4605 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippCopyAttributes">ippCopyAttributes</a></h3> | |
4606 | <p class="description">Copy attributes from one IPP message to another.</p> | |
4607 | <p class="code"> | |
98d88c8d MS |
4608 | int ippCopyAttributes(<a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_t">ipp_t</a> *src, int quickcopy, <a href="#ipp_copycb_t">ipp_copycb_t</a> cb, void *context);</p> |
4609 | <h4 class="parameters">Parameters</h4> | |
4610 | <table class="list"><tbody> | |
4611 | <tr><th>dst</th> | |
4612 | <td class="description">Destination IPP message</td></tr> | |
4613 | <tr><th>src</th> | |
4614 | <td class="description">Source IPP message</td></tr> | |
4615 | <tr><th>quickcopy</th> | |
4616 | <td class="description">1 for a referenced copy, 0 for normal</td></tr> | |
4617 | <tr><th>cb</th> | |
4618 | <td class="description">Copy callback or <code>NULL</code> for none</td></tr> | |
4619 | <tr><th>context</th> | |
4620 | <td class="description">Context pointer</td></tr> | |
4621 | </tbody></table> | |
798d6e29 MS |
4622 | <h4 class="returnvalue">Return Value</h4> |
4623 | <p class="description">1 on success, 0 on error</p> | |
4624 | <h4 class="discussion">Discussion</h4> | |
4625 | <p class="discussion">Zero or more attributes are copied from the source IPP message, <code>src</code>, to the | |
4626 | destination IPP message, <code>dst</code>. When <code>quickcopy</code> is non-zero, a "shallow" | |
4627 | reference copy of the attribute is created - this should only be done as long as the | |
4628 | original source IPP message will not be freed for the life of the destination.<br> | |
4629 | <br> | |
4630 | The <code>cb</code> and <code>context</code> parameters provide a generic way to "filter" the | |
4631 | attributes that are copied - the function must return 1 to copy the attribute or | |
4632 | 0 to skip it. The function may also choose to do a partial copy of the source attribute | |
4633 | itself. | |
4634 | ||
4635 | </p> | |
4636 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippCreateRequestedArray">ippCreateRequestedArray</a></h3> | |
4637 | <p class="description">Create a CUPS array of attribute names from the | |
4638 | given requested-attributes attribute.</p> | |
4639 | <p class="code"> | |
98d88c8d | 4640 | cups_array_t *ippCreateRequestedArray(<a href="#ipp_t">ipp_t</a> *request);</p> |
798d6e29 | 4641 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4642 | <table class="list"><tbody> |
4643 | <tr><th>request</th> | |
4644 | <td class="description">IPP request</td></tr> | |
4645 | </tbody></table> | |
798d6e29 MS |
4646 | <h4 class="returnvalue">Return Value</h4> |
4647 | <p class="description">CUPS array or <code>NULL</code> if all</p> | |
4648 | <h4 class="discussion">Discussion</h4> | |
4649 | <p class="discussion">This function creates a (sorted) CUPS array of attribute names matching the | |
4650 | list of "requested-attribute" values supplied in an IPP request. All IANA- | |
4651 | registered values are supported in addition to the CUPS IPP extension | |
4652 | attributes.<br> | |
4653 | <br> | |
4654 | The <code>request</code> parameter specifies the request message that was read from | |
4655 | the client. | |
4656 | ||
4657 | <code>NULL</code> is returned if all attributes should be returned. Otherwise, the | |
4658 | result is a sorted array of attribute names, where <code>cupsArrayFind(array, | |
4659 | "attribute-name")</code> will return a non-NULL pointer. The array must be freed | |
4660 | using the <code>cupsArrayDelete</code> function. | |
4661 | ||
4662 | </p> | |
4663 | <h3 class="function"><a id="ippDateToTime">ippDateToTime</a></h3> | |
65bebeac MS |
4664 | <p class="description">Convert from RFC 2579 Date/Time format to time in |
4665 | seconds.</p> | |
798d6e29 | 4666 | <p class="code"> |
98d88c8d | 4667 | time_t ippDateToTime(const <a href="#ipp_uchar_t">ipp_uchar_t</a> *date);</p> |
798d6e29 | 4668 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4669 | <table class="list"><tbody> |
4670 | <tr><th>date</th> | |
65bebeac | 4671 | <td class="description">RFC 2579 date info</td></tr> |
98d88c8d | 4672 | </tbody></table> |
798d6e29 MS |
4673 | <h4 class="returnvalue">Return Value</h4> |
4674 | <p class="description">UNIX time value</p> | |
4675 | <h3 class="function"><a id="ippDelete">ippDelete</a></h3> | |
98d88c8d | 4676 | <p class="description">Delete an IPP message.</p> |
798d6e29 | 4677 | <p class="code"> |
98d88c8d | 4678 | void ippDelete(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 4679 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4680 | <table class="list"><tbody> |
4681 | <tr><th>ipp</th> | |
4682 | <td class="description">IPP message</td></tr> | |
4683 | </tbody></table> | |
4684 | <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippDeleteAttribute">ippDeleteAttribute</a></h3> | |
53af7f21 | 4685 | <p class="description">Delete a single attribute in an IPP message.</p> |
98d88c8d MS |
4686 | <p class="code"> |
4687 | void ippDeleteAttribute(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> | |
4688 | <h4 class="parameters">Parameters</h4> | |
4689 | <table class="list"><tbody> | |
4690 | <tr><th>ipp</th> | |
4691 | <td class="description">IPP message</td></tr> | |
4692 | <tr><th>attr</th> | |
4693 | <td class="description">Attribute to delete</td></tr> | |
4694 | </tbody></table> | |
798d6e29 MS |
4695 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippDeleteValues">ippDeleteValues</a></h3> |
4696 | <p class="description">Delete values in an attribute.</p> | |
4697 | <p class="code"> | |
98d88c8d MS |
4698 | int ippDeleteValues(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int count);</p> |
4699 | <h4 class="parameters">Parameters</h4> | |
4700 | <table class="list"><tbody> | |
4701 | <tr><th>ipp</th> | |
4702 | <td class="description">IPP message</td></tr> | |
4703 | <tr><th>attr</th> | |
4704 | <td class="description">Attribute</td></tr> | |
4705 | <tr><th>element</th> | |
4706 | <td class="description">Index of first value to delete (0-based)</td></tr> | |
4707 | <tr><th>count</th> | |
4708 | <td class="description">Number of values to delete</td></tr> | |
4709 | </tbody></table> | |
798d6e29 MS |
4710 | <h4 class="returnvalue">Return Value</h4> |
4711 | <p class="description">1 on success, 0 on failure</p> | |
4712 | <h4 class="discussion">Discussion</h4> | |
4713 | <p class="discussion">The <code>element</code> parameter specifies the first value to delete, starting at | |
4714 | 0. It must be less than the number of values returned by <a href="#ippGetCount"><code>ippGetCount</code></a>.<br> | |
4715 | <br> | |
4716 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
4717 | <br> | |
4718 | Deleting all values in an attribute deletes the attribute. | |
4719 | ||
4720 | </p> | |
4721 | <h3 class="function"><a id="ippEnumString">ippEnumString</a></h3> | |
4722 | <p class="description">Return a string corresponding to the enum value.</p> | |
4723 | <p class="code"> | |
98d88c8d | 4724 | const char *ippEnumString(const char *attrname, int enumvalue);</p> |
798d6e29 | 4725 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4726 | <table class="list"><tbody> |
4727 | <tr><th>attrname</th> | |
4728 | <td class="description">Attribute name</td></tr> | |
4729 | <tr><th>enumvalue</th> | |
4730 | <td class="description">Enum value</td></tr> | |
4731 | </tbody></table> | |
798d6e29 MS |
4732 | <h4 class="returnvalue">Return Value</h4> |
4733 | <p class="description">Enum string</p> | |
4734 | <h3 class="function"><a id="ippEnumValue">ippEnumValue</a></h3> | |
4735 | <p class="description">Return the value associated with a given enum string.</p> | |
4736 | <p class="code"> | |
98d88c8d | 4737 | int ippEnumValue(const char *attrname, const char *enumstring);</p> |
798d6e29 | 4738 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4739 | <table class="list"><tbody> |
4740 | <tr><th>attrname</th> | |
4741 | <td class="description">Attribute name</td></tr> | |
4742 | <tr><th>enumstring</th> | |
4743 | <td class="description">Enum string</td></tr> | |
4744 | </tbody></table> | |
798d6e29 MS |
4745 | <h4 class="returnvalue">Return Value</h4> |
4746 | <p class="description">Enum value or -1 if unknown</p> | |
4747 | <h3 class="function"><a id="ippErrorString">ippErrorString</a></h3> | |
4748 | <p class="description">Return a name for the given status code.</p> | |
4749 | <p class="code"> | |
98d88c8d | 4750 | const char *ippErrorString(ipp_status_t error);</p> |
798d6e29 | 4751 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4752 | <table class="list"><tbody> |
4753 | <tr><th>error</th> | |
4754 | <td class="description">Error status</td></tr> | |
4755 | </tbody></table> | |
798d6e29 MS |
4756 | <h4 class="returnvalue">Return Value</h4> |
4757 | <p class="description">Text string</p> | |
4758 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippErrorValue">ippErrorValue</a></h3> | |
4759 | <p class="description">Return a status code for the given name.</p> | |
4760 | <p class="code"> | |
98d88c8d | 4761 | ipp_status_t ippErrorValue(const char *name);</p> |
798d6e29 | 4762 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4763 | <table class="list"><tbody> |
4764 | <tr><th>name</th> | |
4765 | <td class="description">Name</td></tr> | |
4766 | </tbody></table> | |
798d6e29 MS |
4767 | <h4 class="returnvalue">Return Value</h4> |
4768 | <p class="description">IPP status code</p> | |
4769 | <h3 class="function"><a id="ippFindAttribute">ippFindAttribute</a></h3> | |
4770 | <p class="description">Find a named attribute in a request.</p> | |
4771 | <p class="code"> | |
98d88c8d MS |
4772 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindAttribute(<a href="#ipp_t">ipp_t</a> *ipp, const char *name, ipp_tag_t type);</p> |
4773 | <h4 class="parameters">Parameters</h4> | |
4774 | <table class="list"><tbody> | |
4775 | <tr><th>ipp</th> | |
4776 | <td class="description">IPP message</td></tr> | |
4777 | <tr><th>name</th> | |
4778 | <td class="description">Name of attribute</td></tr> | |
4779 | <tr><th>type</th> | |
4780 | <td class="description">Type of attribute</td></tr> | |
4781 | </tbody></table> | |
798d6e29 MS |
4782 | <h4 class="returnvalue">Return Value</h4> |
4783 | <p class="description">Matching attribute</p> | |
4784 | <h4 class="discussion">Discussion</h4> | |
4785 | <p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list | |
4786 | of attribute and member names separated by slashes, for example | |
4787 | "media-col/media-size".</p> | |
4788 | <h3 class="function"><a id="ippFindNextAttribute">ippFindNextAttribute</a></h3> | |
4789 | <p class="description">Find the next named attribute in a request.</p> | |
4790 | <p class="code"> | |
98d88c8d MS |
4791 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFindNextAttribute(<a href="#ipp_t">ipp_t</a> *ipp, const char *name, ipp_tag_t type);</p> |
4792 | <h4 class="parameters">Parameters</h4> | |
4793 | <table class="list"><tbody> | |
4794 | <tr><th>ipp</th> | |
4795 | <td class="description">IPP message</td></tr> | |
4796 | <tr><th>name</th> | |
4797 | <td class="description">Name of attribute</td></tr> | |
4798 | <tr><th>type</th> | |
4799 | <td class="description">Type of attribute</td></tr> | |
4800 | </tbody></table> | |
798d6e29 MS |
4801 | <h4 class="returnvalue">Return Value</h4> |
4802 | <p class="description">Matching attribute</p> | |
4803 | <h4 class="discussion">Discussion</h4> | |
4804 | <p class="discussion">Starting with CUPS 2.0, the attribute name can contain a hierarchical list | |
4805 | of attribute and member names separated by slashes, for example | |
4806 | "media-col/media-size".</p> | |
4807 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippFirstAttribute">ippFirstAttribute</a></h3> | |
4808 | <p class="description">Return the first attribute in the message.</p> | |
4809 | <p class="code"> | |
98d88c8d | 4810 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippFirstAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 4811 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4812 | <table class="list"><tbody> |
4813 | <tr><th>ipp</th> | |
4814 | <td class="description">IPP message</td></tr> | |
4815 | </tbody></table> | |
798d6e29 MS |
4816 | <h4 class="returnvalue">Return Value</h4> |
4817 | <p class="description">First attribute or <code>NULL</code> if none</p> | |
4818 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetBoolean">ippGetBoolean</a></h3> | |
4819 | <p class="description">Get a boolean value for an attribute.</p> | |
4820 | <p class="code"> | |
98d88c8d | 4821 | int ippGetBoolean(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> |
798d6e29 | 4822 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4823 | <table class="list"><tbody> |
4824 | <tr><th>attr</th> | |
4825 | <td class="description">IPP attribute</td></tr> | |
4826 | <tr><th>element</th> | |
4827 | <td class="description">Value number (0-based)</td></tr> | |
4828 | </tbody></table> | |
798d6e29 MS |
4829 | <h4 class="returnvalue">Return Value</h4> |
4830 | <p class="description">Boolean value or 0 on error</p> | |
4831 | <h4 class="discussion">Discussion</h4> | |
4832 | <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to | |
65bebeac | 4833 | <code>ippGetCount(attr)</code> - 1. |
798d6e29 MS |
4834 | |
4835 | </p> | |
4836 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetCollection">ippGetCollection</a></h3> | |
4837 | <p class="description">Get a collection value for an attribute.</p> | |
4838 | <p class="code"> | |
98d88c8d | 4839 | <a href="#ipp_t">ipp_t</a> *ippGetCollection(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> |
798d6e29 | 4840 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4841 | <table class="list"><tbody> |
4842 | <tr><th>attr</th> | |
4843 | <td class="description">IPP attribute</td></tr> | |
4844 | <tr><th>element</th> | |
4845 | <td class="description">Value number (0-based)</td></tr> | |
4846 | </tbody></table> | |
798d6e29 MS |
4847 | <h4 class="returnvalue">Return Value</h4> |
4848 | <p class="description">Collection value or <code>NULL</code> on error</p> | |
4849 | <h4 class="discussion">Discussion</h4> | |
4850 | <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to | |
65bebeac | 4851 | <code>ippGetCount(attr)</code> - 1. |
798d6e29 MS |
4852 | |
4853 | </p> | |
4854 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetCount">ippGetCount</a></h3> | |
4855 | <p class="description">Get the number of values in an attribute.</p> | |
4856 | <p class="code"> | |
98d88c8d | 4857 | int ippGetCount(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
798d6e29 | 4858 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4859 | <table class="list"><tbody> |
4860 | <tr><th>attr</th> | |
4861 | <td class="description">IPP attribute</td></tr> | |
4862 | </tbody></table> | |
798d6e29 MS |
4863 | <h4 class="returnvalue">Return Value</h4> |
4864 | <p class="description">Number of values or 0 on error</p> | |
4865 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetDate">ippGetDate</a></h3> | |
65bebeac | 4866 | <p class="description">Get a dateTime value for an attribute.</p> |
798d6e29 | 4867 | <p class="code"> |
98d88c8d | 4868 | const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippGetDate(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> |
798d6e29 | 4869 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4870 | <table class="list"><tbody> |
4871 | <tr><th>attr</th> | |
4872 | <td class="description">IPP attribute</td></tr> | |
4873 | <tr><th>element</th> | |
4874 | <td class="description">Value number (0-based)</td></tr> | |
4875 | </tbody></table> | |
798d6e29 | 4876 | <h4 class="returnvalue">Return Value</h4> |
65bebeac | 4877 | <p class="description">dateTime value or <code>NULL</code></p> |
798d6e29 MS |
4878 | <h4 class="discussion">Discussion</h4> |
4879 | <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to | |
65bebeac | 4880 | <code>ippGetCount(attr)</code> - 1. |
798d6e29 MS |
4881 | |
4882 | </p> | |
4883 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetGroupTag">ippGetGroupTag</a></h3> | |
4884 | <p class="description">Get the group associated with an attribute.</p> | |
4885 | <p class="code"> | |
98d88c8d | 4886 | ipp_tag_t ippGetGroupTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
798d6e29 | 4887 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4888 | <table class="list"><tbody> |
4889 | <tr><th>attr</th> | |
4890 | <td class="description">IPP attribute</td></tr> | |
4891 | </tbody></table> | |
798d6e29 MS |
4892 | <h4 class="returnvalue">Return Value</h4> |
4893 | <p class="description">Group tag or <code>IPP_TAG_ZERO</code> on error</p> | |
4894 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetInteger">ippGetInteger</a></h3> | |
4895 | <p class="description">Get the integer/enum value for an attribute.</p> | |
4896 | <p class="code"> | |
98d88c8d | 4897 | int ippGetInteger(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element);</p> |
798d6e29 | 4898 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4899 | <table class="list"><tbody> |
4900 | <tr><th>attr</th> | |
4901 | <td class="description">IPP attribute</td></tr> | |
4902 | <tr><th>element</th> | |
4903 | <td class="description">Value number (0-based)</td></tr> | |
4904 | </tbody></table> | |
798d6e29 MS |
4905 | <h4 class="returnvalue">Return Value</h4> |
4906 | <p class="description">Value or 0 on error</p> | |
4907 | <h4 class="discussion">Discussion</h4> | |
4908 | <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to | |
65bebeac | 4909 | <code>ippGetCount(attr)</code> - 1. |
798d6e29 MS |
4910 | |
4911 | </p> | |
4912 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetName">ippGetName</a></h3> | |
4913 | <p class="description">Get the attribute name.</p> | |
4914 | <p class="code"> | |
98d88c8d | 4915 | const char *ippGetName(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
798d6e29 | 4916 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4917 | <table class="list"><tbody> |
4918 | <tr><th>attr</th> | |
4919 | <td class="description">IPP attribute</td></tr> | |
4920 | </tbody></table> | |
798d6e29 MS |
4921 | <h4 class="returnvalue">Return Value</h4> |
4922 | <p class="description">Attribute name or <code>NULL</code> for separators</p> | |
4923 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippGetOctetString">ippGetOctetString</a></h3> | |
4924 | <p class="description">Get an octetString value from an IPP attribute.</p> | |
4925 | <p class="code"> | |
98d88c8d MS |
4926 | void *ippGetOctetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *datalen);</p> |
4927 | <h4 class="parameters">Parameters</h4> | |
4928 | <table class="list"><tbody> | |
4929 | <tr><th>attr</th> | |
4930 | <td class="description">IPP attribute</td></tr> | |
4931 | <tr><th>element</th> | |
4932 | <td class="description">Value number (0-based)</td></tr> | |
4933 | <tr><th>datalen</th> | |
4934 | <td class="description">Length of octetString data</td></tr> | |
4935 | </tbody></table> | |
798d6e29 MS |
4936 | <h4 class="returnvalue">Return Value</h4> |
4937 | <p class="description">Pointer to octetString data</p> | |
4938 | <h4 class="discussion">Discussion</h4> | |
4939 | <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to | |
65bebeac | 4940 | <code>ippGetCount(attr)</code> - 1. |
798d6e29 MS |
4941 | |
4942 | </p> | |
4943 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetOperation">ippGetOperation</a></h3> | |
4944 | <p class="description">Get the operation ID in an IPP message.</p> | |
4945 | <p class="code"> | |
98d88c8d | 4946 | ipp_op_t ippGetOperation(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 4947 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4948 | <table class="list"><tbody> |
4949 | <tr><th>ipp</th> | |
4950 | <td class="description">IPP request message</td></tr> | |
4951 | </tbody></table> | |
798d6e29 MS |
4952 | <h4 class="returnvalue">Return Value</h4> |
4953 | <p class="description">Operation ID or 0 on error</p> | |
4954 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetRange">ippGetRange</a></h3> | |
4955 | <p class="description">Get a rangeOfInteger value from an attribute.</p> | |
4956 | <p class="code"> | |
98d88c8d MS |
4957 | int ippGetRange(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *uppervalue);</p> |
4958 | <h4 class="parameters">Parameters</h4> | |
4959 | <table class="list"><tbody> | |
4960 | <tr><th>attr</th> | |
4961 | <td class="description">IPP attribute</td></tr> | |
4962 | <tr><th>element</th> | |
4963 | <td class="description">Value number (0-based)</td></tr> | |
4964 | <tr><th>uppervalue</th> | |
4965 | <td class="description">Upper value of range</td></tr> | |
4966 | </tbody></table> | |
798d6e29 MS |
4967 | <h4 class="returnvalue">Return Value</h4> |
4968 | <p class="description">Lower value of range or 0</p> | |
4969 | <h4 class="discussion">Discussion</h4> | |
4970 | <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to | |
65bebeac | 4971 | <code>ippGetCount(attr)</code> - 1. |
798d6e29 MS |
4972 | |
4973 | </p> | |
4974 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetRequestId">ippGetRequestId</a></h3> | |
4975 | <p class="description">Get the request ID from an IPP message.</p> | |
4976 | <p class="code"> | |
98d88c8d | 4977 | int ippGetRequestId(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 4978 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
4979 | <table class="list"><tbody> |
4980 | <tr><th>ipp</th> | |
4981 | <td class="description">IPP message</td></tr> | |
4982 | </tbody></table> | |
798d6e29 MS |
4983 | <h4 class="returnvalue">Return Value</h4> |
4984 | <p class="description">Request ID or 0 on error</p> | |
4985 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetResolution">ippGetResolution</a></h3> | |
4986 | <p class="description">Get a resolution value for an attribute.</p> | |
4987 | <p class="code"> | |
98d88c8d MS |
4988 | int ippGetResolution(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, int *yres, <a href="#ipp_res_t">ipp_res_t</a> *units);</p> |
4989 | <h4 class="parameters">Parameters</h4> | |
4990 | <table class="list"><tbody> | |
4991 | <tr><th>attr</th> | |
4992 | <td class="description">IPP attribute</td></tr> | |
4993 | <tr><th>element</th> | |
4994 | <td class="description">Value number (0-based)</td></tr> | |
4995 | <tr><th>yres</th> | |
4996 | <td class="description">Vertical/feed resolution</td></tr> | |
4997 | <tr><th>units</th> | |
4998 | <td class="description">Units for resolution</td></tr> | |
4999 | </tbody></table> | |
798d6e29 MS |
5000 | <h4 class="returnvalue">Return Value</h4> |
5001 | <p class="description">Horizontal/cross feed resolution or 0</p> | |
5002 | <h4 class="discussion">Discussion</h4> | |
5003 | <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to | |
65bebeac | 5004 | <code>ippGetCount(attr)</code> - 1. |
798d6e29 MS |
5005 | |
5006 | </p> | |
5007 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetState">ippGetState</a></h3> | |
5008 | <p class="description">Get the IPP message state.</p> | |
5009 | <p class="code"> | |
98d88c8d | 5010 | <a href="#ipp_state_t">ipp_state_t</a> ippGetState(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 5011 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5012 | <table class="list"><tbody> |
5013 | <tr><th>ipp</th> | |
5014 | <td class="description">IPP message</td></tr> | |
5015 | </tbody></table> | |
798d6e29 MS |
5016 | <h4 class="returnvalue">Return Value</h4> |
5017 | <p class="description">IPP message state value</p> | |
5018 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetStatusCode">ippGetStatusCode</a></h3> | |
5019 | <p class="description">Get the status code from an IPP response or event message.</p> | |
5020 | <p class="code"> | |
98d88c8d | 5021 | ipp_status_t ippGetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 5022 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5023 | <table class="list"><tbody> |
5024 | <tr><th>ipp</th> | |
5025 | <td class="description">IPP response or event message</td></tr> | |
5026 | </tbody></table> | |
798d6e29 MS |
5027 | <h4 class="returnvalue">Return Value</h4> |
5028 | <p class="description">Status code in IPP message</p> | |
5029 | <h3 class="function"><a id="ippGetString">ippGetString</a></h3> | |
98d88c8d MS |
5030 | <p class="description"></p> |
5031 | <p class="code"> | |
5032 | const char *ippGetString(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr, int element, const char **language);</p> | |
5033 | <h4 class="parameters">Parameters</h4> | |
5034 | <table class="list"><tbody> | |
5035 | <tr><th>attr</th> | |
5036 | <td class="description">IPP attribute</td></tr> | |
5037 | <tr><th>element</th> | |
5038 | <td class="description">Value number (0-based)</td></tr> | |
5039 | <tr><th>language</th> | |
5040 | <td class="description">Language code (<code>NULL</code> for don't care)</td></tr> | |
5041 | </tbody></table> | |
798d6e29 MS |
5042 | <h4 class="returnvalue">Return Value</h4> |
5043 | <p class="description">Get the string and optionally the language code for an attribute.</p> | |
5044 | <p class="discussion">The <code>element</code> parameter specifies which value to get from 0 to | |
65bebeac | 5045 | <code>ippGetCount(attr)</code> - 1. |
798d6e29 MS |
5046 | |
5047 | </p> | |
5048 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetValueTag">ippGetValueTag</a></h3> | |
5049 | <p class="description">Get the value tag for an attribute.</p> | |
5050 | <p class="code"> | |
98d88c8d | 5051 | ipp_tag_t ippGetValueTag(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
798d6e29 | 5052 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5053 | <table class="list"><tbody> |
5054 | <tr><th>attr</th> | |
5055 | <td class="description">IPP attribute</td></tr> | |
5056 | </tbody></table> | |
798d6e29 MS |
5057 | <h4 class="returnvalue">Return Value</h4> |
5058 | <p class="description">Value tag or <code>IPP_TAG_ZERO</code> on error</p> | |
5059 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippGetVersion">ippGetVersion</a></h3> | |
5060 | <p class="description">Get the major and minor version number from an IPP message.</p> | |
5061 | <p class="code"> | |
98d88c8d | 5062 | int ippGetVersion(<a href="#ipp_t">ipp_t</a> *ipp, int *minor);</p> |
798d6e29 | 5063 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5064 | <table class="list"><tbody> |
5065 | <tr><th>ipp</th> | |
5066 | <td class="description">IPP message</td></tr> | |
5067 | <tr><th>minor</th> | |
65bebeac | 5068 | <td class="description">Minor version number or <code>NULL</code> for don't care</td></tr> |
98d88c8d | 5069 | </tbody></table> |
798d6e29 MS |
5070 | <h4 class="returnvalue">Return Value</h4> |
5071 | <p class="description">Major version number or 0 on error</p> | |
5072 | <h3 class="function"><a id="ippLength">ippLength</a></h3> | |
5073 | <p class="description">Compute the length of an IPP message.</p> | |
5074 | <p class="code"> | |
98d88c8d | 5075 | size_t ippLength(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 5076 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5077 | <table class="list"><tbody> |
5078 | <tr><th>ipp</th> | |
5079 | <td class="description">IPP message</td></tr> | |
5080 | </tbody></table> | |
798d6e29 MS |
5081 | <h4 class="returnvalue">Return Value</h4> |
5082 | <p class="description">Size of IPP message</p> | |
5083 | <h3 class="function"><a id="ippNew">ippNew</a></h3> | |
5084 | <p class="description">Allocate a new IPP message.</p> | |
5085 | <p class="code"> | |
98d88c8d | 5086 | <a href="#ipp_t">ipp_t</a> *ippNew(void);</p> |
798d6e29 MS |
5087 | <h4 class="returnvalue">Return Value</h4> |
5088 | <p class="description">New IPP message</p> | |
5089 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippNewRequest">ippNewRequest</a></h3> | |
5090 | <p class="description">Allocate a new IPP request message.</p> | |
5091 | <p class="code"> | |
98d88c8d | 5092 | <a href="#ipp_t">ipp_t</a> *ippNewRequest(ipp_op_t op);</p> |
798d6e29 | 5093 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5094 | <table class="list"><tbody> |
5095 | <tr><th>op</th> | |
5096 | <td class="description">Operation code</td></tr> | |
5097 | </tbody></table> | |
798d6e29 MS |
5098 | <h4 class="returnvalue">Return Value</h4> |
5099 | <p class="description">IPP request message</p> | |
5100 | <h4 class="discussion">Discussion</h4> | |
65bebeac MS |
5101 | <p class="discussion">The new request message is initialized with the "attributes-charset" and |
5102 | "attributes-natural-language" attributes added. The | |
5103 | "attributes-natural-language" value is derived from the current locale. | |
798d6e29 MS |
5104 | |
5105 | </p> | |
5106 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippNewResponse">ippNewResponse</a></h3> | |
5107 | <p class="description">Allocate a new IPP response message.</p> | |
5108 | <p class="code"> | |
98d88c8d | 5109 | <a href="#ipp_t">ipp_t</a> *ippNewResponse(<a href="#ipp_t">ipp_t</a> *request);</p> |
798d6e29 | 5110 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5111 | <table class="list"><tbody> |
5112 | <tr><th>request</th> | |
5113 | <td class="description">IPP request message</td></tr> | |
5114 | </tbody></table> | |
798d6e29 MS |
5115 | <h4 class="returnvalue">Return Value</h4> |
5116 | <p class="description">IPP response message</p> | |
5117 | <h4 class="discussion">Discussion</h4> | |
65bebeac MS |
5118 | <p class="discussion">The new response message is initialized with the same "version-number", |
5119 | "request-id", "attributes-charset", and "attributes-natural-language" as the | |
5120 | provided request message. If the "attributes-charset" or | |
5121 | "attributes-natural-language" attributes are missing from the request, | |
5122 | 'utf-8' and a value derived from the current locale are substituted, | |
798d6e29 MS |
5123 | respectively. |
5124 | ||
5125 | </p> | |
5126 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippNextAttribute">ippNextAttribute</a></h3> | |
5127 | <p class="description">Return the next attribute in the message.</p> | |
5128 | <p class="code"> | |
98d88c8d | 5129 | <a href="#ipp_attribute_t">ipp_attribute_t</a> *ippNextAttribute(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 5130 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5131 | <table class="list"><tbody> |
5132 | <tr><th>ipp</th> | |
5133 | <td class="description">IPP message</td></tr> | |
5134 | </tbody></table> | |
798d6e29 MS |
5135 | <h4 class="returnvalue">Return Value</h4> |
5136 | <p class="description">Next attribute or <code>NULL</code> if none</p> | |
5137 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippOpString">ippOpString</a></h3> | |
5138 | <p class="description">Return a name for the given operation id.</p> | |
5139 | <p class="code"> | |
98d88c8d | 5140 | const char *ippOpString(ipp_op_t op);</p> |
798d6e29 | 5141 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5142 | <table class="list"><tbody> |
5143 | <tr><th>op</th> | |
5144 | <td class="description">Operation ID</td></tr> | |
5145 | </tbody></table> | |
798d6e29 MS |
5146 | <h4 class="returnvalue">Return Value</h4> |
5147 | <p class="description">Name</p> | |
5148 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippOpValue">ippOpValue</a></h3> | |
5149 | <p class="description">Return an operation id for the given name.</p> | |
5150 | <p class="code"> | |
98d88c8d | 5151 | ipp_op_t ippOpValue(const char *name);</p> |
798d6e29 | 5152 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5153 | <table class="list"><tbody> |
5154 | <tr><th>name</th> | |
5155 | <td class="description">Textual name</td></tr> | |
5156 | </tbody></table> | |
798d6e29 MS |
5157 | <h4 class="returnvalue">Return Value</h4> |
5158 | <p class="description">Operation ID</p> | |
5159 | <h3 class="function"><a id="ippPort">ippPort</a></h3> | |
5160 | <p class="description">Return the default IPP port number.</p> | |
5161 | <p class="code"> | |
98d88c8d | 5162 | int ippPort(void);</p> |
798d6e29 MS |
5163 | <h4 class="returnvalue">Return Value</h4> |
5164 | <p class="description">Port number</p> | |
5165 | <h3 class="function"><a id="ippRead">ippRead</a></h3> | |
5166 | <p class="description">Read data for an IPP message from a HTTP connection.</p> | |
5167 | <p class="code"> | |
98d88c8d | 5168 | <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> |
798d6e29 | 5169 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5170 | <table class="list"><tbody> |
5171 | <tr><th>http</th> | |
5172 | <td class="description">HTTP connection</td></tr> | |
5173 | <tr><th>ipp</th> | |
5174 | <td class="description">IPP data</td></tr> | |
5175 | </tbody></table> | |
798d6e29 MS |
5176 | <h4 class="returnvalue">Return Value</h4> |
5177 | <p class="description">Current state</p> | |
5178 | <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippReadFile">ippReadFile</a></h3> | |
5179 | <p class="description">Read data for an IPP message from a file.</p> | |
5180 | <p class="code"> | |
98d88c8d | 5181 | <a href="#ipp_state_t">ipp_state_t</a> ippReadFile(int fd, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 5182 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5183 | <table class="list"><tbody> |
5184 | <tr><th>fd</th> | |
5185 | <td class="description">HTTP data</td></tr> | |
5186 | <tr><th>ipp</th> | |
5187 | <td class="description">IPP data</td></tr> | |
5188 | </tbody></table> | |
798d6e29 MS |
5189 | <h4 class="returnvalue">Return Value</h4> |
5190 | <p class="description">Current state</p> | |
5191 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippReadIO">ippReadIO</a></h3> | |
5192 | <p class="description">Read data for an IPP message.</p> | |
5193 | <p class="code"> | |
98d88c8d MS |
5194 | <a href="#ipp_state_t">ipp_state_t</a> ippReadIO(void *src, <a href="#ipp_iocb_t">ipp_iocb_t</a> cb, int blocking, <a href="#ipp_t">ipp_t</a> *parent, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
5195 | <h4 class="parameters">Parameters</h4> | |
5196 | <table class="list"><tbody> | |
5197 | <tr><th>src</th> | |
5198 | <td class="description">Data source</td></tr> | |
5199 | <tr><th>cb</th> | |
5200 | <td class="description">Read callback function</td></tr> | |
5201 | <tr><th>blocking</th> | |
5202 | <td class="description">Use blocking IO?</td></tr> | |
5203 | <tr><th>parent</th> | |
5204 | <td class="description">Parent request, if any</td></tr> | |
5205 | <tr><th>ipp</th> | |
5206 | <td class="description">IPP data</td></tr> | |
5207 | </tbody></table> | |
798d6e29 MS |
5208 | <h4 class="returnvalue">Return Value</h4> |
5209 | <p class="description">Current state</p> | |
5210 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetBoolean">ippSetBoolean</a></h3> | |
5211 | <p class="description">Set a boolean value in an attribute.</p> | |
5212 | <p class="code"> | |
98d88c8d MS |
5213 | int ippSetBoolean(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int boolvalue);</p> |
5214 | <h4 class="parameters">Parameters</h4> | |
5215 | <table class="list"><tbody> | |
5216 | <tr><th>ipp</th> | |
5217 | <td class="description">IPP message</td></tr> | |
5218 | <tr><th>attr</th> | |
5219 | <td class="description">IPP attribute</td></tr> | |
5220 | <tr><th>element</th> | |
5221 | <td class="description">Value number (0-based)</td></tr> | |
5222 | <tr><th>boolvalue</th> | |
5223 | <td class="description">Boolean value</td></tr> | |
5224 | </tbody></table> | |
798d6e29 MS |
5225 | <h4 class="returnvalue">Return Value</h4> |
5226 | <p class="description">1 on success, 0 on failure</p> | |
5227 | <h4 class="discussion">Discussion</h4> | |
5228 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5229 | 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> | |
5230 | <br> | |
5231 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5232 | <br> | |
5233 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5234 | <code>ippGetCount(attr)</code>. |
798d6e29 MS |
5235 | |
5236 | </p> | |
5237 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetCollection">ippSetCollection</a></h3> | |
5238 | <p class="description">Set a collection value in an attribute.</p> | |
5239 | <p class="code"> | |
98d88c8d MS |
5240 | int ippSetCollection(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, <a href="#ipp_t">ipp_t</a> *colvalue);</p> |
5241 | <h4 class="parameters">Parameters</h4> | |
5242 | <table class="list"><tbody> | |
5243 | <tr><th>ipp</th> | |
5244 | <td class="description">IPP message</td></tr> | |
5245 | <tr><th>attr</th> | |
5246 | <td class="description">IPP attribute</td></tr> | |
5247 | <tr><th>element</th> | |
5248 | <td class="description">Value number (0-based)</td></tr> | |
5249 | <tr><th>colvalue</th> | |
5250 | <td class="description">Collection value</td></tr> | |
5251 | </tbody></table> | |
798d6e29 MS |
5252 | <h4 class="returnvalue">Return Value</h4> |
5253 | <p class="description">1 on success, 0 on failure</p> | |
5254 | <h4 class="discussion">Discussion</h4> | |
5255 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5256 | 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> | |
5257 | <br> | |
5258 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5259 | <br> | |
5260 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5261 | <code>ippGetCount(attr)</code>. |
798d6e29 MS |
5262 | |
5263 | </p> | |
5264 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetDate">ippSetDate</a></h3> | |
65bebeac | 5265 | <p class="description">Set a dateTime value in an attribute.</p> |
798d6e29 | 5266 | <p class="code"> |
98d88c8d MS |
5267 | int ippSetDate(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const <a href="#ipp_uchar_t">ipp_uchar_t</a> *datevalue);</p> |
5268 | <h4 class="parameters">Parameters</h4> | |
5269 | <table class="list"><tbody> | |
5270 | <tr><th>ipp</th> | |
5271 | <td class="description">IPP message</td></tr> | |
5272 | <tr><th>attr</th> | |
5273 | <td class="description">IPP attribute</td></tr> | |
5274 | <tr><th>element</th> | |
5275 | <td class="description">Value number (0-based)</td></tr> | |
5276 | <tr><th>datevalue</th> | |
65bebeac | 5277 | <td class="description">dateTime value</td></tr> |
98d88c8d | 5278 | </tbody></table> |
798d6e29 MS |
5279 | <h4 class="returnvalue">Return Value</h4> |
5280 | <p class="description">1 on success, 0 on failure</p> | |
5281 | <h4 class="discussion">Discussion</h4> | |
5282 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5283 | 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> | |
5284 | <br> | |
5285 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5286 | <br> | |
5287 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5288 | <code>ippGetCount(attr)</code>. |
798d6e29 MS |
5289 | |
5290 | </p> | |
5291 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetGroupTag">ippSetGroupTag</a></h3> | |
5292 | <p class="description">Set the group tag of an attribute.</p> | |
5293 | <p class="code"> | |
98d88c8d MS |
5294 | int ippSetGroupTag(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, ipp_tag_t group_tag);</p> |
5295 | <h4 class="parameters">Parameters</h4> | |
5296 | <table class="list"><tbody> | |
5297 | <tr><th>ipp</th> | |
5298 | <td class="description">IPP message</td></tr> | |
5299 | <tr><th>attr</th> | |
5300 | <td class="description">Attribute</td></tr> | |
5301 | <tr><th>group_tag</th> | |
5302 | <td class="description">Group tag</td></tr> | |
5303 | </tbody></table> | |
798d6e29 MS |
5304 | <h4 class="returnvalue">Return Value</h4> |
5305 | <p class="description">1 on success, 0 on failure</p> | |
5306 | <h4 class="discussion">Discussion</h4> | |
5307 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5308 | 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> | |
5309 | <br> | |
5310 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5311 | <br> | |
5312 | The <code>group</code> parameter specifies the IPP attribute group tag: none | |
5313 | (<code>IPP_TAG_ZERO</code>, for member attributes), document (<code>IPP_TAG_DOCUMENT</code>), | |
5314 | event notification (<code>IPP_TAG_EVENT_NOTIFICATION</code>), operation | |
5315 | (<code>IPP_TAG_OPERATION</code>), printer (<code>IPP_TAG_PRINTER</code>), subscription | |
5316 | (<code>IPP_TAG_SUBSCRIPTION</code>), or unsupported (<code>IPP_TAG_UNSUPPORTED_GROUP</code>). | |
5317 | ||
5318 | </p> | |
5319 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetInteger">ippSetInteger</a></h3> | |
5320 | <p class="description">Set an integer or enum value in an attribute.</p> | |
5321 | <p class="code"> | |
98d88c8d MS |
5322 | int ippSetInteger(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int intvalue);</p> |
5323 | <h4 class="parameters">Parameters</h4> | |
5324 | <table class="list"><tbody> | |
5325 | <tr><th>ipp</th> | |
5326 | <td class="description">IPP message</td></tr> | |
5327 | <tr><th>attr</th> | |
5328 | <td class="description">IPP attribute</td></tr> | |
5329 | <tr><th>element</th> | |
5330 | <td class="description">Value number (0-based)</td></tr> | |
5331 | <tr><th>intvalue</th> | |
5332 | <td class="description">Integer/enum value</td></tr> | |
5333 | </tbody></table> | |
798d6e29 MS |
5334 | <h4 class="returnvalue">Return Value</h4> |
5335 | <p class="description">1 on success, 0 on failure</p> | |
5336 | <h4 class="discussion">Discussion</h4> | |
5337 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5338 | 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> | |
5339 | <br> | |
5340 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5341 | <br> | |
5342 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5343 | <code>ippGetCount(attr)</code>. |
798d6e29 MS |
5344 | |
5345 | </p> | |
5346 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetName">ippSetName</a></h3> | |
5347 | <p class="description">Set the name of an attribute.</p> | |
5348 | <p class="code"> | |
98d88c8d MS |
5349 | int ippSetName(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, const char *name);</p> |
5350 | <h4 class="parameters">Parameters</h4> | |
5351 | <table class="list"><tbody> | |
5352 | <tr><th>ipp</th> | |
5353 | <td class="description">IPP message</td></tr> | |
5354 | <tr><th>attr</th> | |
5355 | <td class="description">IPP attribute</td></tr> | |
5356 | <tr><th>name</th> | |
5357 | <td class="description">Attribute name</td></tr> | |
5358 | </tbody></table> | |
798d6e29 MS |
5359 | <h4 class="returnvalue">Return Value</h4> |
5360 | <p class="description">1 on success, 0 on failure</p> | |
5361 | <h4 class="discussion">Discussion</h4> | |
5362 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5363 | 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> | |
5364 | <br> | |
5365 | The <code>attr</code> parameter may be modified as a result of setting the value. | |
5366 | ||
5367 | </p> | |
5368 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippSetOctetString">ippSetOctetString</a></h3> | |
5369 | <p class="description">Set an octetString value in an IPP attribute.</p> | |
5370 | <p class="code"> | |
98d88c8d MS |
5371 | int ippSetOctetString(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const void *data, int datalen);</p> |
5372 | <h4 class="parameters">Parameters</h4> | |
5373 | <table class="list"><tbody> | |
5374 | <tr><th>ipp</th> | |
5375 | <td class="description">IPP message</td></tr> | |
5376 | <tr><th>attr</th> | |
5377 | <td class="description">IPP attribute</td></tr> | |
5378 | <tr><th>element</th> | |
5379 | <td class="description">Value number (0-based)</td></tr> | |
5380 | <tr><th>data</th> | |
5381 | <td class="description">Pointer to octetString data</td></tr> | |
5382 | <tr><th>datalen</th> | |
5383 | <td class="description">Length of octetString data</td></tr> | |
5384 | </tbody></table> | |
798d6e29 MS |
5385 | <h4 class="returnvalue">Return Value</h4> |
5386 | <p class="description">1 on success, 0 on failure</p> | |
5387 | <h4 class="discussion">Discussion</h4> | |
5388 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5389 | the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> | |
5390 | <br> | |
5391 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5392 | <br> | |
5393 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5394 | <code>ippGetCount(attr)</code>. |
798d6e29 MS |
5395 | |
5396 | </p> | |
5397 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetOperation">ippSetOperation</a></h3> | |
5398 | <p class="description">Set the operation ID in an IPP request message.</p> | |
5399 | <p class="code"> | |
98d88c8d | 5400 | int ippSetOperation(<a href="#ipp_t">ipp_t</a> *ipp, ipp_op_t op);</p> |
798d6e29 | 5401 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5402 | <table class="list"><tbody> |
5403 | <tr><th>ipp</th> | |
5404 | <td class="description">IPP request message</td></tr> | |
5405 | <tr><th>op</th> | |
5406 | <td class="description">Operation ID</td></tr> | |
5407 | </tbody></table> | |
798d6e29 MS |
5408 | <h4 class="returnvalue">Return Value</h4> |
5409 | <p class="description">1 on success, 0 on failure</p> | |
5410 | <h4 class="discussion">Discussion</h4> | |
5411 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5412 | the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. | |
5413 | ||
5414 | </p> | |
5415 | <h3 class="function"><a id="ippSetPort">ippSetPort</a></h3> | |
98d88c8d | 5416 | <p class="description">Set the default port number.</p> |
798d6e29 | 5417 | <p class="code"> |
98d88c8d | 5418 | void ippSetPort(int p);</p> |
798d6e29 | 5419 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5420 | <table class="list"><tbody> |
5421 | <tr><th>p</th> | |
5422 | <td class="description">Port number to use</td></tr> | |
5423 | </tbody></table> | |
798d6e29 MS |
5424 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetRange">ippSetRange</a></h3> |
5425 | <p class="description">Set a rangeOfInteger value in an attribute.</p> | |
5426 | <p class="code"> | |
98d88c8d MS |
5427 | int ippSetRange(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, int lowervalue, int uppervalue);</p> |
5428 | <h4 class="parameters">Parameters</h4> | |
5429 | <table class="list"><tbody> | |
5430 | <tr><th>ipp</th> | |
5431 | <td class="description">IPP message</td></tr> | |
5432 | <tr><th>attr</th> | |
5433 | <td class="description">IPP attribute</td></tr> | |
5434 | <tr><th>element</th> | |
5435 | <td class="description">Value number (0-based)</td></tr> | |
5436 | <tr><th>lowervalue</th> | |
5437 | <td class="description">Lower bound for range</td></tr> | |
5438 | <tr><th>uppervalue</th> | |
5439 | <td class="description">Upper bound for range</td></tr> | |
5440 | </tbody></table> | |
798d6e29 MS |
5441 | <h4 class="returnvalue">Return Value</h4> |
5442 | <p class="description">1 on success, 0 on failure</p> | |
5443 | <h4 class="discussion">Discussion</h4> | |
5444 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5445 | the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions.<br> | |
5446 | <br> | |
5447 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5448 | <br> | |
5449 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5450 | <code>ippGetCount(attr)</code>. |
798d6e29 MS |
5451 | |
5452 | </p> | |
5453 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetRequestId">ippSetRequestId</a></h3> | |
5454 | <p class="description">Set the request ID in an IPP message.</p> | |
5455 | <p class="code"> | |
98d88c8d | 5456 | int ippSetRequestId(<a href="#ipp_t">ipp_t</a> *ipp, int request_id);</p> |
798d6e29 | 5457 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5458 | <table class="list"><tbody> |
5459 | <tr><th>ipp</th> | |
5460 | <td class="description">IPP message</td></tr> | |
5461 | <tr><th>request_id</th> | |
5462 | <td class="description">Request ID</td></tr> | |
5463 | </tbody></table> | |
798d6e29 MS |
5464 | <h4 class="returnvalue">Return Value</h4> |
5465 | <p class="description">1 on success, 0 on failure</p> | |
5466 | <h4 class="discussion">Discussion</h4> | |
5467 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5468 | 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> | |
5469 | <br> | |
5470 | The <code>request_id</code> parameter must be greater than 0. | |
5471 | ||
5472 | </p> | |
5473 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetResolution">ippSetResolution</a></h3> | |
5474 | <p class="description">Set a resolution value in an attribute.</p> | |
5475 | <p class="code"> | |
98d88c8d MS |
5476 | int ippSetResolution(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, <a href="#ipp_res_t">ipp_res_t</a> unitsvalue, int xresvalue, int yresvalue);</p> |
5477 | <h4 class="parameters">Parameters</h4> | |
5478 | <table class="list"><tbody> | |
5479 | <tr><th>ipp</th> | |
5480 | <td class="description">IPP message</td></tr> | |
5481 | <tr><th>attr</th> | |
5482 | <td class="description">IPP attribute</td></tr> | |
5483 | <tr><th>element</th> | |
5484 | <td class="description">Value number (0-based)</td></tr> | |
5485 | <tr><th>unitsvalue</th> | |
5486 | <td class="description">Resolution units</td></tr> | |
5487 | <tr><th>xresvalue</th> | |
5488 | <td class="description">Horizontal/cross feed resolution</td></tr> | |
5489 | <tr><th>yresvalue</th> | |
5490 | <td class="description">Vertical/feed resolution</td></tr> | |
5491 | </tbody></table> | |
798d6e29 MS |
5492 | <h4 class="returnvalue">Return Value</h4> |
5493 | <p class="description">1 on success, 0 on failure</p> | |
5494 | <h4 class="discussion">Discussion</h4> | |
5495 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5496 | 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> | |
5497 | <br> | |
5498 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5499 | <br> | |
5500 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5501 | <code>ippGetCount(attr)</code>. |
798d6e29 MS |
5502 | |
5503 | </p> | |
5504 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetState">ippSetState</a></h3> | |
5505 | <p class="description">Set the current state of the IPP message.</p> | |
5506 | <p class="code"> | |
98d88c8d | 5507 | int ippSetState(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_state_t">ipp_state_t</a> state);</p> |
798d6e29 | 5508 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5509 | <table class="list"><tbody> |
5510 | <tr><th>ipp</th> | |
5511 | <td class="description">IPP message</td></tr> | |
5512 | <tr><th>state</th> | |
5513 | <td class="description">IPP state value</td></tr> | |
5514 | </tbody></table> | |
798d6e29 MS |
5515 | <h4 class="returnvalue">Return Value</h4> |
5516 | <p class="description">1 on success, 0 on failure</p> | |
5517 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetStatusCode">ippSetStatusCode</a></h3> | |
5518 | <p class="description">Set the status code in an IPP response or event message.</p> | |
5519 | <p class="code"> | |
98d88c8d | 5520 | int ippSetStatusCode(<a href="#ipp_t">ipp_t</a> *ipp, ipp_status_t status);</p> |
798d6e29 | 5521 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5522 | <table class="list"><tbody> |
5523 | <tr><th>ipp</th> | |
5524 | <td class="description">IPP response or event message</td></tr> | |
5525 | <tr><th>status</th> | |
5526 | <td class="description">Status code</td></tr> | |
5527 | </tbody></table> | |
798d6e29 MS |
5528 | <h4 class="returnvalue">Return Value</h4> |
5529 | <p class="description">1 on success, 0 on failure</p> | |
5530 | <h4 class="discussion">Discussion</h4> | |
5531 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5532 | the <a href="#ippNew"><code>ippNew</code></a>, <a href="#ippNewRequest"><code>ippNewRequest</code></a>, or <a href="#ippNewResponse"><code>ippNewResponse</code></a> functions. | |
5533 | ||
5534 | </p> | |
5535 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetString">ippSetString</a></h3> | |
5536 | <p class="description">Set a string value in an attribute.</p> | |
5537 | <p class="code"> | |
98d88c8d MS |
5538 | int ippSetString(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const char *strvalue);</p> |
5539 | <h4 class="parameters">Parameters</h4> | |
5540 | <table class="list"><tbody> | |
5541 | <tr><th>ipp</th> | |
5542 | <td class="description">IPP message</td></tr> | |
5543 | <tr><th>attr</th> | |
5544 | <td class="description">IPP attribute</td></tr> | |
5545 | <tr><th>element</th> | |
5546 | <td class="description">Value number (0-based)</td></tr> | |
5547 | <tr><th>strvalue</th> | |
5548 | <td class="description">String value</td></tr> | |
5549 | </tbody></table> | |
798d6e29 MS |
5550 | <h4 class="returnvalue">Return Value</h4> |
5551 | <p class="description">1 on success, 0 on failure</p> | |
5552 | <h4 class="discussion">Discussion</h4> | |
5553 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5554 | 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> | |
5555 | <br> | |
5556 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5557 | <br> | |
5558 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5559 | <code>ippGetCount(attr)</code>. |
798d6e29 MS |
5560 | |
5561 | </p> | |
5562 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippSetStringf">ippSetStringf</a></h3> | |
5563 | <p class="description">Set a formatted string value of an attribute.</p> | |
5564 | <p class="code"> | |
98d88c8d MS |
5565 | int ippSetStringf(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const char *format, ...);</p> |
5566 | <h4 class="parameters">Parameters</h4> | |
5567 | <table class="list"><tbody> | |
5568 | <tr><th>ipp</th> | |
5569 | <td class="description">IPP message</td></tr> | |
5570 | <tr><th>attr</th> | |
5571 | <td class="description">IPP attribute</td></tr> | |
5572 | <tr><th>element</th> | |
5573 | <td class="description">Value number (0-based)</td></tr> | |
5574 | <tr><th>format</th> | |
5575 | <td class="description">Printf-style format string</td></tr> | |
5576 | <tr><th>...</th> | |
5577 | <td class="description">Additional arguments as needed</td></tr> | |
5578 | </tbody></table> | |
798d6e29 MS |
5579 | <h4 class="returnvalue">Return Value</h4> |
5580 | <p class="description">1 on success, 0 on failure</p> | |
5581 | <h4 class="discussion">Discussion</h4> | |
5582 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5583 | 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> | |
5584 | <br> | |
5585 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5586 | <br> | |
5587 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5588 | <code>ippGetCount(attr)</code>.<br> |
798d6e29 MS |
5589 | <br> |
5590 | The <code>format</code> parameter uses formatting characters compatible with the | |
5591 | printf family of standard functions. Additional arguments follow it as | |
5592 | needed. The formatted string is truncated as needed to the maximum length of | |
5593 | the corresponding value type. | |
5594 | ||
5595 | </p> | |
5596 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippSetStringfv">ippSetStringfv</a></h3> | |
5597 | <p class="description">Set a formatted string value of an attribute.</p> | |
5598 | <p class="code"> | |
98d88c8d MS |
5599 | int ippSetStringfv(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, int element, const char *format, va_list ap);</p> |
5600 | <h4 class="parameters">Parameters</h4> | |
5601 | <table class="list"><tbody> | |
5602 | <tr><th>ipp</th> | |
5603 | <td class="description">IPP message</td></tr> | |
5604 | <tr><th>attr</th> | |
5605 | <td class="description">IPP attribute</td></tr> | |
5606 | <tr><th>element</th> | |
5607 | <td class="description">Value number (0-based)</td></tr> | |
5608 | <tr><th>format</th> | |
5609 | <td class="description">Printf-style format string</td></tr> | |
5610 | <tr><th>ap</th> | |
5611 | <td class="description">Pointer to additional arguments</td></tr> | |
5612 | </tbody></table> | |
798d6e29 MS |
5613 | <h4 class="returnvalue">Return Value</h4> |
5614 | <p class="description">1 on success, 0 on failure</p> | |
5615 | <h4 class="discussion">Discussion</h4> | |
5616 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5617 | 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> | |
5618 | <br> | |
5619 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5620 | <br> | |
5621 | The <code>element</code> parameter specifies which value to set from 0 to | |
65bebeac | 5622 | <code>ippGetCount(attr)</code>.<br> |
798d6e29 MS |
5623 | <br> |
5624 | The <code>format</code> parameter uses formatting characters compatible with the | |
5625 | printf family of standard functions. Additional arguments follow it as | |
5626 | needed. The formatted string is truncated as needed to the maximum length of | |
5627 | the corresponding value type. | |
5628 | ||
5629 | </p> | |
5630 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetValueTag">ippSetValueTag</a></h3> | |
5631 | <p class="description">Set the value tag of an attribute.</p> | |
5632 | <p class="code"> | |
98d88c8d MS |
5633 | int ippSetValueTag(<a href="#ipp_t">ipp_t</a> *ipp, <a href="#ipp_attribute_t">ipp_attribute_t</a> **attr, ipp_tag_t value_tag);</p> |
5634 | <h4 class="parameters">Parameters</h4> | |
5635 | <table class="list"><tbody> | |
5636 | <tr><th>ipp</th> | |
5637 | <td class="description">IPP message</td></tr> | |
5638 | <tr><th>attr</th> | |
5639 | <td class="description">IPP attribute</td></tr> | |
5640 | <tr><th>value_tag</th> | |
5641 | <td class="description">Value tag</td></tr> | |
5642 | </tbody></table> | |
798d6e29 MS |
5643 | <h4 class="returnvalue">Return Value</h4> |
5644 | <p class="description">1 on success, 0 on failure</p> | |
5645 | <h4 class="discussion">Discussion</h4> | |
5646 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5647 | 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> | |
5648 | <br> | |
5649 | The <code>attr</code> parameter may be modified as a result of setting the value.<br> | |
5650 | <br> | |
5651 | Integer (<code>IPP_TAG_INTEGER</code>) values can be promoted to rangeOfInteger | |
5652 | (<code>IPP_TAG_RANGE</code>) values, the various string tags can be promoted to name | |
5653 | (<code>IPP_TAG_NAME</code>) or nameWithLanguage (<code>IPP_TAG_NAMELANG</code>) values, text | |
5654 | (<code>IPP_TAG_TEXT</code>) values can be promoted to textWithLanguage | |
5655 | (<code>IPP_TAG_TEXTLANG</code>) values, and all values can be demoted to the various | |
5656 | out-of-band value tags such as no-value (<code>IPP_TAG_NOVALUE</code>). All other changes | |
5657 | will be rejected.<br> | |
5658 | <br> | |
5659 | Promoting a string attribute to nameWithLanguage or textWithLanguage adds the language | |
5660 | code in the "attributes-natural-language" attribute or, if not present, the language | |
5661 | code for the current locale. | |
5662 | ||
5663 | </p> | |
5664 | <h3 class="function"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="ippSetVersion">ippSetVersion</a></h3> | |
5665 | <p class="description">Set the version number in an IPP message.</p> | |
5666 | <p class="code"> | |
98d88c8d MS |
5667 | int ippSetVersion(<a href="#ipp_t">ipp_t</a> *ipp, int major, int minor);</p> |
5668 | <h4 class="parameters">Parameters</h4> | |
5669 | <table class="list"><tbody> | |
5670 | <tr><th>ipp</th> | |
5671 | <td class="description">IPP message</td></tr> | |
5672 | <tr><th>major</th> | |
5673 | <td class="description">Major version number (major.minor)</td></tr> | |
5674 | <tr><th>minor</th> | |
5675 | <td class="description">Minor version number (major.minor)</td></tr> | |
5676 | </tbody></table> | |
798d6e29 MS |
5677 | <h4 class="returnvalue">Return Value</h4> |
5678 | <p class="description">1 on success, 0 on failure</p> | |
5679 | <h4 class="discussion">Discussion</h4> | |
5680 | <p class="discussion">The <code>ipp</code> parameter refers to an IPP message previously created using | |
5681 | 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> | |
5682 | <br> | |
5683 | The valid version numbers are currently 1.0, 1.1, 2.0, 2.1, and 2.2. | |
5684 | ||
5685 | </p> | |
5686 | <h3 class="function"><span class="info"> CUPS 2.0/OS 10.10 </span><a id="ippStateString">ippStateString</a></h3> | |
5687 | <p class="description">Return the name corresponding to a state value.</p> | |
5688 | <p class="code"> | |
98d88c8d | 5689 | const char *ippStateString(<a href="#ipp_state_t">ipp_state_t</a> state);</p> |
798d6e29 | 5690 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5691 | <table class="list"><tbody> |
5692 | <tr><th>state</th> | |
5693 | <td class="description">State value</td></tr> | |
5694 | </tbody></table> | |
798d6e29 MS |
5695 | <h4 class="returnvalue">Return Value</h4> |
5696 | <p class="description">State name</p> | |
5697 | <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="ippTagString">ippTagString</a></h3> | |
5698 | <p class="description">Return the tag name corresponding to a tag value.</p> | |
5699 | <p class="code"> | |
98d88c8d | 5700 | const char *ippTagString(ipp_tag_t tag);</p> |
798d6e29 | 5701 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5702 | <table class="list"><tbody> |
5703 | <tr><th>tag</th> | |
5704 | <td class="description">Tag value</td></tr> | |
5705 | </tbody></table> | |
798d6e29 MS |
5706 | <h4 class="returnvalue">Return Value</h4> |
5707 | <p class="description">Tag name</p> | |
5708 | <h4 class="discussion">Discussion</h4> | |
65bebeac | 5709 | <p class="discussion">The returned names are defined in RFC 8011 and the IANA IPP Registry. |
798d6e29 MS |
5710 | |
5711 | </p> | |
5712 | <h3 class="function"><span class="info"> CUPS 1.4/macOS 10.6 </span><a id="ippTagValue">ippTagValue</a></h3> | |
5713 | <p class="description">Return the tag value corresponding to a tag name.</p> | |
5714 | <p class="code"> | |
98d88c8d | 5715 | ipp_tag_t ippTagValue(const char *name);</p> |
798d6e29 | 5716 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5717 | <table class="list"><tbody> |
5718 | <tr><th>name</th> | |
5719 | <td class="description">Tag name</td></tr> | |
5720 | </tbody></table> | |
798d6e29 MS |
5721 | <h4 class="returnvalue">Return Value</h4> |
5722 | <p class="description">Tag value</p> | |
5723 | <h4 class="discussion">Discussion</h4> | |
65bebeac | 5724 | <p class="discussion">The tag names are defined in RFC 8011 and the IANA IPP Registry. |
798d6e29 MS |
5725 | |
5726 | </p> | |
5727 | <h3 class="function"><a id="ippTimeToDate">ippTimeToDate</a></h3> | |
65bebeac | 5728 | <p class="description">Convert from time in seconds to RFC 2579 format.</p> |
798d6e29 | 5729 | <p class="code"> |
98d88c8d | 5730 | const <a href="#ipp_uchar_t">ipp_uchar_t</a> *ippTimeToDate(time_t t);</p> |
798d6e29 | 5731 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5732 | <table class="list"><tbody> |
5733 | <tr><th>t</th> | |
65bebeac | 5734 | <td class="description">Time in seconds</td></tr> |
98d88c8d | 5735 | </tbody></table> |
798d6e29 | 5736 | <h4 class="returnvalue">Return Value</h4> |
65bebeac | 5737 | <p class="description">RFC-2579 date/time data</p> |
798d6e29 MS |
5738 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippValidateAttribute">ippValidateAttribute</a></h3> |
5739 | <p class="description">Validate the contents of an attribute.</p> | |
5740 | <p class="code"> | |
98d88c8d | 5741 | int ippValidateAttribute(<a href="#ipp_attribute_t">ipp_attribute_t</a> *attr);</p> |
798d6e29 | 5742 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5743 | <table class="list"><tbody> |
5744 | <tr><th>attr</th> | |
5745 | <td class="description">Attribute</td></tr> | |
5746 | </tbody></table> | |
798d6e29 MS |
5747 | <h4 class="returnvalue">Return Value</h4> |
5748 | <p class="description">1 if valid, 0 otherwise</p> | |
5749 | <h4 class="discussion">Discussion</h4> | |
5750 | <p class="discussion">This function validates the contents of an attribute based on the name and | |
5751 | value tag. 1 is returned if the attribute is valid, 0 otherwise. On | |
65bebeac | 5752 | failure, <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> is set to a human-readable message. |
798d6e29 MS |
5753 | |
5754 | </p> | |
5755 | <h3 class="function"><span class="info"> CUPS 1.7/macOS 10.9 </span><a id="ippValidateAttributes">ippValidateAttributes</a></h3> | |
5756 | <p class="description">Validate all attributes in an IPP message.</p> | |
5757 | <p class="code"> | |
98d88c8d | 5758 | int ippValidateAttributes(<a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 5759 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5760 | <table class="list"><tbody> |
5761 | <tr><th>ipp</th> | |
5762 | <td class="description">IPP message</td></tr> | |
5763 | </tbody></table> | |
798d6e29 MS |
5764 | <h4 class="returnvalue">Return Value</h4> |
5765 | <p class="description">1 if valid, 0 otherwise</p> | |
5766 | <h4 class="discussion">Discussion</h4> | |
5767 | <p class="discussion">This function validates the contents of the IPP message, including each | |
65bebeac MS |
5768 | attribute. Like <a href="#ippValidateAttribute"><code>ippValidateAttribute</code></a>, <a href="#cupsLastErrorString"><code>cupsLastErrorString</code></a> is |
5769 | set to a human-readable message on failure. | |
798d6e29 MS |
5770 | |
5771 | </p> | |
5772 | <h3 class="function"><a id="ippWrite">ippWrite</a></h3> | |
5773 | <p class="description">Write data for an IPP message to a HTTP connection.</p> | |
5774 | <p class="code"> | |
98d88c8d | 5775 | <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> |
798d6e29 | 5776 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5777 | <table class="list"><tbody> |
5778 | <tr><th>http</th> | |
5779 | <td class="description">HTTP connection</td></tr> | |
5780 | <tr><th>ipp</th> | |
5781 | <td class="description">IPP data</td></tr> | |
5782 | </tbody></table> | |
798d6e29 MS |
5783 | <h4 class="returnvalue">Return Value</h4> |
5784 | <p class="description">Current state</p> | |
5785 | <h3 class="function"><span class="info"> CUPS 1.1.19/macOS 10.3 </span><a id="ippWriteFile">ippWriteFile</a></h3> | |
5786 | <p class="description">Write data for an IPP message to a file.</p> | |
5787 | <p class="code"> | |
98d88c8d | 5788 | <a href="#ipp_state_t">ipp_state_t</a> ippWriteFile(int fd, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
798d6e29 | 5789 | <h4 class="parameters">Parameters</h4> |
98d88c8d MS |
5790 | <table class="list"><tbody> |
5791 | <tr><th>fd</th> | |
5792 | <td class="description">HTTP data</td></tr> | |
5793 | <tr><th>ipp</th> | |
5794 | <td class="description">IPP data</td></tr> | |
5795 | </tbody></table> | |
798d6e29 MS |
5796 | <h4 class="returnvalue">Return Value</h4> |
5797 | <p class="description">Current state</p> | |
5798 | <h3 class="function"><span class="info"> CUPS 1.2/macOS 10.5 </span><a id="ippWriteIO">ippWriteIO</a></h3> | |
5799 | <p class="description">Write data for an IPP message.</p> | |
5800 | <p class="code"> | |
98d88c8d MS |
5801 | <a href="#ipp_state_t">ipp_state_t</a> ippWriteIO(void *dst, <a href="#ipp_iocb_t">ipp_iocb_t</a> cb, int blocking, <a href="#ipp_t">ipp_t</a> *parent, <a href="#ipp_t">ipp_t</a> *ipp);</p> |
5802 | <h4 class="parameters">Parameters</h4> | |
5803 | <table class="list"><tbody> | |
5804 | <tr><th>dst</th> | |
5805 | <td class="description">Destination</td></tr> | |
5806 | <tr><th>cb</th> | |
5807 | <td class="description">Write callback function</td></tr> | |
5808 | <tr><th>blocking</th> | |
5809 | <td class="description">Use blocking IO?</td></tr> | |
5810 | <tr><th>parent</th> | |
5811 | <td class="description">Parent IPP message</td></tr> | |
5812 | <tr><th>ipp</th> | |
5813 | <td class="description">IPP data</td></tr> | |
5814 | </tbody></table> | |
798d6e29 MS |
5815 | <h4 class="returnvalue">Return Value</h4> |
5816 | <p class="description">Current state</p> | |
798d6e29 | 5817 | <h2 class="title"><a id="TYPES">Data Types</a></h2> |
798d6e29 MS |
5818 | <h3 class="typedef"><a id="cups_client_cert_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>cups_client_cert_cb_t</a></h3> |
5819 | <p class="description">Client credentials callback | |
5820 | </p> | |
5821 | <p class="code"> | |
53af7f21 | 5822 | typedef int(*)(http_t *http, void *tls, cups_array_t *distinguished_names, void *user_data)cups_client_cert_cb_t; |
798d6e29 MS |
5823 | </p> |
5824 | <h3 class="typedef"><a id="cups_dest_cb_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>cups_dest_cb_t</a></h3> | |
5825 | <p class="description">Destination enumeration callback | |
5826 | </p> | |
5827 | <p class="code"> | |
5828 | typedef int(*)(void *user_data, unsigned flags, <a href="#cups_dest_t">cups_dest_t</a> *dest)cups_dest_cb_t; | |
5829 | </p> | |
5830 | <h3 class="typedef"><a id="cups_dest_t">cups_dest_t</a></h3> | |
5831 | <p class="description">Destination</p> | |
5832 | <p class="code"> | |
5833 | typedef struct <a href="#cups_dest_s">cups_dest_s</a> cups_dest_t; | |
5834 | </p> | |
5835 | <h3 class="typedef"><a id="cups_dinfo_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>cups_dinfo_t</a></h3> | |
5836 | <p class="description">Destination capability and status | |
5837 | information </p> | |
5838 | <p class="code"> | |
5839 | typedef struct _cups_dinfo_s cups_dinfo_t; | |
798d6e29 MS |
5840 | </p> |
5841 | <h3 class="typedef"><a id="cups_job_t">cups_job_t</a></h3> | |
5842 | <p class="description">Job</p> | |
5843 | <p class="code"> | |
5844 | typedef struct <a href="#cups_job_s">cups_job_s</a> cups_job_t; | |
798d6e29 MS |
5845 | </p> |
5846 | <h3 class="typedef"><a id="cups_option_t">cups_option_t</a></h3> | |
5847 | <p class="description">Printer Options</p> | |
5848 | <p class="code"> | |
5849 | typedef struct <a href="#cups_option_s">cups_option_s</a> cups_option_t; | |
5850 | </p> | |
5851 | <h3 class="typedef"><a id="cups_password_cb2_t"><span class="info"> CUPS 1.4/macOS 10.6 </span>cups_password_cb2_t</a></h3> | |
5852 | <p class="description">New password callback | |
5853 | </p> | |
5854 | <p class="code"> | |
5855 | 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; | |
798d6e29 MS |
5856 | </p> |
5857 | <h3 class="typedef"><a id="cups_ptype_t">cups_ptype_t</a></h3> | |
5858 | <p class="description">Printer type/capability bits</p> | |
5859 | <p class="code"> | |
5860 | typedef unsigned cups_ptype_t; | |
5861 | </p> | |
5862 | <h3 class="typedef"><a id="cups_server_cert_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>cups_server_cert_cb_t</a></h3> | |
5863 | <p class="description">Server credentials callback | |
5864 | </p> | |
5865 | <p class="code"> | |
53af7f21 | 5866 | typedef int(*)(http_t *http, void *tls, cups_array_t *certs, void *user_data)cups_server_cert_cb_t; |
798d6e29 MS |
5867 | </p> |
5868 | <h3 class="typedef"><a id="cups_size_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>cups_size_t</a></h3> | |
5869 | <p class="description">Media Size </p> | |
5870 | <p class="code"> | |
5871 | typedef struct <a href="#cups_size_s">cups_size_s</a> cups_size_t; | |
798d6e29 MS |
5872 | </p> |
5873 | <h3 class="typedef"><a id="http_addr_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>http_addr_t</a></h3> | |
5874 | <p class="description">Socket address union, which | |
5875 | makes using IPv6 and other | |
5876 | address types easier and | |
5877 | more portable. </p> | |
5878 | <p class="code"> | |
5879 | typedef union _http_addr_u / http_addr_t; | |
798d6e29 MS |
5880 | </p> |
5881 | <h3 class="typedef"><a id="http_encoding_t">http_encoding_t</a></h3> | |
5882 | <p class="description">HTTP transfer encoding values</p> | |
5883 | <p class="code"> | |
5884 | typedef enum <a href="#http_encoding_e">http_encoding_e</a> http_encoding_t; | |
5885 | </p> | |
5886 | <h3 class="typedef"><a id="http_encryption_t">http_encryption_t</a></h3> | |
5887 | <p class="description">HTTP encryption values</p> | |
5888 | <p class="code"> | |
5889 | typedef enum <a href="#http_encryption_e">http_encryption_e</a> http_encryption_t; | |
5890 | </p> | |
5891 | <h3 class="typedef"><a id="http_field_t">http_field_t</a></h3> | |
5892 | <p class="description">HTTP field names</p> | |
5893 | <p class="code"> | |
5894 | typedef enum <a href="#http_field_e">http_field_e</a> http_field_t; | |
5895 | </p> | |
5896 | <h3 class="typedef"><a id="http_keepalive_t">http_keepalive_t</a></h3> | |
5897 | <p class="description">HTTP keep-alive values</p> | |
5898 | <p class="code"> | |
5899 | typedef enum <a href="#http_keepalive_e">http_keepalive_e</a> http_keepalive_t; | |
5900 | </p> | |
5901 | <h3 class="typedef"><a id="http_state_t">http_state_t</a></h3> | |
5902 | <p class="description">HTTP state values; states | |
5903 | are server-oriented...</p> | |
5904 | <p class="code"> | |
5905 | typedef enum <a href="#http_state_e">http_state_e</a> http_state_t; | |
5906 | </p> | |
5907 | <h3 class="typedef"><a id="http_t">http_t</a></h3> | |
5908 | <p class="description">HTTP connection type</p> | |
5909 | <p class="code"> | |
5910 | typedef struct _http_s http_t; | |
5911 | </p> | |
5912 | <h3 class="typedef"><a id="http_timeout_cb_t"><span class="info"> CUPS 1.5/macOS 10.7 </span>http_timeout_cb_t</a></h3> | |
5913 | <p class="description">HTTP timeout callback </p> | |
5914 | <p class="code"> | |
5915 | typedef int(*)(http_t *http, void *user_data)http_timeout_cb_t; | |
5916 | </p> | |
5917 | <h3 class="typedef"><a id="http_trust_t"><span class="info"> CUPS 2.0/OS 10.10 </span>http_trust_t</a></h3> | |
5918 | <p class="description">Level of trust for credentials </p> | |
5919 | <p class="code"> | |
5920 | typedef enum <a href="#http_trust_e">http_trust_e</a> http_trust_t; | |
5921 | </p> | |
5922 | <h3 class="typedef"><a id="http_uri_coding_t">http_uri_coding_t</a></h3> | |
5923 | <p class="description">URI en/decode flags</p> | |
5924 | <p class="code"> | |
5925 | typedef enum <a href="#http_uri_coding_e">http_uri_coding_e</a> http_uri_coding_t; | |
5926 | </p> | |
5927 | <h3 class="typedef"><a id="http_uri_status_t"><span class="info"> CUPS 1.2 </span>http_uri_status_t</a></h3> | |
5928 | <p class="description">URI separation status </p> | |
5929 | <p class="code"> | |
5930 | typedef enum <a href="#http_uri_status_e">http_uri_status_e</a> http_uri_status_t; | |
798d6e29 MS |
5931 | </p> |
5932 | <h3 class="typedef"><a id="ipp_attribute_t">ipp_attribute_t</a></h3> | |
5933 | <p class="description">IPP attribute</p> | |
5934 | <p class="code"> | |
5935 | typedef struct _ipp_attribute_s ipp_attribute_t; | |
5936 | </p> | |
65bebeac MS |
5937 | <h3 class="typedef"><a id="ipp_copycb_t"><span class="info"> CUPS 1.6/macOS 10.8 </span>ipp_copycb_t</a></h3> |
5938 | <p class="description">ippCopyAttributes callback function </p> | |
798d6e29 MS |
5939 | <p class="code"> |
5940 | typedef int(*)(void *context, <a href="#ipp_t">ipp_t</a> *dst, <a href="#ipp_attribute_t">ipp_attribute_t</a> *attr)ipp_copycb_t; | |
798d6e29 MS |
5941 | </p> |
5942 | <h3 class="typedef"><a id="ipp_iocb_t"><span class="info"> CUPS 1.2/macOS 10.5 </span>ipp_iocb_t</a></h3> | |
65bebeac | 5943 | <p class="description">ippReadIO/ippWriteIO callback function </p> |
798d6e29 | 5944 | <p class="code"> |
98d88c8d | 5945 | typedef ssize_t(*)(void *context, ipp_uchar_t *buffer, size_t bytes) ipp_iocb_t; |
798d6e29 MS |
5946 | </p> |
5947 | <h3 class="typedef"><a id="ipp_orient_t">ipp_orient_t</a></h3> | |
5948 | <p class="description">Orientation values</p> | |
5949 | <p class="code"> | |
5950 | typedef enum <a href="#ipp_orient_e">ipp_orient_e</a> ipp_orient_t; | |
5951 | </p> | |
5952 | <h3 class="typedef"><a id="ipp_pstate_t">ipp_pstate_t</a></h3> | |
65bebeac | 5953 | <p class="description">Printer state values</p> |
798d6e29 MS |
5954 | <p class="code"> |
5955 | typedef enum <a href="#ipp_pstate_e">ipp_pstate_e</a> ipp_pstate_t; | |
5956 | </p> | |
5957 | <h3 class="typedef"><a id="ipp_quality_t">ipp_quality_t</a></h3> | |
65bebeac | 5958 | <p class="description">Print quality values</p> |
798d6e29 MS |
5959 | <p class="code"> |
5960 | typedef enum <a href="#ipp_quality_e">ipp_quality_e</a> ipp_quality_t; | |
5961 | </p> | |
5962 | <h3 class="typedef"><a id="ipp_res_t">ipp_res_t</a></h3> | |
5963 | <p class="description">Resolution units</p> | |
5964 | <p class="code"> | |
5965 | typedef enum <a href="#ipp_res_e">ipp_res_e</a> ipp_res_t; | |
06a5a4d3 MS |
5966 | </p> |
5967 | <h3 class="typedef"><a id="ipp_rstate_t">ipp_rstate_t</a></h3> | |
5968 | <p class="description">resource-state values</p> | |
5969 | <p class="code"> | |
5970 | typedef enum <a href="#ipp_rstate_e">ipp_rstate_e</a> ipp_rstate_t; | |
5971 | </p> | |
5972 | <h3 class="typedef"><a id="ipp_sstate_t">ipp_sstate_t</a></h3> | |
5973 | <p class="description">system-state values</p> | |
5974 | <p class="code"> | |
5975 | typedef enum <a href="#ipp_sstate_e">ipp_sstate_e</a> ipp_sstate_t; | |
798d6e29 MS |
5976 | </p> |
5977 | <h3 class="typedef"><a id="ipp_state_t">ipp_state_t</a></h3> | |
65bebeac | 5978 | <p class="description">ipp_t state values</p> |
798d6e29 MS |
5979 | <p class="code"> |
5980 | typedef enum <a href="#ipp_state_e">ipp_state_e</a> ipp_state_t; | |
5981 | </p> | |
5982 | <h3 class="typedef"><a id="ipp_t">ipp_t</a></h3> | |
5983 | <p class="description">IPP request/response data</p> | |
5984 | <p class="code"> | |
5985 | typedef struct _ipp_s ipp_t; | |
798d6e29 MS |
5986 | </p> |
5987 | <h2 class="title"><a id="STRUCTURES">Structures</a></h2> | |
798d6e29 MS |
5988 | <h3 class="struct"><a id="cups_dest_s">cups_dest_s</a></h3> |
5989 | <p class="description">Destination</p> | |
5990 | <p class="code">struct cups_dest_s {<br> | |
5991 |     char *name, *instance;<br> | |
5992 |     int is_default;<br> | |
5993 |     int num_options;<br> | |
5994 |     <a href="#cups_option_t">cups_option_t</a> *options;<br> | |
5995 | };</p> | |
5996 | <h4 class="members">Members</h4> | |
98d88c8d MS |
5997 | <table class="list"><tbody> |
5998 | <tr><th>instance </th> | |
5999 | <td class="description">Local instance name or NULL</td></tr> | |
6000 | <tr><th>is_default </th> | |
6001 | <td class="description">Is this printer the default?</td></tr> | |
6002 | <tr><th>num_options </th> | |
6003 | <td class="description">Number of options</td></tr> | |
6004 | <tr><th>options </th> | |
6005 | <td class="description">Options</td></tr> | |
6006 | </tbody></table> | |
798d6e29 MS |
6007 | <h3 class="struct"><a id="cups_job_s">cups_job_s</a></h3> |
6008 | <p class="description">Job</p> | |
6009 | <p class="code">struct cups_job_s {<br> | |
6010 |     time_t completed_time;<br> | |
6011 |     time_t creation_time;<br> | |
6012 |     char *dest;<br> | |
6013 |     char *format;<br> | |
6014 |     int id;<br> | |
6015 |     int priority;<br> | |
6016 |     time_t processing_time;<br> | |
6017 |     int size;<br> | |
6018 |     ipp_jstate_t state;<br> | |
6019 |     char *title;<br> | |
6020 |     char *user;<br> | |
6021 | };</p> | |
6022 | <h4 class="members">Members</h4> | |
98d88c8d MS |
6023 | <table class="list"><tbody> |
6024 | <tr><th>completed_time </th> | |
6025 | <td class="description">Time the job was completed</td></tr> | |
6026 | <tr><th>creation_time </th> | |
6027 | <td class="description">Time the job was created</td></tr> | |
6028 | <tr><th>dest </th> | |
6029 | <td class="description">Printer or class name</td></tr> | |
6030 | <tr><th>format </th> | |
6031 | <td class="description">Document format</td></tr> | |
6032 | <tr><th>id </th> | |
6033 | <td class="description">The job ID</td></tr> | |
6034 | <tr><th>priority </th> | |
6035 | <td class="description">Priority (1-100)</td></tr> | |
6036 | <tr><th>processing_time </th> | |
6037 | <td class="description">Time the job was processed</td></tr> | |
6038 | <tr><th>size </th> | |
6039 | <td class="description">Size in kilobytes</td></tr> | |
6040 | <tr><th>state </th> | |
6041 | <td class="description">Job state</td></tr> | |
6042 | <tr><th>title </th> | |
6043 | <td class="description">Title/job name</td></tr> | |
6044 | <tr><th>user </th> | |
6045 | <td class="description">User that submitted the job</td></tr> | |
6046 | </tbody></table> | |
798d6e29 MS |
6047 | <h3 class="struct"><a id="cups_option_s">cups_option_s</a></h3> |
6048 | <p class="description">Printer Options</p> | |
6049 | <p class="code">struct cups_option_s {<br> | |
6050 |     char *name;<br> | |
6051 |     char *value;<br> | |
6052 | };</p> | |
6053 | <h4 class="members">Members</h4> | |
98d88c8d MS |
6054 | <table class="list"><tbody> |
6055 | <tr><th>name </th> | |
6056 | <td class="description">Name of option</td></tr> | |
6057 | <tr><th>value </th> | |
6058 | <td class="description">Value of option</td></tr> | |
6059 | </tbody></table> | |
798d6e29 MS |
6060 | <h3 class="struct"><span class="info"> CUPS 1.6/macOS 10.8 </span><a id="cups_size_s">cups_size_s</a></h3> |
6061 | <p class="description">Media Size </p> | |
6062 | <p class="code">struct cups_size_s {<br> | |
6063 |     char media[128];<br> | |
6064 |     int width, length, bottom, left, right, top;<br> | |
6065 | };</p> | |
6066 | <h4 class="members">Members</h4> | |
98d88c8d MS |
6067 | <table class="list"><tbody> |
6068 | <tr><th>media[128] </th> | |
6069 | <td class="description">Media name to use</td></tr> | |
6070 | <tr><th>top </th> | |
6071 | <td class="description">Top margin in hundredths of | |
6072 | millimeters</td></tr> | |
6073 | </tbody></table> | |
73721e3e MS |
6074 | <h2 class="title"><a id="VARIABLES">Variables</a></h2> |
6075 | <h3 class="variable"><a id="kSecOidOrganizationalUnit">kSecOidOrganizationalUnit</a></h3> | |
6076 | <p class="description">Constants, very secure stuff...</p> | |
6077 | <p class="code">extern const void *kSecOidOrganizationalUnit;</p> | |
798d6e29 | 6078 | <h2 class="title"><a id="ENUMERATIONS">Constants</a></h2> |
798d6e29 MS |
6079 | <h3 class="enumeration"><a id="cups_ptype_e">cups_ptype_e</a></h3> |
6080 | <p class="description">Printer type/capability bit | |
6081 | constants</p> | |
6082 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6083 | <table class="list"><tbody> |
6084 | <tr><th>CUPS_PRINTER_AUTHENTICATED <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer requires authentication | |
6085 | </td></tr> | |
6086 | <tr><th>CUPS_PRINTER_BIND </th> <td class="description">Can bind output</td></tr> | |
6087 | <tr><th>CUPS_PRINTER_BW </th> <td class="description">Can do B&W printing</td></tr> | |
6088 | <tr><th>CUPS_PRINTER_CLASS </th> <td class="description">Printer class</td></tr> | |
6089 | <tr><th>CUPS_PRINTER_COLLATE </th> <td class="description">Can quickly collate copies</td></tr> | |
6090 | <tr><th>CUPS_PRINTER_COLOR </th> <td class="description">Can do color printing</td></tr> | |
6091 | <tr><th>CUPS_PRINTER_COMMANDS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer supports maintenance commands | |
6092 | </td></tr> | |
6093 | <tr><th>CUPS_PRINTER_COPIES </th> <td class="description">Can do copies in hardware</td></tr> | |
6094 | <tr><th>CUPS_PRINTER_COVER </th> <td class="description">Can cover output</td></tr> | |
6095 | <tr><th>CUPS_PRINTER_DEFAULT </th> <td class="description">Default printer on network</td></tr> | |
6096 | <tr><th>CUPS_PRINTER_DISCOVERED <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer was discovered </td></tr> | |
6097 | <tr><th>CUPS_PRINTER_DUPLEX </th> <td class="description">Can do two-sided printing</td></tr> | |
6098 | <tr><th>CUPS_PRINTER_FAX </th> <td class="description">Fax queue</td></tr> | |
6099 | <tr><th>CUPS_PRINTER_LARGE </th> <td class="description">Can print on D/E/A1/A0-size media</td></tr> | |
6100 | <tr><th>CUPS_PRINTER_LOCAL </th> <td class="description">Local printer or class</td></tr> | |
6101 | <tr><th>CUPS_PRINTER_MEDIUM </th> <td class="description">Can print on Tabloid/B/C/A3/A2-size media</td></tr> | |
6102 | <tr><th>CUPS_PRINTER_NOT_SHARED <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Printer is not shared | |
6103 | </td></tr> | |
6104 | <tr><th>CUPS_PRINTER_PUNCH </th> <td class="description">Can punch output</td></tr> | |
6105 | <tr><th>CUPS_PRINTER_REJECTING </th> <td class="description">Printer is rejecting jobs</td></tr> | |
6106 | <tr><th>CUPS_PRINTER_REMOTE </th> <td class="description">Remote printer or class</td></tr> | |
6107 | <tr><th>CUPS_PRINTER_SMALL </th> <td class="description">Can print on Letter/Legal/A4-size media</td></tr> | |
6108 | <tr><th>CUPS_PRINTER_SORT </th> <td class="description">Can sort output</td></tr> | |
6109 | <tr><th>CUPS_PRINTER_STAPLE </th> <td class="description">Can staple output</td></tr> | |
6110 | <tr><th>CUPS_PRINTER_VARIABLE </th> <td class="description">Can print on rolls and custom-size media</td></tr> | |
6111 | </tbody></table> | |
798d6e29 MS |
6112 | <h3 class="enumeration"><a id="http_encoding_e">http_encoding_e</a></h3> |
6113 | <p class="description">HTTP transfer encoding values</p> | |
6114 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6115 | <table class="list"><tbody> |
6116 | <tr><th>HTTP_ENCODING_CHUNKED </th> <td class="description">Data is chunked</td></tr> | |
6117 | <tr><th>HTTP_ENCODING_FIELDS </th> <td class="description">Sending HTTP fields</td></tr> | |
6118 | <tr><th>HTTP_ENCODING_LENGTH </th> <td class="description">Data is sent with Content-Length</td></tr> | |
6119 | </tbody></table> | |
798d6e29 MS |
6120 | <h3 class="enumeration"><a id="http_encryption_e">http_encryption_e</a></h3> |
6121 | <p class="description">HTTP encryption values</p> | |
6122 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6123 | <table class="list"><tbody> |
6124 | <tr><th>HTTP_ENCRYPTION_ALWAYS </th> <td class="description">Always encrypt (SSL)</td></tr> | |
6125 | <tr><th>HTTP_ENCRYPTION_IF_REQUESTED </th> <td class="description">Encrypt if requested (TLS upgrade)</td></tr> | |
6126 | <tr><th>HTTP_ENCRYPTION_NEVER </th> <td class="description">Never encrypt</td></tr> | |
6127 | <tr><th>HTTP_ENCRYPTION_REQUIRED </th> <td class="description">Encryption is required (TLS upgrade)</td></tr> | |
6128 | </tbody></table> | |
798d6e29 MS |
6129 | <h3 class="enumeration"><a id="http_field_e">http_field_e</a></h3> |
6130 | <p class="description">HTTP field names</p> | |
6131 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6132 | <table class="list"><tbody> |
6133 | <tr><th>HTTP_FIELD_ACCEPT_ENCODING <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Accepting-Encoding field </td></tr> | |
6134 | <tr><th>HTTP_FIELD_ACCEPT_LANGUAGE </th> <td class="description">Accept-Language field</td></tr> | |
6135 | <tr><th>HTTP_FIELD_ACCEPT_RANGES </th> <td class="description">Accept-Ranges field</td></tr> | |
6136 | <tr><th>HTTP_FIELD_ALLOW <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Allow field </td></tr> | |
73721e3e | 6137 | <tr><th>HTTP_FIELD_AUTHENTICATION_INFO <span class="info"> CUPS 2.2.9) </span></th> <td class="description">Authentication-Info field (</td></tr> |
98d88c8d MS |
6138 | <tr><th>HTTP_FIELD_AUTHORIZATION </th> <td class="description">Authorization field</td></tr> |
6139 | <tr><th>HTTP_FIELD_CONNECTION </th> <td class="description">Connection field</td></tr> | |
6140 | <tr><th>HTTP_FIELD_CONTENT_ENCODING </th> <td class="description">Content-Encoding field</td></tr> | |
6141 | <tr><th>HTTP_FIELD_CONTENT_LANGUAGE </th> <td class="description">Content-Language field</td></tr> | |
6142 | <tr><th>HTTP_FIELD_CONTENT_LENGTH </th> <td class="description">Content-Length field</td></tr> | |
6143 | <tr><th>HTTP_FIELD_CONTENT_LOCATION </th> <td class="description">Content-Location field</td></tr> | |
6144 | <tr><th>HTTP_FIELD_CONTENT_MD5 </th> <td class="description">Content-MD5 field</td></tr> | |
6145 | <tr><th>HTTP_FIELD_CONTENT_RANGE </th> <td class="description">Content-Range field</td></tr> | |
6146 | <tr><th>HTTP_FIELD_CONTENT_TYPE </th> <td class="description">Content-Type field</td></tr> | |
6147 | <tr><th>HTTP_FIELD_CONTENT_VERSION </th> <td class="description">Content-Version field</td></tr> | |
6148 | <tr><th>HTTP_FIELD_DATE </th> <td class="description">Date field</td></tr> | |
6149 | <tr><th>HTTP_FIELD_HOST </th> <td class="description">Host field</td></tr> | |
6150 | <tr><th>HTTP_FIELD_IF_MODIFIED_SINCE </th> <td class="description">If-Modified-Since field</td></tr> | |
6151 | <tr><th>HTTP_FIELD_IF_UNMODIFIED_SINCE </th> <td class="description">If-Unmodified-Since field</td></tr> | |
6152 | <tr><th>HTTP_FIELD_KEEP_ALIVE </th> <td class="description">Keep-Alive field</td></tr> | |
6153 | <tr><th>HTTP_FIELD_LAST_MODIFIED </th> <td class="description">Last-Modified field</td></tr> | |
6154 | <tr><th>HTTP_FIELD_LINK </th> <td class="description">Link field</td></tr> | |
6155 | <tr><th>HTTP_FIELD_LOCATION </th> <td class="description">Location field</td></tr> | |
6156 | <tr><th>HTTP_FIELD_MAX </th> <td class="description">Maximum field index</td></tr> | |
6157 | <tr><th>HTTP_FIELD_RANGE </th> <td class="description">Range field</td></tr> | |
6158 | <tr><th>HTTP_FIELD_REFERER </th> <td class="description">Referer field</td></tr> | |
6159 | <tr><th>HTTP_FIELD_RETRY_AFTER </th> <td class="description">Retry-After field</td></tr> | |
6160 | <tr><th>HTTP_FIELD_SERVER <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Server field </td></tr> | |
6161 | <tr><th>HTTP_FIELD_TRANSFER_ENCODING </th> <td class="description">Transfer-Encoding field</td></tr> | |
6162 | <tr><th>HTTP_FIELD_UNKNOWN </th> <td class="description">Unknown field</td></tr> | |
6163 | <tr><th>HTTP_FIELD_UPGRADE </th> <td class="description">Upgrade field</td></tr> | |
6164 | <tr><th>HTTP_FIELD_USER_AGENT </th> <td class="description">User-Agent field</td></tr> | |
6165 | <tr><th>HTTP_FIELD_WWW_AUTHENTICATE </th> <td class="description">WWW-Authenticate field</td></tr> | |
6166 | </tbody></table> | |
798d6e29 MS |
6167 | <h3 class="enumeration"><a id="http_keepalive_e">http_keepalive_e</a></h3> |
6168 | <p class="description">HTTP keep-alive values</p> | |
6169 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6170 | <table class="list"><tbody> |
6171 | <tr><th>HTTP_KEEPALIVE_OFF </th> <td class="description">No keep alive support</td></tr> | |
6172 | <tr><th>HTTP_KEEPALIVE_ON </th> <td class="description">Use keep alive</td></tr> | |
6173 | </tbody></table> | |
798d6e29 MS |
6174 | <h3 class="enumeration"><a id="http_state_e">http_state_e</a></h3> |
6175 | <p class="description">HTTP state values; states | |
6176 | are server-oriented...</p> | |
6177 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6178 | <table class="list"><tbody> |
6179 | <tr><th>HTTP_STATE_CONNECT </th> <td class="description">CONNECT command, waiting for blank line</td></tr> | |
6180 | <tr><th>HTTP_STATE_DELETE </th> <td class="description">DELETE command, waiting for blank line</td></tr> | |
6181 | <tr><th>HTTP_STATE_ERROR </th> <td class="description">Error on socket</td></tr> | |
6182 | <tr><th>HTTP_STATE_GET </th> <td class="description">GET command, waiting for blank line</td></tr> | |
6183 | <tr><th>HTTP_STATE_GET_SEND </th> <td class="description">GET command, sending data</td></tr> | |
6184 | <tr><th>HTTP_STATE_HEAD </th> <td class="description">HEAD command, waiting for blank line</td></tr> | |
6185 | <tr><th>HTTP_STATE_OPTIONS </th> <td class="description">OPTIONS command, waiting for blank line</td></tr> | |
6186 | <tr><th>HTTP_STATE_POST </th> <td class="description">POST command, waiting for blank line</td></tr> | |
6187 | <tr><th>HTTP_STATE_POST_RECV </th> <td class="description">POST command, receiving data</td></tr> | |
6188 | <tr><th>HTTP_STATE_POST_SEND </th> <td class="description">POST command, sending data</td></tr> | |
6189 | <tr><th>HTTP_STATE_PUT </th> <td class="description">PUT command, waiting for blank line</td></tr> | |
6190 | <tr><th>HTTP_STATE_PUT_RECV </th> <td class="description">PUT command, receiving data</td></tr> | |
6191 | <tr><th>HTTP_STATE_STATUS </th> <td class="description">Command complete, sending status</td></tr> | |
6192 | <tr><th>HTTP_STATE_TRACE </th> <td class="description">TRACE command, waiting for blank line</td></tr> | |
6193 | <tr><th>HTTP_STATE_UNKNOWN_METHOD <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Unknown request method, waiting for blank line </td></tr> | |
6194 | <tr><th>HTTP_STATE_UNKNOWN_VERSION <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">Unknown request method, waiting for blank line </td></tr> | |
6195 | <tr><th>HTTP_STATE_WAITING </th> <td class="description">Waiting for command</td></tr> | |
6196 | </tbody></table> | |
798d6e29 MS |
6197 | <h3 class="enumeration"><a id="http_status_e">http_status_e</a></h3> |
6198 | <p class="description">HTTP status codes</p> | |
6199 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6200 | <table class="list"><tbody> |
6201 | <tr><th>HTTP_STATUS_ACCEPTED </th> <td class="description">DELETE command was successful</td></tr> | |
6202 | <tr><th>HTTP_STATUS_BAD_GATEWAY </th> <td class="description">Bad gateway</td></tr> | |
6203 | <tr><th>HTTP_STATUS_BAD_REQUEST </th> <td class="description">Bad request</td></tr> | |
6204 | <tr><th>HTTP_STATUS_CONFLICT </th> <td class="description">Request is self-conflicting</td></tr> | |
6205 | <tr><th>HTTP_STATUS_CONTINUE </th> <td class="description">Everything OK, keep going...</td></tr> | |
6206 | <tr><th>HTTP_STATUS_CREATED </th> <td class="description">PUT command was successful</td></tr> | |
6207 | <tr><th>HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED <span class="info"> CUPS 1.4 </span></th> <td class="description">User canceled authorization </td></tr> | |
6208 | <tr><th>HTTP_STATUS_CUPS_PKI_ERROR <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">Error negotiating a secure connection </td></tr> | |
6209 | <tr><th>HTTP_STATUS_ERROR </th> <td class="description">An error response from httpXxxx()</td></tr> | |
6210 | <tr><th>HTTP_STATUS_EXPECTATION_FAILED </th> <td class="description">The expectation given in an Expect header field was not met</td></tr> | |
6211 | <tr><th>HTTP_STATUS_FORBIDDEN </th> <td class="description">Forbidden to access this URI</td></tr> | |
699fe020 | 6212 | <tr><th>HTTP_STATUS_FOUND </th> <td class="description">Document was found at a different URI</td></tr> |
98d88c8d MS |
6213 | <tr><th>HTTP_STATUS_GATEWAY_TIMEOUT </th> <td class="description">Gateway connection timed out</td></tr> |
6214 | <tr><th>HTTP_STATUS_GONE </th> <td class="description">Server has gone away</td></tr> | |
6215 | <tr><th>HTTP_STATUS_LENGTH_REQUIRED </th> <td class="description">A content length or encoding is required</td></tr> | |
6216 | <tr><th>HTTP_STATUS_METHOD_NOT_ALLOWED </th> <td class="description">Method is not allowed</td></tr> | |
6217 | <tr><th>HTTP_STATUS_MOVED_PERMANENTLY </th> <td class="description">Document has moved permanently</td></tr> | |
98d88c8d MS |
6218 | <tr><th>HTTP_STATUS_MULTIPLE_CHOICES </th> <td class="description">Multiple files match request</td></tr> |
6219 | <tr><th>HTTP_STATUS_NONE <span class="info"> CUPS 1.7/macOS 10.9 </span></th> <td class="description">No Expect value </td></tr> | |
6220 | <tr><th>HTTP_STATUS_NOT_ACCEPTABLE </th> <td class="description">Not Acceptable</td></tr> | |
6221 | <tr><th>HTTP_STATUS_NOT_AUTHORITATIVE </th> <td class="description">Information isn't authoritative</td></tr> | |
6222 | <tr><th>HTTP_STATUS_NOT_FOUND </th> <td class="description">URI was not found</td></tr> | |
6223 | <tr><th>HTTP_STATUS_NOT_IMPLEMENTED </th> <td class="description">Feature not implemented</td></tr> | |
6224 | <tr><th>HTTP_STATUS_NOT_MODIFIED </th> <td class="description">File not modified</td></tr> | |
6225 | <tr><th>HTTP_STATUS_NOT_SUPPORTED </th> <td class="description">HTTP version not supported</td></tr> | |
6226 | <tr><th>HTTP_STATUS_NO_CONTENT </th> <td class="description">Successful command, no new data</td></tr> | |
6227 | <tr><th>HTTP_STATUS_OK </th> <td class="description">OPTIONS/GET/HEAD/POST/TRACE command was successful</td></tr> | |
6228 | <tr><th>HTTP_STATUS_PARTIAL_CONTENT </th> <td class="description">Only a partial file was received/sent</td></tr> | |
6229 | <tr><th>HTTP_STATUS_PAYMENT_REQUIRED </th> <td class="description">Payment required</td></tr> | |
6230 | <tr><th>HTTP_STATUS_PRECONDITION </th> <td class="description">Precondition failed</td></tr> | |
6231 | <tr><th>HTTP_STATUS_PROXY_AUTHENTICATION </th> <td class="description">Proxy Authentication is Required</td></tr> | |
6232 | <tr><th>HTTP_STATUS_REQUESTED_RANGE </th> <td class="description">The requested range is not satisfiable</td></tr> | |
6233 | <tr><th>HTTP_STATUS_REQUEST_TIMEOUT </th> <td class="description">Request timed out</td></tr> | |
6234 | <tr><th>HTTP_STATUS_REQUEST_TOO_LARGE </th> <td class="description">Request entity too large</td></tr> | |
6235 | <tr><th>HTTP_STATUS_RESET_CONTENT </th> <td class="description">Content was reset/recreated</td></tr> | |
699fe020 | 6236 | <tr><th>HTTP_STATUS_SEE_OTHER </th> <td class="description">See this other link</td></tr> |
98d88c8d MS |
6237 | <tr><th>HTTP_STATUS_SERVER_ERROR </th> <td class="description">Internal server error</td></tr> |
6238 | <tr><th>HTTP_STATUS_SERVICE_UNAVAILABLE </th> <td class="description">Service is unavailable</td></tr> | |
6239 | <tr><th>HTTP_STATUS_SWITCHING_PROTOCOLS </th> <td class="description">HTTP upgrade to TLS/SSL</td></tr> | |
699fe020 | 6240 | <tr><th>HTTP_STATUS_TEMPORARY_REDIRECT </th> <td class="description">Temporary redirection</td></tr> |
98d88c8d MS |
6241 | <tr><th>HTTP_STATUS_UNAUTHORIZED </th> <td class="description">Unauthorized to access host</td></tr> |
6242 | <tr><th>HTTP_STATUS_UNSUPPORTED_MEDIATYPE </th> <td class="description">The requested media type is unsupported</td></tr> | |
6243 | <tr><th>HTTP_STATUS_UPGRADE_REQUIRED </th> <td class="description">Upgrade to SSL/TLS required</td></tr> | |
6244 | <tr><th>HTTP_STATUS_URI_TOO_LONG </th> <td class="description">URI too long</td></tr> | |
6245 | <tr><th>HTTP_STATUS_USE_PROXY </th> <td class="description">Must use a proxy to access this URI</td></tr> | |
6246 | </tbody></table> | |
798d6e29 MS |
6247 | <h3 class="enumeration"><a id="http_trust_e"><span class="info"> CUPS 2.0/OS 10.10 </span>http_trust_e</a></h3> |
6248 | <p class="description">Level of trust for credentials </p> | |
6249 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6250 | <table class="list"><tbody> |
6251 | <tr><th>HTTP_TRUST_CHANGED </th> <td class="description">Credentials have changed</td></tr> | |
6252 | <tr><th>HTTP_TRUST_EXPIRED </th> <td class="description">Credentials are expired</td></tr> | |
6253 | <tr><th>HTTP_TRUST_INVALID </th> <td class="description">Credentials are invalid</td></tr> | |
6254 | <tr><th>HTTP_TRUST_OK </th> <td class="description">Credentials are OK/trusted</td></tr> | |
6255 | <tr><th>HTTP_TRUST_RENEWED </th> <td class="description">Credentials have been renewed</td></tr> | |
6256 | <tr><th>HTTP_TRUST_UNKNOWN </th> <td class="description">Credentials are unknown/new</td></tr> | |
6257 | </tbody></table> | |
798d6e29 MS |
6258 | <h3 class="enumeration"><a id="http_uri_coding_e">http_uri_coding_e</a></h3> |
6259 | <p class="description">URI en/decode flags</p> | |
6260 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6261 | <table class="list"><tbody> |
6262 | <tr><th>HTTP_URI_CODING_ALL </th> <td class="description">En/decode everything</td></tr> | |
6263 | <tr><th>HTTP_URI_CODING_HOSTNAME </th> <td class="description">En/decode the hostname portion</td></tr> | |
6264 | <tr><th>HTTP_URI_CODING_MOST </th> <td class="description">En/decode all but the query</td></tr> | |
6265 | <tr><th>HTTP_URI_CODING_NONE </th> <td class="description">Don't en/decode anything</td></tr> | |
6266 | <tr><th>HTTP_URI_CODING_QUERY </th> <td class="description">En/decode the query portion</td></tr> | |
6267 | <tr><th>HTTP_URI_CODING_RESOURCE </th> <td class="description">En/decode the resource portion</td></tr> | |
6268 | <tr><th>HTTP_URI_CODING_RFC6874 </th> <td class="description">Use RFC 6874 address format</td></tr> | |
6269 | <tr><th>HTTP_URI_CODING_USERNAME </th> <td class="description">En/decode the username portion</td></tr> | |
6270 | </tbody></table> | |
798d6e29 MS |
6271 | <h3 class="enumeration"><a id="http_uri_status_e"><span class="info"> CUPS 1.2 </span>http_uri_status_e</a></h3> |
6272 | <p class="description">URI separation status </p> | |
6273 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6274 | <table class="list"><tbody> |
6275 | <tr><th>HTTP_URI_STATUS_BAD_ARGUMENTS </th> <td class="description">Bad arguments to function (error)</td></tr> | |
6276 | <tr><th>HTTP_URI_STATUS_BAD_HOSTNAME </th> <td class="description">Bad hostname in URI (error)</td></tr> | |
6277 | <tr><th>HTTP_URI_STATUS_BAD_PORT </th> <td class="description">Bad port number in URI (error)</td></tr> | |
6278 | <tr><th>HTTP_URI_STATUS_BAD_RESOURCE </th> <td class="description">Bad resource in URI (error)</td></tr> | |
6279 | <tr><th>HTTP_URI_STATUS_BAD_SCHEME </th> <td class="description">Bad scheme in URI (error)</td></tr> | |
6280 | <tr><th>HTTP_URI_STATUS_BAD_URI </th> <td class="description">Bad/empty URI (error)</td></tr> | |
6281 | <tr><th>HTTP_URI_STATUS_BAD_USERNAME </th> <td class="description">Bad username in URI (error)</td></tr> | |
6282 | <tr><th>HTTP_URI_STATUS_MISSING_RESOURCE </th> <td class="description">Missing resource in URI (warning)</td></tr> | |
6283 | <tr><th>HTTP_URI_STATUS_MISSING_SCHEME </th> <td class="description">Missing scheme in URI (warning)</td></tr> | |
6284 | <tr><th>HTTP_URI_STATUS_OK </th> <td class="description">URI decoded OK</td></tr> | |
6285 | <tr><th>HTTP_URI_STATUS_OVERFLOW </th> <td class="description">URI buffer for httpAssembleURI is too small</td></tr> | |
6286 | <tr><th>HTTP_URI_STATUS_UNKNOWN_SCHEME </th> <td class="description">Unknown scheme in URI (warning)</td></tr> | |
6287 | </tbody></table> | |
798d6e29 | 6288 | <h3 class="enumeration"><a id="ipp_finishings_e">ipp_finishings_e</a></h3> |
718ee2ff | 6289 | <p class="description">Finishings values</p> |
798d6e29 | 6290 | <h4 class="constants">Constants</h4> |
98d88c8d MS |
6291 | <table class="list"><tbody> |
6292 | <tr><th>IPP_FINISHINGS_BALE </th> <td class="description">Bale (any type)</td></tr> | |
6293 | <tr><th>IPP_FINISHINGS_BIND </th> <td class="description">Bind</td></tr> | |
6294 | <tr><th>IPP_FINISHINGS_BIND_BOTTOM </th> <td class="description">Bind on bottom</td></tr> | |
6295 | <tr><th>IPP_FINISHINGS_BIND_LEFT </th> <td class="description">Bind on left</td></tr> | |
6296 | <tr><th>IPP_FINISHINGS_BIND_RIGHT </th> <td class="description">Bind on right</td></tr> | |
6297 | <tr><th>IPP_FINISHINGS_BIND_TOP </th> <td class="description">Bind on top</td></tr> | |
6298 | <tr><th>IPP_FINISHINGS_BOOKLET_MAKER </th> <td class="description">Fold to make booklet</td></tr> | |
6299 | <tr><th>IPP_FINISHINGS_COAT </th> <td class="description">Apply protective liquid or powder coating</td></tr> | |
6300 | <tr><th>IPP_FINISHINGS_COVER </th> <td class="description">Add cover</td></tr> | |
6301 | <tr><th>IPP_FINISHINGS_EDGE_STITCH </th> <td class="description">Stitch along any side</td></tr> | |
6302 | <tr><th>IPP_FINISHINGS_EDGE_STITCH_BOTTOM </th> <td class="description">Stitch along bottom edge</td></tr> | |
6303 | <tr><th>IPP_FINISHINGS_EDGE_STITCH_LEFT </th> <td class="description">Stitch along left side</td></tr> | |
6304 | <tr><th>IPP_FINISHINGS_EDGE_STITCH_RIGHT </th> <td class="description">Stitch along right side</td></tr> | |
6305 | <tr><th>IPP_FINISHINGS_EDGE_STITCH_TOP </th> <td class="description">Stitch along top edge</td></tr> | |
6306 | <tr><th>IPP_FINISHINGS_FOLD </th> <td class="description">Fold (any type)</td></tr> | |
6307 | <tr><th>IPP_FINISHINGS_FOLD_ACCORDIAN </th> <td class="description">Accordian-fold the paper vertically into four sections</td></tr> | |
6308 | <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> | |
6309 | <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> | |
6310 | <tr><th>IPP_FINISHINGS_FOLD_GATE </th> <td class="description">Fold the top and bottom quarters of the paper towards the midline</td></tr> | |
6311 | <tr><th>IPP_FINISHINGS_FOLD_HALF </th> <td class="description">Fold the paper in half vertically</td></tr> | |
6312 | <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> | |
6313 | <tr><th>IPP_FINISHINGS_FOLD_LEFT_GATE </th> <td class="description">Fold the top quarter of the paper towards the midline</td></tr> | |
6314 | <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> | |
6315 | <tr><th>IPP_FINISHINGS_FOLD_PARALLEL </th> <td class="description">Fold the paper in half vertically two times, yielding four sections</td></tr> | |
6316 | <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> | |
6317 | <tr><th>IPP_FINISHINGS_FOLD_RIGHT_GATE </th> <td class="description">Fold the bottom quarter of the paper towards the midline</td></tr> | |
6318 | <tr><th>IPP_FINISHINGS_FOLD_Z </th> <td class="description">Fold the paper vertically into three sections, forming a Z</td></tr> | |
6319 | <tr><th>IPP_FINISHINGS_JOG_OFFSET </th> <td class="description">Offset for binding (any type)</td></tr> | |
6320 | <tr><th>IPP_FINISHINGS_LAMINATE </th> <td class="description">Apply protective (solid) material</td></tr> | |
6321 | <tr><th>IPP_FINISHINGS_NONE </th> <td class="description">No finishing</td></tr> | |
6322 | <tr><th>IPP_FINISHINGS_PUNCH </th> <td class="description">Punch (any location/count)</td></tr> | |
6323 | <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_LEFT </th> <td class="description">Punch 1 hole bottom left</td></tr> | |
6324 | <tr><th>IPP_FINISHINGS_PUNCH_BOTTOM_RIGHT </th> <td class="description">Punch 1 hole bottom right</td></tr> | |
6325 | <tr><th>IPP_FINISHINGS_PUNCH_DUAL_BOTTOM </th> <td class="description">Punch 2 holes bottom edge</td></tr> | |
6326 | <tr><th>IPP_FINISHINGS_PUNCH_DUAL_LEFT </th> <td class="description">Punch 2 holes left side</td></tr> | |
6327 | <tr><th>IPP_FINISHINGS_PUNCH_DUAL_RIGHT </th> <td class="description">Punch 2 holes right side</td></tr> | |
6328 | <tr><th>IPP_FINISHINGS_PUNCH_DUAL_TOP </th> <td class="description">Punch 2 holes top edge</td></tr> | |
6329 | <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_BOTTOM </th> <td class="description">Pucnh multiple holes bottom edge</td></tr> | |
6330 | <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_LEFT </th> <td class="description">Pucnh multiple holes left side</td></tr> | |
6331 | <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_RIGHT </th> <td class="description">Pucnh multiple holes right side</td></tr> | |
6332 | <tr><th>IPP_FINISHINGS_PUNCH_MULTIPLE_TOP </th> <td class="description">Pucnh multiple holes top edge</td></tr> | |
6333 | <tr><th>IPP_FINISHINGS_PUNCH_QUAD_BOTTOM </th> <td class="description">Punch 4 holes bottom edge</td></tr> | |
6334 | <tr><th>IPP_FINISHINGS_PUNCH_QUAD_LEFT </th> <td class="description">Punch 4 holes left side</td></tr> | |
6335 | <tr><th>IPP_FINISHINGS_PUNCH_QUAD_RIGHT </th> <td class="description">Punch 4 holes right side</td></tr> | |
6336 | <tr><th>IPP_FINISHINGS_PUNCH_QUAD_TOP </th> <td class="description">Punch 4 holes top edge</td></tr> | |
6337 | <tr><th>IPP_FINISHINGS_PUNCH_TOP_LEFT </th> <td class="description">Punch 1 hole top left</td></tr> | |
6338 | <tr><th>IPP_FINISHINGS_PUNCH_TOP_RIGHT </th> <td class="description">Punch 1 hole top right</td></tr> | |
6339 | <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_BOTTOM </th> <td class="description">Punch 3 holes bottom edge</td></tr> | |
6340 | <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_LEFT </th> <td class="description">Punch 3 holes left side</td></tr> | |
6341 | <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_RIGHT </th> <td class="description">Punch 3 holes right side</td></tr> | |
6342 | <tr><th>IPP_FINISHINGS_PUNCH_TRIPLE_TOP </th> <td class="description">Punch 3 holes top edge</td></tr> | |
6343 | <tr><th>IPP_FINISHINGS_SADDLE_STITCH </th> <td class="description">Staple interior</td></tr> | |
6344 | <tr><th>IPP_FINISHINGS_STAPLE </th> <td class="description">Staple (any location/method)</td></tr> | |
6345 | <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_LEFT </th> <td class="description">Staple bottom left corner</td></tr> | |
6346 | <tr><th>IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT </th> <td class="description">Staple bottom right corner</td></tr> | |
6347 | <tr><th>IPP_FINISHINGS_STAPLE_DUAL_BOTTOM </th> <td class="description">Two staples on bottom</td></tr> | |
6348 | <tr><th>IPP_FINISHINGS_STAPLE_DUAL_LEFT </th> <td class="description">Two staples on left</td></tr> | |
6349 | <tr><th>IPP_FINISHINGS_STAPLE_DUAL_RIGHT </th> <td class="description">Two staples on right</td></tr> | |
6350 | <tr><th>IPP_FINISHINGS_STAPLE_DUAL_TOP </th> <td class="description">Two staples on top</td></tr> | |
6351 | <tr><th>IPP_FINISHINGS_STAPLE_TOP_LEFT </th> <td class="description">Staple top left corner</td></tr> | |
6352 | <tr><th>IPP_FINISHINGS_STAPLE_TOP_RIGHT </th> <td class="description">Staple top right corner</td></tr> | |
6353 | <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_BOTTOM </th> <td class="description">Three staples on bottom</td></tr> | |
6354 | <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_LEFT </th> <td class="description">Three staples on left</td></tr> | |
6355 | <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_RIGHT </th> <td class="description">Three staples on right</td></tr> | |
6356 | <tr><th>IPP_FINISHINGS_STAPLE_TRIPLE_TOP </th> <td class="description">Three staples on top</td></tr> | |
6357 | <tr><th>IPP_FINISHINGS_TRIM </th> <td class="description">Trim (any type)</td></tr> | |
6358 | <tr><th>IPP_FINISHINGS_TRIM_AFTER_COPIES </th> <td class="description">Trim output after each copy</td></tr> | |
6359 | <tr><th>IPP_FINISHINGS_TRIM_AFTER_DOCUMENTS </th> <td class="description">Trim output after each document</td></tr> | |
6360 | <tr><th>IPP_FINISHINGS_TRIM_AFTER_JOB </th> <td class="description">Trim output after job</td></tr> | |
6361 | <tr><th>IPP_FINISHINGS_TRIM_AFTER_PAGES </th> <td class="description">Trim output after each page</td></tr> | |
6362 | </tbody></table> | |
798d6e29 MS |
6363 | <h3 class="enumeration"><a id="ipp_jstate_e">ipp_jstate_e</a></h3> |
6364 | <p class="description">Job states</p> | |
6365 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6366 | <table class="list"><tbody> |
6367 | <tr><th>IPP_JSTATE_ABORTED </th> <td class="description">Job has aborted due to error</td></tr> | |
6368 | <tr><th>IPP_JSTATE_CANCELED </th> <td class="description">Job has been canceled</td></tr> | |
6369 | <tr><th>IPP_JSTATE_COMPLETED </th> <td class="description">Job has completed successfully</td></tr> | |
6370 | <tr><th>IPP_JSTATE_HELD </th> <td class="description">Job is held for printing</td></tr> | |
6371 | <tr><th>IPP_JSTATE_PENDING </th> <td class="description">Job is waiting to be printed</td></tr> | |
6372 | <tr><th>IPP_JSTATE_PROCESSING </th> <td class="description">Job is currently printing</td></tr> | |
6373 | <tr><th>IPP_JSTATE_STOPPED </th> <td class="description">Job has been stopped</td></tr> | |
6374 | </tbody></table> | |
798d6e29 MS |
6375 | <h3 class="enumeration"><a id="ipp_op_e">ipp_op_e</a></h3> |
6376 | <p class="description">IPP operations</p> | |
6377 | <h4 class="constants">Constants</h4> | |
98d88c8d | 6378 | <table class="list"><tbody> |
4f63d6cd | 6379 | <tr><th>IPP_OP_ALLOCATE_PRINTER_RESOURCES </th> <td class="description">Allocate-Printer-Resources: Use resources for a printer.</td></tr> |
98d88c8d MS |
6380 | <tr><th>IPP_OP_CANCEL_CURRENT_JOB </th> <td class="description">Cancel-Current-Job: Cancel the current job</td></tr> |
6381 | <tr><th>IPP_OP_CANCEL_JOB </th> <td class="description">Cancel-Job: Cancel a job</td></tr> | |
6382 | <tr><th>IPP_OP_CANCEL_JOBS </th> <td class="description">Cancel-Jobs: Cancel all jobs (administrative)</td></tr> | |
6383 | <tr><th>IPP_OP_CANCEL_MY_JOBS </th> <td class="description">Cancel-My-Jobs: Cancel a user's jobs</td></tr> | |
4f63d6cd | 6384 | <tr><th>IPP_OP_CANCEL_RESOURCE </th> <td class="description">Cancel-Resource: Uninstall a resource.</td></tr> |
98d88c8d MS |
6385 | <tr><th>IPP_OP_CANCEL_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Cancel-Subscription: Cancel a subscription </td></tr> |
6386 | <tr><th>IPP_OP_CLOSE_JOB </th> <td class="description">Close-Job: Close a job and start printing</td></tr> | |
6387 | <tr><th>IPP_OP_CREATE_JOB </th> <td class="description">Create-Job: Create an empty print job</td></tr> | |
6388 | <tr><th>IPP_OP_CREATE_JOB_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Create-Job-Subscriptions: Create one of more job subscriptions </td></tr> | |
4f63d6cd | 6389 | <tr><th>IPP_OP_CREATE_PRINTER </th> <td class="description">Create-Printer: Create a new service.</td></tr> |
98d88c8d | 6390 | <tr><th>IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Create-Printer-Subscriptions: Create one or more printer subscriptions </td></tr> |
4f63d6cd MS |
6391 | <tr><th>IPP_OP_CREATE_RESOURCE </th> <td class="description">Create-Resource: Create a new (empty) resource.</td></tr> |
6392 | <tr><th>IPP_OP_CREATE_RESOURCE_SUBSCRIPTIONS </th> <td class="description">Create-Resource-Subscriptions: Create event subscriptions for a resource.</td></tr> | |
6393 | <tr><th>IPP_OP_CREATE_SYSTEM_SUBSCRIPTIONS </th> <td class="description">Create-System-Subscriptions: Create event subscriptions for a system.</td></tr> | |
98d88c8d MS |
6394 | <tr><th>IPP_OP_CUPS_ADD_MODIFY_CLASS </th> <td class="description">CUPS-Add-Modify-Class: Add or modify a class</td></tr> |
6395 | <tr><th>IPP_OP_CUPS_ADD_MODIFY_PRINTER </th> <td class="description">CUPS-Add-Modify-Printer: Add or modify a printer</td></tr> | |
6396 | <tr><th>IPP_OP_CUPS_AUTHENTICATE_JOB <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">CUPS-Authenticate-Job: Authenticate a job </td></tr> | |
6397 | <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> | |
6398 | <tr><th>IPP_OP_CUPS_DELETE_CLASS </th> <td class="description">CUPS-Delete-Class: Delete a class</td></tr> | |
6399 | <tr><th>IPP_OP_CUPS_DELETE_PRINTER </th> <td class="description">CUPS-Delete-Printer: Delete a printer</td></tr> | |
6400 | <tr><th>IPP_OP_CUPS_GET_DEFAULT </th> <td class="description">CUPS-Get-Default: Get the default printer</td></tr> | |
6401 | <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> | |
6402 | <tr><th>IPP_OP_CUPS_GET_DOCUMENT <span class="info"> CUPS 1.4/macOS 10.6 </span></th> <td class="description">CUPS-Get-Document: Get a document file </td></tr> | |
6403 | <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> | |
6404 | <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> | |
6405 | <tr><th>IPP_OP_CUPS_GET_PRINTERS </th> <td class="description">CUPS-Get-Printers: Get a list of printers and/or classes</td></tr> | |
6406 | <tr><th>IPP_OP_CUPS_INVALID </th> <td class="description">Invalid operation name for <a href="#ippOpValue"><code>ippOpValue</code></a></td></tr> | |
6407 | <tr><th>IPP_OP_CUPS_MOVE_JOB </th> <td class="description">CUPS-Move-Job: Move a job to a different printer</td></tr> | |
6408 | <tr><th>IPP_OP_CUPS_SET_DEFAULT </th> <td class="description">CUPS-Set-Default: Set the default printer</td></tr> | |
4f63d6cd MS |
6409 | <tr><th>IPP_OP_DEALLOCATE_PRINTER_RESOURCES </th> <td class="description">Deallocate-Printer-Resources: Stop using resources for a printer.</td></tr> |
6410 | <tr><th>IPP_OP_DELETE_PRINTER </th> <td class="description">Delete-Printer: Delete an existing service.</td></tr> | |
6411 | <tr><th>IPP_OP_DISABLE_ALL_PRINTERS </th> <td class="description">Disable-All-Printers: Stop accepting new jobs on all services.</td></tr> | |
98d88c8d | 6412 | <tr><th>IPP_OP_DISABLE_PRINTER </th> <td class="description">Disable-Printer: Reject new jobs for a printer</td></tr> |
4f63d6cd | 6413 | <tr><th>IPP_OP_ENABLE_ALL_PRINTERS </th> <td class="description">Enable-All-Printers: Start accepting new jobs on all services.</td></tr> |
98d88c8d MS |
6414 | <tr><th>IPP_OP_ENABLE_PRINTER </th> <td class="description">Enable-Printer: Accept new jobs for a printer</td></tr> |
6415 | <tr><th>IPP_OP_GET_JOBS </th> <td class="description">Get-Jobs: Get a list of jobs</td></tr> | |
6416 | <tr><th>IPP_OP_GET_JOB_ATTRIBUTES </th> <td class="description">Get-Job-Attribute: Get information about a job</td></tr> | |
6417 | <tr><th>IPP_OP_GET_NOTIFICATIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Get-Notifications: Get notification events </td></tr> | |
4f63d6cd | 6418 | <tr><th>IPP_OP_GET_PRINTERS </th> <td class="description">Get-Printers: Get a list of services.</td></tr> |
98d88c8d MS |
6419 | <tr><th>IPP_OP_GET_PRINTER_ATTRIBUTES </th> <td class="description">Get-Printer-Attributes: Get information about a printer</td></tr> |
6420 | <tr><th>IPP_OP_GET_PRINTER_SUPPORTED_VALUES </th> <td class="description">Get-Printer-Supported-Values: Get supported values</td></tr> | |
6421 | <tr><th>IPP_OP_GET_SUBSCRIPTIONS <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Get-Subscriptions: Get list of subscriptions </td></tr> | |
6422 | <tr><th>IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Get-Subscription-Attributes: Get subscription information </td></tr> | |
4f63d6cd MS |
6423 | <tr><th>IPP_OP_GET_SYSTEM_ATTRIBUTES </th> <td class="description">Get-System-Attributes: Get system object attributes.</td></tr> |
6424 | <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> | |
98d88c8d MS |
6425 | <tr><th>IPP_OP_HOLD_JOB </th> <td class="description">Hold-Job: Hold a job for printing</td></tr> |
6426 | <tr><th>IPP_OP_HOLD_NEW_JOBS </th> <td class="description">Hold-New-Jobs: Hold new jobs</td></tr> | |
6427 | <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> | |
4f63d6cd MS |
6428 | <tr><th>IPP_OP_INSTALL_RESOURCE </th> <td class="description">Install-Resource: Install a resource.</td></tr> |
6429 | <tr><th>IPP_OP_PAUSE_ALL_PRINTERS </th> <td class="description">Pause-All-Printers: Stop all services immediately.</td></tr> | |
6430 | <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> | |
98d88c8d MS |
6431 | <tr><th>IPP_OP_PAUSE_PRINTER </th> <td class="description">Pause-Printer: Stop a printer</td></tr> |
6432 | <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> | |
6433 | <tr><th>IPP_OP_PRINT_JOB </th> <td class="description">Print-Job: Print a single file</td></tr> | |
6434 | <tr><th>IPP_OP_PROMOTE_JOB </th> <td class="description">Promote-Job: Promote a job to print sooner</td></tr> | |
4f63d6cd | 6435 | <tr><th>IPP_OP_REGISTER_OUTPUT_DEVICE </th> <td class="description">Register-Output-Device: Register a remote service.</td></tr> |
98d88c8d MS |
6436 | <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> |
6437 | <tr><th>IPP_OP_RELEASE_JOB </th> <td class="description">Release-Job: Release a job for printing</td></tr> | |
6438 | <tr><th>IPP_OP_RENEW_SUBSCRIPTION <span class="info"> CUPS 1.2/macOS 10.5 </span></th> <td class="description">Renew-Subscription: Renew a printer subscription </td></tr> | |
6439 | <tr><th>IPP_OP_RESTART_JOB <span class="info"> DEPRECATED </span></th> <td class="description">Restart-Job: Reprint a job </td></tr> | |
4f63d6cd MS |
6440 | <tr><th>IPP_OP_RESTART_SYSTEM </th> <td class="description">Restart-System: Restart all services.</td></tr> |
6441 | <tr><th>IPP_OP_RESUME_ALL_PRINTERS </th> <td class="description">Resume-All-Printers: Start job processing on all services.</td></tr> | |
98d88c8d MS |
6442 | <tr><th>IPP_OP_RESUME_JOB </th> <td class="description">Resume-Job: Resume the current job</td></tr> |
6443 | <tr><th>IPP_OP_RESUME_PRINTER </th> <td class="description">Resume-Printer: Start a printer</td></tr> | |
6444 | <tr><th>IPP_OP_SCHEDULE_JOB_AFTER </th> <td class="description">Schedule-Job-After: Schedule a job to print after another</td></tr> | |
6445 | <tr><th>IPP_OP_SEND_DOCUMENT </th> <td class="description">Send-Document: Add a file to a job</td></tr> | |
4f63d6cd | 6446 | <tr><th>IPP_OP_SEND_RESOURCE_DATA </th> <td class="description">Send-Resource-Data: Upload the data for a resource.</td></tr> |
98d88c8d MS |
6447 | <tr><th>IPP_OP_SET_JOB_ATTRIBUTES </th> <td class="description">Set-Job-Attributes: Set job values</td></tr> |
6448 | <tr><th>IPP_OP_SET_PRINTER_ATTRIBUTES </th> <td class="description">Set-Printer-Attributes: Set printer values</td></tr> | |
4f63d6cd MS |
6449 | <tr><th>IPP_OP_SET_RESOURCE_ATTRIBUTES </th> <td class="description">Set-Resource-Attributes: Set resource object attributes.</td></tr> |
6450 | <tr><th>IPP_OP_SET_SYSTEM_ATTRIBUTES </th> <td class="description">Set-System-Attributes: Set system object attributes.</td></tr> | |
6451 | <tr><th>IPP_OP_SHUTDOWN_ALL_PRINTERS </th> <td class="description">Shutdown-All-Printers: Shutdown all services.</td></tr> | |
6452 | <tr><th>IPP_OP_SHUTDOWN_ONE_PRINTER </th> <td class="description">Shutdown-One-Printer: Shutdown a service.</td></tr> | |
6453 | <tr><th>IPP_OP_STARTUP_ALL_PRINTERS </th> <td class="description">Startup-All-Printers: Startup all services.</td></tr> | |
6454 | <tr><th>IPP_OP_STARTUP_ONE_PRINTER </th> <td class="description">Startup-One-Printer: Start a service.</td></tr> | |
98d88c8d MS |
6455 | <tr><th>IPP_OP_SUSPEND_CURRENT_JOB </th> <td class="description">Suspend-Current-Job: Suspend the current job</td></tr> |
6456 | <tr><th>IPP_OP_VALIDATE_JOB </th> <td class="description">Validate-Job: Validate job values prior to submission</td></tr> | |
6457 | </tbody></table> | |
798d6e29 MS |
6458 | <h3 class="enumeration"><a id="ipp_orient_e">ipp_orient_e</a></h3> |
6459 | <p class="description">Orientation values</p> | |
6460 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6461 | <table class="list"><tbody> |
6462 | <tr><th>IPP_ORIENT_LANDSCAPE </th> <td class="description">90 degrees counter-clockwise</td></tr> | |
6463 | <tr><th>IPP_ORIENT_NONE </th> <td class="description">No rotation</td></tr> | |
6464 | <tr><th>IPP_ORIENT_PORTRAIT </th> <td class="description">No rotation</td></tr> | |
6465 | <tr><th>IPP_ORIENT_REVERSE_LANDSCAPE </th> <td class="description">90 degrees clockwise</td></tr> | |
6466 | <tr><th>IPP_ORIENT_REVERSE_PORTRAIT </th> <td class="description">180 degrees</td></tr> | |
6467 | </tbody></table> | |
798d6e29 | 6468 | <h3 class="enumeration"><a id="ipp_pstate_e">ipp_pstate_e</a></h3> |
65bebeac | 6469 | <p class="description">Printer state values</p> |
798d6e29 | 6470 | <h4 class="constants">Constants</h4> |
98d88c8d MS |
6471 | <table class="list"><tbody> |
6472 | <tr><th>IPP_PSTATE_IDLE </th> <td class="description">Printer is idle</td></tr> | |
6473 | <tr><th>IPP_PSTATE_PROCESSING </th> <td class="description">Printer is working</td></tr> | |
6474 | <tr><th>IPP_PSTATE_STOPPED </th> <td class="description">Printer is stopped</td></tr> | |
6475 | </tbody></table> | |
798d6e29 | 6476 | <h3 class="enumeration"><a id="ipp_quality_e">ipp_quality_e</a></h3> |
65bebeac | 6477 | <p class="description">Print quality values</p> |
798d6e29 | 6478 | <h4 class="constants">Constants</h4> |
98d88c8d MS |
6479 | <table class="list"><tbody> |
6480 | <tr><th>IPP_QUALITY_DRAFT </th> <td class="description">Draft quality</td></tr> | |
6481 | <tr><th>IPP_QUALITY_HIGH </th> <td class="description">High quality</td></tr> | |
6482 | <tr><th>IPP_QUALITY_NORMAL </th> <td class="description">Normal quality</td></tr> | |
6483 | </tbody></table> | |
798d6e29 MS |
6484 | <h3 class="enumeration"><a id="ipp_res_e">ipp_res_e</a></h3> |
6485 | <p class="description">Resolution units</p> | |
6486 | <h4 class="constants">Constants</h4> | |
98d88c8d MS |
6487 | <table class="list"><tbody> |
6488 | <tr><th>IPP_RES_PER_CM </th> <td class="description">Pixels per centimeter</td></tr> | |
6489 | <tr><th>IPP_RES_PER_INCH </th> <td class="description">Pixels per inch</td></tr> | |
06a5a4d3 MS |
6490 | </tbody></table> |
6491 | <h3 class="enumeration"><a id="ipp_rstate_e">ipp_rstate_e</a></h3> | |
6492 | <p class="description">resource-state values</p> | |
6493 | <h4 class="constants">Constants</h4> | |
6494 | <table class="list"><tbody> | |
6495 | <tr><th>IPP_RSTATE_ABORTED </th> <td class="description">Resource has been aborted and is pending deletion.</td></tr> | |
6496 | <tr><th>IPP_RSTATE_AVAILABLE </th> <td class="description">Resource is available for installation.</td></tr> | |
6497 | <tr><th>IPP_RSTATE_CANCELED </th> <td class="description">Resource has been canceled and is pending deletion.</td></tr> | |
6498 | <tr><th>IPP_RSTATE_INSTALLED </th> <td class="description">Resource is installed.</td></tr> | |
6499 | <tr><th>IPP_RSTATE_PENDING </th> <td class="description">Resource is created but has no data yet.</td></tr> | |
6500 | </tbody></table> | |
6501 | <h3 class="enumeration"><a id="ipp_sstate_e">ipp_sstate_e</a></h3> | |
6502 | <p class="description">system-state values</p> | |
6503 | <h4 class="constants">Constants</h4> | |
6504 | <table class="list"><tbody> | |
6505 | <tr><th>IPP_SSTATE_IDLE </th> <td class="description">At least one printer is idle and none are processing a job.</td></tr> | |
6506 | <tr><th>IPP_SSTATE_PROCESSING </th> <td class="description">At least one printer is processing a job.</td></tr> | |
6507 | <tr><th>IPP_SSTATE_STOPPED </th> <td class="description">All printers are stopped.</td></tr> | |
98d88c8d | 6508 | </tbody></table> |
798d6e29 | 6509 | <h3 class="enumeration"><a id="ipp_state_e">ipp_state_e</a></h3> |
65bebeac | 6510 | <p class="description">ipp_t state values</p> |
798d6e29 | 6511 | <h4 class="constants">Constants</h4> |
98d88c8d MS |
6512 | <table class="list"><tbody> |
6513 | <tr><th>IPP_STATE_ATTRIBUTE </th> <td class="description">One or more attributes need to be sent/received</td></tr> | |
6514 | <tr><th>IPP_STATE_DATA </th> <td class="description">IPP request data needs to be sent/received</td></tr> | |
6515 | <tr><th>IPP_STATE_ERROR </th> <td class="description">An error occurred</td></tr> | |
6516 | <tr><th>IPP_STATE_HEADER </th> <td class="description">The request header needs to be sent/received</td></tr> | |
6517 | <tr><th>IPP_STATE_IDLE </th> <td class="description">Nothing is happening/request completed</td></tr> | |
6518 | </tbody></table> | |
798d6e29 | 6519 | <h3 class="enumeration"><a id="ipp_status_e">ipp_status_e</a></h3> |
65bebeac | 6520 | <p class="description">IPP status code values</p> |
798d6e29 | 6521 | <h4 class="constants">Constants</h4> |
98d88c8d MS |
6522 | <table class="list"><tbody> |
6523 | <tr><th>IPP_STATUS_CUPS_INVALID </th> <td class="description">Invalid status name for <a href="#ippErrorValue"><code>ippErrorValue</code></a></td></tr> | |
6524 | <tr><th>IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED </th> <td class="description">client-error-account-authorization-failed</td></tr> | |
6525 | <tr><th>IPP_STATUS_ERROR_ACCOUNT_CLOSED </th> <td class="description">client-error-account-closed</td></tr> | |
6526 | <tr><th>IPP_STATUS_ERROR_ACCOUNT_INFO_NEEDED </th> <td class="description">client-error-account-info-needed</td></tr> | |
6527 | <tr><th>IPP_STATUS_ERROR_ACCOUNT_LIMIT_REACHED </th> <td class="description">client-error-account-limit-reached</td></tr> | |
6528 | <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE </th> <td class="description">client-error-attributes-not-settable</td></tr> | |
6529 | <tr><th>IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES </th> <td class="description">client-error-attributes-or-values-not-supported</td></tr> | |
6530 | <tr><th>IPP_STATUS_ERROR_BAD_REQUEST </th> <td class="description">client-error-bad-request</td></tr> | |
6531 | <tr><th>IPP_STATUS_ERROR_BUSY </th> <td class="description">server-error-busy</td></tr> | |
6532 | <tr><th>IPP_STATUS_ERROR_CHARSET </th> <td class="description">client-error-charset-not-supported</td></tr> | |
6533 | <tr><th>IPP_STATUS_ERROR_COMPRESSION_ERROR </th> <td class="description">client-error-compression-error</td></tr> | |
6534 | <tr><th>IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED </th> <td class="description">client-error-compression-not-supported</td></tr> | |
6535 | <tr><th>IPP_STATUS_ERROR_CONFLICTING </th> <td class="description">client-error-conflicting-attributes</td></tr> | |
6536 | <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> | |
6537 | <tr><th>IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED </th> <td class="description">cups-error-account-closed @deprecate@</td></tr> | |
6538 | <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> | |
6539 | <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> | |
6540 | <tr><th>IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">cups-authentication-canceled - Authentication canceled by user </td></tr> | |
6541 | <tr><th>IPP_STATUS_ERROR_CUPS_PKI <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">cups-pki-error - Error negotiating a secure connection </td></tr> | |
6542 | <tr><th>IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED <span class="info"> CUPS 1.5/macOS 10.7 </span></th> <td class="description">cups-upgrade-required - TLS upgrade required </td></tr> | |
6543 | <tr><th>IPP_STATUS_ERROR_DEVICE </th> <td class="description">server-error-device-error</td></tr> | |
6544 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_ACCESS </th> <td class="description">client-error-document-access-error</td></tr> | |
6545 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR </th> <td class="description">client-error-document-format-error</td></tr> | |
6546 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED </th> <td class="description">client-error-document-format-not-supported</td></tr> | |
6547 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_PASSWORD </th> <td class="description">client-error-document-password-error</td></tr> | |
6548 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_PERMISSION </th> <td class="description">client-error-document-permission-error</td></tr> | |
6549 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_SECURITY </th> <td class="description">client-error-document-security-error</td></tr> | |
6550 | <tr><th>IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE </th> <td class="description">client-error-document-unprintable-error</td></tr> | |
6551 | <tr><th>IPP_STATUS_ERROR_FORBIDDEN </th> <td class="description">client-error-forbidden</td></tr> | |
6552 | <tr><th>IPP_STATUS_ERROR_GONE </th> <td class="description">client-error-gone</td></tr> | |
6553 | <tr><th>IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS </th> <td class="description">client-error-ignored-all-subscriptions</td></tr> | |
6554 | <tr><th>IPP_STATUS_ERROR_INTERNAL </th> <td class="description">server-error-internal-error</td></tr> | |
6555 | <tr><th>IPP_STATUS_ERROR_JOB_CANCELED </th> <td class="description">server-error-job-canceled</td></tr> | |
6556 | <tr><th>IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED </th> <td class="description">server-error-multiple-document-jobs-not-supported</td></tr> | |
6557 | <tr><th>IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS </th> <td class="description">server-error-not-accepting-jobs</td></tr> | |
6558 | <tr><th>IPP_STATUS_ERROR_NOT_AUTHENTICATED </th> <td class="description">client-error-not-authenticated</td></tr> | |
6559 | <tr><th>IPP_STATUS_ERROR_NOT_AUTHORIZED </th> <td class="description">client-error-not-authorized</td></tr> | |
6560 | <tr><th>IPP_STATUS_ERROR_NOT_FETCHABLE </th> <td class="description">client-error-not-fetchable</td></tr> | |
6561 | <tr><th>IPP_STATUS_ERROR_NOT_FOUND </th> <td class="description">client-error-not-found</td></tr> | |
6562 | <tr><th>IPP_STATUS_ERROR_NOT_POSSIBLE </th> <td class="description">client-error-not-possible</td></tr> | |
6563 | <tr><th>IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED </th> <td class="description">server-error-operation-not-supported</td></tr> | |
6564 | <tr><th>IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED </th> <td class="description">server-error-printer-is-deactivated</td></tr> | |
6565 | <tr><th>IPP_STATUS_ERROR_REQUEST_ENTITY </th> <td class="description">client-error-request-entity-too-large</td></tr> | |
6566 | <tr><th>IPP_STATUS_ERROR_REQUEST_VALUE </th> <td class="description">client-error-request-value-too-long</td></tr> | |
6567 | <tr><th>IPP_STATUS_ERROR_SERVICE_UNAVAILABLE </th> <td class="description">server-error-service-unavailable</td></tr> | |
6568 | <tr><th>IPP_STATUS_ERROR_TEMPORARY </th> <td class="description">server-error-temporary-error</td></tr> | |
6569 | <tr><th>IPP_STATUS_ERROR_TIMEOUT </th> <td class="description">client-error-timeout</td></tr> | |
6570 | <tr><th>IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS </th> <td class="description">server-error-too-many-documents</td></tr> | |
6571 | <tr><th>IPP_STATUS_ERROR_TOO_MANY_JOBS </th> <td class="description">server-error-too-many-jobs</td></tr> | |
6572 | <tr><th>IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS </th> <td class="description">client-error-too-many-subscriptions</td></tr> | |
6573 | <tr><th>IPP_STATUS_ERROR_URI_SCHEME </th> <td class="description">client-error-uri-scheme-not-supported</td></tr> | |
6574 | <tr><th>IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED </th> <td class="description">server-error-version-not-supported</td></tr> | |
6575 | <tr><th>IPP_STATUS_OK </th> <td class="description">successful-ok</td></tr> | |
6576 | <tr><th>IPP_STATUS_OK_CONFLICTING </th> <td class="description">successful-ok-conflicting-attributes</td></tr> | |
6577 | <tr><th>IPP_STATUS_OK_EVENTS_COMPLETE </th> <td class="description">successful-ok-events-complete</td></tr> | |
6578 | <tr><th>IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED </th> <td class="description">successful-ok-ignored-or-substituted-attributes</td></tr> | |
6579 | <tr><th>IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS </th> <td class="description">successful-ok-ignored-subscriptions</td></tr> | |
6580 | <tr><th>IPP_STATUS_OK_TOO_MANY_EVENTS </th> <td class="description">successful-ok-too-many-events</td></tr> | |
6581 | </tbody></table> | |
798d6e29 | 6582 | <h3 class="enumeration"><a id="ipp_tag_e">ipp_tag_e</a></h3> |
65bebeac | 6583 | <p class="description">Value and group tag values for attributes</p> |
798d6e29 | 6584 | <h4 class="constants">Constants</h4> |
98d88c8d MS |
6585 | <table class="list"><tbody> |
6586 | <tr><th>IPP_TAG_ADMINDEFINE </th> <td class="description">Admin-defined value</td></tr> | |
6587 | <tr><th>IPP_TAG_BOOLEAN </th> <td class="description">Boolean value</td></tr> | |
6588 | <tr><th>IPP_TAG_CHARSET </th> <td class="description">Character set value</td></tr> | |
6589 | <tr><th>IPP_TAG_CUPS_INVALID </th> <td class="description">Invalid tag name for <a href="#ippTagValue"><code>ippTagValue</code></a></td></tr> | |
6590 | <tr><th>IPP_TAG_DATE </th> <td class="description">Date/time value</td></tr> | |
6591 | <tr><th>IPP_TAG_DEFAULT </th> <td class="description">Default value</td></tr> | |
6592 | <tr><th>IPP_TAG_DELETEATTR </th> <td class="description">Delete-attribute value</td></tr> | |
4f63d6cd | 6593 | <tr><th>IPP_TAG_DOCUMENT </th> <td class="description">Document group</td></tr> |
98d88c8d MS |
6594 | <tr><th>IPP_TAG_END </th> <td class="description">End-of-attributes</td></tr> |
6595 | <tr><th>IPP_TAG_ENUM </th> <td class="description">Enumeration value</td></tr> | |
6596 | <tr><th>IPP_TAG_EVENT_NOTIFICATION </th> <td class="description">Event group</td></tr> | |
6597 | <tr><th>IPP_TAG_INTEGER </th> <td class="description">Integer value</td></tr> | |
6598 | <tr><th>IPP_TAG_JOB </th> <td class="description">Job group</td></tr> | |
6599 | <tr><th>IPP_TAG_KEYWORD </th> <td class="description">Keyword value</td></tr> | |
6600 | <tr><th>IPP_TAG_LANGUAGE </th> <td class="description">Language value</td></tr> | |
6601 | <tr><th>IPP_TAG_MIMETYPE </th> <td class="description">MIME media type value</td></tr> | |
6602 | <tr><th>IPP_TAG_NAME </th> <td class="description">Name value</td></tr> | |
6603 | <tr><th>IPP_TAG_NAMELANG </th> <td class="description">Name-with-language value</td></tr> | |
6604 | <tr><th>IPP_TAG_NOTSETTABLE </th> <td class="description">Not-settable value</td></tr> | |
6605 | <tr><th>IPP_TAG_NOVALUE </th> <td class="description">No-value value</td></tr> | |
6606 | <tr><th>IPP_TAG_OPERATION </th> <td class="description">Operation group</td></tr> | |
6607 | <tr><th>IPP_TAG_PRINTER </th> <td class="description">Printer group</td></tr> | |
6608 | <tr><th>IPP_TAG_RANGE </th> <td class="description">Range value</td></tr> | |
6609 | <tr><th>IPP_TAG_RESOLUTION </th> <td class="description">Resolution value</td></tr> | |
4f63d6cd | 6610 | <tr><th>IPP_TAG_RESOURCE </th> <td class="description">Resource group</td></tr> |
98d88c8d MS |
6611 | <tr><th>IPP_TAG_STRING </th> <td class="description">Octet string value</td></tr> |
6612 | <tr><th>IPP_TAG_SUBSCRIPTION </th> <td class="description">Subscription group</td></tr> | |
4f63d6cd | 6613 | <tr><th>IPP_TAG_SYSTEM </th> <td class="description">System group</td></tr> |
98d88c8d MS |
6614 | <tr><th>IPP_TAG_TEXT </th> <td class="description">Text value</td></tr> |
6615 | <tr><th>IPP_TAG_TEXTLANG </th> <td class="description">Text-with-language value</td></tr> | |
6616 | <tr><th>IPP_TAG_UNKNOWN </th> <td class="description">Unknown value</td></tr> | |
6617 | <tr><th>IPP_TAG_UNSUPPORTED_GROUP </th> <td class="description">Unsupported attributes group</td></tr> | |
6618 | <tr><th>IPP_TAG_UNSUPPORTED_VALUE </th> <td class="description">Unsupported value</td></tr> | |
6619 | <tr><th>IPP_TAG_URI </th> <td class="description">URI value</td></tr> | |
6620 | <tr><th>IPP_TAG_URISCHEME </th> <td class="description">URI scheme value</td></tr> | |
6621 | <tr><th>IPP_TAG_ZERO </th> <td class="description">Zero tag - used for separators</td></tr> | |
6622 | </tbody></table> | |
798d6e29 MS |
6623 | </div> |
6624 | </body> | |
6625 | </html> |