xref: /titanic_52/usr/src/man/man3lib/libpapi.3lib (revision d14abf155341d55053c76eeec58b787a456b753b)
te
Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
LIBPAPI 3LIB "Dec 18, 2006"
NAME
libpapi - Free Standards Group Open Printing API (PAPI) library functions
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lpapi [ library.\|.\|. ]
#include <papi.h>
DESCRIPTION

Functions in this library provide an interface for interaction with print services as described in v1.0 of the Free Standards Group (FSG) Open Printing API (PAPI).

This particular implementation of the PAPI includes naming support as described in the printers.conf(4) and printers(4) manual pages. It also supplies support for interaction with local LP services, remote LPD services, and remote IPP services through the use of loadable modules that export the same interface. These modules should not be linked with directly, but can be used directly at runtime through the use of LD_PRELOAD for debugging purposes.

INTERFACES

The shared object libpapi.so.0 provides the public interfaces defined below. See Intro(3) for additional information on shared object interfaces.

"Attribute"
papiAttributeListAddBoolean papiAttributeListAddCollection
papiAttributeListAddDatetime papiAttributeListAddInteger
papiAttributeListAddMetadata papiAttributeListAddRange
papiAttributeListAddResolution papiAttributeListAddString
papiAttributeListAddValue papiAttributeListDelete
papiAttributeListFind papiAttributeListFree
papiAttributeListFromString papiAttributeListGetBoolean
papiAttributeListGetCollection papiAttributeListGetDatetime
papiAttributeListGetInteger papiAttributeListGetMetadata
papiAttributeListGetNext papiAttributeListGetRange
papiAttributeListGetResolution papiAttributeListGetString
papiAttributeListGetValue papiAttributeListToString
"Service"
papiServiceCreate papiServiceDestroy
papiServiceGetAppData papiServiceGetAttributeList
papiServiceGetEncryption papiServiceGetPassword
papiServiceGetServiceName papiServiceGetStatusMessage
papiServiceGetUserName papiServiceSetAppData
papiServiceSetAuthCB papiServiceSetEncryption
papiServiceSetPassword papiServiceSetUserName
"Printer"
papiPrinterAdd papiPrinterDisable
papiPrinterEnable papiPrinterFree
papiPrinterGetAttributeList papiPrinterListFree
papiPrinterListJobs papiPrinterModify
papiPrinterPause papiPrinterPurgeJobs
papiPrinterQuery papiPrinterRemove
papiPrinterResume papiPrintersList
"Job"
papiJobCancel papiJobFree
papiJobGetAttributeList papiJobGetId
papiJobGetJobTicket papiJobGetPrinterName
papiJobHold papiJobListFree
papiJobModify papiJobMove
papiJobPromote papiJobQuery
papiJobRelease papiJobRestart
papiJobStreamClose papiJobStreamOpen
papiJobStreamWrite papiJobSubmit
papiJobSubmitByReference papiJobValidate
"Miscellaneous"
papiLibrarySupportedCall papiLibrarySupportedCalls
papiStatusString
FILES
/usr/lib/libpapi.so.0

shared object

/usr/lib/libpapi-common.so.0

private shared code

/usr/lib/print/psm-lpd.so

private rfc1179 support

/usr/lib/print/psm-lpsched.so

private LP support

/usr/lib/print/psm-ipp.so

private IPP support

/usr/lib/libipp-core.so

private IPP marshalling support

/usr/lib/libipp-listener.so

private IPP operations support

/usr/lip/libhttp-core.so

private HTTP support

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Volatile
MT-Level Safe
SEE ALSO

Intro(3), printers(4), printers.conf(4), attributes(5)