Función DeletePort

La función DeletePort muestra un cuadro de diálogo que permite al usuario eliminar un nombre de puerto.

Sintaxis

BOOL DeletePort(
  _In_ LPTSTR pName,
  _In_ HWND   hWnd,
  _In_ LPTSTR pPortName
);

Parámetros

pName [in]

Puntero a una cadena terminada en cero que especifica el nombre del servidor para el que se debe eliminar el puerto. Si este parámetro es NULL, se elimina un puerto local.

hWnd [in]

Identificador de la ventana primaria del cuadro de diálogo de eliminación de puertos.

pPortName [in]

Puntero a una cadena terminada en cero que especifica el nombre del puerto que se debe eliminar.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero.

Comentarios

Nota

Se trata de una función de bloqueo o sincrónica y podría no devolverse inmediatamente. La rapidez con la que devuelve esta función depende de factores en tiempo de ejecución, como el estado de red, la configuración del servidor de impresión y los factores de implementación de controladores de impresora que son difíciles de predecir al escribir una aplicación. Llamar a esta función desde un subproceso que administra la interacción con la interfaz de usuario podría hacer que la aplicación parezca que no responde.

Una aplicación puede recuperar los nombres de los puertos válidos mediante una llamada a la función EnumPorts .

La función DeletePort devuelve un error si una impresora está conectada actualmente al puerto especificado.

El autor de la llamada de la función DeletePort debe tener SERVER_ACCESS_ADMINISTER acceso al servidor al que está conectado el puerto.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado	Winspool.h (incluye Windows.h)
Biblioteca	Winspool.lib
Archivo DLL	Winspool.drv
Nombres Unicode y ANSI	DeletePortW (Unicode) y DeletePortA (ANSI)

Consulte también

Impresión

Funciones de la API del administrador de trabajos de impresión

AddPort

EnumPorts