Get the status of a printer and a print job

This article introduces how to get the status of a printer and a print job by using the Win32 Spooler.

Original product version: В Win32 Spooler
Original KB number: В 160129

The status of printers and print jobs are updated by the Win32 Spooler during the despool of a print job. At all other times, when that printer isn’t despooling and reports no state information, the printer is considered to be ready and idle.

As referred to by the Win32 API, a printer is comprised of the printer driver, the print queue, and the input/output path to the physical printer. The operating system treats a physical printer as merely the destination of a print job generated by and passed through a system Printer, referred to in the rest of this article as a Printer.

The most visible part of a Printer is a print queue. It’s managed by the Print Manager or the Printer folders in the Windows 95-style user interfaces. The printer driver is the interface to the Printer that is used by applications to create print jobs via printer DCs. The I/O path for a Printer consists of several layers of system code culminating with a port monitor.

The port monitor is the interface to the physical printer at the down- stream end of a system Printer and is responsible for transferring the data of a print job across whatever connection exists to the physical printer. In the case of bi-directional printers, the port monitor would be responsible for transferring data to and from the physical printer. This connection, and the physical printer, are where errors occur. It’s the job of the port monitor to report those errors.

The Spooler doesn’t query for the state of a physical printer to which a Printer is connected. Instead, the state of a physical printer determines the success of a print job at the time it’s despooled over the port monitor. If some error occurs in this process, the error is reported by the port monitor and recorded in a print job’s status information. The Spooler, in turn, propagates reasonable error information to the Printer Queue.

Consequently, a system Printer reports no status when the Printer queue is empty. In this state, the Printer is assumed ready to accept print jobs. This is a valid assumption even if the physical printer is in an error state such as off-line. The operating system considers the Printer ready to accept print jobs even if, for some reason, it can’t complete delivery to the physical printer. Such a circumstance is considered an error state in the operating system that must be addressed by the user. It isn’t considered an error reportable to the application that is allowed to complete the spooling of the print job successfully.

Determine the state of a physical printer

There is one fundamental premise that must be true to determine the state of a physical printer: the Spooler must be attempting to send a print job to the physical printer. This is the only time the state of the printer is reported by the port monitor. In addition, the most meaningful information may be reported in the status members of a JOB_INFO structure for that particular print job because some port monitor will have set these values directly.

The JOB_INFO structures contain a Status member and a pStatus member. Both members contain status information of a print job reported by the port monitor. These two members differ in that the Status member is a bit field of states that contains predetermined values, while the pStatus member is a pointer to a string that could contain just about anything. These values are documented by the Win32 SDK and the WinSpool.h header file. The pStatus member is sometimes, but not always, set to a descriptive status string. The contents of this string are defined by each port monitor.

JOB_INFO structures are returned by two API functions: GetJob and EnumJobs . EnumJobs returns an array of JOB_INFO structures without requiring that the caller reference a particular job in the Printer queue. The print job that is currently despooling (printing) contains the status information. To find this job in the array, search the array of JOB_INFO structures to locate the print job whose Status member has the JOB_STATUS_PRINTING bit set.

An easier method of determining the printer status is to examine the Status member of a PRINTER_INFO structure. This structure is returned by the GetPrinter function. There is a disadvantage to this approach in that there is no pStatus string member in a PRINTER_INFO structure that might provide more detailed or extensive state information. However, there is an advantage in that a port monitor may set some of the more extensive printer status bits of the PRINTER_INFO structure. However, that the default port monitor for Windows doesn’t set more than the PRINTER_STATUS_ERROR bit of a Printer’s Status member.

The Status members of either set of structures may contain state information that isn’t strictly related to the physical printer. For example, the Status member of the PRINTER_INFO structures may be set with PRINTER_STATUS_PAUSED or PRINTER_STATUS_PENDING_DELETION , that are strictly relevant to the Print Queue. Also, the Status member of the JOB_INFO structure may contain state values for JOB_STATUS_PAUSED or JOB_STATUS_DELETING , that are relevant only to that particular print job. Print jobs may accumulate in a Print queue after they have despooled and would be left with a state of JOB_STATUS_PRINTED .

Each of these functions requires a handle to a printer to identify the wanted Printer. This handle is obtained from the OpenPrinter function, that accepts a string containing the name of the printer. This name can be either the local name of the printer or a UNC share name to a network printer.

