DosPrintJobEnum

The DosPrintJobEnum API retrieves a list of all print jobs on a specified printer queue, optionally supplying status information about each job.

Restrictions

This API can be called from DLS and OS/2 workstations, but DLS workstations can issue this call only to a remote LAN Server workstation. This API does not have any access authority requirements.

Starting with LAN Server 2.0, three new print destination status bits (9, 10, and 11) were added to the fsStatus element of the PRJINFO data structure. Existing applications that do not examine these new status bits cannot accurately report the status.

#define INCL_BASE
#include <os2.h>
#include <pmspl.h>
#include <neterr.h>
#include <netcons.h>
 
SPLERR SPLENTRY
DosPrintJobEnum(pszServername, pszQueueName, uLevel, buf,
           usBuflen, pusEntriesReturned, pusEntriesAvail);     /* 16 bit */

See Common Parameter Definitions for descriptions of parameters not defined here.

uLevel

Print Job Information Data Structures

pusEntriesReturned

(PUSHORT) points to an unsigned short integer indicating the number of entries that were returned. This count is valid only if DosPrintJobEnum returns NERR_Success or ERROR_MORE_DATA.

pusEntriesAvail

(PUSHORT) points to an unsigned short integer indicating the number of entries that were available. This count is valid only if DosPrintJobEnum returns NERR_Success or ERROR_MORE_DATA.

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) кФФФФФФФФФФФФФФФФФФФФФФФФФФФФФТФФФФФФФТФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФПГSYMBOLICCONSTANT ГVALUEГMEANING Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_Success Г 0 Г No errors were encountered. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_BAD_NETPATH Г 53 Г The network path cannot be found. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_LEVEL Г 124 Г The uLevel parameter is not valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_MORE_DATA Г 234 Г Additional data is available, but the Г
Г Г Г buffer is too small. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_QNotFound Г 2150 Г The printer queue does not exist. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_SpoolerNotLoaded Г 2161 Г The spooler service has not been Г
Г Г Г started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidComputer Г 2351 Г The specified computer name is not Г
Г Г Г valid. Г
РФФФФФФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

If you call this API with the buffer length parameter equal to zero, the API returns a value for total entries available. This technique is useful if you do not know the exact buffer size required.

For information about:

Changing instructions for a submitted print job, see Print Job - DosPrintJobSetInfo.
Retrieving information about a particular print job, see Print Job - DosPrintJobGetInfo.

[Back]

[Next]