ConfigurePort

The ConfigurePort function displays the port-configuration dialog box for a port on the specified server.

BOOL ConfigurePort(
  LPTSTR pName,      // pointer to server name
  HWND hWnd,         // handle to parent window of the dialog box
  LPTSTR pPortName   // pointer to port name
);
 

Parameters

pName

Pointer to a null-terminated string that specifies the name of the server on which the specified port exists. If this parameter is NULL, the port is local.

hWnd

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

pPortName

Pointer to a null-terminated string that specifies the name of the port to be configured.

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

Before calling the ConfigurePort function, an application should call the EnumPorts function to determine valid port names.

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