Description

The papiJobSubmit() function creates a print job containing the passed in files
with the supplied attributes. When the function returns, the data in
the passed files will have been copied by the print service. A
job object is returned that reflects the state of the job.

The papiJobSubmitByReference() function creates a print job containing the passed in files
with the supplied attributes. When the function returns, the data in
the passed files might have been copied by the print service. A
job object is returned that reflects the state of the job.

The papiJobStreamOpen(), papiJobStreamWrite(), papiJobStreamClose() functions create a print job by opening a
stream, writing to the stream, and closing it.

The papiJobValidate() function validates that the supplied attributes and files will result
in a valid print job.

The papiJobQuery() function retrieves job information from the print service.

The papiJobModify() function modifies a queued job according to the attribute list
passed into the call. A job object is returned that reflects
the state of the job after the modification has been applied.

The papiJobMove() function moves a job from its current queue to the
named destination within the same print service.

The papiJobCancel() function removes a job from the queue.

The papiJobHold() and papiJobRelease() functions set the job state to “held” or
“idle” to indicate whether the job is eligible for processing.

The papiJobRestart() function restarts processing of a currently queued print job.

The papiJobGetAttributeList() function returns a list of attributes describing the job. This
list can be searched and/or enumerated using papiAttributeList*() calls. See papiAttributeListAddValue(3PAPI).

The papiJobGetPrinterName() function returns the name of the queue where the job
is currently queued.

The papiJobGetId() function returns a job identifier number from the job object
passed in.

The papiJobPromote() function moves a job to the head of the print
queue.

The papiJobGetJobTicket() function retrieves a pointer to a job ticket associated with
the job object.

The papiJobFree() and papiJobListFree() functions deallocate memory allocated for the return of
printer object(s) from functions that return printer objects.

Return Values

Upon successful completion, all papiJob*() functions that return a value return PAPI_OK.
Otherwise, they return an appropriate papi_status_t indicating the type of failure.

Upon successful completion, papiJobGetAttributeList() returns a pointer to the requested data. Otherwise,
it returns NULL.