ConfigurePortUI-Funktion (winsplp.h)

Artikel
02/27/2024

Die ConfigurePortUI-Funktion einer Portmonitor-UI-DLL ruft Portkonfigurationsinformationen vom Benutzer ab und sendet sie an die Portmonitorserver-DLL.

Syntax

BOOL WINAPI pfnConfigurePortUI(
  _In_opt_ PCWSTR pszServer,
  _In_     HWND   hWnd,
  _In_     PCWSTR pszPortName
);

Parameter

[in, optional] pszServer

Vom Aufrufer bereitgestellter Zeiger auf eine Zeichenfolge, die einen Servernamen darstellt, oder NULL , wenn der Drucker lokal ist. (Der Portmonitor kann diesen Parameter ignorieren.)

[in] hWnd

Das vom Aufrufer bereitgestellte Handle des Fensters, das als übergeordnetes Element für Dialogfelder verwendet werden soll. Bei NULL sollten keine Dialogfelder angezeigt werden.

[in] pszPortName

Vom Aufrufer bereitgestellter Zeiger auf eine Zeichenfolge, die den Namen des zu konfigurierenden Ports darstellt.

Rückgabewert

Wenn der Vorgang erfolgreich ist, sollte die Funktion TRUE zurückgeben. Andernfalls sollte false zurückgegeben werden. Wenn der Vorgang nicht unterstützt wird oder vom Benutzer abgebrochen wird (entweder durch Auswählen von ABBRECHEN oder durch Auswählen von OK ohne Änderung der Konfigurationsparameter), sollte die Funktion SetLastError(ERROR_CANCELLED) aufrufen und dann FALSE zurückgeben.

Hinweise

Portmonitor-UI-DLLs sind erforderlich, um eine ConfigurePortUI-Funktion zu definieren und die Adresse der Funktion in eine MONITORUI-Struktur einzuschließen.

Der Spooler des Clients ruft ConfigurePortUI aus seiner ConfigurePort-Funktion auf (in der Microsoft Windows SDK-Dokumentation beschrieben). Die von ConfigurePortUI empfangenen Argumente sind die Argumente, die von ConfigurePort empfangen werden.

Die Funktion sollte die folgenden Vorgänge ausführen:

Rufen Sie OpenPrinter auf, und geben Sie einen Druckernamen im folgenden Format an:

\\ServerName\,XcvPortPortName

wobei ServerName und PortName die Server- und Portnamen sind, die als ConfigurePortUI-Funktionsargumente empfangen werden.

Der Aufruf von OpenPrinter erfordert eine PRINTER_DEFAULTS-Struktur, die in der Windows SDK-Dokumentation beschrieben wird. Das DesiredAccess-Element der Struktur muss auf SERVER_ACCESS_ADMINISTER festgelegt werden. Die pDatatype - und pDevMode-Member können NULL sein.

Dieser Aufruf bewirkt, dass die XcvOpenPort-Funktion der Druckmonitorserver-DLL aufgerufen wird.
Rufen Sie portkonfigurationsparameter vom Benutzer ab, indem Sie ein Dialogfeld anzeigen.
Rufen Sie XcvData mindestens einmal auf, und geben Sie benutzerdefinierte Datennamenzeichenfolgen an, um jeden Konfigurationsparameter an die Server-DLL zu senden. Jeder XcvData-Aufruf bewirkt, dass die XcvDataPort-Funktion des Servers aufgerufen wird.
Rufen Sie ClosePrinter auf, und geben Sie das von OpenPrinter empfangene Handle an. Dadurch wird die XcvClosePort-Funktion der Server-DLL aufgerufen.