Função DeletePort

A função DeletePort exibe uma caixa de diálogo que permite que o usuário exclua um nome de porta.

Sintaxe

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

Parâmetros

pName [in]

Um ponteiro para uma cadeia de caracteres terminada em zero que especifica o nome do servidor para o qual a porta deve ser excluída. Se esse parâmetro for NULL, uma porta local será excluída.

hWnd [in]

Um identificador para a janela pai da caixa de diálogo de exclusão de porta.

pPortName [in]

Um ponteiro para uma cadeia de caracteres terminada em zero que especifica o nome da porta que deve ser excluída.

Valor retornado

Se a função for bem-sucedida, o valor retornado será um valor diferente de zero.

Se a função falhar, o valor retornado será zero.

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.

Um aplicativo pode recuperar os nomes de portas válidas chamando a função EnumPorts .

A função DeletePort retornará um erro se uma impressora estiver conectada à porta especificada no momento.

O chamador da função DeletePort deve ter SERVER_ACCESS_ADMINISTER acesso ao servidor ao qual a porta está conectada.

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	DeletePortW (Unicode) e DeletePortA (ANSI)

Confira também

Impressão

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

AddPort

EnumPorts