]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/ipp.h
projects / thirdparty / cups.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Import experimental work-in-progress HTTP/2 branch
[thirdparty/cups.git] / cups / ipp.h
CommitLineData
ef416fc2 1/*
354aadbe 2 * "$Id: ipp.h 13138 2016-03-15 14:59:54Z msweet $"
ef416fc2 3 *
d21dc0ed 4 * Internet Printing Protocol definitions for CUPS.
ef416fc2 5 *
42404685 6 * Copyright 2007-2014 by Apple Inc.
d21dc0ed 7 * Copyright 1997-2006 by Easy Software Products.
ef416fc2 8 *
d21dc0ed
MS		 9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
ef416fc2 14 *
d21dc0ed 15 * This file is subject to the Apple OS-Developed Software exception.
ef416fc2 16 */
17
18#ifndef _CUPS_IPP_H_
19# define _CUPS_IPP_H_
20
21/*
22 * Include necessary headers...
23 */
24
25# include "http.h"
c1420c87 26# include <stdarg.h>
ef416fc2 27
28
29/*
30 * C++ magic...
31 */
32
33# ifdef __cplusplus
34extern "C" {
35# endif /* __cplusplus */
36
37
38/*
39 * IPP version string...
40 */
41
5a6b583a 42# define IPP_VERSION "\002\001"
ef416fc2 43
44/*
45 * IPP registered port number...
46 *
47 * Note: Applications should never use IPP_PORT, but instead use the
48 * ippPort() function to allow overrides via the IPP_PORT environment
49 * variable and services file if needed!
50 */
51
52# define IPP_PORT 631
53
54/*
55 * Common limits...
56 */
57
5a9febac
MS		 58# define IPP_MAX_CHARSET 64 /* Maximum length of charset values w/nul */
59# define IPP_MAX_KEYWORD 256 /* Maximum length of keyword values w/nul */
60# define IPP_MAX_LANGUAGE 64 /* Maximum length of naturalLanguage values w/nul */
a41f09e2 61# define IPP_MAX_LENGTH 32767 /* Maximum size of any single value */
5a9febac
MS		 62# define IPP_MAX_MIMETYPE 256 /* Maximum length of mimeMediaType values w/nul */
63# define IPP_MAX_NAME 256 /* Maximum length of common name values w/nul */
64# define IPP_MAX_OCTETSTRING 1023 /* Maximum length of octetString values w/o nul */
65# define IPP_MAX_TEXT 1024 /* Maximum length of text values w/nul */
66# define IPP_MAX_URI 1024 /* Maximum length of uri values w/nul */
67# define IPP_MAX_URISCHEME 64 /* Maximum length of uriScheme values w/nul */
ef416fc2 68# define IPP_MAX_VALUES 8 /* Power-of-2 allocation increment */
69
7e86f2f6
MS		 70/*
71 * Macro to flag a text string attribute as "const" (static storage) vs.
72 * allocated.
73 */
74
75# define IPP_CONST_TAG(x) (ipp_tag_t)(IPP_TAG_CUPS_CONST | (x))
76
ef416fc2 77
78/*
79 * Types and structures...
80 */
81
a2326b5b 82typedef enum ipp_dstate_e /**** Document states ****/
ef416fc2 83{
a469f8a5
MS		 84 IPP_DOCUMENT_PENDING = 3, /* Document is pending */
85 IPP_DOCUMENT_PROCESSING = 5, /* Document is processing */
86 IPP_DOCUMENT_CANCELED = 7, /* Document is canceled */
87 IPP_DOCUMENT_ABORTED, /* Document is aborted */
88 IPP_DOCUMENT_COMPLETED /* Document is completed */
89
90# ifndef _CUPS_NO_DEPRECATED
91# define IPP_DOCUMENT_PENDING IPP_DSTATE_PENDING
92# define IPP_DOCUMENT_PROCESSING IPP_DSTATE_PROCESSING
93# define IPP_DOCUMENT_CANCELED IPP_DSTATE_CANCELED
94# define IPP_DOCUMENT_ABORTED IPP_DSTATE_ABORTED
95# define IPP_DOCUMENT_COMPLETED IPP_DSTATE_COMPLETED
96# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b 97} ipp_dstate_t;
ef416fc2 98
a469f8a5 99typedef enum ipp_finishings_e /**** Finishings ****/
ef416fc2 100{
ecdc0628 101 IPP_FINISHINGS_NONE = 3, /* No finishing */
102 IPP_FINISHINGS_STAPLE, /* Staple (any location) */
103 IPP_FINISHINGS_PUNCH, /* Punch (any location/count) */
104 IPP_FINISHINGS_COVER, /* Add cover */
105 IPP_FINISHINGS_BIND, /* Bind */
106 IPP_FINISHINGS_SADDLE_STITCH, /* Staple interior */
107 IPP_FINISHINGS_EDGE_STITCH, /* Stitch along any side */
108 IPP_FINISHINGS_FOLD, /* Fold (any type) */
109 IPP_FINISHINGS_TRIM, /* Trim (any type) */
110 IPP_FINISHINGS_BALE, /* Bale (any type) */
111 IPP_FINISHINGS_BOOKLET_MAKER, /* Fold to make booklet */
6961465f 112 IPP_FINISHINGS_JOG_OFFSET, /* Offset for binding (any type) */
cd3614ae
MS		 113 IPP_FINISHINGS_COAT, /* Apply protective liquid or powder coating */
114 IPP_FINISHINGS_LAMINATE, /* Apply protective (solid) material */
ecdc0628 115 IPP_FINISHINGS_STAPLE_TOP_LEFT = 20, /* Staple top left corner */
116 IPP_FINISHINGS_STAPLE_BOTTOM_LEFT, /* Staple bottom left corner */
117 IPP_FINISHINGS_STAPLE_TOP_RIGHT, /* Staple top right corner */
118 IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT, /* Staple bottom right corner */
119 IPP_FINISHINGS_EDGE_STITCH_LEFT, /* Stitch along left side */
120 IPP_FINISHINGS_EDGE_STITCH_TOP, /* Stitch along top edge */
121 IPP_FINISHINGS_EDGE_STITCH_RIGHT, /* Stitch along right side */
122 IPP_FINISHINGS_EDGE_STITCH_BOTTOM, /* Stitch along bottom edge */
123 IPP_FINISHINGS_STAPLE_DUAL_LEFT, /* Two staples on left */
124 IPP_FINISHINGS_STAPLE_DUAL_TOP, /* Two staples on top */
125 IPP_FINISHINGS_STAPLE_DUAL_RIGHT, /* Two staples on right */
126 IPP_FINISHINGS_STAPLE_DUAL_BOTTOM, /* Two staples on bottom */
cd3614ae
MS		 127 IPP_FINISHINGS_STAPLE_TRIPLE_LEFT, /* Three staples on left */
128 IPP_FINISHINGS_STAPLE_TRIPLE_TOP, /* Three staples on top */
129 IPP_FINISHINGS_STAPLE_TRIPLE_RIGHT, /* Three staples on right */
130 IPP_FINISHINGS_STAPLE_TRIPLE_BOTTOM, /* Three staples on bottom */
ecdc0628 131 IPP_FINISHINGS_BIND_LEFT = 50, /* Bind on left */
132 IPP_FINISHINGS_BIND_TOP, /* Bind on top */
133 IPP_FINISHINGS_BIND_RIGHT, /* Bind on right */
a2326b5b
MS		 134 IPP_FINISHINGS_BIND_BOTTOM, /* Bind on bottom */
135 IPP_FINISHINGS_TRIM_AFTER_PAGES = 60, /* Trim output after each page */
136 IPP_FINISHINGS_TRIM_AFTER_DOCUMENTS, /* Trim output after each document */
137 IPP_FINISHINGS_TRIM_AFTER_COPIES, /* Trim output after each copy */
a469f8a5 138 IPP_FINISHINGS_TRIM_AFTER_JOB, /* Trim output after job */
9475ec92
MS		 139 IPP_FINISHINGS_PUNCH_TOP_LEFT = 70, /* Punch 1 hole top left */
140 IPP_FINISHINGS_PUNCH_BOTTOM_LEFT, /* Punch 1 hole bottom left */
141 IPP_FINISHINGS_PUNCH_TOP_RIGHT, /* Punch 1 hole top right */
142 IPP_FINISHINGS_PUNCH_BOTTOM_RIGHT, /* Punch 1 hole bottom right */
143 IPP_FINISHINGS_PUNCH_DUAL_LEFT, /* Punch 2 holes left side */
144 IPP_FINISHINGS_PUNCH_DUAL_TOP, /* Punch 2 holes top edge */
145 IPP_FINISHINGS_PUNCH_DUAL_RIGHT, /* Punch 2 holes right side */
146 IPP_FINISHINGS_PUNCH_DUAL_BOTTOM, /* Punch 2 holes bottom edge */
147 IPP_FINISHINGS_PUNCH_TRIPLE_LEFT, /* Punch 3 holes left side */
148 IPP_FINISHINGS_PUNCH_TRIPLE_TOP, /* Punch 3 holes top edge */
149 IPP_FINISHINGS_PUNCH_TRIPLE_RIGHT, /* Punch 3 holes right side */
150 IPP_FINISHINGS_PUNCH_TRIPLE_BOTTOM, /* Punch 3 holes bottom edge */
151 IPP_FINISHINGS_PUNCH_QUAD_LEFT, /* Punch 4 holes left side */
152 IPP_FINISHINGS_PUNCH_QUAD_TOP, /* Punch 4 holes top edge */
153 IPP_FINISHINGS_PUNCH_QUAD_RIGHT, /* Punch 4 holes right side */
154 IPP_FINISHINGS_PUNCH_QUAD_BOTTOM, /* Punch 4 holes bottom edge */
155 IPP_FINISHINGS_FOLD_ACCORDIAN = 90, /* Accordian-fold the paper vertically into four sections */
156 IPP_FINISHINGS_FOLD_DOUBLE_GATE, /* Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically */
157 IPP_FINISHINGS_FOLD_GATE, /* Fold the top and bottom quarters of the paper towards the midline */
158 IPP_FINISHINGS_FOLD_HALF, /* Fold the paper in half vertically */
159 IPP_FINISHINGS_FOLD_HALF_Z, /* Fold the paper in half horizontally, then Z-fold the paper vertically */
160 IPP_FINISHINGS_FOLD_LEFT_GATE, /* Fold the top quarter of the paper towards the midline */
161 IPP_FINISHINGS_FOLD_LETTER, /* Fold the paper into three sections vertically; sometimes also known as a C fold*/
162 IPP_FINISHINGS_FOLD_PARALLEL, /* Fold the paper in half vertically two times, yielding four sections */
163 IPP_FINISHINGS_FOLD_POSTER, /* Fold the paper in half horizontally and vertically; sometimes also called a cross fold */
164 IPP_FINISHINGS_FOLD_RIGHT_GATE, /* Fold the bottom quarter of the paper towards the midline */
165 IPP_FINISHINGS_FOLD_Z, /* Fold the paper vertically into three sections, forming a Z */
a469f8a5 166
9475ec92 167 /* CUPS extensions for finishings (pre-standard versions of values above) */
a469f8a5
MS		 168 IPP_FINISHINGS_CUPS_PUNCH_TOP_LEFT = 0x40000046,
169 /* Punch 1 hole top left */
170 IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_LEFT,/* Punch 1 hole bottom left */
171 IPP_FINISHINGS_CUPS_PUNCH_TOP_RIGHT, /* Punch 1 hole top right */
172 IPP_FINISHINGS_CUPS_PUNCH_BOTTOM_RIGHT,
173 /* Punch 1 hole bottom right */
174 IPP_FINISHINGS_CUPS_PUNCH_DUAL_LEFT, /* Punch 2 holes left side */
175 IPP_FINISHINGS_CUPS_PUNCH_DUAL_TOP, /* Punch 2 holes top edge */
176 IPP_FINISHINGS_CUPS_PUNCH_DUAL_RIGHT, /* Punch 2 holes right side */
177 IPP_FINISHINGS_CUPS_PUNCH_DUAL_BOTTOM,/* Punch 2 holes bottom edge */
178 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_LEFT,/* Punch 3 holes left side */
179 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_TOP, /* Punch 3 holes top edge */
180 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_RIGHT,
181 /* Punch 3 holes right side */
182 IPP_FINISHINGS_CUPS_PUNCH_TRIPLE_BOTTOM,
183 /* Punch 3 holes bottom edge */
184 IPP_FINISHINGS_CUPS_PUNCH_QUAD_LEFT, /* Punch 4 holes left side */
185 IPP_FINISHINGS_CUPS_PUNCH_QUAD_TOP, /* Punch 4 holes top edge */
186 IPP_FINISHINGS_CUPS_PUNCH_QUAD_RIGHT, /* Punch 4 holes right side */
6961465f
MS		 187 IPP_FINISHINGS_CUPS_PUNCH_QUAD_BOTTOM,/* Punch 4 holes bottom edge */
188
189 IPP_FINISHINGS_CUPS_FOLD_ACCORDIAN = 0x4000005A,
190 /* Accordian-fold the paper vertically into four sections */
191 IPP_FINISHINGS_CUPS_FOLD_DOUBLE_GATE, /* Fold the top and bottom quarters of the paper towards the midline, then fold in half vertically */
192 IPP_FINISHINGS_CUPS_FOLD_GATE, /* Fold the top and bottom quarters of the paper towards the midline */
193 IPP_FINISHINGS_CUPS_FOLD_HALF, /* Fold the paper in half vertically */
194 IPP_FINISHINGS_CUPS_FOLD_HALF_Z, /* Fold the paper in half horizontally, then Z-fold the paper vertically */
195 IPP_FINISHINGS_CUPS_FOLD_LEFT_GATE, /* Fold the top quarter of the paper towards the midline */
196 IPP_FINISHINGS_CUPS_FOLD_LETTER, /* Fold the paper into three sections vertically; sometimes also known as a C fold*/
197 IPP_FINISHINGS_CUPS_FOLD_PARALLEL, /* Fold the paper in half vertically two times, yielding four sections */
198 IPP_FINISHINGS_CUPS_FOLD_POSTER, /* Fold the paper in half horizontally and vertically; sometimes also called a cross fold */
199 IPP_FINISHINGS_CUPS_FOLD_RIGHT_GATE, /* Fold the bottom quarter of the paper towards the midline */
200 IPP_FINISHINGS_CUPS_FOLD_Z /* Fold the paper vertically into three sections, forming a Z */
a469f8a5
MS		 201} ipp_finishings_t;
202# ifndef _CUPS_NO_DEPRECATED
6961465f
MS		 203# define IPP_FINISHINGS_JOB_OFFSET IPP_FINISHINGS_JOG_OFFSET
204 /* Long-time misspelling... */
a469f8a5
MS		 205typedef enum ipp_finishings_e ipp_finish_t;
206# endif /* !_CUPS_NO_DEPRECATED */
ef416fc2 207
a2326b5b 208typedef enum ipp_jcollate_e /**** Job collation types ****/
ef416fc2 209{
a469f8a5
MS		 210 IPP_JCOLLATE_UNCOLLATED_SHEETS = 3,
211 IPP_JCOLLATE_COLLATED_DOCUMENTS,
212 IPP_JCOLLATE_UNCOLLATED_DOCUMENTS
213
214# ifndef _CUPS_NO_DEPRECATED
215# define IPP_JOB_UNCOLLATED_SHEETS IPP_JCOLLATE_UNCOLLATED_SHEETS
216# define IPP_JOB_COLLATED_DOCUMENTS IPP_JCOLLATE_COLLATED_DOCUMENTS
217# define IPP_JOB_UNCOLLATED_DOCUMENTS IPP_JCOLLATE_UNCOLLATED_DOCUMENTS
218# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b 219} ipp_jcollate_t;
ef416fc2 220
5a6b583a 221typedef enum ipp_jstate_e /**** Job states ****/
ef416fc2 222{
a469f8a5
MS		 223 IPP_JSTATE_PENDING = 3, /* Job is waiting to be printed */
224 IPP_JSTATE_HELD, /* Job is held for printing */
225 IPP_JSTATE_PROCESSING, /* Job is currently printing */
226 IPP_JSTATE_STOPPED, /* Job has been stopped */
227 IPP_JSTATE_CANCELED, /* Job has been canceled */
228 IPP_JSTATE_ABORTED, /* Job has aborted due to error */
229 IPP_JSTATE_COMPLETED /* Job has completed successfully */
230
231# ifndef _CUPS_NO_DEPRECATED
232# define IPP_JOB_PENDING IPP_JSTATE_PENDING
233# define IPP_JOB_HELD IPP_JSTATE_HELD
234# define IPP_JOB_PROCESSING IPP_JSTATE_PROCESSING
235# define IPP_JOB_STOPPED IPP_JSTATE_STOPPED
236# define IPP_JOB_CANCELED IPP_JSTATE_CANCELED
237# define IPP_JOB_ABORTED IPP_JSTATE_ABORTED
238# define IPP_JOB_COMPLETED IPP_JSTATE_COMPLETED
a2326b5b 239 /* Legacy name for canceled state */
a469f8a5
MS		 240# define IPP_JOB_CANCELLED IPP_JSTATE_CANCELED
241# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b 242} ipp_jstate_t;
ef416fc2 243
5a6b583a 244typedef enum ipp_op_e /**** IPP operations ****/
ef416fc2 245{
dcb445bc 246 IPP_OP_CUPS_INVALID = -1, /* Invalid operation name for @link ippOpValue@ */
a469f8a5
MS		 247 IPP_OP_CUPS_NONE = 0, /* No operation @private@ */
248 IPP_OP_PRINT_JOB = 0x0002, /* Print a single file */
9b4bd602 249 IPP_OP_PRINT_URI, /* Print a single URL */
a469f8a5
MS		 250 IPP_OP_VALIDATE_JOB, /* Validate job options */
251 IPP_OP_CREATE_JOB, /* Create an empty print job */
252 IPP_OP_SEND_DOCUMENT, /* Add a file to a job */
9b4bd602 253 IPP_OP_SEND_URI, /* Add a URL to a job */
a469f8a5
MS		 254 IPP_OP_CANCEL_JOB, /* Cancel a job */
255 IPP_OP_GET_JOB_ATTRIBUTES, /* Get job attributes */
256 IPP_OP_GET_JOBS, /* Get a list of jobs */
257 IPP_OP_GET_PRINTER_ATTRIBUTES, /* Get printer attributes */
258 IPP_OP_HOLD_JOB, /* Hold a job for printing */
259 IPP_OP_RELEASE_JOB, /* Release a job for printing */
260 IPP_OP_RESTART_JOB, /* Reprint a job */
261 IPP_OP_PAUSE_PRINTER = 0x0010, /* Stop a printer */
262 IPP_OP_RESUME_PRINTER, /* Start a printer */
263 IPP_OP_PURGE_JOBS, /* Cancel all jobs */
9b4bd602 264 IPP_OP_SET_PRINTER_ATTRIBUTES, /* Set printer attributes */
a469f8a5
MS		 265 IPP_OP_SET_JOB_ATTRIBUTES, /* Set job attributes */
266 IPP_OP_GET_PRINTER_SUPPORTED_VALUES, /* Get supported attribute values */
42404685
MS		 267 IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS, /* Create one or more printer subscriptions @since CUPS 1.2/OS X 10.5@ */
268 IPP_OP_CREATE_JOB_SUBSCRIPTIONS, /* Create one of more job subscriptions @since CUPS 1.2/OS X 10.5@ */
a469f8a5
MS		 269 IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES, /* Get subscription attributes @since CUPS 1.2/OS X 10.5@ */
270 IPP_OP_GET_SUBSCRIPTIONS, /* Get list of subscriptions @since CUPS 1.2/OS X 10.5@ */
271 IPP_OP_RENEW_SUBSCRIPTION, /* Renew a printer subscription @since CUPS 1.2/OS X 10.5@ */
272 IPP_OP_CANCEL_SUBSCRIPTION, /* Cancel a subscription @since CUPS 1.2/OS X 10.5@ */
273 IPP_OP_GET_NOTIFICATIONS, /* Get notification events @since CUPS 1.2/OS X 10.5@ */
274 IPP_OP_SEND_NOTIFICATIONS, /* Send notification events @private@ */
275 IPP_OP_GET_RESOURCE_ATTRIBUTES, /* Get resource attributes @private@ */
276 IPP_OP_GET_RESOURCE_DATA, /* Get resource data @private@ */
277 IPP_OP_GET_RESOURCES, /* Get list of resources @private@ */
278 IPP_OP_GET_PRINT_SUPPORT_FILES, /* Get printer support files @private@ */
279 IPP_OP_ENABLE_PRINTER, /* Start a printer */
280 IPP_OP_DISABLE_PRINTER, /* Stop a printer */
281 IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB,
9b4bd602
MS		 282 /* Stop printer after the current job */
283 IPP_OP_HOLD_NEW_JOBS, /* Hold new jobs */
284 IPP_OP_RELEASE_HELD_NEW_JOBS, /* Release new jobs */
285 IPP_OP_DEACTIVATE_PRINTER, /* Stop a printer */
286 IPP_OP_ACTIVATE_PRINTER, /* Start a printer */
287 IPP_OP_RESTART_PRINTER, /* Restart a printer */
288 IPP_OP_SHUTDOWN_PRINTER, /* Turn a printer off */
289 IPP_OP_STARTUP_PRINTER, /* Turn a printer on */
290 IPP_OP_REPROCESS_JOB, /* Reprint a job */
291 IPP_OP_CANCEL_CURRENT_JOB, /* Cancel the current job */
292 IPP_OP_SUSPEND_CURRENT_JOB, /* Suspend the current job */
293 IPP_OP_RESUME_JOB, /* Resume the current job */
294 IPP_OP_PROMOTE_JOB, /* Promote a job to print sooner */
295 IPP_OP_SCHEDULE_JOB_AFTER, /* Schedule a job to print after another */
296 IPP_OP_CANCEL_DOCUMENT = 0x0033, /* Cancel-Document */
297 IPP_OP_GET_DOCUMENT_ATTRIBUTES, /* Get-Document-Attributes */
298 IPP_OP_GET_DOCUMENTS, /* Get-Documents */
299 IPP_OP_DELETE_DOCUMENT, /* Delete-Document */
300 IPP_OP_SET_DOCUMENT_ATTRIBUTES, /* Set-Document-Attributes */
a469f8a5
MS		 301 IPP_OP_CANCEL_JOBS, /* Cancel-Jobs */
302 IPP_OP_CANCEL_MY_JOBS, /* Cancel-My-Jobs */
303 IPP_OP_RESUBMIT_JOB, /* Resubmit-Job */
304 IPP_OP_CLOSE_JOB, /* Close-Job */
9b4bd602
MS		 305 IPP_OP_IDENTIFY_PRINTER, /* Identify-Printer */
306 IPP_OP_VALIDATE_DOCUMENT, /* Validate-Document */
307 IPP_OP_SEND_HARDCOPY_DOCUMENT, /* Send-Hardcopy-Document */
308 IPP_OP_ACKNOWLEDGE_DOCUMENT, /* Acknowledge-Document */
309 IPP_OP_ACKNOWLEDGE_IDENTIFY_PRINTER, /* Acknowledge-Identify-Printer */
310 IPP_OP_ACKNOWLEDGE_JOB, /* Acknowledge-Job */
311 IPP_OP_FETCH_DOCUMENT, /* Fetch-Document */
312 IPP_OP_FETCH_JOB, /* Fetch-Job */
313 IPP_OP_GET_OUTPUT_DEVICE_ATTRIBUTES, /* Get-Output-Device-Attributes */
314 IPP_OP_UPDATE_ACTIVE_JOBS, /* Update-Active-Jobs */
315 IPP_OP_DEREGISTER_OUTPUT_DEVICE, /* Deregister-Output-Device */
316 IPP_OP_UPDATE_DOCUMENT_STATUS, /* Update-Document-Status */
317 IPP_OP_UPDATE_JOB_STATUS, /* Update-Job-Status */
318 IPP_OP_UPDATE_OUTPUT_DEVICE_ATTRIBUTES,
319 /* Update-Output-Device-Attributes */
320 IPP_OP_GET_NEXT_DOCUMENT_DATA, /* Get-Next-Document-Data */
9475ec92 321
a469f8a5
MS		 322 IPP_OP_PRIVATE = 0x4000, /* Reserved @private@ */
323 IPP_OP_CUPS_GET_DEFAULT, /* Get the default printer */
324 IPP_OP_CUPS_GET_PRINTERS, /* Get a list of printers and/or classes */
325 IPP_OP_CUPS_ADD_MODIFY_PRINTER, /* Add or modify a printer */
326 IPP_OP_CUPS_DELETE_PRINTER, /* Delete a printer */
327 IPP_OP_CUPS_GET_CLASSES, /* Get a list of classes @deprecated@ */
328 IPP_OP_CUPS_ADD_MODIFY_CLASS, /* Add or modify a class */
329 IPP_OP_CUPS_DELETE_CLASS, /* Delete a class */
330 IPP_OP_CUPS_ACCEPT_JOBS, /* Accept new jobs on a printer */
331 IPP_OP_CUPS_REJECT_JOBS, /* Reject new jobs on a printer */
332 IPP_OP_CUPS_SET_DEFAULT, /* Set the default printer */
7ae00c35
MS		 333 IPP_OP_CUPS_GET_DEVICES, /* Get a list of supported devices @deprecated@ */
334 IPP_OP_CUPS_GET_PPDS, /* Get a list of supported drivers @deprecated@ */
a469f8a5
MS		 335 IPP_OP_CUPS_MOVE_JOB, /* Move a job to a different printer */
336 IPP_OP_CUPS_AUTHENTICATE_JOB, /* Authenticate a job @since CUPS 1.2/OS X 10.5@ */
7ae00c35
MS		 337 IPP_OP_CUPS_GET_PPD, /* Get a PPD file @deprecated@ */
338 IPP_OP_CUPS_GET_DOCUMENT = 0x4027, /* Get a document file @since CUPS 1.4/OS X 10.6@ */
339 IPP_OP_CUPS_CREATE_LOCAL_PRINTER /* Create a local (temporary) printer @since CUPS 2.2 */
a469f8a5
MS		 340
341# ifndef _CUPS_NO_DEPRECATED
342# define IPP_PRINT_JOB IPP_OP_PRINT_JOB
343# define IPP_PRINT_URI IPP_OP_PRINT_URI
344# define IPP_VALIDATE_JOB IPP_OP_VALIDATE_JOB
345# define IPP_CREATE_JOB IPP_OP_CREATE_JOB
346# define IPP_SEND_DOCUMENT IPP_OP_SEND_DOCUMENT
347# define IPP_SEND_URI IPP_OP_SEND_URI
348# define IPP_CANCEL_JOB IPP_OP_CANCEL_JOB
349# define IPP_GET_JOB_ATTRIBUTES IPP_OP_GET_JOB_ATTRIBUTES
350# define IPP_GET_JOBS IPP_OP_GET_JOBS
351# define IPP_GET_PRINTER_ATTRIBUTES IPP_OP_GET_PRINTER_ATTRIBUTES
352# define IPP_HOLD_JOB IPP_OP_HOLD_JOB
353# define IPP_RELEASE_JOB IPP_OP_RELEASE_JOB
354# define IPP_RESTART_JOB IPP_OP_RESTART_JOB
355# define IPP_PAUSE_PRINTER IPP_OP_PAUSE_PRINTER
356# define IPP_RESUME_PRINTER IPP_OP_RESUME_PRINTER
357# define IPP_PURGE_JOBS IPP_OP_PURGE_JOBS
358# define IPP_SET_PRINTER_ATTRIBUTES IPP_OP_SET_PRINTER_ATTRIBUTES
359# define IPP_SET_JOB_ATTRIBUTES IPP_OP_SET_JOB_ATTRIBUTES
360# define IPP_GET_PRINTER_SUPPORTED_VALUES IPP_OP_GET_PRINTER_SUPPORTED_VALUES
42404685
MS		 361# define IPP_CREATE_PRINTER_SUBSCRIPTION IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS
362# define IPP_CREATE_JOB_SUBSCRIPTION IPP_OP_CREATE_JOB_SUBSCRIPTIONS
363# define IPP_OP_CREATE_PRINTER_SUBSCRIPTION IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS
364# define IPP_OP_CREATE_JOB_SUBSCRIPTION IPP_OP_CREATE_JOB_SUBSCRIPTIONS
a469f8a5
MS		 365# define IPP_GET_SUBSCRIPTION_ATTRIBUTES IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES
366# define IPP_GET_SUBSCRIPTIONS IPP_OP_GET_SUBSCRIPTIONS
367# define IPP_RENEW_SUBSCRIPTION IPP_OP_RENEW_SUBSCRIPTION
368# define IPP_CANCEL_SUBSCRIPTION IPP_OP_CANCEL_SUBSCRIPTION
369# define IPP_GET_NOTIFICATIONS IPP_OP_GET_NOTIFICATIONS
370# define IPP_SEND_NOTIFICATIONS IPP_OP_SEND_NOTIFICATIONS
371# define IPP_GET_RESOURCE_ATTRIBUTES IPP_OP_GET_RESOURCE_ATTRIBUTES
372# define IPP_GET_RESOURCE_DATA IPP_OP_GET_RESOURCE_DATA
373# define IPP_GET_RESOURCES IPP_OP_GET_RESOURCES
374# define IPP_GET_PRINT_SUPPORT_FILES IPP_OP_GET_PRINT_SUPPORT_FILES
375# define IPP_ENABLE_PRINTER IPP_OP_ENABLE_PRINTER
376# define IPP_DISABLE_PRINTER IPP_OP_DISABLE_PRINTER
377# define IPP_PAUSE_PRINTER_AFTER_CURRENT_JOB IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB
378# define IPP_HOLD_NEW_JOBS IPP_OP_HOLD_NEW_JOBS
379# define IPP_RELEASE_HELD_NEW_JOBS IPP_OP_RELEASE_HELD_NEW_JOBS
380# define IPP_DEACTIVATE_PRINTER IPP_OP_DEACTIVATE_PRINTER
381# define IPP_ACTIVATE_PRINTER IPP_OP_ACTIVATE_PRINTER
382# define IPP_RESTART_PRINTER IPP_OP_RESTART_PRINTER
383# define IPP_SHUTDOWN_PRINTER IPP_OP_SHUTDOWN_PRINTER
384# define IPP_STARTUP_PRINTER IPP_OP_STARTUP_PRINTER
385# define IPP_REPROCESS_JOB IPP_OP_REPROCESS_JOB
386# define IPP_CANCEL_CURRENT_JOB IPP_OP_CANCEL_CURRENT_JOB
387# define IPP_SUSPEND_CURRENT_JOB IPP_OP_SUSPEND_CURRENT_JOB
388# define IPP_RESUME_JOB IPP_OP_RESUME_JOB
389# define IPP_PROMOTE_JOB IPP_OP_PROMOTE_JOB
390# define IPP_SCHEDULE_JOB_AFTER IPP_OP_SCHEDULE_JOB_AFTER
391# define IPP_CANCEL_DOCUMENT IPP_OP_CANCEL_DOCUMENT
392# define IPP_GET_DOCUMENT_ATTRIBUTES IPP_OP_GET_DOCUMENT_ATTRIBUTES
393# define IPP_GET_DOCUMENTS IPP_OP_GET_DOCUMENTS
394# define IPP_DELETE_DOCUMENT IPP_OP_DELETE_DOCUMENT
395# define IPP_SET_DOCUMENT_ATTRIBUTES IPP_OP_SET_DOCUMENT_ATTRIBUTES
396# define IPP_CANCEL_JOBS IPP_OP_CANCEL_JOBS
397# define IPP_CANCEL_MY_JOBS IPP_OP_CANCEL_MY_JOBS
398# define IPP_RESUBMIT_JOB IPP_OP_RESUBMIT_JOB
399# define IPP_CLOSE_JOB IPP_OP_CLOSE_JOB
400# define IPP_IDENTIFY_PRINTER IPP_OP_IDENTIFY_PRINTER
401# define IPP_VALIDATE_DOCUMENT IPP_OP_VALIDATE_DOCUMENT
402# define IPP_PRIVATE IPP_OP_PRIVATE
403# define CUPS_GET_DEFAULT IPP_OP_CUPS_GET_DEFAULT
404# define CUPS_GET_PRINTERS IPP_OP_CUPS_GET_PRINTERS
405# define CUPS_ADD_MODIFY_PRINTER IPP_OP_CUPS_ADD_MODIFY_PRINTER
406# define CUPS_DELETE_PRINTER IPP_OP_CUPS_DELETE_PRINTER
407# define CUPS_GET_CLASSES IPP_OP_CUPS_GET_CLASSES
408# define CUPS_ADD_MODIFY_CLASS IPP_OP_CUPS_ADD_MODIFY_CLASS
409# define CUPS_DELETE_CLASS IPP_OP_CUPS_DELETE_CLASS
410# define CUPS_ACCEPT_JOBS IPP_OP_CUPS_ACCEPT_JOBS
411# define CUPS_REJECT_JOBS IPP_OP_CUPS_REJECT_JOBS
412# define CUPS_SET_DEFAULT IPP_OP_CUPS_SET_DEFAULT
413# define CUPS_GET_DEVICES IPP_OP_CUPS_GET_DEVICES
414# define CUPS_GET_PPDS IPP_OP_CUPS_GET_PPDS
415# define CUPS_MOVE_JOB IPP_OP_CUPS_MOVE_JOB
416# define CUPS_AUTHENTICATE_JOB IPP_OP_CUPS_AUTHENTICATE_JOB
417# define CUPS_GET_PPD IPP_OP_CUPS_GET_PPD
418# define CUPS_GET_DOCUMENT IPP_OP_CUPS_GET_DOCUMENT
419 /* Legacy names */
420# define CUPS_ADD_PRINTER IPP_OP_CUPS_ADD_MODIFY_PRINTER
421# define CUPS_ADD_CLASS IPP_OP_CUPS_ADD_MODIFY_CLASS
422# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b
MS		 423} ipp_op_t;
424
425typedef enum ipp_orient_e /**** Orientation values ****/
426{
a469f8a5
MS		 427 IPP_ORIENT_PORTRAIT = 3, /* No rotation */
428 IPP_ORIENT_LANDSCAPE, /* 90 degrees counter-clockwise */
429 IPP_ORIENT_REVERSE_LANDSCAPE, /* 90 degrees clockwise */
8f787fca
MS		 430 IPP_ORIENT_REVERSE_PORTRAIT, /* 180 degrees */
431 IPP_ORIENT_NONE /* No rotation */
a469f8a5
MS		 432
433# ifndef _CUPS_NO_DEPRECATED
434# define IPP_PORTRAIT IPP_ORIENT_PORTRAIT
435# define IPP_LANDSCAPE IPP_ORIENT_LANDSCAPE
436# define IPP_REVERSE_LANDSCAPE IPP_ORIENT_REVERSE_LANDSCAPE
437# define IPP_REVERSE_PORTRAIT IPP_ORIENT_REVERSE_PORTRAIT
438# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b
MS		 439} ipp_orient_t;
440
441typedef enum ipp_pstate_e /**** Printer states ****/
442{
a469f8a5
MS		 443 IPP_PSTATE_IDLE = 3, /* Printer is idle */
444 IPP_PSTATE_PROCESSING, /* Printer is working */
445 IPP_PSTATE_STOPPED /* Printer is stopped */
446
447# ifndef _CUPS_NO_DEPRECATED
448# define IPP_PRINTER_IDLE IPP_PSTATE_IDLE
449# define IPP_PRINTER_PROCESSING IPP_PSTATE_PROCESSING
450# define IPP_PRINTER_STOPPED IPP_PSTATE_STOPPED
451# endif /* _CUPS_NO_DEPRECATED */
a2326b5b
MS		 452} ipp_pstate_t;
453
454typedef enum ipp_quality_e /**** Qualities ****/
455{
456 IPP_QUALITY_DRAFT = 3, /* Draft quality */
457 IPP_QUALITY_NORMAL, /* Normal quality */
458 IPP_QUALITY_HIGH /* High quality */
459} ipp_quality_t;
460
461typedef enum ipp_res_e /**** Resolution units ****/
462{
463 IPP_RES_PER_INCH = 3, /* Pixels per inch */
464 IPP_RES_PER_CM /* Pixels per centimeter */
465} ipp_res_t;
466
467typedef enum ipp_state_e /**** IPP states ****/
468{
a469f8a5
MS		 469 IPP_STATE_ERROR = -1, /* An error occurred */
470 IPP_STATE_IDLE, /* Nothing is happening/request completed */
471 IPP_STATE_HEADER, /* The request header needs to be sent/received */
472 IPP_STATE_ATTRIBUTE, /* One or more attributes need to be sent/received */
473 IPP_STATE_DATA /* IPP request data needs to be sent/received */
474
475# ifndef _CUPS_NO_DEPRECATED
476# define IPP_ERROR IPP_STATE_ERROR
477# define IPP_IDLE IPP_STATE_IDLE
478# define IPP_HEADER IPP_STATE_HEADER
479# define IPP_ATTRIBUTE IPP_STATE_ATTRIBUTE
480# define IPP_DATA IPP_STATE_DATA
481# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b 482} ipp_state_t;
fa73b229 483
5a6b583a 484typedef enum ipp_status_e /**** IPP status codes ****/
ef416fc2 485{
dcb445bc 486 IPP_STATUS_CUPS_INVALID = -1, /* Invalid status name for @link ippErrorValue@ */
a469f8a5
MS		 487 IPP_STATUS_OK = 0x0000, /* successful-ok */
488 IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED, /* successful-ok-ignored-or-substituted-attributes */
489 IPP_STATUS_OK_CONFLICTING, /* successful-ok-conflicting-attributes */
490 IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS, /* successful-ok-ignored-subscriptions */
491 IPP_STATUS_OK_IGNORED_NOTIFICATIONS, /* successful-ok-ignored-notifications @private@ */
492 IPP_STATUS_OK_TOO_MANY_EVENTS, /* successful-ok-too-many-events */
493 IPP_STATUS_OK_BUT_CANCEL_SUBSCRIPTION,/* successful-ok-but-cancel-subscription @private@ */
494 IPP_STATUS_OK_EVENTS_COMPLETE, /* successful-ok-events-complete */
495 IPP_STATUS_REDIRECTION_OTHER_SITE = 0x0200,
496 /* redirection-other-site @private@ */
497 IPP_STATUS_CUPS_SEE_OTHER = 0x0280, /* cups-see-other */
498 IPP_STATUS_ERROR_BAD_REQUEST = 0x0400,/* client-error-bad-request */
499 IPP_STATUS_ERROR_FORBIDDEN, /* client-error-forbidden */
500 IPP_STATUS_ERROR_NOT_AUTHENTICATED, /* client-error-not-authenticated */
501 IPP_STATUS_ERROR_NOT_AUTHORIZED, /* client-error-not-authorized */
502 IPP_STATUS_ERROR_NOT_POSSIBLE, /* client-error-not-possible */
503 IPP_STATUS_ERROR_TIMEOUT, /* client-error-timeout */
504 IPP_STATUS_ERROR_NOT_FOUND, /* client-error-not-found */
505 IPP_STATUS_ERROR_GONE, /* client-error-gone */
506 IPP_STATUS_ERROR_REQUEST_ENTITY, /* client-error-request-entity-too-large */
507 IPP_STATUS_ERROR_REQUEST_VALUE, /* client-error-request-value-too-long */
508 IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED,
509 /* client-error-document-format-not-supported */
510 IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES,/* client-error-attributes-or-values-not-supported */
511 IPP_STATUS_ERROR_URI_SCHEME, /* client-error-uri-scheme-not-supported */
512 IPP_STATUS_ERROR_CHARSET, /* client-error-charset-not-supported */
513 IPP_STATUS_ERROR_CONFLICTING, /* client-error-conflicting-attributes */
514 IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED,
515 /* client-error-compression-not-supported */
516 IPP_STATUS_ERROR_COMPRESSION_ERROR, /* client-error-compression-error */
517 IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR,
518 /* client-error-document-format-error */
519 IPP_STATUS_ERROR_DOCUMENT_ACCESS, /* client-error-document-access-error */
520 IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE,
521 /* client-error-attributes-not-settable */
522 IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS,
523 /* client-error-ignored-all-subscriptions */
524 IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS,
525 /* client-error-too-many-subscriptions */
526 IPP_STATUS_ERROR_IGNORED_ALL_NOTIFICATIONS,
527 /* client-error-ignored-all-notifications @private@ */
528 IPP_STATUS_ERROR_PRINT_SUPPORT_FILE_NOT_FOUND,
529 /* client-error-print-support-file-not-found @private@ */
530 IPP_STATUS_ERROR_DOCUMENT_PASSWORD, /* client-error-document-password-error */
531 IPP_STATUS_ERROR_DOCUMENT_PERMISSION, /* client-error-document-permission-error */
532 IPP_STATUS_ERROR_DOCUMENT_SECURITY, /* client-error-document-security-error */
533 IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE,/* client-error-document-unprintable-error */
6b13fa61
MS		 534 IPP_STATUS_ERROR_ACCOUNT_INFO_NEEDED, /* client-error-account-info-needed */
535 IPP_STATUS_ERROR_ACCOUNT_CLOSED, /* client-error-account-closed */
536 IPP_STATUS_ERROR_ACCOUNT_LIMIT_REACHED,
537 /* client-error-account-limit-reached */
538 IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED,
539 /* client-error-account-authorization-failed */
c47d4869 540 IPP_STATUS_ERROR_NOT_FETCHABLE, /* client-error-not-fetchable */
6b13fa61
MS		 541
542 /* Legacy status codes for paid printing */
a469f8a5 543 IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED = 0x049C,
6b13fa61
MS		 544 /* cups-error-account-info-needed @deprecated@ */
545 IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED, /* cups-error-account-closed @deprecate@ */
a469f8a5 546 IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED,
6b13fa61 547 /* cups-error-account-limit-reached @deprecated@ */
a469f8a5 548 IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED,
6b13fa61 549 /* cups-error-account-authorization-failed @deprecated@ */
a469f8a5
MS		 550
551 IPP_STATUS_ERROR_INTERNAL = 0x0500, /* server-error-internal-error */
552 IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED,
553 /* server-error-operation-not-supported */
554 IPP_STATUS_ERROR_SERVICE_UNAVAILABLE, /* server-error-service-unavailable */
555 IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED,
556 /* server-error-version-not-supported */
557 IPP_STATUS_ERROR_DEVICE, /* server-error-device-error */
558 IPP_STATUS_ERROR_TEMPORARY, /* server-error-temporary-error */
559 IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS, /* server-error-not-accepting-jobs */
560 IPP_STATUS_ERROR_BUSY, /* server-error-busy */
561 IPP_STATUS_ERROR_JOB_CANCELED, /* server-error-job-canceled */
562 IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED,
563 /* server-error-multiple-document-jobs-not-supported */
564 IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED,
565 /* server-error-printer-is-deactivated */
566 IPP_STATUS_ERROR_TOO_MANY_JOBS, /* server-error-too-many-jobs */
567 IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS, /* server-error-too-many-documents */
568
569 /* These are internal and never sent over the wire... */
570 IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED = 0x1000,
571 /* cups-authentication-canceled - Authentication canceled by user @since CUPS 1.5/OS X 10.7@ */
572 IPP_STATUS_ERROR_CUPS_PKI, /* cups-pki-error - Error negotiating a secure connection @since CUPS 1.5/OS X 10.7@ */
573 IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED/* cups-upgrade-required - TLS upgrade required */
574
575# ifndef _CUPS_NO_DEPRECATED
576# define IPP_OK IPP_STATUS_OK
577# define IPP_OK_SUBST IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED
578# define IPP_OK_CONFLICT IPP_STATUS_OK_CONFLICTING
579# define IPP_OK_IGNORED_SUBSCRIPTIONS IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS
580# define IPP_OK_IGNORED_NOTIFICATIONS IPP_STATUS_OK_IGNORED_NOTIFICATIONS
581# define IPP_OK_TOO_MANY_EVENTS IPP_STATUS_OK_TOO_MANY_EVENTS
582# define IPP_OK_BUT_CANCEL_SUBSCRIPTION IPP_STATUS_OK_BUT_CANCEL_SUBSCRIPTION
583# define IPP_OK_EVENTS_COMPLETE IPP_STATUS_OK_EVENTS_COMPLETE
584# define IPP_REDIRECTION_OTHER_SITE IPP_STATUS_REDIRECTION_OTHER_SITE
585# define CUPS_SEE_OTHER IPP_STATUS_CUPS_SEE_OTHER
586# define IPP_BAD_REQUEST IPP_STATUS_ERROR_BAD_REQUEST
587# define IPP_FORBIDDEN IPP_STATUS_ERROR_FORBIDDEN
588# define IPP_NOT_AUTHENTICATED IPP_STATUS_ERROR_NOT_AUTHENTICATED
589# define IPP_NOT_AUTHORIZED IPP_STATUS_ERROR_NOT_AUTHORIZED
590# define IPP_NOT_POSSIBLE IPP_STATUS_ERROR_NOT_POSSIBLE
591# define IPP_TIMEOUT IPP_STATUS_ERROR_TIMEOUT
592# define IPP_NOT_FOUND IPP_STATUS_ERROR_NOT_FOUND
593# define IPP_GONE IPP_STATUS_ERROR_GONE
594# define IPP_REQUEST_ENTITY IPP_STATUS_ERROR_REQUEST_ENTITY
595# define IPP_REQUEST_VALUE IPP_STATUS_ERROR_REQUEST_VALUE
596# define IPP_DOCUMENT_FORMAT IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
597# define IPP_ATTRIBUTES IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
598# define IPP_URI_SCHEME IPP_STATUS_ERROR_URI_SCHEME
599# define IPP_CHARSET IPP_STATUS_ERROR_CHARSET
600# define IPP_CONFLICT IPP_STATUS_ERROR_CONFLICTING
601# define IPP_COMPRESSION_NOT_SUPPORTED IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED
602# define IPP_COMPRESSION_ERROR IPP_STATUS_ERROR_COMPRESSION_ERROR
603# define IPP_DOCUMENT_FORMAT_ERROR IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
604# define IPP_DOCUMENT_ACCESS_ERROR IPP_STATUS_ERROR_DOCUMENT_ACCESS
605# define IPP_ATTRIBUTES_NOT_SETTABLE IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE
606# define IPP_IGNORED_ALL_SUBSCRIPTIONS IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS
607# define IPP_TOO_MANY_SUBSCRIPTIONS IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS
608# define IPP_IGNORED_ALL_NOTIFICATIONS IPP_STATUS_ERROR_IGNORED_ALL_NOTIFICATIONS
609# define IPP_PRINT_SUPPORT_FILE_NOT_FOUND IPP_STATUS_ERROR_PRINT_SUPPORT_FILE_NOT_FOUND
610# define IPP_DOCUMENT_PASSWORD_ERROR IPP_STATUS_ERROR_DOCUMENT_PASSWORD
611# define IPP_DOCUMENT_PERMISSION_ERROR IPP_STATUS_ERROR_DOCUMENT_PERMISSION
612# define IPP_DOCUMENT_SECURITY_ERROR IPP_STATUS_ERROR_DOCUMENT_SECURITY
613# define IPP_DOCUMENT_UNPRINTABLE_ERROR IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
614# define IPP_INTERNAL_ERROR IPP_STATUS_ERROR_INTERNAL
615# define IPP_OPERATION_NOT_SUPPORTED IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
616# define IPP_SERVICE_UNAVAILABLE IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
617# define IPP_VERSION_NOT_SUPPORTED IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED
618# define IPP_DEVICE_ERROR IPP_STATUS_ERROR_DEVICE
619# define IPP_TEMPORARY_ERROR IPP_STATUS_ERROR_TEMPORARY
620# define IPP_NOT_ACCEPTING IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS
621# define IPP_PRINTER_BUSY IPP_STATUS_ERROR_BUSY
622# define IPP_ERROR_JOB_CANCELED IPP_STATUS_ERROR_JOB_CANCELED
623# define IPP_MULTIPLE_JOBS_NOT_SUPPORTED IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED
624# define IPP_PRINTER_IS_DEACTIVATED IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED
625# define IPP_TOO_MANY_JOBS IPP_STATUS_ERROR_TOO_MANY_JOBS
626# define IPP_TOO_MANY_DOCUMENTS IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS
627# define IPP_AUTHENTICATION_CANCELED IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
628# define IPP_PKI_ERROR IPP_STATUS_ERROR_CUPS_PKI
629# define IPP_UPGRADE_REQUIRED IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
630 /* Legacy name for canceled status */
631# define IPP_ERROR_JOB_CANCELLED IPP_STATUS_ERROR_JOB_CANCELED
632# endif /* _CUPS_NO_DEPRECATED */
a2326b5b 633} ipp_status_t;
ef416fc2 634
a2326b5b 635typedef enum ipp_tag_e /**** Format tags for attributes ****/
ef416fc2 636{
dcb445bc 637 IPP_TAG_CUPS_INVALID = -1, /* Invalid tag name for @link ippTagValue@ */
a2326b5b
MS		 638 IPP_TAG_ZERO = 0x00, /* Zero tag - used for separators */
639 IPP_TAG_OPERATION, /* Operation group */
640 IPP_TAG_JOB, /* Job group */
641 IPP_TAG_END, /* End-of-attributes */
642 IPP_TAG_PRINTER, /* Printer group */
643 IPP_TAG_UNSUPPORTED_GROUP, /* Unsupported attributes group */
644 IPP_TAG_SUBSCRIPTION, /* Subscription group */
645 IPP_TAG_EVENT_NOTIFICATION, /* Event group */
646 IPP_TAG_RESOURCE, /* Resource group @private@ */
647 IPP_TAG_DOCUMENT, /* Document group */
648 IPP_TAG_UNSUPPORTED_VALUE = 0x10, /* Unsupported value */
649 IPP_TAG_DEFAULT, /* Default value */
650 IPP_TAG_UNKNOWN, /* Unknown value */
651 IPP_TAG_NOVALUE, /* No-value value */
652 IPP_TAG_NOTSETTABLE = 0x15, /* Not-settable value */
653 IPP_TAG_DELETEATTR, /* Delete-attribute value */
654 IPP_TAG_ADMINDEFINE, /* Admin-defined value */
655 IPP_TAG_INTEGER = 0x21, /* Integer value */
656 IPP_TAG_BOOLEAN, /* Boolean value */
657 IPP_TAG_ENUM, /* Enumeration value */
658 IPP_TAG_STRING = 0x30, /* Octet string value */
659 IPP_TAG_DATE, /* Date/time value */
660 IPP_TAG_RESOLUTION, /* Resolution value */
661 IPP_TAG_RANGE, /* Range value */
662 IPP_TAG_BEGIN_COLLECTION, /* Beginning of collection value */
663 IPP_TAG_TEXTLANG, /* Text-with-language value */
664 IPP_TAG_NAMELANG, /* Name-with-language value */
665 IPP_TAG_END_COLLECTION, /* End of collection value */
666 IPP_TAG_TEXT = 0x41, /* Text value */
667 IPP_TAG_NAME, /* Name value */
668 IPP_TAG_RESERVED_STRING, /* Reserved for future string value @private@ */
669 IPP_TAG_KEYWORD, /* Keyword value */
670 IPP_TAG_URI, /* URI value */
671 IPP_TAG_URISCHEME, /* URI scheme value */
672 IPP_TAG_CHARSET, /* Character set value */
673 IPP_TAG_LANGUAGE, /* Language value */
674 IPP_TAG_MIMETYPE, /* MIME media type value */
675 IPP_TAG_MEMBERNAME, /* Collection member name value */
676 IPP_TAG_EXTENSION = 0x7f, /* Extension point for 32-bit tags */
a469f8a5 677 IPP_TAG_CUPS_MASK = 0x7fffffff, /* Mask for copied attribute values @private@ */
a2326b5b 678 /* The following expression is used to avoid compiler warnings with +/-0x80000000 */
a469f8a5
MS		 679 IPP_TAG_CUPS_CONST = -0x7fffffff-1 /* Bitflag for copied/const attribute values @private@ */
680
681# ifndef _CUPS_NO_DEPRECATED
682# define IPP_TAG_MASK IPP_TAG_CUPS_MASK
683# define IPP_TAG_COPY IPP_TAG_CUPS_CONST
684# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b 685} ipp_tag_t;
ef416fc2 686
a2326b5b
MS		 687typedef unsigned char ipp_uchar_t; /**** Unsigned 8-bit integer/character ****/
688typedef struct _ipp_s ipp_t; /**** IPP request/response data ****/
689typedef struct _ipp_attribute_s ipp_attribute_t;
690 /**** IPP attribute ****/
ef416fc2 691
f3c17241 692/**** New in CUPS 1.2/OS X 10.5 ****/
a2326b5b 693typedef ssize_t (*ipp_iocb_t)(void *context, ipp_uchar_t *buffer, size_t bytes);
f3c17241 694 /**** IPP IO Callback Function @since CUPS 1.2/OS X 10.5@ ****/
aaf19ab0 695
f3c17241 696/**** New in CUPS 1.6/OS X 10.8 ****/
a2326b5b 697typedef int (*ipp_copycb_t)(void *context, ipp_t *dst, ipp_attribute_t *attr);
ef416fc2 698
699
82cc1f9a 700/*
f3c17241
MS		 701 * The following structures are PRIVATE starting with CUPS 1.6/OS X 10.8.
702 * Please use the new accessor functions available in CUPS 1.6 and later, as
703 * these definitions will be moved to a private header file in a future release.
82cc1f9a 704 *
a469f8a5 705 * Define _IPP_PRIVATE_STRUCTURES to 1 to cause the private IPP structures to be
f3c17241
MS		 706 * exposed in CUPS 1.6. This happens automatically on OS X when compiling for
707 * a deployment target of 10.7 or earlier.
a469f8a5
MS		 708 *
709 * Define _IPP_PRIVATE_STRUCTURES to 0 to prevent the private IPP structures
710 * from being exposed. This is useful when migrating existing code to the new
711 * accessors.
82cc1f9a
MS		 712 */
713
a469f8a5
MS		 714# ifdef _IPP_PRIVATE_STRUCTURES
715 /* Somebody has overridden the value */
716# elif defined(_CUPS_SOURCE) || defined(_CUPS_IPP_PRIVATE_H_)
82cc1f9a
MS		 717 /* Building CUPS */
718# define _IPP_PRIVATE_STRUCTURES 1
719# elif defined(__APPLE__)
720# if defined(MAC_OS_X_VERSION_10_8) && MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_8
721 /* Building for 10.7 and earlier */
722# define _IPP_PRIVATE_STRUCTURES 1
723# elif !defined(MAC_OS_X_VERSION_10_8)
724 /* Building for 10.7 and earlier */
725# define _IPP_PRIVATE_STRUCTURES 1
726# endif /* MAC_OS_X_VERSION_10_8 && MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_8 */
a469f8a5
MS		 727# else
728# define _IPP_PRIVATE_STRUCTURES 0
82cc1f9a
MS		 729# endif /* _CUPS_SOURCE || _CUPS_IPP_PRIVATE_H_ */
730
a469f8a5 731# if _IPP_PRIVATE_STRUCTURES
82cc1f9a
MS		 732typedef union _ipp_request_u /**** Request Header ****/
733{
734 struct /* Any Header */
735 {
736 ipp_uchar_t version[2]; /* Protocol version number */
737 int op_status; /* Operation ID or status code*/
738 int request_id; /* Request ID */
739 } any;
740
741 struct /* Operation Header */
742 {
743 ipp_uchar_t version[2]; /* Protocol version number */
744 ipp_op_t operation_id; /* Operation ID */
745 int request_id; /* Request ID */
746 } op;
747
748 struct /* Status Header */
749 {
750 ipp_uchar_t version[2]; /* Protocol version number */
751 ipp_status_t status_code; /* Status code */
752 int request_id; /* Request ID */
753 } status;
754
755 /**** New in CUPS 1.1.19 ****/
f3c17241 756 struct /* Event Header @since CUPS 1.1.19/OS X 10.3@ */
82cc1f9a
MS		 757 {
758 ipp_uchar_t version[2]; /* Protocol version number */
759 ipp_status_t status_code; /* Status code */
760 int request_id; /* Request ID */
761 } event;
762} _ipp_request_t;
763
764/**** New in CUPS 1.1.19 ****/
765
766typedef union _ipp_value_u /**** Attribute Value ****/
767{
768 int integer; /* Integer/enumerated value */
769
770 char boolean; /* Boolean value */
771
772 ipp_uchar_t date[11]; /* Date/time value */
773
774 struct
775 {
776 int xres, /* Horizontal resolution */
777 yres; /* Vertical resolution */
778 ipp_res_t units; /* Resolution units */
779 } resolution; /* Resolution value */
780
781 struct
782 {
783 int lower, /* Lower value */
784 upper; /* Upper value */
785 } range; /* Range of integers value */
786
787 struct
788 {
789 char *language; /* Language code */
790 char *text; /* String */
791 } string; /* String with language value */
792
793 struct
794 {
795 int length; /* Length of attribute */
796 void *data; /* Data in attribute */
797 } unknown; /* Unknown attribute type */
798
799/**** New in CUPS 1.1.19 ****/
f3c17241 800 ipp_t *collection; /* Collection value @since CUPS 1.1.19/OS X 10.3@ */
82cc1f9a
MS		 801} _ipp_value_t;
802typedef _ipp_value_t ipp_value_t; /**** Convenience typedef that will be removed @private@ ****/
803
804struct _ipp_attribute_s /**** Attribute ****/
805{
806 ipp_attribute_t *next; /* Next attribute in list */
807 ipp_tag_t group_tag, /* Job/Printer/Operation group tag */
808 value_tag; /* What type of value is it? */
809 char *name; /* Name of attribute */
810 int num_values; /* Number of values */
811 _ipp_value_t values[1]; /* Values */
812};
813
814struct _ipp_s /**** IPP Request/Response/Notification ****/
815{
816 ipp_state_t state; /* State of request */
817 _ipp_request_t request; /* Request header */
818 ipp_attribute_t *attrs; /* Attributes */
819 ipp_attribute_t *last; /* Last attribute in list */
820 ipp_attribute_t *current; /* Current attribute (for read/write) */
821 ipp_tag_t curtag; /* Current attribute group tag */
822
823/**** New in CUPS 1.2 ****/
f3c17241 824 ipp_attribute_t *prev; /* Previous attribute (for read) @since CUPS 1.2/OS X 10.5@ */
82cc1f9a
MS		 825
826/**** New in CUPS 1.4.4 ****/
f3c17241 827 int use; /* Use count @since CUPS 1.4.4/OS X 10.6.?@ */
f2a31e21
MS		 828/**** New in CUPS 2.0 ****/
829 int atend, /* At end of list? */
830 curindex; /* Current attribute index for hierarchical search */
82cc1f9a
MS		 831};
832# endif /* _IPP_PRIVATE_STRUCTURES */
833
834
ef416fc2 835/*
836 * Prototypes...
837 */
838
fa73b229 839extern ipp_attribute_t *ippAddBoolean(ipp_t *ipp, ipp_tag_t group,
840 const char *name, char value);
841extern ipp_attribute_t *ippAddBooleans(ipp_t *ipp, ipp_tag_t group,
842 const char *name, int num_values,
843 const char *values);
844extern ipp_attribute_t *ippAddDate(ipp_t *ipp, ipp_tag_t group,
845 const char *name, const ipp_uchar_t *value);
846extern ipp_attribute_t *ippAddInteger(ipp_t *ipp, ipp_tag_t group,
a2326b5b 847 ipp_tag_t value_tag, const char *name,
fa73b229 848 int value);
849extern ipp_attribute_t *ippAddIntegers(ipp_t *ipp, ipp_tag_t group,
a2326b5b 850 ipp_tag_t value_tag, const char *name,
fa73b229 851 int num_values, const int *values);
852extern ipp_attribute_t *ippAddRange(ipp_t *ipp, ipp_tag_t group,
853 const char *name, int lower, int upper);
854extern ipp_attribute_t *ippAddRanges(ipp_t *ipp, ipp_tag_t group,
855 const char *name, int num_values,
856 const int *lower, const int *upper);
857extern ipp_attribute_t *ippAddResolution(ipp_t *ipp, ipp_tag_t group,
858 const char *name, ipp_res_t units,
859 int xres, int yres);
860extern ipp_attribute_t *ippAddResolutions(ipp_t *ipp, ipp_tag_t group,
861 const char *name, int num_values,
862 ipp_res_t units, const int *xres,
863 const int *yres);
ef416fc2 864extern ipp_attribute_t *ippAddSeparator(ipp_t *ipp);
fa73b229 865extern ipp_attribute_t *ippAddString(ipp_t *ipp, ipp_tag_t group,
a2326b5b
MS		 866 ipp_tag_t value_tag, const char *name,
867 const char *language, const char *value);
fa73b229 868extern ipp_attribute_t *ippAddStrings(ipp_t *ipp, ipp_tag_t group,
a2326b5b
MS		 869 ipp_tag_t value_tag, const char *name,
870 int num_values, const char *language,
fa73b229 871 const char * const *values);
ef416fc2 872extern time_t ippDateToTime(const ipp_uchar_t *date);
873extern void ippDelete(ipp_t *ipp);
874extern const char *ippErrorString(ipp_status_t error);
875extern ipp_attribute_t *ippFindAttribute(ipp_t *ipp, const char *name,
a2326b5b 876 ipp_tag_t value_tag);
ef416fc2 877extern ipp_attribute_t *ippFindNextAttribute(ipp_t *ipp, const char *name,
a2326b5b 878 ipp_tag_t value_tag);
ef416fc2 879extern size_t ippLength(ipp_t *ipp);
880extern ipp_t *ippNew(void);
881extern ipp_state_t ippRead(http_t *http, ipp_t *ipp);
882extern const ipp_uchar_t *ippTimeToDate(time_t t);
883extern ipp_state_t ippWrite(http_t *http, ipp_t *ipp);
884extern int ippPort(void);
885extern void ippSetPort(int p);
886
887/**** New in CUPS 1.1.19 ****/
fa73b229 888extern ipp_attribute_t *ippAddCollection(ipp_t *ipp, ipp_tag_t group,
2fb76298 889 const char *name, ipp_t *value) _CUPS_API_1_1_19;
fa73b229 890extern ipp_attribute_t *ippAddCollections(ipp_t *ipp, ipp_tag_t group,
891 const char *name, int num_values,
2fb76298
MS		 892 const ipp_t **values) _CUPS_API_1_1_19;
893extern void ippDeleteAttribute(ipp_t *ipp, ipp_attribute_t *attr) _CUPS_API_1_1_19;
894extern ipp_state_t ippReadFile(int fd, ipp_t *ipp) _CUPS_API_1_1_19;
895extern ipp_state_t ippWriteFile(int fd, ipp_t *ipp) _CUPS_API_1_1_19;
ef416fc2 896
f3c17241 897/**** New in CUPS 1.2/OS X 10.5 ****/
ef416fc2 898extern ipp_attribute_t *ippAddOctetString(ipp_t *ipp, ipp_tag_t group,
899 const char *name,
2fb76298
MS		 900 const void *data, int datalen) _CUPS_API_1_2;
901extern ipp_status_t ippErrorValue(const char *name) _CUPS_API_1_2;
902extern ipp_t *ippNewRequest(ipp_op_t op) _CUPS_API_1_2;
903extern const char *ippOpString(ipp_op_t op) _CUPS_API_1_2;
904extern ipp_op_t ippOpValue(const char *name) _CUPS_API_1_2;
a4d04587 905extern ipp_state_t ippReadIO(void *src, ipp_iocb_t cb, int blocking,
2fb76298 906 ipp_t *parent, ipp_t *ipp) _CUPS_API_1_2;
a4d04587 907extern ipp_state_t ippWriteIO(void *dst, ipp_iocb_t cb, int blocking,
2fb76298 908 ipp_t *parent, ipp_t *ipp) _CUPS_API_1_2;
ef416fc2 909
f3c17241 910/**** New in CUPS 1.4/OS X 10.6 ****/
1ff0402e
MS		 911extern const char *ippTagString(ipp_tag_t tag) _CUPS_API_1_4;
912extern ipp_tag_t ippTagValue(const char *name) _CUPS_API_1_4;
913
f3c17241 914/**** New in CUPS 1.6/OS X 10.8 ****/
9c80ffa2
MS		 915extern ipp_attribute_t *ippAddOutOfBand(ipp_t *ipp, ipp_tag_t group,
916 ipp_tag_t value_tag, const char *name)
917 _CUPS_API_1_6;
a2326b5b
MS		 918extern size_t ippAttributeString(ipp_attribute_t *attr, char *buffer,
919 size_t bufsize) _CUPS_API_1_6;
920extern ipp_attribute_t *ippCopyAttribute(ipp_t *dst, ipp_attribute_t *attr,
921 int quickcopy) _CUPS_API_1_6;
922extern int ippCopyAttributes(ipp_t *dst, ipp_t *src,
9c80ffa2
MS		 923 int quickcopy, ipp_copycb_t cb,
924 void *context) _CUPS_API_1_6;
925extern int ippDeleteValues(ipp_t *ipp, ipp_attribute_t **attr,
926 int element, int count) _CUPS_API_1_6;
927extern const char *ippEnumString(const char *attrname, int enumvalue)
928 _CUPS_API_1_6;
929extern int ippEnumValue(const char *attrname,
930 const char *enumstring) _CUPS_API_1_6;
a2326b5b
MS		 931extern ipp_attribute_t *ippFirstAttribute(ipp_t *ipp) _CUPS_API_1_6;
932extern int ippGetBoolean(ipp_attribute_t *attr, int element)
933 _CUPS_API_1_6;
934extern ipp_t *ippGetCollection(ipp_attribute_t *attr,
935 int element) _CUPS_API_1_6;
936extern int ippGetCount(ipp_attribute_t *attr) _CUPS_API_1_6;
9c80ffa2
MS		 937extern const ipp_uchar_t *ippGetDate(ipp_attribute_t *attr, int element)
938 _CUPS_API_1_6;
a2326b5b
MS		 939extern ipp_tag_t ippGetGroupTag(ipp_attribute_t *attr) _CUPS_API_1_6;
940extern int ippGetInteger(ipp_attribute_t *attr, int element)
941 _CUPS_API_1_6;
942extern const char *ippGetName(ipp_attribute_t *attr) _CUPS_API_1_6;
943extern ipp_op_t ippGetOperation(ipp_t *ipp) _CUPS_API_1_6;
9c80ffa2
MS		 944extern int ippGetRange(ipp_attribute_t *attr, int element,
945 int *upper) _CUPS_API_1_6;
a2326b5b
MS		 946extern int ippGetRequestId(ipp_t *ipp) _CUPS_API_1_6;
947extern int ippGetResolution(ipp_attribute_t *attr, int element,
9c80ffa2
MS		 948 int *yres, ipp_res_t *units)
949 _CUPS_API_1_6;
950extern ipp_state_t ippGetState(ipp_t *ipp) _CUPS_API_1_6;
a2326b5b
MS		 951extern ipp_status_t ippGetStatusCode(ipp_t *ipp) _CUPS_API_1_6;
952extern const char *ippGetString(ipp_attribute_t *attr, int element,
953 const char **language) _CUPS_API_1_6;
954extern ipp_tag_t ippGetValueTag(ipp_attribute_t *attr) _CUPS_API_1_6;
955extern int ippGetVersion(ipp_t *ipp, int *minor) _CUPS_API_1_6;
956extern ipp_attribute_t *ippNextAttribute(ipp_t *ipp) _CUPS_API_1_6;
957extern int ippSetBoolean(ipp_t *ipp, ipp_attribute_t **attr,
958 int element, int boolvalue) _CUPS_API_1_6;
959extern int ippSetCollection(ipp_t *ipp, ipp_attribute_t **attr,
9c80ffa2
MS		 960 int element, ipp_t *colvalue)
961 _CUPS_API_1_6;
962extern int ippSetDate(ipp_t *ipp, ipp_attribute_t **attr,
963 int element, const ipp_uchar_t *datevalue)
964 _CUPS_API_1_6;
a2326b5b
MS		 965extern int ippSetGroupTag(ipp_t *ipp, ipp_attribute_t **attr,
966 ipp_tag_t group_tag) _CUPS_API_1_6;
967extern int ippSetInteger(ipp_t *ipp, ipp_attribute_t **attr,
968 int element, int intvalue) _CUPS_API_1_6;
9c80ffa2
MS		 969extern int ippSetName(ipp_t *ipp, ipp_attribute_t **attr,
970 const char *name) _CUPS_API_1_6;
a2326b5b 971extern int ippSetOperation(ipp_t *ipp, ipp_op_t op) _CUPS_API_1_6;
9c80ffa2
MS		 972extern int ippSetRange(ipp_t *ipp, ipp_attribute_t **attr,
973 int element, int lowervalue, int uppervalue)
974 _CUPS_API_1_6;
a2326b5b
MS		 975extern int ippSetRequestId(ipp_t *ipp, int request_id)
976 _CUPS_API_1_6;
977extern int ippSetResolution(ipp_t *ipp, ipp_attribute_t **attr,
978 int element, ipp_res_t unitsvalue,
9c80ffa2
MS		 979 int xresvalue, int yresvalue)
980 _CUPS_API_1_6;
981extern int ippSetState(ipp_t *ipp, ipp_state_t state)
982 _CUPS_API_1_6;
983extern int ippSetStatusCode(ipp_t *ipp, ipp_status_t status)
984 _CUPS_API_1_6;
a2326b5b 985extern int ippSetString(ipp_t *ipp, ipp_attribute_t **attr,
9c80ffa2
MS		 986 int element, const char *strvalue)
987 _CUPS_API_1_6;
a2326b5b
MS		 988extern int ippSetValueTag(ipp_t *ipp, ipp_attribute_t **attr,
989 ipp_tag_t value_tag) _CUPS_API_1_6;
9c80ffa2
MS		 990extern int ippSetVersion(ipp_t *ipp, int major, int minor)
991 _CUPS_API_1_6;
a2326b5b 992
a469f8a5
MS		 993/**** New in CUPS 1.7 ****/
994extern ipp_attribute_t *ippAddStringf(ipp_t *ipp, ipp_tag_t group,
995 ipp_tag_t value_tag, const char *name,
996 const char *language, const char *format,
997 ...) _CUPS_API_1_7;
998extern ipp_attribute_t *ippAddStringfv(ipp_t *ipp, ipp_tag_t group,
999 ipp_tag_t value_tag, const char *name,
1000 const char *language,
1001 const char *format, va_list ap)
1002 _CUPS_API_1_7;
1003extern int ippContainsInteger(ipp_attribute_t *attr, int value)
1004 _CUPS_API_1_7;
1005extern int ippContainsString(ipp_attribute_t *attr,
1006 const char *value) _CUPS_API_1_7;
db8b865d 1007extern cups_array_t *ippCreateRequestedArray(ipp_t *request) _CUPS_API_1_7;
6961465f
MS		 1008extern void *ippGetOctetString(ipp_attribute_t *attr, int element,
1009 int *datalen) _CUPS_API_1_7;
a469f8a5 1010extern ipp_t *ippNewResponse(ipp_t *request) _CUPS_API_1_7;
6961465f
MS		 1011extern int ippSetOctetString(ipp_t *ipp, ipp_attribute_t **attr,
1012 int element, const void *data,
1013 int datalen) _CUPS_API_1_7;
a469f8a5
MS		 1014extern int ippSetStringf(ipp_t *ipp, ipp_attribute_t **attr,
1015 int element, const char *format,
1016 ...) _CUPS_API_1_7;
1017extern int ippSetStringfv(ipp_t *ipp, ipp_attribute_t **attr,
1018 int element, const char *format,
1019 va_list ap) _CUPS_API_1_7;
c1420c87
MS		 1020extern int ippValidateAttribute(ipp_attribute_t *attr)
1021 _CUPS_API_1_7;
1022extern int ippValidateAttributes(ipp_t *ipp) _CUPS_API_1_7;
a469f8a5 1023
ef416fc2 1024
d21dc0ed
MS		 1025/**** New in CUPS 2.0 ****/
1026extern const char *ippStateString(ipp_state_t state) _CUPS_API_2_0;
1027
1028
ef416fc2 1029/*
1030 * C++ magic...
1031 */
1032
1033# ifdef __cplusplus
1034}
1035# endif /* __cplusplus */
1036#endif /* !_CUPS_IPP_H_ */
1037
1038/*
354aadbe 1039 * End of "$Id: ipp.h 13138 2016-03-15 14:59:54Z msweet $".
ef416fc2 1040 */
Unnamed repository; edit this file 'description' to name the repository.