Update ipp documentation to reflect the behavior of configuring WiFi on IPP USB printers.

[thirdparty/cups.git] / cups / adminutil.h

diff --git a/cups/adminutil.h b/cups/adminutil.h
index 8b66d1b8d39bdec5fb3a2de32261fc98749adf76..c3c0dc3b56cd4072a4e23112eccae7831ad9fa53 100644 (file)
--- a/cups/adminutil.h
+++ b/cups/adminutil.h
@@ -1,31 +1,10 @@
 /*
- * "$Id: adminutil.h 5235 2006-03-06 13:02:23Z mike $"
+ * Administration utility API definitions for CUPS.
  *
- *   Administration utility API definitions for the Common UNIX Printing
- *   System (CUPS).
+ * Copyright 2007-2016 by Apple Inc.
+ * Copyright 2001-2007 by Easy Software Products.
  *
- *   MANY OF THE FUNCTIONS IN THIS HEADER ARE PRIVATE AND SUBJECT TO
- *   CHANGE AT ANY TIME.  USE AT YOUR OWN RISK.
- *
- *   Copyright 2001-2006 by Easy Software Products.
- *
- *   These coded instructions, statements, and computer programs are the
- *   property of Easy Software Products and are protected by Federal
- *   copyright law.  Distribution and use rights are outlined in the file
- *   "LICENSE.txt" which should have been included with this file.  If this
- *   file is missing or damaged please contact Easy Software Products
- *   at:
- *
- *       Attn: CUPS Licensing Information
- *       Easy Software Products
- *       44141 Airport View Drive, Suite 204
- *       Hollywood, Maryland 20636 USA
- *
- *       Voice: (301) 373-9600
- *       EMail: cups-info@cups.org
- *         WWW: http://www.cups.org
- *
- *   This file is subject to the Apple OS-Developed Software exception.
+ * Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
  */
 
 #ifndef _CUPS_ADMINUTIL_H_
@@ -35,6 +14,7 @@
  * Include necessary headers...
  */
 
+#  include <stdio.h>
 #  include "cups.h"
 
 
@@ -53,11 +33,24 @@ extern "C" {
 
 #  define CUPS_SERVER_DEBUG_LOGGING    "_debug_logging"
 #  define CUPS_SERVER_REMOTE_ADMIN     "_remote_admin"
-#  define CUPS_SERVER_REMOTE_PRINTERS  "_remote_printers"
+#  define CUPS_SERVER_REMOTE_ANY       "_remote_any"
 #  define CUPS_SERVER_SHARE_PRINTERS   "_share_printers"
 #  define CUPS_SERVER_USER_CANCEL_ANY  "_user_cancel_any"
 
 
+/*
+ * Types and structures...
+ */
+
+typedef void (*cups_device_cb_t)(const char *device_class,
+                                 const char *device_id, const char *device_info,
+                                 const char *device_make_and_model,
+                                 const char *device_uri,
+                                const char *device_location, void *user_data);
+                                       /* Device callback
+                                        * @since CUPS 1.4/macOS 10.6@ */
+
+
 /*
  * Functions...
  */
@@ -66,16 +59,25 @@ extern int  cupsAdminExportSamba(const char *dest, const char *ppd,
                                     const char *samba_server,
                                     const char *samba_user,
                                     const char *samba_password,
-                                    FILE *logfile);
+                                    FILE *logfile) _CUPS_DEPRECATED;
 extern char    *cupsAdminCreateWindowsPPD(http_t *http, const char *dest,
-                                          char *buffer, int bufsize);
+                                          char *buffer, int bufsize)
+                                          _CUPS_DEPRECATED;
+
+extern int     cupsAdminGetServerSettings(http_t *http,
+                                          int *num_settings,
+                                          cups_option_t **settings)
+                                          _CUPS_API_1_3;
+extern int     cupsAdminSetServerSettings(http_t *http,
+                                          int num_settings,
+                                          cups_option_t *settings)
+                                          _CUPS_API_1_3;
 
-extern int     _cupsAdminGetServerSettings(http_t *http,
-                                           int *num_settings,
-                                           cups_option_t **settings);
-extern int     _cupsAdminSetServerSettings(http_t *http,
-                                           int num_settings,
-                                           cups_option_t *settings);
+extern ipp_status_t    cupsGetDevices(http_t *http, int timeout,
+                                      const char *include_schemes,
+                                      const char *exclude_schemes,
+                                      cups_device_cb_t callback,
+                                      void *user_data) _CUPS_DEPRECATED;
 
 
 #  ifdef __cplusplus
@@ -83,7 +85,3 @@ extern int    _cupsAdminSetServerSettings(http_t *http,
 #  endif /* __cplusplus */
 
 #endif /* !_CUPS_ADMINUTIL_H_ */
-
-/*
- * End of "$Id: adminutil.h 5235 2006-03-06 13:02:23Z mike $".
- */