StartRenderPageJob

Inspeção de documentos, composição

Descrição

Inicia uma tarefa em segundo plano que compõe uma página de um ficheiro PDF sem bloquear o processo do chamador

Como TPDFlib não é seguro para threads, o trabalho cria uma instância isolada a partir do mesmo ficheiro de origem e é executado numa tarefa do sistema, pelo que uma página grande deixa de ocupar o thread anfitrião até terminar

A tarefa transmite um sinalizador de cancelamento e uma barreira de pausa com reposição manual ao processador, que os consulta entre operadores de fluxos de conteúdo; é isto que permite a PauseRenderJob, ResumeRenderJob e CancelRenderJob interromper uma página em curso

Sintaxe

Delphi

Function TPDFlib.StartRenderPageJob(Const FileName, Password, OutputFileName: WideString; DPI: Double; Page, Options: Integer): Integer;

DLL

int DLStartRenderPageJob(int InstanceID, const wchar_t* FileName, const wchar_t* Password, const wchar_t* OutputFileName, double DPI, int Page, int Options);

ActiveX

Function PDFlib::StartRenderPageJob(FileName As String, Password As String, OutputFileName As String, DPI As Double, Page As Long, Options As Long) As Long

Parâmetros

FileName	O caminho do ficheiro PDF de origem
Password	A palavra-passe do documento, ou uma cadeia vazia quando o PDF não está encriptado
OutputFileName	O caminho da imagem de destino; o formato segue `Options`, tal como em `RenderPageToFile`
DPI	A resolução de composição
Page	O número de página de base 1 a compor
Options	A opção de formato de imagem passada diretamente a `RenderPageToFile`

Valores devolvidos

>0	Um identificador de tarefa de base 1 a utilizar com os métodos de controlo de tarefas de composição
0	Não foi possível iniciar o trabalho

Observações

Consulte o progresso com GetRenderJobState e bloqueie com WaitForRenderJob; ambos devolvem os códigos RENDER_JOB_STATE_*

Utilize PauseRenderJob, ResumeRenderJob e CancelRenderJob para interromper uma página em execução sem perder o processo de trabalho

A instância que iniciou a tarefa é a sua proprietária; libertar a instância aguarda pelas tarefas pendentes, pelo que uma página parcialmente concluída nunca sobrevive à sua proprietária