DosPrintQEnum

The DosPrintQEnum API retrieves a list of all printer queues on a local workstation or a remote server, optionally supplying additional information.

Levels 0, 1, and 2 return queue names only if the number of bytes in the queue name is less than or equal to QNLEN, as defined in PMSPL.H. At levels 0, 1, and 2, the values of pcReturned and pcTotal are set to the count of queues with short names. At levels 3, 4, and 5, all queue names are returned, and the values pcReturned and pcTotal represent the count of all queues.

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.

Levels 0, 1, and 2 are provided only for compatibility with existing LAN Server 1.0 applications and should not be used in new applications. All new applications should use levels 3, 4, and 5.

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

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

uLevel

Printer Queue Data Structures

pusEntriesReturned

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

pusEntriesAvail

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

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 is not valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_MORE_DATA Г 234 Г Additional data is available, but the Г
Г Г Г buffer is too small. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_NetNotStarted Г 2102 Г The redirector NETWKSTA.200 has not Г
Г Г Г been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_RemoteOnly Г 2106 Г This operation is not supported on Г
Г Г Г workstations. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г 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 retrieving information about a printer queue, see Printer Queue - DosPrintQGetInfo.

[Back]

[Next]