4 * API definitions for CUPS.
6 * Copyright 2007-2013 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products.
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/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 # define _CUPS_CUPS_H_
22 * Include necessary headers...
25 # include <sys/types.h>
26 # if defined(WIN32) && !defined(__CUPS_SSIZE_T_DEFINED)
27 # define __CUPS_SSIZE_T_DEFINED
29 /* Windows does not support the ssize_t type, so map it to off_t... */
30 typedef off_t ssize_t
; /* @private@ */
31 # endif /* WIN32 && !__CUPS_SSIZE_T_DEFINED */
34 # include <dispatch/dispatch.h>
35 # endif /* __BLOCKS__ */
39 # include "language.h"
49 # endif /* __cplusplus */
56 # define CUPS_VERSION 2.0000
57 # define CUPS_VERSION_MAJOR 2
58 # define CUPS_VERSION_MINOR 0
59 # define CUPS_VERSION_PATCH 0
62 /* Back-channel file descriptor for
64 # define CUPS_DATE_ANY (time_t)-1
65 # define CUPS_EXCLUDE_NONE (const char *)0
66 # define CUPS_FORMAT_AUTO "application/octet-stream"
67 # define CUPS_FORMAT_COMMAND "application/vnd.cups-command"
68 # define CUPS_FORMAT_JPEG "image/jpeg"
69 # define CUPS_FORMAT_PDF "application/pdf"
70 # define CUPS_FORMAT_POSTSCRIPT "application/postscript"
71 # define CUPS_FORMAT_RAW "application/vnd.cups-raw"
72 # define CUPS_FORMAT_TEXT "text/plain"
73 # define CUPS_HTTP_DEFAULT (http_t *)0
74 # define CUPS_INCLUDE_ALL (const char *)0
75 # define CUPS_JOBID_ALL -1
76 # define CUPS_JOBID_CURRENT 0
77 # define CUPS_LENGTH_VARIABLE (ssize_t)0
78 # define CUPS_TIMEOUT_DEFAULT 0
79 # define CUPS_WHICHJOBS_ALL -1
80 # define CUPS_WHICHJOBS_ACTIVE 0
81 # define CUPS_WHICHJOBS_COMPLETED 1
83 /* Flags for cupsConnectDest and cupsEnumDests */
84 # define CUPS_DEST_FLAGS_NONE 0x00
85 /* No flags are set */
86 # define CUPS_DEST_FLAGS_UNCONNECTED 0x01
87 /* There is not connection */
88 # define CUPS_DEST_FLAGS_MORE 0x02
89 /* There are more destinations */
90 # define CUPS_DEST_FLAGS_REMOVED 0x04
91 /* The destination has gone away */
92 # define CUPS_DEST_FLAGS_ERROR 0x08
93 /* An error occurred */
94 # define CUPS_DEST_FLAGS_RESOLVING 0x10
95 /* The destination address is being
97 # define CUPS_DEST_FLAGS_CONNECTING 0x20
98 /* A connection is being established */
99 # define CUPS_DEST_FLAGS_CANCELED 0x40
100 /* Operation was canceled */
102 /* Flags for cupsGetDestMediaByName/Size */
103 # define CUPS_MEDIA_FLAGS_DEFAULT 0x00
104 /* Find the closest size supported by
106 # define CUPS_MEDIA_FLAGS_BORDERLESS 0x01
107 /* Find a borderless size */
108 # define CUPS_MEDIA_FLAGS_DUPLEX 0x02
109 /* Find a size compatible with 2-sided
111 # define CUPS_MEDIA_FLAGS_EXACT 0x04
112 /* Find an exact match for the size */
113 # define CUPS_MEDIA_FLAGS_READY 0x08
114 /* If the printer supports media
115 * sensing, find the size amongst the
118 /* Options and values */
119 # define CUPS_COPIES "copies"
120 # define CUPS_COPIES_SUPPORTED "copies-supported"
122 # define CUPS_FINISHINGS "finishings"
123 # define CUPS_FINISHINGS_SUPPORTED "finishings-supported"
125 # define CUPS_FINISHINGS_BIND "7"
126 # define CUPS_FINISHINGS_COVER "6"
127 # define CUPS_FINISHINGS_FOLD "10"
128 # define CUPS_FINISHINGS_NONE "3"
129 # define CUPS_FINISHINGS_PUNCH "5"
130 # define CUPS_FINISHINGS_STAPLE "4"
131 # define CUPS_FINISHINGS_TRIM "11"
133 # define CUPS_MEDIA "media"
134 # define CUPS_MEDIA_READY "media-ready"
135 # define CUPS_MEDIA_SUPPORTED "media-supported"
137 # define CUPS_MEDIA_3X5 "na_index-3x5_3x5in"
138 # define CUPS_MEDIA_4X6 "na_index-4x6_4x6in"
139 # define CUPS_MEDIA_5X7 "na_5x7_5x7in"
140 # define CUPS_MEDIA_8X10 "na_govt-letter_8x10in"
141 # define CUPS_MEDIA_A3 "iso_a3_297x420mm"
142 # define CUPS_MEDIA_A4 "iso_a4_210x297mm"
143 # define CUPS_MEDIA_A5 "iso_a5_148x210mm"
144 # define CUPS_MEDIA_A6 "iso_a6_105x148mm"
145 # define CUPS_MEDIA_ENV10 "na_number-10_4.125x9.5in"
146 # define CUPS_MEDIA_ENVDL "iso_dl_110x220mm"
147 # define CUPS_MEDIA_LEGAL "na_legal_8.5x14in"
148 # define CUPS_MEDIA_LETTER "na_letter_8.5x11in"
149 # define CUPS_MEDIA_PHOTO_L "oe_photo-l_3.5x5in"
150 # define CUPS_MEDIA_SUPERBA3 "na_super-b_13x19in"
151 # define CUPS_MEDIA_TABLOID "na_ledger_11x17in"
153 # define CUPS_MEDIA_SOURCE "media-source"
154 # define CUPS_MEDIA_SOURCE_SUPPORTED "media-source-supported"
156 # define CUPS_MEDIA_SOURCE_AUTO "auto"
157 # define CUPS_MEDIA_SOURCE_MANUAL "manual"
159 # define CUPS_MEDIA_TYPE "media-type"
160 # define CUPS_MEDIA_TYPE_SUPPORTED "media-type-supported"
162 # define CUPS_MEDIA_TYPE_AUTO "auto"
163 # define CUPS_MEDIA_TYPE_ENVELOPE "envelope"
164 # define CUPS_MEDIA_TYPE_LABELS "labels"
165 # define CUPS_MEDIA_TYPE_LETTERHEAD "stationery-letterhead"
166 # define CUPS_MEDIA_TYPE_PHOTO "photographic"
167 # define CUPS_MEDIA_TYPE_PHOTO_GLOSSY "photographic-glossy"
168 # define CUPS_MEDIA_TYPE_PHOTO_MATTE "photographic-matte"
169 # define CUPS_MEDIA_TYPE_PLAIN "stationery"
170 # define CUPS_MEDIA_TYPE_TRANSPARENCY "transparency"
172 # define CUPS_NUMBER_UP "number-up"
173 # define CUPS_NUMBER_UP_SUPPORTED "number-up-supported"
175 # define CUPS_ORIENTATION "orientation-requested"
176 # define CUPS_ORIENTATION_SUPPORTED "orientation-requested-supported"
178 # define CUPS_ORIENTATION_PORTRAIT "3"
179 # define CUPS_ORIENTATION_LANDSCAPE "4"
181 # define CUPS_PRINT_COLOR_MODE "print-color-mode"
182 # define CUPS_PRINT_COLOR_MODE_SUPPORTED "print-color-mode-supported"
184 # define CUPS_PRINT_COLOR_MODE_AUTO "auto"
185 # define CUPS_PRINT_COLOR_MODE_MONOCHROME "monochrome"
186 # define CUPS_PRINT_COLOR_MODE_COLOR "color"
188 # define CUPS_PRINT_QUALITY "print-quality"
189 # define CUPS_PRINT_QUALITY_SUPPORTED "print-quality-supported"
191 # define CUPS_PRINT_QUALITY_DRAFT "3"
192 # define CUPS_PRINT_QUALITY_NORMAL "4"
193 # define CUPS_PRINT_QUALITY_HIGH "5"
195 # define CUPS_SIDES "sides"
196 # define CUPS_SIDES_SUPPORTED "sides-supported"
198 # define CUPS_SIDES_ONE_SIDED "one-sided"
199 # define CUPS_SIDES_TWO_SIDED_PORTRAIT "two-sided-long-edge"
200 # define CUPS_SIDES_TWO_SIDED_LANDSCAPE "two-sided-short-edge"
204 * Types and structures...
207 typedef unsigned cups_ptype_t
; /* Printer type/capability bits */
208 enum cups_ptype_e
/* Printer type/capability bit
210 { /* Not a typedef'd enum so we can OR */
211 CUPS_PRINTER_LOCAL
= 0x0000, /* Local printer or class */
212 CUPS_PRINTER_CLASS
= 0x0001, /* Printer class */
213 CUPS_PRINTER_REMOTE
= 0x0002, /* Remote printer or class */
214 CUPS_PRINTER_BW
= 0x0004, /* Can do B&W printing */
215 CUPS_PRINTER_COLOR
= 0x0008, /* Can do color printing */
216 CUPS_PRINTER_DUPLEX
= 0x0010, /* Can do duplexing */
217 CUPS_PRINTER_STAPLE
= 0x0020, /* Can staple output */
218 CUPS_PRINTER_COPIES
= 0x0040, /* Can do copies */
219 CUPS_PRINTER_COLLATE
= 0x0080, /* Can collage copies */
220 CUPS_PRINTER_PUNCH
= 0x0100, /* Can punch output */
221 CUPS_PRINTER_COVER
= 0x0200, /* Can cover output */
222 CUPS_PRINTER_BIND
= 0x0400, /* Can bind output */
223 CUPS_PRINTER_SORT
= 0x0800, /* Can sort output */
224 CUPS_PRINTER_SMALL
= 0x1000, /* Can do Letter/Legal/A4 */
225 CUPS_PRINTER_MEDIUM
= 0x2000, /* Can do Tabloid/B/C/A3/A2 */
226 CUPS_PRINTER_LARGE
= 0x4000, /* Can do D/E/A1/A0 */
227 CUPS_PRINTER_VARIABLE
= 0x8000, /* Can do variable sizes */
228 CUPS_PRINTER_IMPLICIT
= 0x10000, /* Implicit class @private@
229 * @since Deprecated@ */
230 CUPS_PRINTER_DEFAULT
= 0x20000, /* Default printer on network */
231 CUPS_PRINTER_FAX
= 0x40000, /* Fax queue */
232 CUPS_PRINTER_REJECTING
= 0x80000, /* Printer is rejecting jobs */
233 CUPS_PRINTER_DELETE
= 0x100000, /* Delete printer
234 * @since CUPS 1.2/OS X 10.5@ */
235 CUPS_PRINTER_NOT_SHARED
= 0x200000, /* Printer is not shared
236 * @since CUPS 1.2/OS X 10.5@ */
237 CUPS_PRINTER_AUTHENTICATED
= 0x400000,/* Printer requires authentication
238 * @since CUPS 1.2/OS X 10.5@ */
239 CUPS_PRINTER_COMMANDS
= 0x800000, /* Printer supports maintenance commands
240 * @since CUPS 1.2/OS X 10.5@ */
241 CUPS_PRINTER_DISCOVERED
= 0x1000000, /* Printer was automatically discovered
242 * and added @private@
243 * @since Deprecated@ */
244 CUPS_PRINTER_SCANNER
= 0x2000000, /* Scanner-only device
245 * @since CUPS 1.4/OS X 10.6@ */
246 CUPS_PRINTER_MFP
= 0x4000000, /* Printer with scanning capabilities
247 * @since CUPS 1.4/OS X 10.6@ */
248 CUPS_PRINTER_OPTIONS
= 0x6fffc /* ~(CLASS | REMOTE | IMPLICIT |
249 * DEFAULT | FAX | REJECTING | DELETE |
250 * NOT_SHARED | AUTHENTICATED |
251 * COMMANDS | DISCOVERED) @private@ */
254 typedef struct cups_option_s
/**** Printer Options ****/
256 char *name
; /* Name of option */
257 char *value
; /* Value of option */
260 typedef struct cups_dest_s
/**** Destination ****/
262 char *name
, /* Printer or class name */
263 *instance
; /* Local instance name or NULL */
264 int is_default
; /* Is this printer the default? */
265 int num_options
; /* Number of options */
266 cups_option_t
*options
; /* Options */
269 typedef struct _cups_dinfo_s cups_dinfo_t
;
270 /* Destination capability and status
271 * information @since CUPS 1.6/OS X 10.8@ */
273 typedef struct cups_job_s
/**** Job ****/
275 int id
; /* The job ID */
276 char *dest
; /* Printer or class name */
277 char *title
; /* Title/job name */
278 char *user
; /* User the submitted the job */
279 char *format
; /* Document format */
280 ipp_jstate_t state
; /* Job state */
281 int size
; /* Size in kilobytes */
282 int priority
; /* Priority (1-100) */
283 time_t completed_time
; /* Time the job was completed */
284 time_t creation_time
; /* Time the job was created */
285 time_t processing_time
; /* Time the job was processed */
288 typedef struct cups_size_s
/**** Media Size @since CUPS 1.6/OS X 10.8@ ****/
290 char media
[128]; /* Media name to use */
291 int width
, /* Width in hundredths of millimeters */
292 length
, /* Length in hundredths of
294 bottom
, /* Bottom margin in hundredths of
296 left
, /* Left margin in hundredths of
298 right
, /* Right margin in hundredths of
300 top
; /* Top margin in hundredths of
304 typedef int (*cups_client_cert_cb_t
)(http_t
*http
, void *tls
,
305 cups_array_t
*distinguished_names
,
307 /* Client credentials callback
308 * @since CUPS 1.5/OS X 10.7@ */
310 typedef int (*cups_dest_cb_t
)(void *user_data
, unsigned flags
,
312 /* Destination enumeration callback
313 * @since CUPS 1.6/OS X 10.8@ */
316 typedef int (^cups_dest_block_t
)(unsigned flags
, cups_dest_t
*dest
);
317 /* Destination enumeration block
318 * @since CUPS 1.6/OS X 10.8@ */
319 # endif /* __BLOCKS__ */
321 typedef void (*cups_device_cb_t
)(const char *device_class
,
322 const char *device_id
, const char *device_info
,
323 const char *device_make_and_model
,
324 const char *device_uri
,
325 const char *device_location
, void *user_data
);
327 * @since CUPS 1.4/OS X 10.6@ */
329 typedef const char *(*cups_password_cb_t
)(const char *prompt
);
330 /* Password callback */
332 typedef const char *(*cups_password_cb2_t
)(const char *prompt
, http_t
*http
,
334 const char *resource
,
336 /* New password callback
337 * @since CUPS 1.4/OS X 10.6@ */
339 typedef int (*cups_server_cert_cb_t
)(http_t
*http
, void *tls
,
340 cups_array_t
*certs
, void *user_data
);
341 /* Server credentials callback
342 * @since CUPS 1.5/OS X 10.7@ */
349 extern int cupsCancelJob(const char *name
, int job_id
);
350 extern ipp_t
*cupsDoFileRequest(http_t
*http
, ipp_t
*request
,
351 const char *resource
,
352 const char *filename
);
353 extern ipp_t
*cupsDoRequest(http_t
*http
, ipp_t
*request
,
354 const char *resource
);
355 extern http_encryption_t
cupsEncryption(void);
356 extern void cupsFreeJobs(int num_jobs
, cups_job_t
*jobs
);
357 extern int cupsGetClasses(char ***classes
) _CUPS_DEPRECATED_MSG("Use cupsGetDests instead.");
358 extern const char *cupsGetDefault(void);
359 extern int cupsGetJobs(cups_job_t
**jobs
, const char *name
,
360 int myjobs
, int whichjobs
);
361 extern const char *cupsGetPPD(const char *name
)
362 _CUPS_DEPRECATED_1_6_MSG("Use cupsCopyDestInfo instead.");
363 extern int cupsGetPrinters(char ***printers
) _CUPS_DEPRECATED_MSG("Use cupsGetDests instead.");
364 extern ipp_status_t
cupsLastError(void);
365 extern int cupsPrintFile(const char *name
, const char *filename
,
366 const char *title
, int num_options
,
367 cups_option_t
*options
);
368 extern int cupsPrintFiles(const char *name
, int num_files
,
369 const char **files
, const char *title
,
370 int num_options
, cups_option_t
*options
);
371 extern char *cupsTempFile(char *filename
, int len
) _CUPS_DEPRECATED_MSG("Use cupsTempFd or cupsTempFile2 instead.");
372 extern int cupsTempFd(char *filename
, int len
);
374 extern int cupsAddDest(const char *name
, const char *instance
,
375 int num_dests
, cups_dest_t
**dests
);
376 extern void cupsFreeDests(int num_dests
, cups_dest_t
*dests
);
377 extern cups_dest_t
*cupsGetDest(const char *name
, const char *instance
,
378 int num_dests
, cups_dest_t
*dests
);
379 extern int cupsGetDests(cups_dest_t
**dests
);
380 extern void cupsSetDests(int num_dests
, cups_dest_t
*dests
);
382 extern int cupsAddOption(const char *name
, const char *value
,
383 int num_options
, cups_option_t
**options
);
384 extern void cupsEncodeOptions(ipp_t
*ipp
, int num_options
,
385 cups_option_t
*options
);
386 extern void cupsFreeOptions(int num_options
,
387 cups_option_t
*options
);
388 extern const char *cupsGetOption(const char *name
, int num_options
,
389 cups_option_t
*options
);
390 extern int cupsParseOptions(const char *arg
, int num_options
,
391 cups_option_t
**options
);
393 extern const char *cupsGetPassword(const char *prompt
);
394 extern const char *cupsServer(void);
395 extern void cupsSetEncryption(http_encryption_t e
);
396 extern void cupsSetPasswordCB(cups_password_cb_t cb
);
397 extern void cupsSetServer(const char *server
);
398 extern void cupsSetUser(const char *user
);
399 extern const char *cupsUser(void);
401 /**** New in CUPS 1.1.20 ****/
402 extern int cupsDoAuthentication(http_t
*http
, const char *method
,
403 const char *resource
)
405 extern http_status_t
cupsGetFile(http_t
*http
, const char *resource
,
406 const char *filename
) _CUPS_API_1_1_20
;
407 extern http_status_t
cupsGetFd(http_t
*http
, const char *resource
, int fd
);
408 extern http_status_t
cupsPutFile(http_t
*http
, const char *resource
,
409 const char *filename
) _CUPS_API_1_1_20
;
410 extern http_status_t
cupsPutFd(http_t
*http
, const char *resource
, int fd
)
413 /**** New in CUPS 1.1.21 ****/
414 extern const char *cupsGetDefault2(http_t
*http
) _CUPS_API_1_1_21
;
415 extern int cupsGetDests2(http_t
*http
, cups_dest_t
**dests
)
417 extern int cupsGetJobs2(http_t
*http
, cups_job_t
**jobs
,
418 const char *name
, int myjobs
,
419 int whichjobs
) _CUPS_API_1_1_21
;
420 extern const char *cupsGetPPD2(http_t
*http
, const char *name
)
421 _CUPS_DEPRECATED_1_6_MSG("Use cupsCopyDestInfo instead.");
422 extern int cupsPrintFile2(http_t
*http
, const char *name
,
423 const char *filename
,
424 const char *title
, int num_options
,
425 cups_option_t
*options
) _CUPS_API_1_1_21
;
426 extern int cupsPrintFiles2(http_t
*http
, const char *name
,
427 int num_files
, const char **files
,
428 const char *title
, int num_options
,
429 cups_option_t
*options
)
431 extern int cupsSetDests2(http_t
*http
, int num_dests
,
432 cups_dest_t
*dests
) _CUPS_API_1_1_21
;
434 /**** New in CUPS 1.2/OS X 10.5 ****/
435 extern ssize_t
cupsBackChannelRead(char *buffer
, size_t bytes
,
436 double timeout
) _CUPS_API_1_2
;
437 extern ssize_t
cupsBackChannelWrite(const char *buffer
, size_t bytes
,
438 double timeout
) _CUPS_API_1_2
;
439 extern void cupsEncodeOptions2(ipp_t
*ipp
, int num_options
,
440 cups_option_t
*options
,
441 ipp_tag_t group_tag
) _CUPS_API_1_2
;
442 extern const char *cupsLastErrorString(void) _CUPS_API_1_2
;
443 extern char *cupsNotifySubject(cups_lang_t
*lang
, ipp_t
*event
)
445 extern char *cupsNotifyText(cups_lang_t
*lang
, ipp_t
*event
)
447 extern int cupsRemoveOption(const char *name
, int num_options
,
448 cups_option_t
**options
) _CUPS_API_1_2
;
449 extern cups_file_t
*cupsTempFile2(char *filename
, int len
) _CUPS_API_1_2
;
451 /**** New in CUPS 1.3/OS X 10.5 ****/
452 extern ipp_t
*cupsDoIORequest(http_t
*http
, ipp_t
*request
,
453 const char *resource
, int infile
,
454 int outfile
) _CUPS_API_1_3
;
455 extern char *cupsGetServerPPD(http_t
*http
, const char *name
)
457 extern int cupsRemoveDest(const char *name
,
458 const char *instance
,
459 int num_dests
, cups_dest_t
**dests
)
461 extern void cupsSetDefaultDest(const char *name
,
462 const char *instance
,
464 cups_dest_t
*dests
) _CUPS_API_1_3
;
466 /**** New in CUPS 1.4/OS X 10.6 ****/
467 extern ipp_status_t
cupsCancelJob2(http_t
*http
, const char *name
,
468 int job_id
, int purge
) _CUPS_API_1_4
;
469 extern int cupsCreateJob(http_t
*http
, const char *name
,
470 const char *title
, int num_options
,
471 cups_option_t
*options
) _CUPS_API_1_4
;
472 extern ipp_status_t
cupsFinishDocument(http_t
*http
,
473 const char *name
) _CUPS_API_1_4
;
474 extern ipp_status_t
cupsGetDevices(http_t
*http
, int timeout
,
475 const char *include_schemes
,
476 const char *exclude_schemes
,
477 cups_device_cb_t callback
,
478 void *user_data
) _CUPS_API_1_4
;
479 extern cups_dest_t
*cupsGetNamedDest(http_t
*http
, const char *name
,
480 const char *instance
) _CUPS_API_1_4
;
481 extern const char *cupsGetPassword2(const char *prompt
, http_t
*http
,
483 const char *resource
) _CUPS_API_1_4
;
484 extern http_status_t
cupsGetPPD3(http_t
*http
, const char *name
,
485 time_t *modtime
, char *buffer
,
486 size_t bufsize
) _CUPS_API_1_4
;
487 extern ipp_t
*cupsGetResponse(http_t
*http
,
488 const char *resource
) _CUPS_API_1_4
;
489 extern ssize_t
cupsReadResponseData(http_t
*http
, char *buffer
,
490 size_t length
) _CUPS_API_1_4
;
491 extern http_status_t
cupsSendRequest(http_t
*http
, ipp_t
*request
,
492 const char *resource
,
493 size_t length
) _CUPS_API_1_4
;
494 extern void cupsSetPasswordCB2(cups_password_cb2_t cb
,
495 void *user_data
) _CUPS_API_1_4
;
496 extern http_status_t
cupsStartDocument(http_t
*http
, const char *name
,
497 int job_id
, const char *docname
,
499 int last_document
) _CUPS_API_1_4
;
500 extern http_status_t
cupsWriteRequestData(http_t
*http
, const char *buffer
,
501 size_t length
) _CUPS_API_1_4
;
503 /**** New in CUPS 1.5/OS X 10.7 ****/
504 extern void cupsSetClientCertCB(cups_client_cert_cb_t cb
,
505 void *user_data
) _CUPS_API_1_5
;
506 extern int cupsSetCredentials(cups_array_t
*certs
) _CUPS_API_1_5
;
507 extern void cupsSetServerCertCB(cups_server_cert_cb_t cb
,
508 void *user_data
) _CUPS_API_1_5
;
510 /**** New in CUPS 1.6/OS X 10.8 ****/
511 extern ipp_status_t
cupsCancelDestJob(http_t
*http
, cups_dest_t
*dest
,
512 int job_id
) _CUPS_API_1_6
;
513 extern int cupsCheckDestSupported(http_t
*http
, cups_dest_t
*dest
,
516 const char *value
) _CUPS_API_1_6
;
517 extern ipp_status_t
cupsCloseDestJob(http_t
*http
, cups_dest_t
*dest
,
518 cups_dinfo_t
*info
, int job_id
)
520 extern http_t
*cupsConnectDest(cups_dest_t
*dest
, unsigned flags
,
521 int msec
, int *cancel
,
522 char *resource
, size_t resourcesize
,
523 cups_dest_cb_t cb
, void *user_data
)
526 extern http_t
*cupsConnectDestBlock(cups_dest_t
*dest
,
527 unsigned flags
, int msec
,
528 int *cancel
, char *resource
,
530 cups_dest_block_t block
)
532 # endif /* __BLOCKS__ */
533 extern int cupsCopyDest(cups_dest_t
*dest
, int num_dests
,
534 cups_dest_t
**dests
) _CUPS_API_1_6
;
535 extern cups_dinfo_t
*cupsCopyDestInfo(http_t
*http
, cups_dest_t
*dest
)
537 extern int cupsCopyDestConflicts(http_t
*http
, cups_dest_t
*dest
,
540 cups_option_t
*options
,
541 const char *new_option
,
542 const char *new_value
,
544 cups_option_t
**conflicts
,
546 cups_option_t
**resolved
)
548 extern ipp_status_t
cupsCreateDestJob(http_t
*http
, cups_dest_t
*dest
,
549 cups_dinfo_t
*info
, int *job_id
,
550 const char *title
, int num_options
,
551 cups_option_t
*options
) _CUPS_API_1_6
;
552 extern int cupsEnumDests(unsigned flags
, int msec
, int *cancel
,
553 cups_ptype_t type
, cups_ptype_t mask
,
554 cups_dest_cb_t cb
, void *user_data
)
557 extern int cupsEnumDestsBlock(unsigned flags
, int msec
,
558 int *cancel
, cups_ptype_t type
,
560 cups_dest_block_t block
)
562 # endif /* __BLOCKS__ */
563 extern ipp_status_t
cupsFinishDestDocument(http_t
*http
,
567 extern void cupsFreeDestInfo(cups_dinfo_t
*dinfo
) _CUPS_API_1_6
;
568 extern int cupsGetDestMediaByName(http_t
*http
, cups_dest_t
*dest
,
572 cups_size_t
*size
) _CUPS_API_1_6
;
573 extern int cupsGetDestMediaBySize(http_t
*http
, cups_dest_t
*dest
,
575 int width
, int length
,
577 cups_size_t
*size
) _CUPS_API_1_6
;
578 extern const char *cupsLocalizeDestOption(http_t
*http
, cups_dest_t
*dest
,
582 extern const char *cupsLocalizeDestValue(http_t
*http
, cups_dest_t
*dest
,
587 extern http_status_t
cupsStartDestDocument(http_t
*http
, cups_dest_t
*dest
,
588 cups_dinfo_t
*info
, int job_id
,
592 cups_option_t
*options
,
593 int last_document
) _CUPS_API_1_6
;
595 /* New in CUPS 1.7 */
596 extern ipp_attribute_t
*cupsFindDestDefault(http_t
*http
, cups_dest_t
*dest
,
598 const char *option
) _CUPS_API_1_7
;
599 extern ipp_attribute_t
*cupsFindDestReady(http_t
*http
, cups_dest_t
*dest
,
601 const char *option
) _CUPS_API_1_7
;
602 extern ipp_attribute_t
*cupsFindDestSupported(http_t
*http
, cups_dest_t
*dest
,
606 extern int cupsGetDestMediaByIndex(http_t
*http
, cups_dest_t
*dest
,
607 cups_dinfo_t
*dinfo
, int n
,
611 extern int cupsGetDestMediaCount(http_t
*http
, cups_dest_t
*dest
,
613 unsigned flags
) _CUPS_API_1_7
;
614 extern int cupsGetDestMediaDefault(http_t
*http
, cups_dest_t
*dest
,
619 extern void cupsSetUserAgent(const char *user_agent
) _CUPS_API_1_7
;
620 extern const char *cupsUserAgent(void) _CUPS_API_1_7
;
622 /* New in CUPS 2.0 */
623 extern int cupsSetServerCredentials(const char *path
, const char *common_name
) _CUPS_API_2_0
;
627 # endif /* __cplusplus */
629 #endif /* !_CUPS_CUPS_H_ */