.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::CUPS::Destination 3pm"
.TH Net::CUPS::Destination 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::CUPS::Destination \- CUPS Destination Object
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Net::CUPS::Destination;
\&
\&  my $printer = $cups\->getDestination( "lj4200dn" );
\&
\&  my $name = $printer\->getName();
\&
\&  my @options = $printer\->getOptions();
\&
\&  my $jobid = $printer\->printFile( $filename, $title );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Net::CUPS is an object oriented interface to the Common Unix Printing System.
.PP
Net::CUPS::Destination is an abstraction of the concept of a destination
in CUPS.  Destinations will most likely be a printer, but it can be any 
type of target in which a file is sent for processing.
.SH METHODS
.IX Header "METHODS"
.IP \fBaddOption\fR 4
.IX Item "addOption"
\&\f(CW$dest\fR\->addOption( \f(CW$name\fR, \f(CW$value\fR );
.Sp
Method to add another option name/value pair to the destination.
.IP \fBcancelJob\fR 4
.IX Item "cancelJob"
my \f(CW$dest\fR\->cancelJob( \f(CW$jobid\fR );
.Sp
Method to chancel a job sent to this destination.
.IP \fBgetDescription\fR 4
.IX Item "getDescription"
my \f(CW$description\fR = \f(CW$dest\fR\->\fBgetDescription()\fR;
.Sp
Provides the description string associated with this printer.
.IP \fBgetError\fR 4
.IX Item "getError"
my \f(CW$error\fR = \f(CW$dest\fR\->\fBgetError()\fR;
.Sp
Utility method for returning the last error that occurred.
.IP \fBgetName\fR 4
.IX Item "getName"
my \f(CW$name\fR = \f(CW$dest\fR\->\fBgetName()\fR;
.Sp
Method to return the name of the destination.
.IP \fBgetJob\fR 4
.IX Item "getJob"
my \f(CW$job\fR = \f(CW$dest\fR\->getJob( \f(CW$jobid\fR )
.Sp
Method to get a specific job as a hash of attributes.
.IP \fBgetJobs\fR 4
.IX Item "getJobs"
my \f(CW@jobs\fR = \f(CW$dest\fR\->getJobs( \f(CW$whose\fR, \f(CW$scope\fR );
.Sp
This method will return an array of job identifiers.  \f(CW$whose\fR is 0 for
all users and 1 is just for the selected user.  \f(CW$scope\fR is \-1 for all 
jobs, 0 for active jobs and 1 for completed jobs.
.IP \fBgetLocation\fR 4
.IX Item "getLocation"
Returns the location string for this destination.
.IP \fBgetOptionValue\fR 4
.IX Item "getOptionValue"
my \f(CW$value\fR = \f(CW$dest\fR\->getOptionValue( \f(CW$name\fR );
.Sp
This utility method will return the value of the selected option.
.IP \fBgetOptions\fR 4
.IX Item "getOptions"
my \f(CW@options\fR = \f(CW$dest\fR\->\fBgetOptions()\fR;
.Sp
This method will return an array of the options currently set on the
destination.
.IP \fBprintFile\fR 4
.IX Item "printFile"
my \f(CW$jobid\fR = \f(CW$dest\fR\->printFile( \f(CW$filename\fR, \f(CW$title\fR );
.Sp
I know this is the method that you have been looking for.  This is
what you will use to send a file to handled by the destination.  You
must provide the name of the file and a title for the job.
.IP \fBgetUri\fR 4
.IX Item "getUri"
my \f(CW$uri\fR = \f(CW$dest\fR\->\fBgetUri()\fR;
.Sp
This function returns the device URI of a destination.
For example, a network printer might appear as socket://192.168.1.1
.IP \fBgetState\fR 4
.IX Item "getState"
my \f(CW$state\fR = \f(CW$dest\fR\->\fBgetState()\fR;
.Sp
This function returns the state of a destination.
The value is an enumeration type with 3 meaning 'idle', 4 'processing'
and 5 'stopped'.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::CUPS, Net::CUPS::PPD, Net::CUPS::IPP
.SH SUPPORT
.IX Header "SUPPORT"
Net::CUPS is currently maintained by Stefan Seifert <NINE@cpan.org>.
The Github repository for this project is at
<https://github.com/niner/perl\-Net\-CUPS>. Pull requests are welcome.
.SH AUTHOR
.IX Header "AUTHOR"
Dracken Technology, Inc. (http://www.dracken.com/)
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2003\-2005 David Hageman
.PP
Copyright (c) 2006\-2009 Dracken Technology, Inc.
.PP
All rights reserved.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.
.PP
CUPS, the Common UNIX Printing System, the CUPS logo, and ESP Print Pro are the trademark property of Easy Software Products.