L_PdfCompSetCompression

Summary

Sets the compression type to be used with each image segment inserted in the PDF file.

Syntax

#include "l_bitmap.h"
#include "lpdfComp.h"

L_LCMRC_API L_INT L_PdfCompSetCompression (hDocument, pCompression);

Parameters

LCPDF_HANDLE hDocument

Handle to an existing PDF document. This handle is obtained by calling the L_PdfCompInit function.

LPPDFCOMPRESSION pCompression

Pointer to the PDFCOMPRESSION structure that contains the compression options to set.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function must be called before inserting a compressed image into the PDF file by calling the following functions:

L_PDFCompInsertMRC

L_PDFCompInsertNormal

L_PDFCompInsertSegments

If the user does not call this function before using these methods, then the insertion process will use the default compression types.

Required DLLs and Libraries

• LCMRC
• LCPPDF
• LCPENC
• LCZIB
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions

• L_PdfCompInsertMRC
• L_PDFCompInsertNormal
• L_PDFCompInsertSegments

Topics

• Creating a Compressed PDF File
• PDF Compressor Functions: Creating a File

Example

For an example, refer to L_PdfCompInsertMRC.