ConfigurePort function pointer

The ConfigurePort function is obsolete and is for use only with Windows NT 4.0 and previous versions. For later versions of Windows, use ConfigurePortUI.

ConfigurePort is a port management function that configures the specified port.

Syntax


typedef BOOL ( WINAPI *pfnConfigurePort)(
  _In_ HANDLE hMonitor,
  _In_ LPWSTR pName,
  _In_ HWND   hWnd,
  _In_ LPWSTR pPortName
);

Parameters

hMonitor [in]

Caller supplied monitor instance handle. This is the handle returned by the monitor's InitializePrintMonitor2 function. (This parameter does not exist if the print monitor supports InitializePrintMonitor instead of InitializePrintMonitor2.)

pName [in]

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

hWnd [in]

Handle to the parent window of the dialog box in which the configuration information will be entered.

pPortName [in]

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

Return value

The return value is TRUE if the function is successful.

Remarks

The spooler calls ConfigurePort so a port monitor can perform port configuration. ConfigurePort can offer a dialog box to obtain some or all of the necessary port configuration information from the user.

The spooler does not support remote ConfigurePort calls; consequently, monitors can ignore the pName parameter.

Requirements

Target platform

Header

Winsplp.h (include Winsplp.h)

See also

AddPort
DeletePort
InitializePrintMonitor2
InitializePrintMonitor

 

 

Send comments about this topic to Microsoft

Show: