DARenderPageToFile

Direct access functionality, Rendering and printing

Description

Renders the specified page from the specified document to an image and saves the image data as a file on disk.

By default rendering uses the GDI+ system which is available in Windows XP and later.

Option 10, TIFF (G4) output, is only available on Windows Vista and Windows Server 2008 and later.

It is also possible to render using Cairo, use the SetCairoFileName and SelectRenderer

functions.

Syntax

Delphi

function TPDFlib.DARenderPageToFile(FileHandle, PageRef, Options: Integer; DPI: Double; Const FileName: WideString): Integer;

ActiveX

Function PDFlib::DARenderPageToFile(FileHandle As Long, PageRef As Long, Options As Long, DPI As Double, FileName As String) As Long

DLL

int DLDARenderPageToFile(int InstanceID, int FileHandle, int PageRef, int Options, double DPI, wchar_t * FileName);

Parameters

FileHandleA handle returned by the DAOpenFile, DAOpenFileReadOnly or DAOpenFromStream functions
PageRefA page reference returned by the DAFindPage or DANewPage functions
Options0 = BMP output 1 = JPEG output 2 = WMF output 3 = EMF output 4 = EPS output 5 = PNG output 6 = GIF output 7 = TIFF output 8 = EMF+ output 9 = HTML5 output 10 = G4 TIFF output
DPIThe DPI to use when rendering the page. Values over 300 will cause excessive memory usage.
FileNameThe path and file name of the file to create to store the rendered page image data in.

Return values

0The page could not be rendered. Check the value of the FileHandle and PageRef parameters.
1The page was rendered correctly and the image file was saved to disk The file could not be written to disk 2