DeletePort

The DeletePort function displays a dialog box that allows the user to delete a port name.

BOOL DeletePort(
  LPTSTR pName,      // pointer to server name
  HWND hWnd,         // handle to window that displays dialog box
  LPTSTR pPortName   // pointer to port name
);
 

Parameters

pName

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

hWnd

Handle to the parent window of the port-deletion dialog box.

pPortName

Pointer to a zero-terminated string that specifies the name of the port that should be deleted.

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

An application can retrieve the names of valid ports by calling the EnumPorts function.

The DeletePort function returns an error if a printer is currently connected to the specified port.

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, AddPort, EnumPorts