Função DeletePrinterKey

A função DeletePrinterKey exclui uma chave especificada e todas as subchaves para uma impressora especificada.

Sintaxe

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

Parâmetros

hPrinter [in]

Um identificador para a impressora para a qual a função exclui uma chave. Use a função OpenPrinter ou AddPrinter para recuperar um identificador de impressora.

pKeyName [in]

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica a chave a ser excluída. Use o caractere de barra invertida ( \ ) como delimitador para especificar um caminho com uma ou mais subchaves.

Se pKeyName for uma cadeia de caracteres vazia (""), DeletePrinterKey excluirá todas as chaves abaixo da chave de nível superior da impressora. Se pKeyName for NULL, DeletePrinterKey retornará ERROR_INVALID_PARAMETER.

Valor retornado

Se a função obtiver êxito, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado será um código de erro do sistema.

Comentários

Observação

Essa é uma função de bloqueio ou síncrona e pode não retornar imediatamente. A rapidez com que essa função retorna depende de fatores de tempo de execução, como status de rede, configuração do servidor de impressão e fatores de implementação do driver de impressora que são difíceis de prever ao gravar um aplicativo. Chamar essa função de um thread que gerencia a interação com a interface do usuário pode fazer com que o aplicativo pareça não responder.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Cabeçalho	Winspool.h (inclua Windows.h)
Biblioteca	Winspool.lib
DLL	Winspool.drv
Nomes Unicode e ANSI	DeletePrinterKeyW (Unicode) e DeletePrinterKeyA (ANSI)

Confira também

Impressão

Funções da API do Spooler de impressão

DeletePrinterDataEx

EnumPrinterDataEx

EnumPrinterKey

GetPrinterDataEx

OpenPrinter

SetPrinterDataEx