AddPort

The AddPort function adds the name of a port to the list of supported ports. The AddPort function is exported by the print monitor.

BOOL AddPort(
  LPTSTR pName,         // pointer to a server name
  HWND hWnd,            // handle to parent window
  LPTSTR pMonitorName   // pointer to a monitor name
);
 

Parameters

pName

Pointer to a zero-terminated string that specifies the name of the server to which the port is connected. If this parameter is NULL, the port is local.

hWnd

Handle to the parent window of the AddPort dialog box.

pMonitorName

Pointer to a zero-terminated string that specifies the monitor associated with the port.

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 AddPort function browses the network to find existing ports, and displays a dialog box for the user. The AddPort function should validate the port name entered by the user by calling EnumPorts to ensure that no duplicate names exist.

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

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winspool.h.
  Import Library: Use winspool.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Printing and Print Spooler Overview, Printing and Print Spooler Functions, DeletePort EnumPorts SetPort