In This Topic ▼

L_SetVFFOptions

Summary

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

Syntax

#include "l_bitmap.h"

L_LTFIL_API L_INT EXT_FUNCTION L_SetVFFOptions(pOptions)

Parameters

pFILEVFFOPTIONS pOptions

Pointer to a structure that contains the options used when loading VFF 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 VFF file, call the L_GetVFFOptions function.

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

L_INT SetVFFOptionsExample(L_TCHAR * pszVffFileName, 
                            pBITMAPHANDLE pBitmap)  
{ 
   L_INT nRet;  
   FILEVFFOPTIONS vffOptions;  
   /* Get the current VFF option */ 
   nRet = L_GetVFFOptions(&vffOptions,sizeof(FILEVFFOPTIONS));  
   if(nRet != SUCCESS)  
      return nRet;  
   /* Change view */ 
   vffOptions.uFlags = 0; 
   vffOptions.View = VFF_VIEW_UPTODOWN; 
   /* Set new VFF options */ 
   nRet = L_SetVFFOptions(&vffOptions);  
   if(nRet != SUCCESS)  
      return nRet;  
   /* Now load the VFF file */ 
   nRet = L_LoadBitmap(pszVffFileName, pBitmap, sizeof(BITMAPHANDLE), 0, ORDER_RGB, NULL, NULL);  
   if(nRet != SUCCESS)  
      return nRet;  
   return SUCCESS;  
}