Função StartDocA (wingdi.h)

Artigo
11/20/2024

A função StartDoc inicia um trabalho de impressão.

Sintaxe

int StartDocA(
  [in] HDC            hdc,
  [in] const DOCINFOA *lpdi
);

Parâmetros

[in] hdc

Um identificador para o contexto do dispositivo para o trabalho de impressão.

[in] lpdi

Um ponteiro para uma estrutura DOCINFO que contém o nome do arquivo de documento e o nome do arquivo de saída.

Valor de retorno

Se a função for bem-sucedida, o valor retornado será maior que zero. Esse valor é o identificador do trabalho de impressão do documento.

Se a função falhar, o valor retornado será menor ou igual a zero.

Observações

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 em tempo de execução, como status de rede, configuração do servidor de impressão e implementação do driver de impressora, fatores 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.

Os aplicativos devem chamar a função StartDoc imediatamente antes de iniciar um trabalho de impressão. Usar essa função garante que documentos de várias páginas não sejam intercalados com outros trabalhos de impressão.

Os aplicativos podem usar o valor retornado StartDoc para recuperar ou definir a prioridade de um trabalho de impressão. Chame a função GetJob ou SetJob e forneça esse valor como um dos argumentos necessários.

Exemplos

Para obter um programa de exemplo que usa essa função, consulte How To: Print Using the GDI Print API.

Nota

O cabeçalho wingdi.h define StartDoc como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	wingdi.h (inclua Windows.h)
biblioteca	Gdi32.lib
de DLL	Gdi32.dll

Consulte também

DOCINFO

EndDoc

GetJob

Funções de API do Spooler de Impressão

de Impressão

setJob

Compartilhar via