Compartilhar via


Função EngGetForm (winddi.h)

A função EngGetForm obtém os detalhes FORM_INFO_1 do formulário especificado.

Sintaxe

ENGAPI BOOL EngGetForm(
  [in]           HANDLE  hPrinter,
  [in]           LPWSTR  pFormName,
  [in]           DWORD   Level,
  [in, optional] LPBYTE  pForm,
  [in]           DWORD   cbBuf,
  [out]          LPDWORD pcbNeeded
);

Parâmetros

[in] hPrinter

Manipule para a impressora para a qual o formulário está sendo especificado.

[in] pFormName

Ponteiro para uma cadeia de caracteres que especifica o nome do formulário.

[in] Level

Especifica a versão da estrutura de formulário à qual pForm aponta. Esse valor deve ser 1, o que indica que as informações do formulário serão retornadas em uma estrutura FORM_INFO_1.

[in, optional] pForm

Ponteiro para uma matriz de bytes que recebe a estrutura de FORM_INFO_1 inicializada.

[in] cbBuf

Especifica o tamanho, em bytes, de pForm.

[out] pcbNeeded

Ponteiro para um valor que especifica o número de bytes copiados para o buffer apontado por pForm se a função for bem-sucedida. O valor é o número de bytes necessários para executar a cópia se cbBuf for muito pequeno.

Retornar valor

EngGetForm retornará TRUE se a estrutura do formulário for copiada com êxito para pForm. Caso contrário, ele registra uma mensagem de erro e retorna FALSE. Para obter as informações de erro, chame EngGetLastError.

Comentários

EngGetForm retorna uma estrutura de FORM_INFO_1 (descrita na documentação do SDK do Microsoft Windows) que contém os dados do formulário associados ao pFormName. Os dados gravados e seu tamanho são retornados ao chamador por meio de pForm e pcbNeeded, respectivamente. Se a matriz apontada por pForm não for grande o suficiente para manter os dados do formulário, o tamanho da matriz necessária será retornado em pcbNeeded.

Para obter uma lista de todos os formulários com suporte, o driver de impressora deve chamar EngEnumForms.

Requisitos

Requisito Valor
Cliente mínimo com suporte Disponível no Windows 2000 e versões posteriores dos sistemas operacionais Windows.
Plataforma de Destino Universal
Cabeçalho winddi.h (inclua Winddi.h)
Biblioteca Win32k.lib
DLL Win32k.sys

Confira também

EngEnumForms

EngGetLastError