OpenPort, fonction (winsplp.h)

2025-02-07

La fonction openPort d’un moniteur de port ouvre un port d’imprimante.

Syntaxe

BOOL OpenPort(
  LPWSTR  pName,
  PHANDLE pHandle
);

Paramètres

pName

Pointeur fourni par l’appelant vers une chaîne contenant le nom du port à ouvrir.

pHandle

Pointeur fourni par l’appelant vers un emplacement pour recevoir un handle de port.

Valeur de retour

Si l’opération réussit, la fonction doit retourner TRUE. Sinon, elle doit retourner FALSE.

Remarques

Les DLL du serveur de moniteur de port sont requises pour définir une fonction OpenPort et inclure l’adresse de la fonction dans une structure de MONITOR2.

La fonction OpenPort est appelée, soit par un moniteur de langue, soit par le spouleur d’impression, lorsqu’une file d’attente d’impression est connectée à un port. L’objectif principal de la fonction OpenPort est de renvoyer un handle de port que l’appelant peut utiliser comme argument d’entrée pour les appels suivants aux StartDocPortdu moniteur de port, WritePort, ReadPort, EndDocPortet fonctions GetPrinterDataFromPort.

Outre le retour d’un handle de port, la fonction OpenPort peut effectuer des opérations d’initialisation qui doivent être prises en charge avant l’exécution des opérations de lecture ou d’écriture. Par exemple, si le port prend en charge les valeurs de délai d’attente modifiables, la fonction OpenPort doit définir ces valeurs.

Les appels à OpenPort ne sont pas spécifiques au travail d’impression. Entre chaque appel aux fonctions OpenPort d’un moniteur de port et ClosePort, il peut y avoir plusieurs appels à ses fonctions StartDocPort et EndDocPort.

Vous pouvez supposer qu’une fois que le spouleur d’impression a appelé OpenPort avec un nom de port particulier, il n’appelle pas OpenPort à nouveau avec le même nom de port avant d’appeler ClosePort.

Les fonctions d’analyse d’impression qui acceptent un handle de port comme entrée n’acceptent pas non plus de handle de moniteur. Par conséquent, la fonction OpenPort doit stocker le handle de moniteur reçu dans un emplacement qui peut être référencé par le handle de port. Cela permet aux fonctions qui acceptent un handle de port de référencer le handle du moniteur.