4 * API definitions for CUPS.
6 * Copyright 2007-2014 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 */
35 # include "language.h"
39 * Define _PPD_DEPRECATED to silence the warnings about PPD functions being
43 # ifndef _PPD_DEPRECATED
44 # define _PPD_DEPRECATED _CUPS_DEPRECATED_1_6_MSG("Use cupsCopyDestInfo and friends instead.")
45 # endif /* !_PPD_DEPRECATED */
54 # endif /* __cplusplus */
61 # define CUPS_VERSION 2.0100
62 # define CUPS_VERSION_MAJOR 2
63 # define CUPS_VERSION_MINOR 1
64 # define CUPS_VERSION_PATCH 0
67 /* Back-channel file descriptor for
69 # define CUPS_DATE_ANY (time_t)-1
70 # define CUPS_EXCLUDE_NONE (const char *)0
71 # define CUPS_FORMAT_AUTO "application/octet-stream"
72 # define CUPS_FORMAT_COMMAND "application/vnd.cups-command"
73 # define CUPS_FORMAT_JPEG "image/jpeg"
74 # define CUPS_FORMAT_PDF "application/pdf"
75 # define CUPS_FORMAT_POSTSCRIPT "application/postscript"
76 # define CUPS_FORMAT_RAW "application/vnd.cups-raw"
77 # define CUPS_FORMAT_TEXT "text/plain"
78 # define CUPS_HTTP_DEFAULT (http_t *)0
79 # define CUPS_INCLUDE_ALL (const char *)0
80 # define CUPS_JOBID_ALL -1
81 # define CUPS_JOBID_CURRENT 0
82 # define CUPS_LENGTH_VARIABLE (ssize_t)0
83 # define CUPS_TIMEOUT_DEFAULT 0
84 # define CUPS_WHICHJOBS_ALL -1
85 # define CUPS_WHICHJOBS_ACTIVE 0
86 # define CUPS_WHICHJOBS_COMPLETED 1
88 /* Flags for cupsConnectDest and cupsEnumDests */
89 # define CUPS_DEST_FLAGS_NONE 0x00
90 /* No flags are set */
91 # define CUPS_DEST_FLAGS_UNCONNECTED 0x01
92 /* There is not connection */
93 # define CUPS_DEST_FLAGS_MORE 0x02
94 /* There are more destinations */
95 # define CUPS_DEST_FLAGS_REMOVED 0x04
96 /* The destination has gone away */
97 # define CUPS_DEST_FLAGS_ERROR 0x08
98 /* An error occurred */
99 # define CUPS_DEST_FLAGS_RESOLVING 0x10
100 /* The destination address is being
102 # define CUPS_DEST_FLAGS_CONNECTING 0x20
103 /* A connection is being established */
104 # define CUPS_DEST_FLAGS_CANCELED 0x40
105 /* Operation was canceled */
107 /* Flags for cupsGetDestMediaByName/Size */
108 # define CUPS_MEDIA_FLAGS_DEFAULT 0x00
109 /* Find the closest size supported by
111 # define CUPS_MEDIA_FLAGS_BORDERLESS 0x01
112 /* Find a borderless size */
113 # define CUPS_MEDIA_FLAGS_DUPLEX 0x02
114 /* Find a size compatible with 2-sided
116 # define CUPS_MEDIA_FLAGS_EXACT 0x04
117 /* Find an exact match for the size */
118 # define CUPS_MEDIA_FLAGS_READY 0x08
119 /* If the printer supports media
120 * sensing, find the size amongst the
123 /* Options and values */
124 # define CUPS_COPIES "copies"
125 # define CUPS_COPIES_SUPPORTED "copies-supported"
127 # define CUPS_FINISHINGS "finishings"
128 # define CUPS_FINISHINGS_SUPPORTED "finishings-supported"
130 # define CUPS_FINISHINGS_BIND "7"
131 # define CUPS_FINISHINGS_COVER "6"
132 # define CUPS_FINISHINGS_FOLD "10"
133 # define CUPS_FINISHINGS_NONE "3"
134 # define CUPS_FINISHINGS_PUNCH "5"
135 # define CUPS_FINISHINGS_STAPLE "4"
136 # define CUPS_FINISHINGS_TRIM "11"
138 # define CUPS_MEDIA "media"
139 # define CUPS_MEDIA_READY "media-ready"
140 # define CUPS_MEDIA_SUPPORTED "media-supported"
142 # define CUPS_MEDIA_3X5 "na_index-3x5_3x5in"
143 # define CUPS_MEDIA_4X6 "na_index-4x6_4x6in"
144 # define CUPS_MEDIA_5X7 "na_5x7_5x7in"
145 # define CUPS_MEDIA_8X10 "na_govt-letter_8x10in"
146 # define CUPS_MEDIA_A3 "iso_a3_297x420mm"
147 # define CUPS_MEDIA_A4 "iso_a4_210x297mm"
148 # define CUPS_MEDIA_A5 "iso_a5_148x210mm"
149 # define CUPS_MEDIA_A6 "iso_a6_105x148mm"
150 # define CUPS_MEDIA_ENV10 "na_number-10_4.125x9.5in"
151 # define CUPS_MEDIA_ENVDL "iso_dl_110x220mm"
152 # define CUPS_MEDIA_LEGAL "na_legal_8.5x14in"
153 # define CUPS_MEDIA_LETTER "na_letter_8.5x11in"
154 # define CUPS_MEDIA_PHOTO_L "oe_photo-l_3.5x5in"
155 # define CUPS_MEDIA_SUPERBA3 "na_super-b_13x19in"
156 # define CUPS_MEDIA_TABLOID "na_ledger_11x17in"
158 # define CUPS_MEDIA_SOURCE "media-source"
159 # define CUPS_MEDIA_SOURCE_SUPPORTED "media-source-supported"
161 # define CUPS_MEDIA_SOURCE_AUTO "auto"
162 # define CUPS_MEDIA_SOURCE_MANUAL "manual"
164 # define CUPS_MEDIA_TYPE "media-type"
165 # define CUPS_MEDIA_TYPE_SUPPORTED "media-type-supported"
167 # define CUPS_MEDIA_TYPE_AUTO "auto"
168 # define CUPS_MEDIA_TYPE_ENVELOPE "envelope"
169 # define CUPS_MEDIA_TYPE_LABELS "labels"
170 # define CUPS_MEDIA_TYPE_LETTERHEAD "stationery-letterhead"
171 # define CUPS_MEDIA_TYPE_PHOTO "photographic"
172 # define CUPS_MEDIA_TYPE_PHOTO_GLOSSY "photographic-glossy"
173 # define CUPS_MEDIA_TYPE_PHOTO_MATTE "photographic-matte"
174 # define CUPS_MEDIA_TYPE_PLAIN "stationery"
175 # define CUPS_MEDIA_TYPE_TRANSPARENCY "transparency"
177 # define CUPS_NUMBER_UP "number-up"
178 # define CUPS_NUMBER_UP_SUPPORTED "number-up-supported"
180 # define CUPS_ORIENTATION "orientation-requested"
181 # define CUPS_ORIENTATION_SUPPORTED "orientation-requested-supported"
183 # define CUPS_ORIENTATION_PORTRAIT "3"
184 # define CUPS_ORIENTATION_LANDSCAPE "4"
186 # define CUPS_PRINT_COLOR_MODE "print-color-mode"
187 # define CUPS_PRINT_COLOR_MODE_SUPPORTED "print-color-mode-supported"
189 # define CUPS_PRINT_COLOR_MODE_AUTO "auto"
190 # define CUPS_PRINT_COLOR_MODE_MONOCHROME "monochrome"
191 # define CUPS_PRINT_COLOR_MODE_COLOR "color"
193 # define CUPS_PRINT_QUALITY "print-quality"
194 # define CUPS_PRINT_QUALITY_SUPPORTED "print-quality-supported"
196 # define CUPS_PRINT_QUALITY_DRAFT "3"
197 # define CUPS_PRINT_QUALITY_NORMAL "4"
198 # define CUPS_PRINT_QUALITY_HIGH "5"
200 # define CUPS_SIDES "sides"
201 # define CUPS_SIDES_SUPPORTED "sides-supported"
203 # define CUPS_SIDES_ONE_SIDED "one-sided"
204 # define CUPS_SIDES_TWO_SIDED_PORTRAIT "two-sided-long-edge"
205 # define CUPS_SIDES_TWO_SIDED_LANDSCAPE "two-sided-short-edge"
209 * Types and structures...
212 typedef unsigned cups_ptype_t
; /* Printer type/capability bits */
213 enum cups_ptype_e
/* Printer type/capability bit
215 { /* Not a typedef'd enum so we can OR */
216 CUPS_PRINTER_LOCAL
= 0x0000, /* Local printer or class */
217 CUPS_PRINTER_CLASS
= 0x0001, /* Printer class */
218 CUPS_PRINTER_REMOTE
= 0x0002, /* Remote printer or class */
219 CUPS_PRINTER_BW
= 0x0004, /* Can do B&W printing */
220 CUPS_PRINTER_COLOR
= 0x0008, /* Can do color printing */
221 CUPS_PRINTER_DUPLEX
= 0x0010, /* Can do duplexing */
222 CUPS_PRINTER_STAPLE
= 0x0020, /* Can staple output */
223 CUPS_PRINTER_COPIES
= 0x0040, /* Can do copies */
224 CUPS_PRINTER_COLLATE
= 0x0080, /* Can collage copies */
225 CUPS_PRINTER_PUNCH
= 0x0100, /* Can punch output */
226 CUPS_PRINTER_COVER
= 0x0200, /* Can cover output */
227 CUPS_PRINTER_BIND
= 0x0400, /* Can bind output */
228 CUPS_PRINTER_SORT
= 0x0800, /* Can sort output */
229 CUPS_PRINTER_SMALL
= 0x1000, /* Can do Letter/Legal/A4 */
230 CUPS_PRINTER_MEDIUM
= 0x2000, /* Can do Tabloid/B/C/A3/A2 */
231 CUPS_PRINTER_LARGE
= 0x4000, /* Can do D/E/A1/A0 */
232 CUPS_PRINTER_VARIABLE
= 0x8000, /* Can do variable sizes */
233 CUPS_PRINTER_IMPLICIT
= 0x10000, /* Implicit class @private@
234 * @since Deprecated@ */
235 CUPS_PRINTER_DEFAULT
= 0x20000, /* Default printer on network */
236 CUPS_PRINTER_FAX
= 0x40000, /* Fax queue */
237 CUPS_PRINTER_REJECTING
= 0x80000, /* Printer is rejecting jobs */
238 CUPS_PRINTER_DELETE
= 0x100000, /* Delete printer
239 * @since CUPS 1.2/OS X 10.5@ */
240 CUPS_PRINTER_NOT_SHARED
= 0x200000, /* Printer is not shared
241 * @since CUPS 1.2/OS X 10.5@ */
242 CUPS_PRINTER_AUTHENTICATED
= 0x400000,/* Printer requires authentication
243 * @since CUPS 1.2/OS X 10.5@ */
244 CUPS_PRINTER_COMMANDS
= 0x800000, /* Printer supports maintenance commands
245 * @since CUPS 1.2/OS X 10.5@ */
246 CUPS_PRINTER_DISCOVERED
= 0x1000000, /* Printer was automatically discovered
247 * and added @private@
248 * @since Deprecated@ */
249 CUPS_PRINTER_SCANNER
= 0x2000000, /* Scanner-only device
250 * @since CUPS 1.4/OS X 10.6@ */
251 CUPS_PRINTER_MFP
= 0x4000000, /* Printer with scanning capabilities
252 * @since CUPS 1.4/OS X 10.6@ */
253 CUPS_PRINTER_OPTIONS
= 0x6fffc /* ~(CLASS | REMOTE | IMPLICIT |
254 * DEFAULT | FAX | REJECTING | DELETE |
255 * NOT_SHARED | AUTHENTICATED |
256 * COMMANDS | DISCOVERED) @private@ */
259 typedef struct cups_option_s
/**** Printer Options ****/
261 char *name
; /* Name of option */
262 char *value
; /* Value of option */
265 typedef struct cups_dest_s
/**** Destination ****/
267 char *name
, /* Printer or class name */
268 *instance
; /* Local instance name or NULL */
269 int is_default
; /* Is this printer the default? */
270 int num_options
; /* Number of options */
271 cups_option_t
*options
; /* Options */
274 typedef struct _cups_dinfo_s cups_dinfo_t
;
275 /* Destination capability and status
276 * information @since CUPS 1.6/OS X 10.8@ */
278 typedef struct cups_job_s
/**** Job ****/
280 int id
; /* The job ID */
281 char *dest
; /* Printer or class name */
282 char *title
; /* Title/job name */
283 char *user
; /* User the submitted the job */
284 char *format
; /* Document format */
285 ipp_jstate_t state
; /* Job state */
286 int size
; /* Size in kilobytes */
287 int priority
; /* Priority (1-100) */
288 time_t completed_time
; /* Time the job was completed */
289 time_t creation_time
; /* Time the job was created */
290 time_t processing_time
; /* Time the job was processed */
293 typedef struct cups_size_s
/**** Media Size @since CUPS 1.6/OS X 10.8@ ****/
295 char media
[128]; /* Media name to use */
296 int width
, /* Width in hundredths of millimeters */
297 length
, /* Length in hundredths of
299 bottom
, /* Bottom margin in hundredths of
301 left
, /* Left margin in hundredths of
303 right
, /* Right margin in hundredths of
305 top
; /* Top margin in hundredths of
309 typedef int (*cups_client_cert_cb_t
)(http_t
*http
, void *tls
,
310 cups_array_t
*distinguished_names
,
312 /* Client credentials callback
313 * @since CUPS 1.5/OS X 10.7@ */
315 typedef int (*cups_dest_cb_t
)(void *user_data
, unsigned flags
,
317 /* Destination enumeration callback
318 * @since CUPS 1.6/OS X 10.8@ */
321 typedef int (^cups_dest_block_t
)(unsigned flags
, cups_dest_t
*dest
);
322 /* Destination enumeration block
323 * @since CUPS 1.6/OS X 10.8@ */
324 # endif /* __BLOCKS__ */
326 typedef void (*cups_device_cb_t
)(const char *device_class
,
327 const char *device_id
, const char *device_info
,
328 const char *device_make_and_model
,
329 const char *device_uri
,
330 const char *device_location
, void *user_data
);
332 * @since CUPS 1.4/OS X 10.6@ */
334 typedef const char *(*cups_password_cb_t
)(const char *prompt
);
335 /* Password callback */
337 typedef const char *(*cups_password_cb2_t
)(const char *prompt
, http_t
*http
,
339 const char *resource
,
341 /* New password callback
342 * @since CUPS 1.4/OS X 10.6@ */
344 typedef int (*cups_server_cert_cb_t
)(http_t
*http
, void *tls
,
345 cups_array_t
*certs
, void *user_data
);
346 /* Server credentials callback
347 * @since CUPS 1.5/OS X 10.7@ */
354 extern int cupsCancelJob(const char *name
, int job_id
);
355 extern ipp_t
*cupsDoFileRequest(http_t
*http
, ipp_t
*request
,
356 const char *resource
,
357 const char *filename
);
358 extern ipp_t
*cupsDoRequest(http_t
*http
, ipp_t
*request
,
359 const char *resource
);
360 extern http_encryption_t
cupsEncryption(void);
361 extern void cupsFreeJobs(int num_jobs
, cups_job_t
*jobs
);
362 extern int cupsGetClasses(char ***classes
) _CUPS_DEPRECATED_MSG("Use cupsGetDests instead.");
363 extern const char *cupsGetDefault(void);
364 extern int cupsGetJobs(cups_job_t
**jobs
, const char *name
,
365 int myjobs
, int whichjobs
);
366 extern const char *cupsGetPPD(const char *name
) _PPD_DEPRECATED
;
367 extern int cupsGetPrinters(char ***printers
) _CUPS_DEPRECATED_MSG("Use cupsGetDests instead.");
368 extern ipp_status_t
cupsLastError(void);
369 extern int cupsPrintFile(const char *name
, const char *filename
,
370 const char *title
, int num_options
,
371 cups_option_t
*options
);
372 extern int cupsPrintFiles(const char *name
, int num_files
,
373 const char **files
, const char *title
,
374 int num_options
, cups_option_t
*options
);
375 extern char *cupsTempFile(char *filename
, int len
) _CUPS_DEPRECATED_MSG("Use cupsTempFd or cupsTempFile2 instead.");
376 extern int cupsTempFd(char *filename
, int len
);
378 extern int cupsAddDest(const char *name
, const char *instance
,
379 int num_dests
, cups_dest_t
**dests
);
380 extern void cupsFreeDests(int num_dests
, cups_dest_t
*dests
);
381 extern cups_dest_t
*cupsGetDest(const char *name
, const char *instance
,
382 int num_dests
, cups_dest_t
*dests
);
383 extern int cupsGetDests(cups_dest_t
**dests
);
384 extern void cupsSetDests(int num_dests
, cups_dest_t
*dests
);
386 extern int cupsAddOption(const char *name
, const char *value
,
387 int num_options
, cups_option_t
**options
);
388 extern void cupsEncodeOptions(ipp_t
*ipp
, int num_options
,
389 cups_option_t
*options
);
390 extern void cupsFreeOptions(int num_options
,
391 cups_option_t
*options
);
392 extern const char *cupsGetOption(const char *name
, int num_options
,
393 cups_option_t
*options
);
394 extern int cupsParseOptions(const char *arg
, int num_options
,
395 cups_option_t
**options
);
397 extern const char *cupsGetPassword(const char *prompt
);
398 extern const char *cupsServer(void);
399 extern void cupsSetEncryption(http_encryption_t e
);
400 extern void cupsSetPasswordCB(cups_password_cb_t cb
);
401 extern void cupsSetServer(const char *server
);
402 extern void cupsSetUser(const char *user
);
403 extern const char *cupsUser(void);
405 /**** New in CUPS 1.1.20 ****/
406 extern int cupsDoAuthentication(http_t
*http
, const char *method
,
407 const char *resource
)
409 extern http_status_t
cupsGetFile(http_t
*http
, const char *resource
,
410 const char *filename
) _CUPS_API_1_1_20
;
411 extern http_status_t
cupsGetFd(http_t
*http
, const char *resource
, int fd
);
412 extern http_status_t
cupsPutFile(http_t
*http
, const char *resource
,
413 const char *filename
) _CUPS_API_1_1_20
;
414 extern http_status_t
cupsPutFd(http_t
*http
, const char *resource
, int fd
)
417 /**** New in CUPS 1.1.21 ****/
418 extern const char *cupsGetDefault2(http_t
*http
) _CUPS_API_1_1_21
;
419 extern int cupsGetDests2(http_t
*http
, cups_dest_t
**dests
)
421 extern int cupsGetJobs2(http_t
*http
, cups_job_t
**jobs
,
422 const char *name
, int myjobs
,
423 int whichjobs
) _CUPS_API_1_1_21
;
424 extern const char *cupsGetPPD2(http_t
*http
, const char *name
) _PPD_DEPRECATED
;
425 extern int cupsPrintFile2(http_t
*http
, const char *name
,
426 const char *filename
,
427 const char *title
, int num_options
,
428 cups_option_t
*options
) _CUPS_API_1_1_21
;
429 extern int cupsPrintFiles2(http_t
*http
, const char *name
,
430 int num_files
, const char **files
,
431 const char *title
, int num_options
,
432 cups_option_t
*options
)
434 extern int cupsSetDests2(http_t
*http
, int num_dests
,
435 cups_dest_t
*dests
) _CUPS_API_1_1_21
;
437 /**** New in CUPS 1.2/OS X 10.5 ****/
438 extern ssize_t
cupsBackChannelRead(char *buffer
, size_t bytes
,
439 double timeout
) _CUPS_API_1_2
;
440 extern ssize_t
cupsBackChannelWrite(const char *buffer
, size_t bytes
,
441 double timeout
) _CUPS_API_1_2
;
442 extern void cupsEncodeOptions2(ipp_t
*ipp
, int num_options
,
443 cups_option_t
*options
,
444 ipp_tag_t group_tag
) _CUPS_API_1_2
;
445 extern const char *cupsLastErrorString(void) _CUPS_API_1_2
;
446 extern char *cupsNotifySubject(cups_lang_t
*lang
, ipp_t
*event
)
448 extern char *cupsNotifyText(cups_lang_t
*lang
, ipp_t
*event
)
450 extern int cupsRemoveOption(const char *name
, int num_options
,
451 cups_option_t
**options
) _CUPS_API_1_2
;
452 extern cups_file_t
*cupsTempFile2(char *filename
, int len
) _CUPS_API_1_2
;
454 /**** New in CUPS 1.3/OS X 10.5 ****/
455 extern ipp_t
*cupsDoIORequest(http_t
*http
, ipp_t
*request
,
456 const char *resource
, int infile
,
457 int outfile
) _CUPS_API_1_3
;
458 extern char *cupsGetServerPPD(http_t
*http
, const char *name
)
460 extern int cupsRemoveDest(const char *name
,
461 const char *instance
,
462 int num_dests
, cups_dest_t
**dests
)
464 extern void cupsSetDefaultDest(const char *name
,
465 const char *instance
,
467 cups_dest_t
*dests
) _CUPS_API_1_3
;
469 /**** New in CUPS 1.4/OS X 10.6 ****/
470 extern ipp_status_t
cupsCancelJob2(http_t
*http
, const char *name
,
471 int job_id
, int purge
) _CUPS_API_1_4
;
472 extern int cupsCreateJob(http_t
*http
, const char *name
,
473 const char *title
, int num_options
,
474 cups_option_t
*options
) _CUPS_API_1_4
;
475 extern ipp_status_t
cupsFinishDocument(http_t
*http
,
476 const char *name
) _CUPS_API_1_4
;
477 extern ipp_status_t
cupsGetDevices(http_t
*http
, int timeout
,
478 const char *include_schemes
,
479 const char *exclude_schemes
,
480 cups_device_cb_t callback
,
481 void *user_data
) _CUPS_API_1_4
;
482 extern cups_dest_t
*cupsGetNamedDest(http_t
*http
, const char *name
,
483 const char *instance
) _CUPS_API_1_4
;
484 extern const char *cupsGetPassword2(const char *prompt
, http_t
*http
,
486 const char *resource
) _CUPS_API_1_4
;
487 extern http_status_t
cupsGetPPD3(http_t
*http
, const char *name
,
488 time_t *modtime
, char *buffer
,
489 size_t bufsize
) _PPD_DEPRECATED
;
490 extern ipp_t
*cupsGetResponse(http_t
*http
,
491 const char *resource
) _CUPS_API_1_4
;
492 extern ssize_t
cupsReadResponseData(http_t
*http
, char *buffer
,
493 size_t length
) _CUPS_API_1_4
;
494 extern http_status_t
cupsSendRequest(http_t
*http
, ipp_t
*request
,
495 const char *resource
,
496 size_t length
) _CUPS_API_1_4
;
497 extern void cupsSetPasswordCB2(cups_password_cb2_t cb
,
498 void *user_data
) _CUPS_API_1_4
;
499 extern http_status_t
cupsStartDocument(http_t
*http
, const char *name
,
500 int job_id
, const char *docname
,
502 int last_document
) _CUPS_API_1_4
;
503 extern http_status_t
cupsWriteRequestData(http_t
*http
, const char *buffer
,
504 size_t length
) _CUPS_API_1_4
;
506 /**** New in CUPS 1.5/OS X 10.7 ****/
507 extern void cupsSetClientCertCB(cups_client_cert_cb_t cb
,
508 void *user_data
) _CUPS_API_1_5
;
509 extern int cupsSetCredentials(cups_array_t
*certs
) _CUPS_API_1_5
;
510 extern void cupsSetServerCertCB(cups_server_cert_cb_t cb
,
511 void *user_data
) _CUPS_API_1_5
;
513 /**** New in CUPS 1.6/OS X 10.8 ****/
514 extern ipp_status_t
cupsCancelDestJob(http_t
*http
, cups_dest_t
*dest
,
515 int job_id
) _CUPS_API_1_6
;
516 extern int cupsCheckDestSupported(http_t
*http
, cups_dest_t
*dest
,
519 const char *value
) _CUPS_API_1_6
;
520 extern ipp_status_t
cupsCloseDestJob(http_t
*http
, cups_dest_t
*dest
,
521 cups_dinfo_t
*info
, int job_id
)
523 extern http_t
*cupsConnectDest(cups_dest_t
*dest
, unsigned flags
,
524 int msec
, int *cancel
,
525 char *resource
, size_t resourcesize
,
526 cups_dest_cb_t cb
, void *user_data
)
529 extern http_t
*cupsConnectDestBlock(cups_dest_t
*dest
,
530 unsigned flags
, int msec
,
531 int *cancel
, char *resource
,
533 cups_dest_block_t block
)
535 # endif /* __BLOCKS__ */
536 extern int cupsCopyDest(cups_dest_t
*dest
, int num_dests
,
537 cups_dest_t
**dests
) _CUPS_API_1_6
;
538 extern cups_dinfo_t
*cupsCopyDestInfo(http_t
*http
, cups_dest_t
*dest
)
540 extern int cupsCopyDestConflicts(http_t
*http
, cups_dest_t
*dest
,
543 cups_option_t
*options
,
544 const char *new_option
,
545 const char *new_value
,
547 cups_option_t
**conflicts
,
549 cups_option_t
**resolved
)
551 extern ipp_status_t
cupsCreateDestJob(http_t
*http
, cups_dest_t
*dest
,
552 cups_dinfo_t
*info
, int *job_id
,
553 const char *title
, int num_options
,
554 cups_option_t
*options
) _CUPS_API_1_6
;
555 extern int cupsEnumDests(unsigned flags
, int msec
, int *cancel
,
556 cups_ptype_t type
, cups_ptype_t mask
,
557 cups_dest_cb_t cb
, void *user_data
)
560 extern int cupsEnumDestsBlock(unsigned flags
, int msec
,
561 int *cancel
, cups_ptype_t type
,
563 cups_dest_block_t block
)
565 # endif /* __BLOCKS__ */
566 extern ipp_status_t
cupsFinishDestDocument(http_t
*http
,
570 extern void cupsFreeDestInfo(cups_dinfo_t
*dinfo
) _CUPS_API_1_6
;
571 extern int cupsGetDestMediaByName(http_t
*http
, cups_dest_t
*dest
,
575 cups_size_t
*size
) _CUPS_API_1_6
;
576 extern int cupsGetDestMediaBySize(http_t
*http
, cups_dest_t
*dest
,
578 int width
, int length
,
580 cups_size_t
*size
) _CUPS_API_1_6
;
581 extern const char *cupsLocalizeDestOption(http_t
*http
, cups_dest_t
*dest
,
585 extern const char *cupsLocalizeDestValue(http_t
*http
, cups_dest_t
*dest
,
590 extern http_status_t
cupsStartDestDocument(http_t
*http
, cups_dest_t
*dest
,
591 cups_dinfo_t
*info
, int job_id
,
595 cups_option_t
*options
,
596 int last_document
) _CUPS_API_1_6
;
598 /* New in CUPS 1.7 */
599 extern ipp_attribute_t
*cupsFindDestDefault(http_t
*http
, cups_dest_t
*dest
,
601 const char *option
) _CUPS_API_1_7
;
602 extern ipp_attribute_t
*cupsFindDestReady(http_t
*http
, cups_dest_t
*dest
,
604 const char *option
) _CUPS_API_1_7
;
605 extern ipp_attribute_t
*cupsFindDestSupported(http_t
*http
, cups_dest_t
*dest
,
609 extern int cupsGetDestMediaByIndex(http_t
*http
, cups_dest_t
*dest
,
610 cups_dinfo_t
*dinfo
, int n
,
614 extern int cupsGetDestMediaCount(http_t
*http
, cups_dest_t
*dest
,
616 unsigned flags
) _CUPS_API_1_7
;
617 extern int cupsGetDestMediaDefault(http_t
*http
, cups_dest_t
*dest
,
622 extern void cupsSetUserAgent(const char *user_agent
) _CUPS_API_1_7
;
623 extern const char *cupsUserAgent(void) _CUPS_API_1_7
;
625 /* New in CUPS 2.0/OS X 10.10 */
626 extern cups_dest_t
*cupsGetDestWithURI(const char *name
, const char *uri
) _CUPS_API_2_0
;
627 extern const char *cupsLocalizeDestMedia(http_t
*http
, cups_dest_t
*dest
, cups_dinfo_t
*info
, unsigned flags
, cups_size_t
*size
) _CUPS_API_2_0
;
628 extern int cupsMakeServerCredentials(const char *path
, const char *common_name
, int num_alt_names
, const char **alt_names
, time_t expiration_date
) _CUPS_API_2_0
;
629 extern int cupsSetServerCredentials(const char *path
, const char *common_name
, int auto_create
) _CUPS_API_2_0
;
633 # endif /* __cplusplus */
635 #endif /* !_CUPS_CUPS_H_ */