Função EnumPrintProcessorDatatypesA (winspool.h)

Artigo
02/07/2025

A função EnumPrintProcessorDatatypes de um processador de impressão enumera os tipos de dados aos quais o processador de impressão dá suporte.

Sintaxe

BOOL EnumPrintProcessorDatatypesA(
  [in, optional]  LPSTR   pName,
  [in]            LPSTR   pPrintProcessorName,
                  DWORD   Level,
  [out, optional] LPBYTE  pDatatypes,
                  DWORD   cbBuf,
  [out]           LPDWORD pcbNeeded,
  [out]           LPDWORD pcReturned
);

Parâmetros

[in, optional] pName

Ponteiro fornecido pelo chamador para uma cadeia de caracteres que representa o nome do servidor no qual o processador de impressão está instalado. Se NULL, o servidor será o sistema local.

[in] pPrintProcessorName

Ponteiro fornecido pelo chamador para uma cadeia de caracteres que representa o nome do processador de impressão.

Level

Valor fornecido pelo chamador que indica o tipo das estruturas a serem retornadas no buffer apontado por pDatatypes. Esse valor deve ser 1, indicando que a estrutura está DATATYPES_INFO_1.

[out, optional] pDatatypes

Ponteiro fornecido pelo chamador para um buffer para receber uma matriz de estruturas de DATATYPES_INFO_1, seguido por um conjunto de cadeias de caracteres que representam nomes de tipo de dados. A estrutura DATATYPES_INFO_1 é descrita na documentação do SDK do Microsoft Windows. O membro da estrutura pName deve ser do tipo LPWSTR.

cbBuf

Valor fornecido pelo chamador que representa o tamanho, em bytes, do buffer apontado por pDatatypes.

[out] pcbNeeded

Ponteiro fornecido pelo chamador para um local para receber o tamanho mínimo necessário para o buffer apontado por pDatatypes.

[out] pcReturned

Ponteiro fornecido pelo chamador para um local para receber o número de estruturas de DATATYPES_INFO_1 retornadas no buffer apontado por pDatatypes.

Valor de retorno

Se a operação for bem-sucedida, a função deverá retornar VERDADEIRO. Se a operação falhar, a função deverá chamar SetLastError para definir um código de erro e retornar FALSE.

Observações

Os processadores de impressão são necessários para exportar uma função EnumPrintProcessorDatatypes. O provedor de impressão local chama a função durante a inicialização. A função também é chamada quando um aplicativo chama a versão do spooler da mesma função.

A função deve retornar uma matriz de estruturas de DATATYPES_INFO_1, com cada estrutura apontando para uma cadeia de caracteres que representa um tipo de dados. As cadeias de caracteres reais também devem ser incluídas no buffer, após a matriz da estrutura. Consulte de Processador de Impressão de Exemplo para obter um exemplo.

A função deve retornar o número de estruturas de DATATYPES_INFO_1 retornadas (ou seja, o número de tipos de dados com suporte) no local apontado por pcReturned.

A função deve retornar o tamanho mínimo do buffer necessário no local apontado por pcbNeeded. Se o buffer fornecido for muito pequeno, a função deverá especificar um valor para pcbNeeded, definir o código de erro como ERROR_INSUFFICIENT_BUFFER e retornar false.

Requisitos

Requisito	Valor
da Plataforma de Destino	Área de trabalho
cabeçalho	winspool.h (inclua Winspool.h)

Partilhar via