Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

DynaPDF Manual - Page 314

Previous Page 313   Index   Next Page 315

Function Reference
Page 314 of 750
By default, the function writes the content streams of all pages and referenced templates, patterns,
and images to the output file. The content streams of these objects will be released but the objects
remain in memory. So, all handles remain valid and it is still possible to use already flushed objects
in subsequent pages. For example, a flushed image or template can still be inserted in other pages
with PlaceImage() or PlaceTemplate() because the content streams or image buffers are not required
for this action.
The flag fpfImagesOnly can be used to flush the images in memory only. This can be useful if further
objects must be added to the pages in memory or if a large image was inserted.
It is allowed to call the function within an open page. In this case the function does not flush the
content stream of the current open page but anything else depending on the used flags.
Calling a function like DeletePage(), DeleteField() or any other function that deletes a flushed object
results in a damaged PDF file.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
FreeImageBuffer
Syntax:
void pdfFreeImageBuffer(
const PPDF* IPDF) // Instance pointer
The function frees the buffer of a memory image that was created with the function CreateImage().
FreeImageObj
Syntax:
LBOOL pdfFreeImageObj(
const PPDF* IPDF, // Instance pointer
UI32 Handle)
// Image handle
The function releases memory that was allocated by GetImageObj() to decompress the image.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
FreeImageObjEx
Syntax:
LBOOL pdfFreeImageObjEx(
const PPDF* IPDF,
// Instance pointer
const void* ImagePtr) // Image pointer
The function releases memory that was allocated by GetImageObjEx() to decompress the image.
Return values:
 

Previous topic: FlushPages

Next topic: FreeTextAnnot