The following sample code demonstrates how to call the EnumJobs function properly to retrieve JOB_INFO structures and how to call the GetPrinter function to retrieve PRINTER_INFO structures:

Sample Code

When printer pooling is enabled on Windows NT, there may be more than one print job despooling from a Printer queue that will report a status. This sample code doesn’t consider that circumstance.

exit exit

Область применения: Windows Server (половина ежегодного канала), Windows Server 2019, Windows Server 2016, Windows Server 2012 R2, Windows Server 2012 Applies to: Windows Server (Semi-Annual Channel), Windows Server 2019, Windows Server 2016, Windows Server 2012 R2, Windows Server 2012

Выход из интерпретатора команд или текущего пакетного скрипта. Exits the command interpreter or the current batch script.

Синтаксис Syntax

Параметры Parameters

Параметр Parameter	Описание Description
/b /b	Выход из текущего пакетного скрипта вместо выхода из Cmd.exe. Exits the current batch script instead of exiting Cmd.exe. Если выполняется из-за пределов пакетного скрипта, выполняет выход из Cmd.exe. If executed from outside a batch script, exits Cmd.exe.
Указывает числовое число. Specifies a numeric number. Если указан параметр /b , переменной среды ERRORLEVEL присваивается это число. If /b is specified, the ERRORLEVEL environment variable is set to that number. Если интерпретатор команд закрывается, код завершения процесса устанавливается в это число. If you are quitting the command interpreter, the process exit code is set to that number.
/? /?	Отображение справки в командной строке. Displays help at the command prompt.

Примеры Examples

Чтобы закрыть интерпретатор команд, введите: To close the command interpreter, type:

Получение состояния принтера и задания печати

В этой статье описывается получение состояния принтера и задания печати с помощью диспетчера очереди Win32.

Исходная версия продукта: Диспетчер очереди Win32
Исходный номер статьи базы знаний: 160129

Состояние принтеров и заданий печати обновляются с помощью диспетчера очереди Win32 во время постановки в очередь задания печати. В других случаях, когда принтер не помещается в очередь и не сообщает сведения о состоянии, принтер считается готовым и бездействующим.

Как и в API Win32, принтер состоит из драйвера принтера, очереди печати и пути ввода-вывода к физическому принтеру. Операционная система рассматривает физический принтер как назначение задания печати, созданного и передаваемого через системный принтер, на который ссылается в оставшейся части этой статьи в качестве принтера.

Наиболее видимой частью принтера является очередь печати. Он управляется диспетчером печати или папками принтеров в пользовательских интерфейсах Windows 95. Драйвер принтера — это интерфейс принтера, используемый приложениями для создания заданий печати с помощью контроллеров домена. Путь ввода-вывода для принтера состоит из нескольких уровней системного кода кулминатинг с монитором порта.

Монитор порта — это интерфейс физического принтера в конце системного принтера и отвечает за передачу данных задания печати по любому подключению к физическому принтеру. В случае принтеров с двунаправленным письмом монитор порта отвечает за передачу данных на физический принтер и из него. Для этого подключения и физического принтера возникают ошибки. Для отчета об этих ошибках следует выполнить задание в мониторе порта.

Диспетчер очереди не запрашивает состояние физического принтера, к которому подключен принтер. Вместо этого состояние физического принтера определяет успешность задания печати на тот момент, когда он помещается в очередь через монитор порта. Если в этом процессе возникает какая-либо ошибка, монитор порта сообщает об ошибке и записывается в сведения о состоянии задания печати. Диспетчер очереди, в свою очередь, распространяет сведения об ошибках в очередь принтера.

Следовательно, если очередь принтера пуста, системный принтер сообщает об отсутствии состояния. В этом состоянии принтер считается готовым принимать задания печати. Это допустимое предположение, даже если физический принтер находится в состоянии ошибки, например в состоянии «отключено». Операционная система считает, что принтер готов принимать задания печати, даже если по какой-то причине не удается завершить доставку на физический принтер. Такое обстоятельство считается состоянием ошибки в операционной системе, которое должно быть адресовано пользователю. Она не считается сообщением об ошибке, подотчетной для приложения, которое может успешно завершить работу с очередью для задания печати.

Определение состояния физического принтера

