Share via


Função SetForm

A função SetForm define as informações do formulário para a impressora especificada.

Sintaxe

BOOL SetForm(
  _In_ HANDLE hPrinter,
  _In_ LPTSTR pFormName,
  _In_ DWORD  Level,
  _In_ LPTSTR pForm
);

Parâmetros

hPrinter [in]

Um identificador para a impressora para a qual as informações do formulário são definidas. 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 o qual as informações do formulário são definidas.

Nível [in]

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

pForm [in]

Um ponteiro para uma estrutura de FORM_INFO_1 ou FORM_INFO_2 .

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 do 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.

SetForm pode ser chamado várias vezes para um FORM_INFO_2 existente, cada chamada adicionando pares adicionais de valores pDisplayName e wLangId . Todas as versões de idiomas do formulário obterão os valores Tamanho e ImageableArea do FORM_INFO_2 na chamada mais recente para SetForm.

Se o chamador for remoto e o Nível for 2, o valor StringType do FORM_INFO_2 não poderá ser STRING_MUIDLL.

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
SetFormW (Unicode) e SetFormA (ANSI)

Confira também

Impressão

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

GetForm

OpenPrinter

FORM_INFO_1

FORM_INFO_2