Función DeletePortUI (winsplp.h)

Artículo
03/05/2024

Una función DeletePortUI de la DLL del monitor de puerto de la interfaz de usuario elimina un puerto de impresora.

Sintaxis

BOOL DeletePortUI(
  [in, optional] PCWSTR pszServer,
  [in]           HWND   hWnd,
  [in]           PCWSTR pszPortName
);

Parámetros

[in, optional] pszServer

Puntero proporcionado por el autor de la llamada a una cadena que representa un nombre de servidor o NULL si la impresora es local. (El monitor de puerto puede omitir este parámetro).

[in] hWnd

Identificador proporcionado por el autor de la llamada de la ventana que se debe usar como elemento primario para los cuadros de diálogo. Si es NULL, no se deben mostrar cuadros de diálogo.

[in] pszPortName

Puntero proporcionado por el autor de la llamada a una cadena que representa el nombre del puerto que se va a eliminar.

Valor devuelto

Si la operación se realiza correctamente, la función debe devolver TRUE. De lo contrario, debe devolver FALSE. Si el usuario cancela la operación o no es compatible, la función debe llamar a SetLastError(ERROR_CANCELLED), devuelve FALSE.

Comentarios

Los archivos DLL de interfaz de usuario del monitor de puertos son necesarios para definir una función DeletePortUI e incluir la dirección de la función en una estructura MONITORUI .

El administrador de colas llama a DeletePortUI desde su función DeletePort . Los argumentos recibidos por DeletePortUI son los argumentos recibidos por DeletePort. (La función DeletePort se describe en la documentación de Microsoft Windows SDK).

La función debe realizar las siguientes operaciones:

Llame a OpenPrinter y especifique un nombre de impresora con el formato siguiente:

\\ServerName\,XcvPortPortName

donde ServerName y PortName son los nombres de servidor y puerto recibidos como argumentos de función DeletePortUI .

La llamada a OpenPrinter requiere una estructura PRINTER_DEFAULTS, que se describe en la documentación de Windows SDK. El miembro DesiredAccess de la estructura debe establecerse en SERVER_ACCESS_ADMINISTER. Sus miembros pDatatype y pDevMode pueden ser NULL.

Esta llamada hace que se llame a la función XcvOpenPort del archivo DLL del servidor de supervisión de impresión.
Llame a XcvData y especifique los argumentos de entrada siguientes:
- Identificador recibido de OpenPrinter
- El nombre del puerto recibido como argumento de función
- Cadena de nombre de datos de "DeletePort"
Esta llamada hace que se llame a la función XcvClosePort del archivo DLL del servidor.
Si se requiere interacción del usuario, obtenga información del usuario mostrando un cuadro de diálogo y, a continuación, llame a XcvData, especificando cadenas de nombre de datos personalizadas, para enviar la información al archivo DLL del servidor. La llamada XcvData hace que se llame a la función XcvDataPort del servidor.
Llame a ClosePrinter y especifique el identificador recibido de OpenPrinter. Esto hace que se llame a la función XcvClosePort del archivo DLL del servidor.