In This Topic ▼

LFileSettings::SetPTKOptions

#include "ltwrappr.h"

static L_INT LFileSettings::SetPTKOptions(pOptions)

Sets the file options used by LEADTOOLS when loading PTOCA and AFP:PTOCA files.

Parameters

const pFILEPTKOPTIONS pOptions

Pointer to a FILEPTKOPTIONS structure that contains the options to use when loading PTOCA and AFP:PTOCA files.

Returns

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

Comments

The uStructSize member of the FILEPTKOPTIONS structure must be set before calling this function. If a PTOCA and AFP:PTOCA file is loaded without first calling this function, the following default values will be used:

FILEPTKOPTIONS Member	Default value
nPTKResolution	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.

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

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.

Example

This example loads a PTK file, with a resolution defined by the user.

L_INT LFileSettings__SetPTKOptionsExample(L_TCHAR* pszPTKFileName, LBitmap  * pBitmap, L_INT nDisplayDepth) 
{ 
   UNREFERENCED_PARAMETER(nDisplayDepth); 
 
   L_INT nRet; 
   FILEPTKOPTIONS PtkOptions; 
 
   /* Get the current PTK option */ 
   nRet = LFileSettings::GetPTKOptions(&PtkOptions,sizeof(FILEPTKOPTIONS));  
   if(nRet != SUCCESS) 
      return nRet; 
 
   /*Change Resolution */ 
   PtkOptions. nPTKResolution = 120;  
 
   /* Set new PTK option */ 
   nRet = LFileSettings::SetPTKOptions(&PtkOptions);  
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Now load the PTK file */ 
   nRet = pBitmap->Load(pszPTKFileName,  
       0,  
       ORDER_RGB,  
       NULL,  
       NULL );  
   if(nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
}