LFileSettings::SetXPSOptions

#include "ltwrappr.h"

static L_INT LFileSettings::SetXPSOptions(pOptions)

const pFILEXPSOPTIONS pOptions;

/* pointer to a structure */

Sets the file options used by LEADTOOLS when loading XPS files.

Parameter

Description

pOptions

Pointer to a structure that contains the options to use when loading XPS files.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The uStructSize member of the FILEXPSOPTIONS structure must be set before calling this function. If XPS file is loaded without first calling this function, the following default values will be used:

FILEXPSOPTIONS Member:

Default value:

nXResolution

96

nYResolution

96

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.

To get the current options used when loading a XPS file, call LFileSettings::GetXPSOptions.

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

Win32, x64.

See Also

Functions:

LFileSettings::GetXPSOptions

Topics:

Raster Image Functions: Loading Files

 

Loading and Saving Images

Example

This example loads a XPS file, with a display depth defined by the user and without using font anti-aliasing. 

L_INT LFileSettings__SetXPSOptionsExample(L_TCHAR* pszXPSFileName, LBitmap* pBitmap)
{
   L_INT nRet;
   FILEXPSOPTIONS XPSOptions;
   /* Get the current XPS options */   
   nRet = LFileSettings::GetXPSOptions(&XPSOptions,sizeof(FILEXPSOPTIONS)); 
   if(nRet != SUCCESS)
      return nRet;
   XPSOptions.nXResolution = 120; 
   XPSOptions.nYResolution = 120; 
   /* Set new XPS options */
   nRet = LFileSettings::SetXPSOptions(&XPSOptions); 
   if(nRet != SUCCESS)
      return nRet;
   /* Now load the XPS file */
   nRet = pBitmap->Load(pszXPSFileName, 
                  0, 
                  ORDER_RGB, 
                  NULL, 
                  NULL ); 
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}