Função GetPrintProcessorCapabilities (winsplp.h)

A função GetPrintProcessorCapabilities de um processador de impressão retorna recursos associados a um tipo de dados de entrada especificado.

Sintaxe

DWORD GetPrintProcessorCapabilities(
  [in]  LPTSTR  pValueName,
  [in]  DWORD   dwAttributes,
  [out] LPBYTE  pData,
  [in]  DWORD   nSize,
  [out] LPDWORD pcbNeeded
);

Parâmetros

[in] pValueName

Ponteiro fornecido pelo chamador para uma cadeia de caracteres que representa um tipo de dados compatível com o processador de impressão. O ponteiro de cadeia de caracteres deve ser do tipo LPWSTR.

[in] dwAttributes

Sinalizadores de atributos fornecidos pelo chamador. Consulte o membro Atributos de estruturas PRINTER_INFO_x .

[out] pData

Ponteiro fornecido pelo chamador para uma estrutura de PRINTPROCESSOR_CAPS_1 ou PRINTPROCESSOR_CAPS_2 .

[in] nSize

Valor fornecido pelo chamador que representa o tamanho do buffer apontado por pData.

Se o valor for menor que sizeof(PRINTPROCESSOR_CAPS_1), essa função deverá fornecer um valor igual a sizeof(PRINTPROCESSOR_CAPS_1) ou sizeof(PRINTPROCESSOR_CAPS_2), dependendo de qual estrutura é compatível com o processador de impressão.

Se o valor for menor que sizeof(PRINTPROCESSOR_CAPS_1), o processador de impressão winprint fornecerá um valor de sizeof(PRINTPROCESSOR_CAPS_2).

[out] pcbNeeded

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

Retornar valor

Se a operação for bem-sucedida, a função deverá retornar ERROR_SUCCESS. Caso contrário, ele deverá retornar um código de erro Win32.

Comentários

Opcionalmente, os processadores de impressão podem exportar uma função GetPrintProcessorCapabilities . A finalidade da função é retornar uma estrutura de PRINTPROCESSOR_CAPS_1 ou PRINTPROCESSOR_CAPS_2 preenchida para cada tipo de dados de entrada compatível com o processador de impressão.

O spooler chama a função GetPrintProcessorCapabilities de um processador de impressão quando um aplicativo chama GetPrinterData, especificando um nome de valor com um formato de PrintProcCaps_datatype, em que datatype é o nome de um tipo de dados de entrada. Antes de chamar GetPrintProcessorCapabilities, o spooler remove o prefixo PrintProcCaps_ da cadeia de caracteres de nome de valor.

A função deve determinar se o buffer recebido é grande o suficiente e, se for, deve preencher a estrutura PRINTPROCESSOR_CAPS_1 ou PRINTPROCESSOR_CAPS_2 e retornar. O valor de nSize determina se PRINTPROCESSOR_CAPS_1 ou PRINTPROCESSOR_CAPS_2 serão usados.

A função sempre deve usar o local apontado por pcbNeeded para retornar o tamanho do buffer necessário, se o buffer real é grande o suficiente ou não.

O valor retornado especificado torna-se o valor retornado que o spooler fornece para GetPrinterData.

Requisitos

Requisito	Valor
Plataforma de Destino	Área de Trabalho
Cabeçalho	winsplp.h (inclua Winsplp.h)