Compartilhar via


Função EnumPrintProcessors

A função EnumPrintProcessors enumera os processadores de impressão instalados no servidor especificado.

Sintaxe

BOOL EnumPrintProcessors(
  _In_  LPTSTR  pName,
  _In_  LPTSTR  pEnvironment,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pPrintProcessorInfo,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded,
  _Out_ LPDWORD pcReturned
);

Parâmetros

pName [in]

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome do servidor no qual residem os processadores de impressão. Se esse parâmetro for NULL, os processadores de impressão locais serão enumerados.

pEnvironment [in]

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o ambiente (por exemplo, Windows x86, Windows IA64 ou Windows x64). Se esse parâmetro for NULL, o ambiente atual do aplicativo de chamada e do computador cliente (não do aplicativo de destino e do servidor de impressão) será usado.

Nível [in]

O tipo de informações retornadas no buffer pPrintProcessorInfo . Esse parâmetro deve ser 1.

pPrintProcessorInfo [out]

Um ponteiro para um buffer que recebe uma matriz de estruturas PRINTPROCESSOR_INFO_1 . Cada estrutura descreve um processador de impressão disponível. O buffer deve ser grande o suficiente para receber a matriz de estruturas e quaisquer cadeias de caracteres para as quais os membros da estrutura apontam.

Para determinar o tamanho do buffer necessário, chame EnumPrintProcessors com cbBuf definido como zero. EnumPrintProcessors falha, GetLastError retorna ERROR_INSUFFICIENT_BUFFER e o parâmetro pcbNeeded retorna o tamanho, em bytes, do buffer necessário para manter a matriz de estruturas e seus dados.

cbBuf [in]

O tamanho, em bytes, do buffer apontado por pPrintProcessorInfo.

pcbNeeded [out]

Um ponteiro para uma variável que recebe o número de bytes copiados para o buffer pPrintProcessorInfo se a função for bem-sucedida. Se o buffer for muito pequeno, a função falhará e a variável receberá o número de bytes necessários.

pcReturned [out]

Um ponteiro para uma variável que recebe o número de estruturas retornadas no buffer pPrintProcessorInfo .

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.

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
EnumPrintProcessorsW (Unicode) e EnumPrintProcessorsA (ANSI)

Confira também

Impressão

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

AddPrintProcessor

EnumPrintProcessorDatatypes

PRINTPROCESSOR_INFO_1