The PORT_INFO_3 structure specifies the status value of a printer port.
Syntax
typedef struct _PORT_INFO_3 {
DWORD dwStatus;
LPTSTR pszStatus;
DWORD dwSeverity;
} PORT_INFO_3, *PPORT_INFO_3;
Members
dwStatus
The new port status value. This value is used only if the pszStatus member is NULL.
This member can be one of the following values.
| Value | Meaning |
|---|---|
| 0 | Clears the printer port status. |
| PORT_STATUS_OFFLINE | The port's printer is offline. |
| PORT_STATUS_PAPER_JAM | The port's printer has a paper jam. |
| PORT_STATUS_PAPER_OUT | The port's printer is out of paper. |
| PORT_STATUS_OUTPUT_BIN_FULL | The port's printer's output bin is full. |
| PORT_STATUS_PAPER_PROBLEM | The port's printer has a paper problem. |
| PORT_STATUS_NO_TONER | The port's printer is out of toner. |
| PORT_STATUS_DOOR_OPEN | The door of the port's printer is open. |
| PORT_STATUS_USER_INTERVENTION | The port's printer requires user intervention. |
| PORT_STATUS_OUT_OF_MEMORY | The port's printer is out of memory. |
| PORT_STATUS_TONER_LOW | The port's printer is low on toner. |
| PORT_STATUS_WARMING_UP | The port's printer is warming up. |
| PORT_STATUS_POWER_SAVE | The port's printer is in a power-conservation mode. |
pszStatus
Pointer to a new printer port status value string to set. Use this member if there is no suitable status value among those listed for dwStatus.
dwSeverity
The severity of the port status value.
This member can be one of the following values.
| Value | Meaning |
|---|---|
| PORT_STATUS_TYPE_ERROR | The port status value indicates an error. |
| PORT_STATUS_TYPE_WARNING | The port status value is a warning. |
| PORT_STATUS_TYPE_INFO | The port status value is informational. |
Remarks
When you set a printer port status value with the severity value PORT_STATUS_TYPE_ERROR, the print spooler stops sending jobs to the port. The print spooler does not resume sending jobs to the port until another SetPort call is made to clear the status.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Header | Winspool.h (include Windows.h) |
| Unicode and ANSI names | _PORT_INFO_3W (Unicode) and _PORT_INFO_3A (ANSI) |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
