DosPrintJobGetId

The DosPrintJobGetId API retrieves information about a remote print job.

Restrictions

A call to this API can be issued from DLS or OS/2 workstations, but only to the local computer. This API does not have any access authority requirements.

Although a call to this API must be issued to a local handle, that handle must be associated with a redirected device or remote queue. This API is not available for the local spooler or for other handles associated with local jobs. If this API is called from a workstation without the DLS or OS/2 requester program installed, the ERROR_NOT_SUPPORTED (50) error code is returned.

#define INCL_BASE
#include <os2.h>
#include <pmspl.h>
#include <neterr.h>
#include <netcons.h>
 
SPLERR SPLENTRY
DosPrintJobGetId(handle, buf, usBuflen);     /* 16 bit */

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

handle

(HFILE) contains the handle of a redirected print device.

buf

(unsigned char LSFAR *) points to the data structure to be used with this call, as defined in Print Job Identification Data Structure.

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_ACCESS_DENIED │ 5 │ Administrator privilege is required. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_HANDLE │ 6 │ The specified handle is not valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_NOT_SUPPORTED │ 50 │ This request is not supported by the │
│ │ │ network. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_DevNotRedirected │ 2107 │ The device is not connected. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BufTooSmall │ 2123 │ The buffer is too small for fixed- │
│ │ │ length data. │
└─────────────────────────────┴───────┴────────────────────────────────────────┘

For information about:

Listing the print jobs in a printer queue, see Print Job - DosPrintJobEnum.
Changing the instructions for a submitted print job, see Print Job - DosPrintJobSetInfo.
Retrieving information about a particular print job, see Print Job - DosPrintJobGetInfo.

[Back: DosPrintJobEnum]

[Next: DosPrintJobGetInfo]