Função GetForm

A função GetForm recupera informações sobre um formulário especificado.

Sintaxe

BOOL GetForm(
  _In_  HANDLE  hPrinter,
  _In_  LPTSTR  pFormName,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pForm,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded
);

Parâmetros

hPrinter [in]

Um identificador para a impressora. Use a função OpenPrinter ou AddPrinter para recuperar um identificador de impressora.

pFormName [in]

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome do formulário. Para obter os nomes dos formulários compatíveis com a impressora, chame a função EnumForms .

Nível [in]

A versão da estrutura para a qual pForm aponta. Esse valor deve ser 1 ou 2.

pForm [out]

Um ponteiro para uma matriz de bytes que recebe a estrutura inicializada FORM_INFO_1 ou FORM_INFO_2 .

cbBuf [in]

O tamanho, em bytes, da matriz pForm .

pcbNeeded [out]

Um ponteiro para um valor que especifica o número de bytes copiados se a função for bem-sucedida ou o número de bytes necessários se cbBuf for muito pequeno.

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.

Se o chamador for remoto e o Nível for 2, o valor StringType do FORM_INFO_2 retornado sempre será STRING_LANGPAIR.

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	GetFormW (Unicode) e GetFormA (ANSI)

Confira também

Impressão

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

AddForm

DeleteForm

OpenPrinter

SetForm