Для определения состояния физического принтера необходимо иметь одно фундаментальное значение, которое должно быть равно true: Диспетчер очереди печати должен пытаться отправить задание печати на физический принтер. Это единственный момент времени, когда монитор порта сообщает о состоянии принтера. Кроме того, наиболее осмысленные сведения могут быть предоставлены в списке члены состояния JOB_INFO структуры для определенного задания печати, так как некоторые из них задают эти значения напрямую.

JOB_INFO Структуры содержат Status элементы и pStatus элементы. Оба участника содержат сведения о состоянии задания печати, предоставленного монитором порта. Эти два члена отличаются в том, что Status член является битовым полем состояний, которые содержат предварительно заданные значения, а pStatus член является указателем на строку, которая может содержать только все элементы. Эти значения задокументированы в пакете Win32 SDK и файле заголовка Винспул. h. В pStatus некоторых случаях, Кроме того, для члена задана строка с описанием состояния. Содержимое этой строки определяется каждым монитором порта.

JOB_INFO структуры возвращаются двумя функциями API: GetJob и EnumJobs . EnumJobs Возвращает массив JOB_INFO структур, не требуя, чтобы вызывающий объект ссылался на определенное задание в очереди принтера. Задание печати, которое в данный момент удаляется из очереди (печать), содержит сведения о состоянии. Чтобы найти это задание в массиве, выполните поиск в массиве JOB_INFO структур, чтобы найти задание печати, для Status члена которого JOB_STATUS_PRINTING задан бит.

Более простым способом определения состояния принтера является проверка Status члена PRINTER_INFO структуры. Эта структура возвращается GetPrinter функцией. Недостаток этого подхода заключается в том, что в pStatus структуре нет строкового элемента PRINTER_INFO , который может предоставить более подробные или подробные сведения о состоянии. Тем не менее, в мониторе портов может быть задано несколько более подробных битов состояния принтера PRINTER_INFO структуры. Тем не менее, если для Windows не задано значение, заданное по умолчанию, то оно больше не PRINTER_STATUS_ERROR является битом Status элемента принтера.

Status Элементы любого набора структур могут содержать сведения о состоянии, которые не являются строго связанными с физическим принтером. Например, Status член PRINTER_INFO структуры можно задать с помощью PRINTER_STATUS_PAUSED OR PRINTER_STATUS_PENDING_DELETION , который строго связан с очередью печати. Кроме того, Status член JOB_INFO структуры может содержать значения состояния для JOB_STATUS_PAUSED OR JOB_STATUS_DELETING , которые относятся только к определенному заданию печати. Задания печати могут накапливаться в очереди печати после того, как они будут помещены в очередь и будут оставаться в состоянии JOB_STATUS_PRINTED .

Каждая из этих функций требует наличия дескриптора принтера для определения нужного принтера. Этот дескриптор получается из OpenPrinter функции, которая принимает строку, содержащую имя принтера. Это имя может быть локальным именем принтера или UNC-именем общего ресурса для сетевого принтера.

В приведенном ниже примере кода показано, как EnumJobs правильно вызвать функцию, чтобы получить JOB_INFO структуры, и как вызвать GetPrinter функцию для получения PRINTER_INFO структур:

Пример кода

Если в Windows NT включена поддержка пулов принтеров, в очереди принтера может быть несколько заданий печати, которые будут сообщать о состоянии. В этом примере кода не учитывается это обстоятельство.

How do I get the application exit code from a Windows command line?

I am running a program and want to see what its return code is (since it returns different codes based on different errors).

I know in Bash I can do this by running

What do I do when using cmd.exe on Windows?

7 Answers 7

A pseudo environment variable named errorlevel stores the exit code:

Also, the if command has a special syntax:

See if /? for details.

Example

Warning: If you set an environment variable name errorlevel , %errorlevel% will return that value and not the exit code. Use ( set errorlevel= ) to clear the environment variable, allowing access to the true value of errorlevel via the %errorlevel% environment variable.

Testing ErrorLevel works for console applications, but as hinted at by dmihailescu, this won’t work if you’re trying to run a windowed application (e.g. Win32-based) from a command prompt. A windowed application will run in the background, and control will return immediately to the command prompt (most likely with an ErrorLevel of zero to indicate that the process was created successfully). When a windowed application eventually exits, its exit status is lost.

Instead of using the console-based C++ launcher mentioned elsewhere, though, a simpler alternative is to start a windowed application using the command prompt’s START /WAIT command. This will start the windowed application, wait for it to exit, and then return control to the command prompt with the exit status of the process set in ErrorLevel .