]> git.ipfire.org Git - thirdparty/cups.git/blame - cups/ipp.h
The ipptool program now supports EXPECT statements for collection member
[thirdparty/cups.git] / cups / ipp.h
CommitLineData
ef416fc2 1/*
f2d18633 2 * "$Id$"
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 */
249 IPP_OP_PRINT_URI, /* Print a single URL @private@ */
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 */
253 IPP_OP_SEND_URI, /* Add a URL to a job @private@ */
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 */
264 IPP_OP_SET_PRINTER_ATTRIBUTES, /* Set printer attributes @private@ */
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,
282 /* Stop printer after the current job @private@ */
283 IPP_OP_HOLD_NEW_JOBS, /* Hold new jobs @private@ */
284 IPP_OP_RELEASE_HELD_NEW_JOBS, /* Release new jobs @private@ */
285 IPP_OP_DEACTIVATE_PRINTER, /* Stop a printer @private@ */
286 IPP_OP_ACTIVATE_PRINTER, /* Start a printer @private@ */
287 IPP_OP_RESTART_PRINTER, /* Restart a printer @private@ */
288 IPP_OP_SHUTDOWN_PRINTER, /* Turn a printer off @private@ */
289 IPP_OP_STARTUP_PRINTER, /* Turn a printer on @private@ */
290 IPP_OP_REPROCESS_JOB, /* Reprint a job @private@ */
291 IPP_OP_CANCEL_CURRENT_JOB, /* Cancel the current job @private@ */
292 IPP_OP_SUSPEND_CURRENT_JOB, /* Suspend the current job @private@ */
293 IPP_OP_RESUME_JOB, /* Resume the current job @private@ */
294 IPP_OP_PROMOTE_JOB, /* Promote a job to print sooner @private@ */
295 IPP_OP_SCHEDULE_JOB_AFTER, /* Schedule a job to print after another @private@ */
296 IPP_OP_CANCEL_DOCUMENT = 0x0033, /* Cancel-Document @private@ */
297 IPP_OP_GET_DOCUMENT_ATTRIBUTES, /* Get-Document-Attributes @private@ */
298 IPP_OP_GET_DOCUMENTS, /* Get-Documents @private@ */
299 IPP_OP_DELETE_DOCUMENT, /* Delete-Document @private@ */
300 IPP_OP_SET_DOCUMENT_ATTRIBUTES, /* Set-Document-Attributes @private@ */
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 */
9475ec92
MS
305 IPP_OP_IDENTIFY_PRINTER, /* Identify-Printer @private@ */
306 IPP_OP_VALIDATE_DOCUMENT, /* Validate-Document @private@ */
307 IPP_OP_SEND_HARDCOPY_DOCUMENT, /* Send-Hardcopy-Document @private@ */
308
a469f8a5
MS
309 IPP_OP_PRIVATE = 0x4000, /* Reserved @private@ */
310 IPP_OP_CUPS_GET_DEFAULT, /* Get the default printer */
311 IPP_OP_CUPS_GET_PRINTERS, /* Get a list of printers and/or classes */
312 IPP_OP_CUPS_ADD_MODIFY_PRINTER, /* Add or modify a printer */
313 IPP_OP_CUPS_DELETE_PRINTER, /* Delete a printer */
314 IPP_OP_CUPS_GET_CLASSES, /* Get a list of classes @deprecated@ */
315 IPP_OP_CUPS_ADD_MODIFY_CLASS, /* Add or modify a class */
316 IPP_OP_CUPS_DELETE_CLASS, /* Delete a class */
317 IPP_OP_CUPS_ACCEPT_JOBS, /* Accept new jobs on a printer */
318 IPP_OP_CUPS_REJECT_JOBS, /* Reject new jobs on a printer */
319 IPP_OP_CUPS_SET_DEFAULT, /* Set the default printer */
320 IPP_OP_CUPS_GET_DEVICES, /* Get a list of supported devices */
321 IPP_OP_CUPS_GET_PPDS, /* Get a list of supported drivers */
322 IPP_OP_CUPS_MOVE_JOB, /* Move a job to a different printer */
323 IPP_OP_CUPS_AUTHENTICATE_JOB, /* Authenticate a job @since CUPS 1.2/OS X 10.5@ */
324 IPP_OP_CUPS_GET_PPD, /* Get a PPD file @since CUPS 1.3/OS X 10.5@ */
325 IPP_OP_CUPS_GET_DOCUMENT = 0x4027 /* Get a document file @since CUPS 1.4/OS X 10.6@ */
326
327# ifndef _CUPS_NO_DEPRECATED
328# define IPP_PRINT_JOB IPP_OP_PRINT_JOB
329# define IPP_PRINT_URI IPP_OP_PRINT_URI
330# define IPP_VALIDATE_JOB IPP_OP_VALIDATE_JOB
331# define IPP_CREATE_JOB IPP_OP_CREATE_JOB
332# define IPP_SEND_DOCUMENT IPP_OP_SEND_DOCUMENT
333# define IPP_SEND_URI IPP_OP_SEND_URI
334# define IPP_CANCEL_JOB IPP_OP_CANCEL_JOB
335# define IPP_GET_JOB_ATTRIBUTES IPP_OP_GET_JOB_ATTRIBUTES
336# define IPP_GET_JOBS IPP_OP_GET_JOBS
337# define IPP_GET_PRINTER_ATTRIBUTES IPP_OP_GET_PRINTER_ATTRIBUTES
338# define IPP_HOLD_JOB IPP_OP_HOLD_JOB
339# define IPP_RELEASE_JOB IPP_OP_RELEASE_JOB
340# define IPP_RESTART_JOB IPP_OP_RESTART_JOB
341# define IPP_PAUSE_PRINTER IPP_OP_PAUSE_PRINTER
342# define IPP_RESUME_PRINTER IPP_OP_RESUME_PRINTER
343# define IPP_PURGE_JOBS IPP_OP_PURGE_JOBS
344# define IPP_SET_PRINTER_ATTRIBUTES IPP_OP_SET_PRINTER_ATTRIBUTES
345# define IPP_SET_JOB_ATTRIBUTES IPP_OP_SET_JOB_ATTRIBUTES
346# define IPP_GET_PRINTER_SUPPORTED_VALUES IPP_OP_GET_PRINTER_SUPPORTED_VALUES
42404685
MS
347# define IPP_CREATE_PRINTER_SUBSCRIPTION IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS
348# define IPP_CREATE_JOB_SUBSCRIPTION IPP_OP_CREATE_JOB_SUBSCRIPTIONS
349# define IPP_OP_CREATE_PRINTER_SUBSCRIPTION IPP_OP_CREATE_PRINTER_SUBSCRIPTIONS
350# define IPP_OP_CREATE_JOB_SUBSCRIPTION IPP_OP_CREATE_JOB_SUBSCRIPTIONS
a469f8a5
MS
351# define IPP_GET_SUBSCRIPTION_ATTRIBUTES IPP_OP_GET_SUBSCRIPTION_ATTRIBUTES
352# define IPP_GET_SUBSCRIPTIONS IPP_OP_GET_SUBSCRIPTIONS
353# define IPP_RENEW_SUBSCRIPTION IPP_OP_RENEW_SUBSCRIPTION
354# define IPP_CANCEL_SUBSCRIPTION IPP_OP_CANCEL_SUBSCRIPTION
355# define IPP_GET_NOTIFICATIONS IPP_OP_GET_NOTIFICATIONS
356# define IPP_SEND_NOTIFICATIONS IPP_OP_SEND_NOTIFICATIONS
357# define IPP_GET_RESOURCE_ATTRIBUTES IPP_OP_GET_RESOURCE_ATTRIBUTES
358# define IPP_GET_RESOURCE_DATA IPP_OP_GET_RESOURCE_DATA
359# define IPP_GET_RESOURCES IPP_OP_GET_RESOURCES
360# define IPP_GET_PRINT_SUPPORT_FILES IPP_OP_GET_PRINT_SUPPORT_FILES
361# define IPP_ENABLE_PRINTER IPP_OP_ENABLE_PRINTER
362# define IPP_DISABLE_PRINTER IPP_OP_DISABLE_PRINTER
363# define IPP_PAUSE_PRINTER_AFTER_CURRENT_JOB IPP_OP_PAUSE_PRINTER_AFTER_CURRENT_JOB
364# define IPP_HOLD_NEW_JOBS IPP_OP_HOLD_NEW_JOBS
365# define IPP_RELEASE_HELD_NEW_JOBS IPP_OP_RELEASE_HELD_NEW_JOBS
366# define IPP_DEACTIVATE_PRINTER IPP_OP_DEACTIVATE_PRINTER
367# define IPP_ACTIVATE_PRINTER IPP_OP_ACTIVATE_PRINTER
368# define IPP_RESTART_PRINTER IPP_OP_RESTART_PRINTER
369# define IPP_SHUTDOWN_PRINTER IPP_OP_SHUTDOWN_PRINTER
370# define IPP_STARTUP_PRINTER IPP_OP_STARTUP_PRINTER
371# define IPP_REPROCESS_JOB IPP_OP_REPROCESS_JOB
372# define IPP_CANCEL_CURRENT_JOB IPP_OP_CANCEL_CURRENT_JOB
373# define IPP_SUSPEND_CURRENT_JOB IPP_OP_SUSPEND_CURRENT_JOB
374# define IPP_RESUME_JOB IPP_OP_RESUME_JOB
375# define IPP_PROMOTE_JOB IPP_OP_PROMOTE_JOB
376# define IPP_SCHEDULE_JOB_AFTER IPP_OP_SCHEDULE_JOB_AFTER
377# define IPP_CANCEL_DOCUMENT IPP_OP_CANCEL_DOCUMENT
378# define IPP_GET_DOCUMENT_ATTRIBUTES IPP_OP_GET_DOCUMENT_ATTRIBUTES
379# define IPP_GET_DOCUMENTS IPP_OP_GET_DOCUMENTS
380# define IPP_DELETE_DOCUMENT IPP_OP_DELETE_DOCUMENT
381# define IPP_SET_DOCUMENT_ATTRIBUTES IPP_OP_SET_DOCUMENT_ATTRIBUTES
382# define IPP_CANCEL_JOBS IPP_OP_CANCEL_JOBS
383# define IPP_CANCEL_MY_JOBS IPP_OP_CANCEL_MY_JOBS
384# define IPP_RESUBMIT_JOB IPP_OP_RESUBMIT_JOB
385# define IPP_CLOSE_JOB IPP_OP_CLOSE_JOB
386# define IPP_IDENTIFY_PRINTER IPP_OP_IDENTIFY_PRINTER
387# define IPP_VALIDATE_DOCUMENT IPP_OP_VALIDATE_DOCUMENT
388# define IPP_PRIVATE IPP_OP_PRIVATE
389# define CUPS_GET_DEFAULT IPP_OP_CUPS_GET_DEFAULT
390# define CUPS_GET_PRINTERS IPP_OP_CUPS_GET_PRINTERS
391# define CUPS_ADD_MODIFY_PRINTER IPP_OP_CUPS_ADD_MODIFY_PRINTER
392# define CUPS_DELETE_PRINTER IPP_OP_CUPS_DELETE_PRINTER
393# define CUPS_GET_CLASSES IPP_OP_CUPS_GET_CLASSES
394# define CUPS_ADD_MODIFY_CLASS IPP_OP_CUPS_ADD_MODIFY_CLASS
395# define CUPS_DELETE_CLASS IPP_OP_CUPS_DELETE_CLASS
396# define CUPS_ACCEPT_JOBS IPP_OP_CUPS_ACCEPT_JOBS
397# define CUPS_REJECT_JOBS IPP_OP_CUPS_REJECT_JOBS
398# define CUPS_SET_DEFAULT IPP_OP_CUPS_SET_DEFAULT
399# define CUPS_GET_DEVICES IPP_OP_CUPS_GET_DEVICES
400# define CUPS_GET_PPDS IPP_OP_CUPS_GET_PPDS
401# define CUPS_MOVE_JOB IPP_OP_CUPS_MOVE_JOB
402# define CUPS_AUTHENTICATE_JOB IPP_OP_CUPS_AUTHENTICATE_JOB
403# define CUPS_GET_PPD IPP_OP_CUPS_GET_PPD
404# define CUPS_GET_DOCUMENT IPP_OP_CUPS_GET_DOCUMENT
405 /* Legacy names */
406# define CUPS_ADD_PRINTER IPP_OP_CUPS_ADD_MODIFY_PRINTER
407# define CUPS_ADD_CLASS IPP_OP_CUPS_ADD_MODIFY_CLASS
408# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b
MS
409} ipp_op_t;
410
411typedef enum ipp_orient_e /**** Orientation values ****/
412{
a469f8a5
MS
413 IPP_ORIENT_PORTRAIT = 3, /* No rotation */
414 IPP_ORIENT_LANDSCAPE, /* 90 degrees counter-clockwise */
415 IPP_ORIENT_REVERSE_LANDSCAPE, /* 90 degrees clockwise */
8f787fca
MS
416 IPP_ORIENT_REVERSE_PORTRAIT, /* 180 degrees */
417 IPP_ORIENT_NONE /* No rotation */
a469f8a5
MS
418
419# ifndef _CUPS_NO_DEPRECATED
420# define IPP_PORTRAIT IPP_ORIENT_PORTRAIT
421# define IPP_LANDSCAPE IPP_ORIENT_LANDSCAPE
422# define IPP_REVERSE_LANDSCAPE IPP_ORIENT_REVERSE_LANDSCAPE
423# define IPP_REVERSE_PORTRAIT IPP_ORIENT_REVERSE_PORTRAIT
424# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b
MS
425} ipp_orient_t;
426
427typedef enum ipp_pstate_e /**** Printer states ****/
428{
a469f8a5
MS
429 IPP_PSTATE_IDLE = 3, /* Printer is idle */
430 IPP_PSTATE_PROCESSING, /* Printer is working */
431 IPP_PSTATE_STOPPED /* Printer is stopped */
432
433# ifndef _CUPS_NO_DEPRECATED
434# define IPP_PRINTER_IDLE IPP_PSTATE_IDLE
435# define IPP_PRINTER_PROCESSING IPP_PSTATE_PROCESSING
436# define IPP_PRINTER_STOPPED IPP_PSTATE_STOPPED
437# endif /* _CUPS_NO_DEPRECATED */
a2326b5b
MS
438} ipp_pstate_t;
439
440typedef enum ipp_quality_e /**** Qualities ****/
441{
442 IPP_QUALITY_DRAFT = 3, /* Draft quality */
443 IPP_QUALITY_NORMAL, /* Normal quality */
444 IPP_QUALITY_HIGH /* High quality */
445} ipp_quality_t;
446
447typedef enum ipp_res_e /**** Resolution units ****/
448{
449 IPP_RES_PER_INCH = 3, /* Pixels per inch */
450 IPP_RES_PER_CM /* Pixels per centimeter */
451} ipp_res_t;
452
453typedef enum ipp_state_e /**** IPP states ****/
454{
a469f8a5
MS
455 IPP_STATE_ERROR = -1, /* An error occurred */
456 IPP_STATE_IDLE, /* Nothing is happening/request completed */
457 IPP_STATE_HEADER, /* The request header needs to be sent/received */
458 IPP_STATE_ATTRIBUTE, /* One or more attributes need to be sent/received */
459 IPP_STATE_DATA /* IPP request data needs to be sent/received */
460
461# ifndef _CUPS_NO_DEPRECATED
462# define IPP_ERROR IPP_STATE_ERROR
463# define IPP_IDLE IPP_STATE_IDLE
464# define IPP_HEADER IPP_STATE_HEADER
465# define IPP_ATTRIBUTE IPP_STATE_ATTRIBUTE
466# define IPP_DATA IPP_STATE_DATA
467# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b 468} ipp_state_t;
fa73b229 469
5a6b583a 470typedef enum ipp_status_e /**** IPP status codes ****/
ef416fc2 471{
dcb445bc 472 IPP_STATUS_CUPS_INVALID = -1, /* Invalid status name for @link ippErrorValue@ */
a469f8a5
MS
473 IPP_STATUS_OK = 0x0000, /* successful-ok */
474 IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED, /* successful-ok-ignored-or-substituted-attributes */
475 IPP_STATUS_OK_CONFLICTING, /* successful-ok-conflicting-attributes */
476 IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS, /* successful-ok-ignored-subscriptions */
477 IPP_STATUS_OK_IGNORED_NOTIFICATIONS, /* successful-ok-ignored-notifications @private@ */
478 IPP_STATUS_OK_TOO_MANY_EVENTS, /* successful-ok-too-many-events */
479 IPP_STATUS_OK_BUT_CANCEL_SUBSCRIPTION,/* successful-ok-but-cancel-subscription @private@ */
480 IPP_STATUS_OK_EVENTS_COMPLETE, /* successful-ok-events-complete */
481 IPP_STATUS_REDIRECTION_OTHER_SITE = 0x0200,
482 /* redirection-other-site @private@ */
483 IPP_STATUS_CUPS_SEE_OTHER = 0x0280, /* cups-see-other */
484 IPP_STATUS_ERROR_BAD_REQUEST = 0x0400,/* client-error-bad-request */
485 IPP_STATUS_ERROR_FORBIDDEN, /* client-error-forbidden */
486 IPP_STATUS_ERROR_NOT_AUTHENTICATED, /* client-error-not-authenticated */
487 IPP_STATUS_ERROR_NOT_AUTHORIZED, /* client-error-not-authorized */
488 IPP_STATUS_ERROR_NOT_POSSIBLE, /* client-error-not-possible */
489 IPP_STATUS_ERROR_TIMEOUT, /* client-error-timeout */
490 IPP_STATUS_ERROR_NOT_FOUND, /* client-error-not-found */
491 IPP_STATUS_ERROR_GONE, /* client-error-gone */
492 IPP_STATUS_ERROR_REQUEST_ENTITY, /* client-error-request-entity-too-large */
493 IPP_STATUS_ERROR_REQUEST_VALUE, /* client-error-request-value-too-long */
494 IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED,
495 /* client-error-document-format-not-supported */
496 IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES,/* client-error-attributes-or-values-not-supported */
497 IPP_STATUS_ERROR_URI_SCHEME, /* client-error-uri-scheme-not-supported */
498 IPP_STATUS_ERROR_CHARSET, /* client-error-charset-not-supported */
499 IPP_STATUS_ERROR_CONFLICTING, /* client-error-conflicting-attributes */
500 IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED,
501 /* client-error-compression-not-supported */
502 IPP_STATUS_ERROR_COMPRESSION_ERROR, /* client-error-compression-error */
503 IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR,
504 /* client-error-document-format-error */
505 IPP_STATUS_ERROR_DOCUMENT_ACCESS, /* client-error-document-access-error */
506 IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE,
507 /* client-error-attributes-not-settable */
508 IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS,
509 /* client-error-ignored-all-subscriptions */
510 IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS,
511 /* client-error-too-many-subscriptions */
512 IPP_STATUS_ERROR_IGNORED_ALL_NOTIFICATIONS,
513 /* client-error-ignored-all-notifications @private@ */
514 IPP_STATUS_ERROR_PRINT_SUPPORT_FILE_NOT_FOUND,
515 /* client-error-print-support-file-not-found @private@ */
516 IPP_STATUS_ERROR_DOCUMENT_PASSWORD, /* client-error-document-password-error */
517 IPP_STATUS_ERROR_DOCUMENT_PERMISSION, /* client-error-document-permission-error */
518 IPP_STATUS_ERROR_DOCUMENT_SECURITY, /* client-error-document-security-error */
519 IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE,/* client-error-document-unprintable-error */
6b13fa61
MS
520 IPP_STATUS_ERROR_ACCOUNT_INFO_NEEDED, /* client-error-account-info-needed */
521 IPP_STATUS_ERROR_ACCOUNT_CLOSED, /* client-error-account-closed */
522 IPP_STATUS_ERROR_ACCOUNT_LIMIT_REACHED,
523 /* client-error-account-limit-reached */
524 IPP_STATUS_ERROR_ACCOUNT_AUTHORIZATION_FAILED,
525 /* client-error-account-authorization-failed */
526
527 /* Legacy status codes for paid printing */
a469f8a5 528 IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED = 0x049C,
6b13fa61
MS
529 /* cups-error-account-info-needed @deprecated@ */
530 IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED, /* cups-error-account-closed @deprecate@ */
a469f8a5 531 IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED,
6b13fa61 532 /* cups-error-account-limit-reached @deprecated@ */
a469f8a5 533 IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED,
6b13fa61 534 /* cups-error-account-authorization-failed @deprecated@ */
a469f8a5
MS
535
536 IPP_STATUS_ERROR_INTERNAL = 0x0500, /* server-error-internal-error */
537 IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED,
538 /* server-error-operation-not-supported */
539 IPP_STATUS_ERROR_SERVICE_UNAVAILABLE, /* server-error-service-unavailable */
540 IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED,
541 /* server-error-version-not-supported */
542 IPP_STATUS_ERROR_DEVICE, /* server-error-device-error */
543 IPP_STATUS_ERROR_TEMPORARY, /* server-error-temporary-error */
544 IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS, /* server-error-not-accepting-jobs */
545 IPP_STATUS_ERROR_BUSY, /* server-error-busy */
546 IPP_STATUS_ERROR_JOB_CANCELED, /* server-error-job-canceled */
547 IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED,
548 /* server-error-multiple-document-jobs-not-supported */
549 IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED,
550 /* server-error-printer-is-deactivated */
551 IPP_STATUS_ERROR_TOO_MANY_JOBS, /* server-error-too-many-jobs */
552 IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS, /* server-error-too-many-documents */
553
554 /* These are internal and never sent over the wire... */
555 IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED = 0x1000,
556 /* cups-authentication-canceled - Authentication canceled by user @since CUPS 1.5/OS X 10.7@ */
557 IPP_STATUS_ERROR_CUPS_PKI, /* cups-pki-error - Error negotiating a secure connection @since CUPS 1.5/OS X 10.7@ */
558 IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED/* cups-upgrade-required - TLS upgrade required */
559
560# ifndef _CUPS_NO_DEPRECATED
561# define IPP_OK IPP_STATUS_OK
562# define IPP_OK_SUBST IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED
563# define IPP_OK_CONFLICT IPP_STATUS_OK_CONFLICTING
564# define IPP_OK_IGNORED_SUBSCRIPTIONS IPP_STATUS_OK_IGNORED_SUBSCRIPTIONS
565# define IPP_OK_IGNORED_NOTIFICATIONS IPP_STATUS_OK_IGNORED_NOTIFICATIONS
566# define IPP_OK_TOO_MANY_EVENTS IPP_STATUS_OK_TOO_MANY_EVENTS
567# define IPP_OK_BUT_CANCEL_SUBSCRIPTION IPP_STATUS_OK_BUT_CANCEL_SUBSCRIPTION
568# define IPP_OK_EVENTS_COMPLETE IPP_STATUS_OK_EVENTS_COMPLETE
569# define IPP_REDIRECTION_OTHER_SITE IPP_STATUS_REDIRECTION_OTHER_SITE
570# define CUPS_SEE_OTHER IPP_STATUS_CUPS_SEE_OTHER
571# define IPP_BAD_REQUEST IPP_STATUS_ERROR_BAD_REQUEST
572# define IPP_FORBIDDEN IPP_STATUS_ERROR_FORBIDDEN
573# define IPP_NOT_AUTHENTICATED IPP_STATUS_ERROR_NOT_AUTHENTICATED
574# define IPP_NOT_AUTHORIZED IPP_STATUS_ERROR_NOT_AUTHORIZED
575# define IPP_NOT_POSSIBLE IPP_STATUS_ERROR_NOT_POSSIBLE
576# define IPP_TIMEOUT IPP_STATUS_ERROR_TIMEOUT
577# define IPP_NOT_FOUND IPP_STATUS_ERROR_NOT_FOUND
578# define IPP_GONE IPP_STATUS_ERROR_GONE
579# define IPP_REQUEST_ENTITY IPP_STATUS_ERROR_REQUEST_ENTITY
580# define IPP_REQUEST_VALUE IPP_STATUS_ERROR_REQUEST_VALUE
581# define IPP_DOCUMENT_FORMAT IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
582# define IPP_ATTRIBUTES IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
583# define IPP_URI_SCHEME IPP_STATUS_ERROR_URI_SCHEME
584# define IPP_CHARSET IPP_STATUS_ERROR_CHARSET
585# define IPP_CONFLICT IPP_STATUS_ERROR_CONFLICTING
586# define IPP_COMPRESSION_NOT_SUPPORTED IPP_STATUS_ERROR_COMPRESSION_NOT_SUPPORTED
587# define IPP_COMPRESSION_ERROR IPP_STATUS_ERROR_COMPRESSION_ERROR
588# define IPP_DOCUMENT_FORMAT_ERROR IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
589# define IPP_DOCUMENT_ACCESS_ERROR IPP_STATUS_ERROR_DOCUMENT_ACCESS
590# define IPP_ATTRIBUTES_NOT_SETTABLE IPP_STATUS_ERROR_ATTRIBUTES_NOT_SETTABLE
591# define IPP_IGNORED_ALL_SUBSCRIPTIONS IPP_STATUS_ERROR_IGNORED_ALL_SUBSCRIPTIONS
592# define IPP_TOO_MANY_SUBSCRIPTIONS IPP_STATUS_ERROR_TOO_MANY_SUBSCRIPTIONS
593# define IPP_IGNORED_ALL_NOTIFICATIONS IPP_STATUS_ERROR_IGNORED_ALL_NOTIFICATIONS
594# define IPP_PRINT_SUPPORT_FILE_NOT_FOUND IPP_STATUS_ERROR_PRINT_SUPPORT_FILE_NOT_FOUND
595# define IPP_DOCUMENT_PASSWORD_ERROR IPP_STATUS_ERROR_DOCUMENT_PASSWORD
596# define IPP_DOCUMENT_PERMISSION_ERROR IPP_STATUS_ERROR_DOCUMENT_PERMISSION
597# define IPP_DOCUMENT_SECURITY_ERROR IPP_STATUS_ERROR_DOCUMENT_SECURITY
598# define IPP_DOCUMENT_UNPRINTABLE_ERROR IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
599# define IPP_INTERNAL_ERROR IPP_STATUS_ERROR_INTERNAL
600# define IPP_OPERATION_NOT_SUPPORTED IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
601# define IPP_SERVICE_UNAVAILABLE IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
602# define IPP_VERSION_NOT_SUPPORTED IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED
603# define IPP_DEVICE_ERROR IPP_STATUS_ERROR_DEVICE
604# define IPP_TEMPORARY_ERROR IPP_STATUS_ERROR_TEMPORARY
605# define IPP_NOT_ACCEPTING IPP_STATUS_ERROR_NOT_ACCEPTING_JOBS
606# define IPP_PRINTER_BUSY IPP_STATUS_ERROR_BUSY
607# define IPP_ERROR_JOB_CANCELED IPP_STATUS_ERROR_JOB_CANCELED
608# define IPP_MULTIPLE_JOBS_NOT_SUPPORTED IPP_STATUS_ERROR_MULTIPLE_JOBS_NOT_SUPPORTED
609# define IPP_PRINTER_IS_DEACTIVATED IPP_STATUS_ERROR_PRINTER_IS_DEACTIVATED
610# define IPP_TOO_MANY_JOBS IPP_STATUS_ERROR_TOO_MANY_JOBS
611# define IPP_TOO_MANY_DOCUMENTS IPP_STATUS_ERROR_TOO_MANY_DOCUMENTS
612# define IPP_AUTHENTICATION_CANCELED IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
613# define IPP_PKI_ERROR IPP_STATUS_ERROR_CUPS_PKI
614# define IPP_UPGRADE_REQUIRED IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
615 /* Legacy name for canceled status */
616# define IPP_ERROR_JOB_CANCELLED IPP_STATUS_ERROR_JOB_CANCELED
617# endif /* _CUPS_NO_DEPRECATED */
a2326b5b 618} ipp_status_t;
ef416fc2 619
a2326b5b 620typedef enum ipp_tag_e /**** Format tags for attributes ****/
ef416fc2 621{
dcb445bc 622 IPP_TAG_CUPS_INVALID = -1, /* Invalid tag name for @link ippTagValue@ */
a2326b5b
MS
623 IPP_TAG_ZERO = 0x00, /* Zero tag - used for separators */
624 IPP_TAG_OPERATION, /* Operation group */
625 IPP_TAG_JOB, /* Job group */
626 IPP_TAG_END, /* End-of-attributes */
627 IPP_TAG_PRINTER, /* Printer group */
628 IPP_TAG_UNSUPPORTED_GROUP, /* Unsupported attributes group */
629 IPP_TAG_SUBSCRIPTION, /* Subscription group */
630 IPP_TAG_EVENT_NOTIFICATION, /* Event group */
631 IPP_TAG_RESOURCE, /* Resource group @private@ */
632 IPP_TAG_DOCUMENT, /* Document group */
633 IPP_TAG_UNSUPPORTED_VALUE = 0x10, /* Unsupported value */
634 IPP_TAG_DEFAULT, /* Default value */
635 IPP_TAG_UNKNOWN, /* Unknown value */
636 IPP_TAG_NOVALUE, /* No-value value */
637 IPP_TAG_NOTSETTABLE = 0x15, /* Not-settable value */
638 IPP_TAG_DELETEATTR, /* Delete-attribute value */
639 IPP_TAG_ADMINDEFINE, /* Admin-defined value */
640 IPP_TAG_INTEGER = 0x21, /* Integer value */
641 IPP_TAG_BOOLEAN, /* Boolean value */
642 IPP_TAG_ENUM, /* Enumeration value */
643 IPP_TAG_STRING = 0x30, /* Octet string value */
644 IPP_TAG_DATE, /* Date/time value */
645 IPP_TAG_RESOLUTION, /* Resolution value */
646 IPP_TAG_RANGE, /* Range value */
647 IPP_TAG_BEGIN_COLLECTION, /* Beginning of collection value */
648 IPP_TAG_TEXTLANG, /* Text-with-language value */
649 IPP_TAG_NAMELANG, /* Name-with-language value */
650 IPP_TAG_END_COLLECTION, /* End of collection value */
651 IPP_TAG_TEXT = 0x41, /* Text value */
652 IPP_TAG_NAME, /* Name value */
653 IPP_TAG_RESERVED_STRING, /* Reserved for future string value @private@ */
654 IPP_TAG_KEYWORD, /* Keyword value */
655 IPP_TAG_URI, /* URI value */
656 IPP_TAG_URISCHEME, /* URI scheme value */
657 IPP_TAG_CHARSET, /* Character set value */
658 IPP_TAG_LANGUAGE, /* Language value */
659 IPP_TAG_MIMETYPE, /* MIME media type value */
660 IPP_TAG_MEMBERNAME, /* Collection member name value */
661 IPP_TAG_EXTENSION = 0x7f, /* Extension point for 32-bit tags */
a469f8a5 662 IPP_TAG_CUPS_MASK = 0x7fffffff, /* Mask for copied attribute values @private@ */
a2326b5b 663 /* The following expression is used to avoid compiler warnings with +/-0x80000000 */
a469f8a5
MS
664 IPP_TAG_CUPS_CONST = -0x7fffffff-1 /* Bitflag for copied/const attribute values @private@ */
665
666# ifndef _CUPS_NO_DEPRECATED
667# define IPP_TAG_MASK IPP_TAG_CUPS_MASK
668# define IPP_TAG_COPY IPP_TAG_CUPS_CONST
669# endif /* !_CUPS_NO_DEPRECATED */
a2326b5b 670} ipp_tag_t;
ef416fc2 671
a2326b5b
MS
672typedef unsigned char ipp_uchar_t; /**** Unsigned 8-bit integer/character ****/
673typedef struct _ipp_s ipp_t; /**** IPP request/response data ****/
674typedef struct _ipp_attribute_s ipp_attribute_t;
675 /**** IPP attribute ****/
ef416fc2 676
f3c17241 677/**** New in CUPS 1.2/OS X 10.5 ****/
a2326b5b 678typedef ssize_t (*ipp_iocb_t)(void *context, ipp_uchar_t *buffer, size_t bytes);
f3c17241 679 /**** IPP IO Callback Function @since CUPS 1.2/OS X 10.5@ ****/
aaf19ab0 680
f3c17241 681/**** New in CUPS 1.6/OS X 10.8 ****/
a2326b5b 682typedef int (*ipp_copycb_t)(void *context, ipp_t *dst, ipp_attribute_t *attr);
ef416fc2 683
684
82cc1f9a 685/*
f3c17241
MS
686 * The following structures are PRIVATE starting with CUPS 1.6/OS X 10.8.
687 * Please use the new accessor functions available in CUPS 1.6 and later, as
688 * these definitions will be moved to a private header file in a future release.
82cc1f9a 689 *
a469f8a5 690 * Define _IPP_PRIVATE_STRUCTURES to 1 to cause the private IPP structures to be
f3c17241
MS
691 * exposed in CUPS 1.6. This happens automatically on OS X when compiling for
692 * a deployment target of 10.7 or earlier.
a469f8a5
MS
693 *
694 * Define _IPP_PRIVATE_STRUCTURES to 0 to prevent the private IPP structures
695 * from being exposed. This is useful when migrating existing code to the new
696 * accessors.
82cc1f9a
MS
697 */
698
a469f8a5
MS
699# ifdef _IPP_PRIVATE_STRUCTURES
700 /* Somebody has overridden the value */
701# elif defined(_CUPS_SOURCE) || defined(_CUPS_IPP_PRIVATE_H_)
82cc1f9a
MS
702 /* Building CUPS */
703# define _IPP_PRIVATE_STRUCTURES 1
704# elif defined(__APPLE__)
705# if defined(MAC_OS_X_VERSION_10_8) && MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_8
706 /* Building for 10.7 and earlier */
707# define _IPP_PRIVATE_STRUCTURES 1
708# elif !defined(MAC_OS_X_VERSION_10_8)
709 /* Building for 10.7 and earlier */
710# define _IPP_PRIVATE_STRUCTURES 1
711# endif /* MAC_OS_X_VERSION_10_8 && MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_8 */
a469f8a5
MS
712# else
713# define _IPP_PRIVATE_STRUCTURES 0
82cc1f9a
MS
714# endif /* _CUPS_SOURCE || _CUPS_IPP_PRIVATE_H_ */
715
a469f8a5 716# if _IPP_PRIVATE_STRUCTURES
82cc1f9a
MS
717typedef union _ipp_request_u /**** Request Header ****/
718{
719 struct /* Any Header */
720 {
721 ipp_uchar_t version[2]; /* Protocol version number */
722 int op_status; /* Operation ID or status code*/
723 int request_id; /* Request ID */
724 } any;
725
726 struct /* Operation Header */
727 {
728 ipp_uchar_t version[2]; /* Protocol version number */
729 ipp_op_t operation_id; /* Operation ID */
730 int request_id; /* Request ID */
731 } op;
732
733 struct /* Status Header */
734 {
735 ipp_uchar_t version[2]; /* Protocol version number */
736 ipp_status_t status_code; /* Status code */
737 int request_id; /* Request ID */
738 } status;
739
740 /**** New in CUPS 1.1.19 ****/
f3c17241 741 struct /* Event Header @since CUPS 1.1.19/OS X 10.3@ */
82cc1f9a
MS
742 {
743 ipp_uchar_t version[2]; /* Protocol version number */
744 ipp_status_t status_code; /* Status code */
745 int request_id; /* Request ID */
746 } event;
747} _ipp_request_t;
748
749/**** New in CUPS 1.1.19 ****/
750
751typedef union _ipp_value_u /**** Attribute Value ****/
752{
753 int integer; /* Integer/enumerated value */
754
755 char boolean; /* Boolean value */
756
757 ipp_uchar_t date[11]; /* Date/time value */
758
759 struct
760 {
761 int xres, /* Horizontal resolution */
762 yres; /* Vertical resolution */
763 ipp_res_t units; /* Resolution units */
764 } resolution; /* Resolution value */
765
766 struct
767 {
768 int lower, /* Lower value */
769 upper; /* Upper value */
770 } range; /* Range of integers value */
771
772 struct
773 {
774 char *language; /* Language code */
775 char *text; /* String */
776 } string; /* String with language value */
777
778 struct
779 {
780 int length; /* Length of attribute */
781 void *data; /* Data in attribute */
782 } unknown; /* Unknown attribute type */
783
784/**** New in CUPS 1.1.19 ****/
f3c17241 785 ipp_t *collection; /* Collection value @since CUPS 1.1.19/OS X 10.3@ */
82cc1f9a
MS
786} _ipp_value_t;
787typedef _ipp_value_t ipp_value_t; /**** Convenience typedef that will be removed @private@ ****/
788
789struct _ipp_attribute_s /**** Attribute ****/
790{
791 ipp_attribute_t *next; /* Next attribute in list */
792 ipp_tag_t group_tag, /* Job/Printer/Operation group tag */
793 value_tag; /* What type of value is it? */
794 char *name; /* Name of attribute */
795 int num_values; /* Number of values */
796 _ipp_value_t values[1]; /* Values */
797};
798
799struct _ipp_s /**** IPP Request/Response/Notification ****/
800{
801 ipp_state_t state; /* State of request */
802 _ipp_request_t request; /* Request header */
803 ipp_attribute_t *attrs; /* Attributes */
804 ipp_attribute_t *last; /* Last attribute in list */
805 ipp_attribute_t *current; /* Current attribute (for read/write) */
806 ipp_tag_t curtag; /* Current attribute group tag */
807
808/**** New in CUPS 1.2 ****/
f3c17241 809 ipp_attribute_t *prev; /* Previous attribute (for read) @since CUPS 1.2/OS X 10.5@ */
82cc1f9a
MS
810
811/**** New in CUPS 1.4.4 ****/
f3c17241 812 int use; /* Use count @since CUPS 1.4.4/OS X 10.6.?@ */
f2a31e21
MS
813/**** New in CUPS 2.0 ****/
814 int atend, /* At end of list? */
815 curindex; /* Current attribute index for hierarchical search */
82cc1f9a
MS
816};
817# endif /* _IPP_PRIVATE_STRUCTURES */
818
819
ef416fc2 820/*
821 * Prototypes...
822 */
823
fa73b229 824extern ipp_attribute_t *ippAddBoolean(ipp_t *ipp, ipp_tag_t group,
825 const char *name, char value);
826extern ipp_attribute_t *ippAddBooleans(ipp_t *ipp, ipp_tag_t group,
827 const char *name, int num_values,
828 const char *values);
829extern ipp_attribute_t *ippAddDate(ipp_t *ipp, ipp_tag_t group,
830 const char *name, const ipp_uchar_t *value);
831extern ipp_attribute_t *ippAddInteger(ipp_t *ipp, ipp_tag_t group,
a2326b5b 832 ipp_tag_t value_tag, const char *name,
fa73b229 833 int value);
834extern ipp_attribute_t *ippAddIntegers(ipp_t *ipp, ipp_tag_t group,
a2326b5b 835 ipp_tag_t value_tag, const char *name,
fa73b229 836 int num_values, const int *values);
837extern ipp_attribute_t *ippAddRange(ipp_t *ipp, ipp_tag_t group,
838 const char *name, int lower, int upper);
839extern ipp_attribute_t *ippAddRanges(ipp_t *ipp, ipp_tag_t group,
840 const char *name, int num_values,
841 const int *lower, const int *upper);
842extern ipp_attribute_t *ippAddResolution(ipp_t *ipp, ipp_tag_t group,
843 const char *name, ipp_res_t units,
844 int xres, int yres);
845extern ipp_attribute_t *ippAddResolutions(ipp_t *ipp, ipp_tag_t group,
846 const char *name, int num_values,
847 ipp_res_t units, const int *xres,
848 const int *yres);
ef416fc2 849extern ipp_attribute_t *ippAddSeparator(ipp_t *ipp);
fa73b229 850extern ipp_attribute_t *ippAddString(ipp_t *ipp, ipp_tag_t group,
a2326b5b
MS
851 ipp_tag_t value_tag, const char *name,
852 const char *language, const char *value);
fa73b229 853extern ipp_attribute_t *ippAddStrings(ipp_t *ipp, ipp_tag_t group,
a2326b5b
MS
854 ipp_tag_t value_tag, const char *name,
855 int num_values, const char *language,
fa73b229 856 const char * const *values);
ef416fc2 857extern time_t ippDateToTime(const ipp_uchar_t *date);
858extern void ippDelete(ipp_t *ipp);
859extern const char *ippErrorString(ipp_status_t error);
860extern ipp_attribute_t *ippFindAttribute(ipp_t *ipp, const char *name,
a2326b5b 861 ipp_tag_t value_tag);
ef416fc2 862extern ipp_attribute_t *ippFindNextAttribute(ipp_t *ipp, const char *name,
a2326b5b 863 ipp_tag_t value_tag);
ef416fc2 864extern size_t ippLength(ipp_t *ipp);
865extern ipp_t *ippNew(void);
866extern ipp_state_t ippRead(http_t *http, ipp_t *ipp);
867extern const ipp_uchar_t *ippTimeToDate(time_t t);
868extern ipp_state_t ippWrite(http_t *http, ipp_t *ipp);
869extern int ippPort(void);
870extern void ippSetPort(int p);
871
872/**** New in CUPS 1.1.19 ****/
fa73b229 873extern ipp_attribute_t *ippAddCollection(ipp_t *ipp, ipp_tag_t group,
2fb76298 874 const char *name, ipp_t *value) _CUPS_API_1_1_19;
fa73b229 875extern ipp_attribute_t *ippAddCollections(ipp_t *ipp, ipp_tag_t group,
876 const char *name, int num_values,
2fb76298
MS
877 const ipp_t **values) _CUPS_API_1_1_19;
878extern void ippDeleteAttribute(ipp_t *ipp, ipp_attribute_t *attr) _CUPS_API_1_1_19;
879extern ipp_state_t ippReadFile(int fd, ipp_t *ipp) _CUPS_API_1_1_19;
880extern ipp_state_t ippWriteFile(int fd, ipp_t *ipp) _CUPS_API_1_1_19;
ef416fc2 881
f3c17241 882/**** New in CUPS 1.2/OS X 10.5 ****/
ef416fc2 883extern ipp_attribute_t *ippAddOctetString(ipp_t *ipp, ipp_tag_t group,
884 const char *name,
2fb76298
MS
885 const void *data, int datalen) _CUPS_API_1_2;
886extern ipp_status_t ippErrorValue(const char *name) _CUPS_API_1_2;
887extern ipp_t *ippNewRequest(ipp_op_t op) _CUPS_API_1_2;
888extern const char *ippOpString(ipp_op_t op) _CUPS_API_1_2;
889extern ipp_op_t ippOpValue(const char *name) _CUPS_API_1_2;
a4d04587 890extern ipp_state_t ippReadIO(void *src, ipp_iocb_t cb, int blocking,
2fb76298 891 ipp_t *parent, ipp_t *ipp) _CUPS_API_1_2;
a4d04587 892extern ipp_state_t ippWriteIO(void *dst, ipp_iocb_t cb, int blocking,
2fb76298 893 ipp_t *parent, ipp_t *ipp) _CUPS_API_1_2;
ef416fc2 894
f3c17241 895/**** New in CUPS 1.4/OS X 10.6 ****/
1ff0402e
MS
896extern const char *ippTagString(ipp_tag_t tag) _CUPS_API_1_4;
897extern ipp_tag_t ippTagValue(const char *name) _CUPS_API_1_4;
898
f3c17241 899/**** New in CUPS 1.6/OS X 10.8 ****/
9c80ffa2
MS
900extern ipp_attribute_t *ippAddOutOfBand(ipp_t *ipp, ipp_tag_t group,
901 ipp_tag_t value_tag, const char *name)
902 _CUPS_API_1_6;
a2326b5b
MS
903extern size_t ippAttributeString(ipp_attribute_t *attr, char *buffer,
904 size_t bufsize) _CUPS_API_1_6;
905extern ipp_attribute_t *ippCopyAttribute(ipp_t *dst, ipp_attribute_t *attr,
906 int quickcopy) _CUPS_API_1_6;
907extern int ippCopyAttributes(ipp_t *dst, ipp_t *src,
9c80ffa2
MS
908 int quickcopy, ipp_copycb_t cb,
909 void *context) _CUPS_API_1_6;
910extern int ippDeleteValues(ipp_t *ipp, ipp_attribute_t **attr,
911 int element, int count) _CUPS_API_1_6;
912extern const char *ippEnumString(const char *attrname, int enumvalue)
913 _CUPS_API_1_6;
914extern int ippEnumValue(const char *attrname,
915 const char *enumstring) _CUPS_API_1_6;
a2326b5b
MS
916extern ipp_attribute_t *ippFirstAttribute(ipp_t *ipp) _CUPS_API_1_6;
917extern int ippGetBoolean(ipp_attribute_t *attr, int element)
918 _CUPS_API_1_6;
919extern ipp_t *ippGetCollection(ipp_attribute_t *attr,
920 int element) _CUPS_API_1_6;
921extern int ippGetCount(ipp_attribute_t *attr) _CUPS_API_1_6;
9c80ffa2
MS
922extern const ipp_uchar_t *ippGetDate(ipp_attribute_t *attr, int element)
923 _CUPS_API_1_6;
a2326b5b
MS
924extern ipp_tag_t ippGetGroupTag(ipp_attribute_t *attr) _CUPS_API_1_6;
925extern int ippGetInteger(ipp_attribute_t *attr, int element)
926 _CUPS_API_1_6;
927extern const char *ippGetName(ipp_attribute_t *attr) _CUPS_API_1_6;
928extern ipp_op_t ippGetOperation(ipp_t *ipp) _CUPS_API_1_6;
9c80ffa2
MS
929extern int ippGetRange(ipp_attribute_t *attr, int element,
930 int *upper) _CUPS_API_1_6;
a2326b5b
MS
931extern int ippGetRequestId(ipp_t *ipp) _CUPS_API_1_6;
932extern int ippGetResolution(ipp_attribute_t *attr, int element,
9c80ffa2
MS
933 int *yres, ipp_res_t *units)
934 _CUPS_API_1_6;
935extern ipp_state_t ippGetState(ipp_t *ipp) _CUPS_API_1_6;
a2326b5b
MS
936extern ipp_status_t ippGetStatusCode(ipp_t *ipp) _CUPS_API_1_6;
937extern const char *ippGetString(ipp_attribute_t *attr, int element,
938 const char **language) _CUPS_API_1_6;
939extern ipp_tag_t ippGetValueTag(ipp_attribute_t *attr) _CUPS_API_1_6;
940extern int ippGetVersion(ipp_t *ipp, int *minor) _CUPS_API_1_6;
941extern ipp_attribute_t *ippNextAttribute(ipp_t *ipp) _CUPS_API_1_6;
942extern int ippSetBoolean(ipp_t *ipp, ipp_attribute_t **attr,
943 int element, int boolvalue) _CUPS_API_1_6;
944extern int ippSetCollection(ipp_t *ipp, ipp_attribute_t **attr,
9c80ffa2
MS
945 int element, ipp_t *colvalue)
946 _CUPS_API_1_6;
947extern int ippSetDate(ipp_t *ipp, ipp_attribute_t **attr,
948 int element, const ipp_uchar_t *datevalue)
949 _CUPS_API_1_6;
a2326b5b
MS
950extern int ippSetGroupTag(ipp_t *ipp, ipp_attribute_t **attr,
951 ipp_tag_t group_tag) _CUPS_API_1_6;
952extern int ippSetInteger(ipp_t *ipp, ipp_attribute_t **attr,
953 int element, int intvalue) _CUPS_API_1_6;
9c80ffa2
MS
954extern int ippSetName(ipp_t *ipp, ipp_attribute_t **attr,
955 const char *name) _CUPS_API_1_6;
a2326b5b 956extern int ippSetOperation(ipp_t *ipp, ipp_op_t op) _CUPS_API_1_6;
9c80ffa2
MS
957extern int ippSetRange(ipp_t *ipp, ipp_attribute_t **attr,
958 int element, int lowervalue, int uppervalue)
959 _CUPS_API_1_6;
a2326b5b
MS
960extern int ippSetRequestId(ipp_t *ipp, int request_id)
961 _CUPS_API_1_6;
962extern int ippSetResolution(ipp_t *ipp, ipp_attribute_t **attr,
963 int element, ipp_res_t unitsvalue,
9c80ffa2
MS
964 int xresvalue, int yresvalue)
965 _CUPS_API_1_6;
966extern int ippSetState(ipp_t *ipp, ipp_state_t state)
967 _CUPS_API_1_6;
968extern int ippSetStatusCode(ipp_t *ipp, ipp_status_t status)
969 _CUPS_API_1_6;
a2326b5b 970extern int ippSetString(ipp_t *ipp, ipp_attribute_t **attr,
9c80ffa2
MS
971 int element, const char *strvalue)
972 _CUPS_API_1_6;
a2326b5b
MS
973extern int ippSetValueTag(ipp_t *ipp, ipp_attribute_t **attr,
974 ipp_tag_t value_tag) _CUPS_API_1_6;
9c80ffa2
MS
975extern int ippSetVersion(ipp_t *ipp, int major, int minor)
976 _CUPS_API_1_6;
a2326b5b 977
a469f8a5
MS
978/**** New in CUPS 1.7 ****/
979extern ipp_attribute_t *ippAddStringf(ipp_t *ipp, ipp_tag_t group,
980 ipp_tag_t value_tag, const char *name,
981 const char *language, const char *format,
982 ...) _CUPS_API_1_7;
983extern ipp_attribute_t *ippAddStringfv(ipp_t *ipp, ipp_tag_t group,
984 ipp_tag_t value_tag, const char *name,
985 const char *language,
986 const char *format, va_list ap)
987 _CUPS_API_1_7;
988extern int ippContainsInteger(ipp_attribute_t *attr, int value)
989 _CUPS_API_1_7;
990extern int ippContainsString(ipp_attribute_t *attr,
991 const char *value) _CUPS_API_1_7;
db8b865d 992extern cups_array_t *ippCreateRequestedArray(ipp_t *request) _CUPS_API_1_7;
6961465f
MS
993extern void *ippGetOctetString(ipp_attribute_t *attr, int element,
994 int *datalen) _CUPS_API_1_7;
a469f8a5 995extern ipp_t *ippNewResponse(ipp_t *request) _CUPS_API_1_7;
6961465f
MS
996extern int ippSetOctetString(ipp_t *ipp, ipp_attribute_t **attr,
997 int element, const void *data,
998 int datalen) _CUPS_API_1_7;
a469f8a5
MS
999extern int ippSetStringf(ipp_t *ipp, ipp_attribute_t **attr,
1000 int element, const char *format,
1001 ...) _CUPS_API_1_7;
1002extern int ippSetStringfv(ipp_t *ipp, ipp_attribute_t **attr,
1003 int element, const char *format,
1004 va_list ap) _CUPS_API_1_7;
c1420c87
MS
1005extern int ippValidateAttribute(ipp_attribute_t *attr)
1006 _CUPS_API_1_7;
1007extern int ippValidateAttributes(ipp_t *ipp) _CUPS_API_1_7;
a469f8a5 1008
ef416fc2 1009
d21dc0ed
MS
1010/**** New in CUPS 2.0 ****/
1011extern const char *ippStateString(ipp_state_t state) _CUPS_API_2_0;
1012
1013
ef416fc2 1014/*
1015 * C++ magic...
1016 */
1017
1018# ifdef __cplusplus
1019}
1020# endif /* __cplusplus */
1021#endif /* !_CUPS_IPP_H_ */
1022
1023/*
f2d18633 1024 * End of "$Id$".
ef416fc2 1025 */