Função ReportJobProcessingProgress

Relata ao serviço Spooler de Impressão se um trabalho de impressão XPS está na fase de spool ou renderização e qual parte do processamento está em andamento no momento.

Sintaxe

HRESULT ReportJobProcessingProgress(
  _In_ HANDLE                printerHandle,
  _In_ ULONG                 jobId,
       EPrintXPSJobOperation jobOperation,
       EPrintXPSJobProgress  jobProgress
);

Parâmetros

printerHandle [in]

Um identificador de impressora para o qual a função deve recuperar informações. Use a função OpenPrinter ou AddPrinter para recuperar um identificador de impressora.

jobId [in]

Identifica o trabalho de impressão para o qual recuperar dados. Use a função AddJob ou a função StartDoc para obter um identificador de trabalho de impressão.

jobOperation

Especifica se o trabalho está na fase de spool ou na fase de renderização.

jobProgress

Especifica qual parte do processamento está em andamento no momento. Esse valor refere-se a eventos na fase de spool ou renderização, dependendo do valor de jobOperation.

Valor retornado

Se a operação for bem-sucedida, o valor retornado será S_OK, caso contrário, o HRESULT conterá um código de erro.

Para obter mais informações sobre códigos de erro COM, consulte Tratamento de erros.

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.

Observação

ReportJobProcessingProgress só relatará o progresso do trabalho de impressão XPS se o trabalho de impressão estiver na fase de spool ou renderização. ReportJobProcessingProgress falhará se for chamado quando o trabalho de impressão XPS não estiver na fase de spool ou renderização.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Cabeçalho	Winspool.h (inclua Windows.h)
Biblioteca	Winspool.lib
DLL	Spoolss.dll

Confira também

Impressão

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

EPrintXPSJobOperation

EPrintXPSJobProgress