The administrative APIs provide convenience functions to perform certain administrative functions with the CUPS scheduler.
-Note: +Note:@@ -507,70 +600,54 @@ show_devices(void)Administrative functions normally require administrative privileges to execute and must not be used in ordinary user applications!
DEPRECATED cupsAdminCreateWindowsPPD
Create the Windows PPD file for a printer.
-char *cupsAdminCreateWindowsPPD (
+char *cupsAdminCreateWindowsPPD(http_t *http, const char *dest, char *buffer, int bufsize);
- http_t *http,
- const char *dest,
- char *buffer,
- int bufsize
-);Parameters
--
+- http
-- Connection to server or
-CUPS_HTTP_DEFAULT- dest
-- Printer or class
-- buffer
-- Filename buffer
-- bufsize
-- Size of filename buffer
-+
+ http +Connection to server or CUPS_HTTP_DEFAULT+ dest +Printer or class + buffer +Filename buffer + bufsize +Size of filename buffer Return Value
PPD file or NULL
DEPRECATED cupsAdminExportSamba
Export a printer to Samba.
-int cupsAdminExportSamba (
+int cupsAdminExportSamba(const char *dest, const char *ppd, const char *samba_server, const char *samba_user, const char *samba_password, FILE *logfile);
- const char *dest,
- const char *ppd,
- const char *samba_server,
- const char *samba_user,
- const char *samba_password,
- FILE *logfile
-);Parameters
--
+- dest
-- Destination to export
-- ppd
-- PPD file
-- samba_server
-- Samba server
-- samba_user
-- Samba username
-- samba_password
-- Samba password
-- logfile
-- Log file, if any
-+
+ dest +Destination to export + ppd +PPD file + samba_server +Samba server + samba_user +Samba username + samba_password +Samba password + logfile +Log file, if any Return Value
1 on success, 0 on failure
CUPS 1.3/macOS 10.5 cupsAdminGetServerSettings
Get settings from the server.
-int cupsAdminGetServerSettings (
+int cupsAdminGetServerSettings(http_t *http, int *num_settings, cups_option_t **settings);
- http_t *http,
- int *num_settings,
- cups_option_t **settings
-);Parameters
--
+- http
-- Connection to server or
-CUPS_HTTP_DEFAULT- num_settings
-- Number of settings
-- settings
-- Settings
-+
+ http +Connection to server or CUPS_HTTP_DEFAULT+ num_settings +Number of settings + settings +Settings Return Value
1 on success, 0 on failure
Discussion
@@ -581,48 +658,37 @@ you are done with them.CUPS 1.3/macOS 10.5 cupsAdminSetServerSettings
Set settings on the server.
-int cupsAdminSetServerSettings (
+int cupsAdminSetServerSettings(http_t *http, int num_settings, cups_option_t *settings);
- http_t *http,
- int num_settings,
- cups_option_t *settings
-);Parameters
--
+- http
-- Connection to server or
-CUPS_HTTP_DEFAULT- num_settings
-- Number of settings
-- settings
-- Settings
-+
+ http +Connection to server or CUPS_HTTP_DEFAULT+ num_settings +Number of settings + settings +Settings Return Value
1 on success, 0 on failure
-CUPS 1.4/macOS 10.6 cupsGetDevices
+DEPRECATED cupsGetDevices
Get available printer devices.
-ipp_status_t cupsGetDevices (
+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);
- http_t *http,
- int timeout,
- const char *include_schemes,
- const char *exclude_schemes,
- cups_device_cb_t callback,
- void *user_data
-);Parameters
--
+- http
-- Connection to server or
-CUPS_HTTP_DEFAULT- timeout
-- Timeout in seconds or
-CUPS_TIMEOUT_DEFAULT- include_schemes
-- Comma-separated URI schemes to include or
-CUPS_INCLUDE_ALL- exclude_schemes
-- Comma-separated URI schemes to exclude or
-CUPS_EXCLUDE_NONE- callback
-- Callback function
-- user_data
-- User data pointer
-+
+ http +Connection to server or CUPS_HTTP_DEFAULT+ timeout +Timeout in seconds or CUPS_TIMEOUT_DEFAULT+ include_schemes +Comma-separated URI schemes to include or CUPS_INCLUDE_ALL+ exclude_schemes +Comma-separated URI schemes to exclude or CUPS_EXCLUDE_NONE+ callback +Callback function + user_data +User data pointer Return Value
Request status -
IPP_OKon success.Discussion
@@ -630,7 +696,10 @@ ipp_status_t cupsGetDevices (
devices to the specified callback function. The "timeout" parameter controls how long the request lasts, while the "include_schemes" and "exclude_schemes" parameters provide comma-delimited lists of backends to include or omit from -the request respectively. +the request respectively.
+
+This function is deprecated with the IPP printer discovery functionality +being provided by thecupsEnumDestsand @cupsGetDests@ functions.Data Types