DosPrintDestEnum

The DosPrintDestEnum API retrieves a list of all print destinations on a server, optionally supplying status information about each.

At levels 0 and 1, DosPrintDestEnum returns print destination names only if they are associated with printer queues. At levels 2 and 3, DosPrintDestEnum returns all print destinations.

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.

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

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

uLevel

Print Destination Data Structures

pusEntriesReturned

(PUSHORT) points to an unsigned short integer specifying the number of data structures returned. This parameter is valid only if DosPrintDestEnum returns NERR_Success or ERROR_MORE_DATA.

pusEntriesAvail

(PUSHORT) points to an unsigned short integer indicating the number of data structures that were available. This is valid only if DosPrintDestEnum 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_RemoteOnly Г 2106 Г This operation is not supported on Г
Г Г Г workstations. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_DestNotFound Г 2152 Г The print destination cannot be found. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_SpoolerNotLoaded Г 2161 Г The spooler service has not been Г
Г Г Г started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidComputer Г 2351 Г The specified computer name is not Г
Г Г Г valid. Г
РФФФФФФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

For information about:

Pausing or continuing printing on a particular print destination, see Print Destination - DosPrintDestControl.
Retrieving the status of a particular print destination, see Print Destination - DosPrintDestGetInfo.

[Back]

[Next]