L_SetPDFOptions

#include "l_bitmap.h"

L_INT EXT_FUNCTION L_SetPDFOptions(pOptions)

pFILEPDFOPTIONS pOptions;

/* pointer to a structure */

Sets the file options used by LEADTOOLS when loading PDF, PS or EPS files.

Parameter

Description

pOptions

Pointer to a structure that contains the options to use when loading PDF, PS or EPS files.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The nSize member of the FILEPDFOPTIONS structure must be set before calling this function. If a PDF, PS or EPS file is loaded without first calling this function, the following default values will be used:

FILEPDFOPTIONS Member:

Default value:

bUseLibFonts

TRUE

nXResolution

96

nYResolution

96

nDisplayDepth

24

nTextAlpha

4

nGraphicsAlpha

1

szPassword

""

uFlags

0

The values set by this function are valid for the current thread. To change the values used by the current thread, this function must be called again.

Both font and graphics anti-aliasing slow down the drawing of the resulting bitmap.

Font and graphics anti-aliasing can only be used if nDisplayDepth is 8 or greater.

The value of szPassword member of the FILEPDFOPTIONS structure is used when loading an encrypted file in order to get it decrypted.

If the loaded PDF, PS or EPS file is not encrypted, then the value of the szPassword member of the FILEPDFOPTIONS structure will be ignored.

If the user has passed an empty or wrong password to be used with encrypted PDF, PS or EPS file, the file will not be opened, and an error will occur. For more information, refer to Error Codes.

The value of uFlags member of the FILEPDFOPTIONS structure is used to control loading PDF files with more options, the flags support disabling cropping PDF files and/or disable using CIE-color.

Required DLLs and Libraries

LTFIL
File format DLLs

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

Platforms

Windows 95 / 98 / Me, Windows 2000 / XP.

See Also

Functions:

L_GetPDFOptions

Topics:

Raster Image Functions: Loading Files

 

Implementing PDF Plug in Features

For a list of functions that utilize the LOADFILEOPTION or SAVEFILEOPTION structures, refer to Functions Utilizing the LOADFILEOPTION or SAVEFILEOPTION structures.

Example

/* This example loads a PDF file, with a display depth 
   defined by the user and without using font anti-aliasing */
void LoadPDFFile

   L_TCHAR         *pszPDFFileName, 
   pBITMAPHANDLE  pBitmap,
   L_INT          nDisplayDepth
)
{
   FILEPDFOPTIONS PdfOptions;   

   /* Get the current PDF options */   
   L_GetPDFOptions(&PdfOptions,sizeof(FILEPDFOPTIONS));

   /*Change display depth */
   switch(nDisplayDepth)
   {
      /*We only accept 1,4,8 or 24*/
      case 1   :
      case 4   :
      case 8   :
      case 24  :
         PdfOptions.nDisplayDepth = nDisplayDepth;
         break;
      default :         
         MessageBox (NULL, TEXT("Invalid Display Depth"), TEXT("Notice"), MB_OK);
         /* current value is used instead of value passed by the user */
   }
   /* No font anti-aliasing*/
   PdfOptions.nTextAlpha = 1;

   /* Set new PDF options */
   L_SetPDFOptions(&PdfOptions);

   /* Now load the PDF file */
   L_LoadBitmap(  pszPDFFileName, 
                  pBitmap,
                  sizeof(BITMAPHANDLE),
                  0,
                  ORDER_RGB,
                  NULL, 
                  NULL );
}