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