CAPS Universe documentation  1.0.4
All you need to know to be successful
Data Structures | Macros | Functions
libcapsclient.h File Reference

Printer and printing access for clients. More...

Go to the source code of this file.

Data Structures

struct  caps_cl_notifier
 Define notifier callbacks for Printing Coordinator clients. More...
 
struct  caps_cl_printer_list
 
struct  caps_cl_printer_info
 
struct  caps_cl_printer_state
 
struct  caps_cl_job_state
 

Macros

#define LIBCAPSCLIENT_MAJOR   1
 
#define LIBCAPSCLIENT_MINOR   1
 
#define LIBCAPSCLIENT_MICRO   1
 
#define CAPS_NOTIFIER_HANDLED   0
 
#define CAPS_NOTIFIER_NOT_YET_HANDLED   1
 

Functions

void caps_libclient_version_get (unsigned *major, unsigned *minor, unsigned *micro)
 
struct caps_cl_handlecaps_cl_instance_create (void)
 
int caps_cl_instance_register (struct caps_cl_handle *instance, const struct caps_cl_notifier *notifier, void *data)
 
void caps_cl_instance_unregister (struct caps_cl_handle *instance)
 
void caps_cl_instance_destroy (struct caps_cl_handle *instance)
 
int caps_cl_printer_list_get (struct caps_cl_handle *instance, struct caps_cl_printer_list **list)
 
int caps_cl_printer_info_get (struct caps_cl_handle *instance, caps_identifier printer_id, struct caps_cl_printer_info **info)
 
void caps_cl_printer_info_destroy (struct caps_cl_handle *instance, struct caps_cl_printer_info *info)
 
int caps_cl_printer_state_get (struct caps_cl_handle *instance, caps_identifier printer_id, struct caps_cl_printer_state *state)
 
int caps_cl_printer_PPD_get (struct caps_cl_handle *instance, caps_identifier printer_id, int *ppdfh)
 
int caps_cl_printer_name_to_id (struct caps_cl_handle *instance, const char *name, caps_identifier *printer_id)
 
int caps_cl_notifiers_process (struct caps_cl_handle *instance)
 
int caps_cl_connection_fd_get (struct caps_cl_handle *instance)
 
int caps_cl_error_messages_catch (struct caps_cl_handle *instance, char **ptr, size_t *size)
 
void caps_cl_error_messages_reset (struct caps_cl_handle *instance)
 
int caps_cl_job_commit (struct caps_cl_handle *instance, caps_identifier printer_id, int job_fd, const char *parameter, caps_identifier *job_id)
 
int caps_cl_job_state_get (struct caps_cl_handle *instance, caps_identifier job_id, struct caps_cl_job_state *state)
 
bool caps_cl_job_check_if_done (struct caps_cl_handle *instance, const struct caps_cl_job_state *state)
 
int caps_cl_job_progression_get (struct caps_cl_handle *instance, caps_identifier job_id, struct caps_job_progression *prog)
 
int caps_cl_job_cancel (struct caps_cl_handle *instance, caps_identifier job_id)
 

Detailed Description

Author
Jürgen Borleis
Warning
Use as experimental

Be part of the whole CAPS universe thing and know how. This is the full client API description and some more details.