Função AddPort

A função AddPort adiciona o nome de uma porta à lista de portas com suporte. A função AddPort é exportada pelo monitor de porta.

Sintaxe

BOOL AddPort(
  _In_ LPTSTR pName,
  _In_ HWND   hWnd,
  _In_ LPTSTR pMonitorName
);

Parâmetros

pName [in]

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

hWnd [in]

Um identificador para a janela pai da caixa de diálogo AddPort .

pMonitorName [in]

Um ponteiro para uma cadeia de caracteres terminada em zero que especifica o monitor associado à porta.

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 de driver de impressora que são difíceis de prever ao escrever 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.

A função AddPort navega pela rede para localizar portas existentes e exibe uma caixa de diálogo para o usuário. A função AddPort deve validar o nome da porta inserido pelo usuário chamando EnumPorts para garantir que nenhum nome duplicado exista.

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

Para adicionar uma porta sem exibir uma caixa de diálogo, chame a função XcvData em vez de AddPort. Para obter mais informações sobre XcvData, consulte o DDK (Microsoft Windows Driver Development Kit).

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	Spoolss.dll
Nomes Unicode e ANSI	AddPortW (Unicode) e AddPortA (ANSI)

Confira também

Impressão

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

DeletePort

EnumPorts

SetPort