In This Topic ▼

LFileSettings::SetXLSOptions

✎ NOTE

This function is deprecated, use LFileSettings::SetExcelOptions instead.

Summary

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

Syntax

#include "ltwrappr.h"

static L_INT LFileSettings::SetXLSOptions(pOptions)

Parameters

const pFILEXLSOPTIONS pOptions

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

Returns

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

Comments

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 an XLS file, call LFileSettings::GetXLSOptions.

Required DLLs and Libraries

LTFIL
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 XLS file.

L_INT LFileSettings__SetXLSOptionsExample(L_TCHAR* pszXLSFileName, LBitmap* pBitmap) 
{ 
   L_INT nRet; 
   FILEXLSOPTIONS XLSOptions; 
 
   /* Get the current XLS options */    
   nRet = LFileSettings::GetXLSOptions(&XLSOptions,sizeof(FILEXLSOPTIONS));  
   if(nRet != SUCCESS) 
      return nRet; 
 
   XLSOptions.uFlags = XLS_FLAGS_MULTIPAGE_SHEET; 
 
   /* Set new XLS options */ 
   nRet = LFileSettings::SetXLSOptions(&XLSOptions);  
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Now load the XLS file */ 
   nRet = pBitmap->Load(pszXLSFileName,  
                  0,  
                  ORDER_RGB,  
                  NULL,  
                  NULL );  
   if(nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
}