SetPort

Overview

Group

Quick Info

Windows NT
Yes
Win95
No
Win32s
No
Import Library
winspool.lib
Header File
winspool.h
Unicode
WinNT
Platform Notes
None

[New - Windows NT]

The SetPort function sets the status associated with a printer port.

BOOL SetPort(

LPTSTR pName,	// pointer to a printer server name
LPTSTR pPortName,	// pointer to a printer port name
DWORD dwLevel,	// version of PORT_INFO_* structure
LPBYTE pPortInfo	// pointer to a PORT_INFO_* structure
);

Parameters
pName

Pointer to a zero-terminated string that specifies the name of the printer server to which the port is connected. Set this parameter to NULL if the port is on the local machine.

pPortName

Pointer to a zero-terminated string that specifies the name of the printer port.

dwLevel

Specifies the type of PORT_INFO_* structure pointed to by the pPortInfo parameter.

This value must be 3, which corresponds to a PORT_INFO_3 data structure.

pPortInfo

Pointer to a PORT_INFO_3 structure that contains the port status information to set.

Return Values
If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks
The caller of the SetPort function must have SERVER_ACCESS_ADMINISTER access to the server to which the port is connected.

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 resumes sending jobs to the port when the port status is cleared by another call to SetPort.