Función DeletePrinterKey

La función DeletePrinterKey elimina una clave especificada y todas sus subclaves para una impresora especificada.

Sintaxis

DWORD DeletePrinterKey(
  _In_ HANDLE  hPrinter,
  _In_ LPCTSTR pKeyName
);

Parámetros

hPrinter [in]

Identificador de la impresora para la que la función elimina una clave. Use la función OpenPrinter o AddPrinter para recuperar un identificador de impresora.

pKeyName [in]

Puntero a una cadena terminada en null que especifica la clave que se va a eliminar. Use el carácter de barra diagonal inversa ( \ ) como delimitador para especificar una ruta de acceso con una o varias subclaves.

Si pKeyName es una cadena vacía (""), DeletePrinterKey elimina todas las claves debajo de la clave de nivel superior de la impresora. Si pKeyName es NULL, DeletePrinterKey devuelve ERROR_INVALID_PARAMETER.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto es un código de error del sistema.

Comentarios

Nota:

Se trata de una función de bloqueo o sincrónica que 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 del controlador 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.

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	DeletePrinterKeyW (Unicode) y DeletePrinterKeyA (ANSI)

Consulte también

Impresión

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

DeletePrinterDataEx

EnumPrinterDataEx

EnumPrinterKey

GetPrinterDataEx

OpenPrinter

SetPrinterDataEx