[ Previous | Next | Contents | Home | Search ]
AIX Version 4.3 Kernel and Subsystems Technical Reference, Volume 2

piogetstatus Subroutine

Purpose

Retrieves print job status information from a status file.

Library

libqb.a

Syntax


#include <IN/stfile.h>

int piogetstatus(StatusFileDescriptor, 
VersionMagicNumber, StatusInformation)
int StatusFileDescriptor, VersionMagicNumber;
void *StatusInformation;

Description

The information returned by the piogetstatus subroutine includes the queue name, queue device name, job number, job status, percent done, and number of pages printed. The piogetstatus subroutine reads the specified status file and places the information in the structure specified by the StatusInformation parameter. The format of the status structure is determined by the version magic number specified by the VersionMagicNumber parameter. Each time there is a change in the status file structure for a new release, a unique number is assigned to the release's version magic number. This supports structure formats of previous releases.

Parameters

StatusFileDescriptor Specifies the file descriptor of the status file. The StatusFileDescriptor parameter must specify a value of 3, because the AIX print spooler always opens a status file with a file descriptor value of 3.
VersionMagicNumber Specifies the version magic number that identifies the format of the status structure in which information is specified.
StatusInformation Specifies a generic pointer to a status structure that contains print job status information that is to be stored in the status file.

Return Values

1 Indicates that the pioputstatus subroutine was successful.
-1 Indicates that an error occurred.
[ Previous | Next | Contents | Home | Search ]