OpenPort-Funktion (winsplp.h)

Artikel
02/07/2025

Die OpenPort-Funktion eines Portmonitors öffnet einen Druckeranschluss.

Syntax

BOOL OpenPort(
  LPWSTR  pName,
  PHANDLE pHandle
);

Parameter

pName

Vom Aufrufer bereitgestellter Zeiger auf eine Zeichenfolge, die den Namen des zu öffnenden Ports enthält.

pHandle

Vom Anrufer bereitgestellter Zeiger an einen Ort, an dem ein Porthandle empfangen wird.

Rückgabewert

Wenn der Vorgang erfolgreich ist, sollte die Funktion TRUE-zurückgeben. Andernfalls sollte FALSE-zurückgegeben werden.

Bemerkungen

Portmonitor-Server-DLLs sind erforderlich, um eine OpenPort--Funktion zu definieren und die Adresse der Funktion in eine MONITOR2 Struktur einzuschließen.

Die OpenPort--Funktion wird entweder von einem Sprachmonitor oder vom Druckspooler aufgerufen, wenn eine Druckwarteschlange mit einem Port verbunden wird. Der primäre Zweck der OpenPort-Funktion besteht darin, ein Porthandle zurückzugeben, das der Aufrufer als Eingabeargument für nachfolgende Aufrufe der StartDocPortdes Portmonitors verwenden kann, WritePort, ReadPort, EndDocPortund GetPrinterDataFromPort Funktionen.

Neben dem Zurückgeben eines Porthandles kann die OpenPort--Funktion Initialisierungsvorgänge ausführen, die vor der Ausführung von Lese- oder Schreibvorgängen behandelt werden müssen. Wenn der Port beispielsweise modifizierbare Timeoutwerte unterstützt, sollte die OpenPort--Funktion diese Werte festlegen.

Aufrufe von OpenPort- sind nicht druckauftragsspezifisch. Zwischen jedem Aufruf der OpenPort- und ClosePort- Funktionen eines Portmonitors können mehrere Aufrufe an die StartDocPort-- und EndDocPort--Funktionen vorhanden sein.

Sie können davon ausgehen, dass der Druckspooler OpenPort- mit einem bestimmten Portnamen nicht erneut OpenPort- mit demselben Portnamen aufruft, bevor ClosePort-aufgerufen wird.

Drucküberwachungsfunktionen, die ein Porthandle akzeptieren, als Eingabe akzeptieren auch keinen Monitorhandle. Daher muss die OpenPort--Funktion den empfangenen Monitorhandle an einem Ort speichern, auf den vom Porthandle verwiesen werden kann. Dadurch können die Funktionen, die ein Porthandle akzeptieren, auf den Monitorhandle verweisen.