1Net::CUPS::Destination(U3s)er Contributed Perl DocumentatNieotn::CUPS::Destination(3)
2
3
4

NAME

6       Net::CUPS::Destination - CUPS Destination Object
7

SYNOPSIS

9         use Net::CUPS::Destination;
10
11         my $printer = $cups->getDestination( "lj4200dn" );
12
13         my $name = $printer->getName();
14
15         my @options = $printer->getOptions();
16
17         my $jobid = $printer->printFile( $filename, $title );
18

DESCRIPTION

20       Net::CUPS is an object oriented interface to the Common Unix Printing
21       System.
22
23       Net::CUPS::Destination is an abstraction of the concept of a
24       destination in CUPS.  Destinations will most likely be a printer, but
25       it can be any type of target in which a file is sent for processing.
26

METHODS

28       addOption
29           $dest->addOption( $name, $value );
30
31           Method to add another option name/value pair to the destination.
32
33       cancelJob
34           my $dest->cancelJob( $jobid );
35
36           Method to chancel a job sent to this destination.
37
38       getDescription
39           my $description = $dest->getDescription();
40
41           Provides the description string associated with this printer.
42
43       getError
44           my $error = $dest->getError();
45
46           Utility method for returning the last error that occurred.
47
48       getName
49           my $name = $dest->getName();
50
51           Method to return the name of the destination.
52
53       getJob
54           my $job = $dest->getJob( $jobid )
55
56           Method to get a specific job as a hash of attributes.
57
58       getJobs
59           my @jobs = $dest->getJobs( $whose, $scope );
60
61           This method will return an array of job identifiers.  $whose is 0
62           for all users and 1 is just for the selected user.  $scope is -1
63           for all jobs, 0 for active jobs and 1 for completed jobs.
64
65       getLocation
66           Returns the location string for this destination.
67
68       getOptionValue
69           my $value = $dest->getOptionValue( $name );
70
71           This utility method will return the value of the selected option.
72
73       getOptions
74           my @options = $dest->getOptions();
75
76           This method will return an array of the options currently set on
77           the destination.
78
79       printFile
80           my $jobid = $dest->printFile( $filename, $title );
81
82           I know this is the method that you have been looking for.  This is
83           what you will use to send a file to handled by the destination.
84           You must provide the name of the file and a title for the job.
85
86       getUri
87           my $uri = $dest->getUri();
88
89           This function returns the device URI of a destination.  For
90           example, a network printer might appear as socket://192.168.1.1
91
92       getState
93           my $state = $dest->getState();
94
95           This function returns the state of a destination.  The value is an
96           enumeration type with 3 meaning 'idle', 4 'processing' and 5
97           'stopped'.
98

SEE ALSO

100       Net::CUPS, Net::CUPS::PPD, Net::CUPS::IPP
101

SUPPORT

103       Net::CUPS is currently maintained by Stefan Seifert <NINE@cpan.org>.
104       The Github repository for this project is at
105       <https://github.com/niner/perl-Net-CUPS>. Pull requests are welcome.
106

AUTHOR

108       Dracken Technology, Inc. (http://www.dracken.com/)
109

111       Copyright (c) 2003-2005 David Hageman
112
113       Copyright (c) 2006-2009 Dracken Technology, Inc.
114
115       All rights reserved.
116
117       This library is free software; you can redistribute it and/or modify it
118       under the same terms as Perl itself, either Perl version 5.8.8 or, at
119       your option, any later version of Perl 5 you may have available.
120
121       CUPS, the Common UNIX Printing System, the CUPS logo, and ESP Print Pro
122       are the trademark property of Easy Software Products.
123
124
125
126perl v5.34.0                      2022-01-21         Net::CUPS::Destination(3)
Impressum