StartRenderPageJob

Dokumentinspektion, gengivelse

Beskrivelse

Starter et baggrundsjob, der gengiver en side i en PDF-fil uden at blokere kalderens tråd

Da TPDFlib ikke er trådsikker, opretter jobbet en isoleret instans fra den samme kildefil og kører på en systemopgave, så en stor side ikke længere kan optage værtstråden, indtil den er færdig

Jobbet fører et annulleringsflag og en manuelt nulstillet pausespærring ind i gengiveren, som kontrollerer dem mellem operatorer i indholdsstreamen; dette gør det muligt for PauseRenderJob, ResumeRenderJob og CancelRenderJob at afbryde en enkelt aktiv side

Syntaks

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

Parametre

FileName	Stien til PDF-kildefilen
Password	Dokumentets adgangskode eller en tom streng, når PDF'en ikke er krypteret
OutputFileName	Stien til destinationsbilledet; formatet følger `Options` som i `RenderPageToFile`
DPI	Gengivelsesopløsningen
Page	Det 1-baserede sidenummer, der skal gengives
Options	Billedformatindstillingen videregives direkte til `RenderPageToFile`

Returværdier

>0	Et 1-baseret jobhåndtag til brug med metoderne til styring af gengivelsesjob
0	Jobbet kunne ikke startes

Bemærkninger

Forespørg om status med GetRenderJobState, og blokér med WaitForRenderJob; begge returnerer RENDER_JOB_STATE_*-koderne

Brug PauseRenderJob, ResumeRenderJob og CancelRenderJob til at afbryde en kørende side uden at miste arbejdstråden

Den instans, der startede jobbet, ejer det; når instansen frigives, sammenføjes udestående job, så en halvfærdig side aldrig overlever sin ejer