In This Topic ▼

LFile::LoadFile

Summary

Loads an image file into the class object's associated bitmap. The file can be in any supported image file format and bits per pixel, whether compressed or uncompressed.

Syntax

#include "ltwrappr.h"

virtual L_INT LFile::LoadFile(nBitsPerPixel, nOrder, uFlags, nPage, pFileInfo=NULL)

virtual L_INT LFile::LoadFile(nBitsPerPixel=0, nOrder=ORDER_BGRORGRAY, uFlags=LOADFILE_ALLOCATE|LOADFILE_STORE, pLoadFileOption=NULL, pFileInfo=NULL)

Parameters

L_INT nBitsPerPixel

Resulting bitmap pixel depth. Possible values are:

Value	Meaning
0	Keep the original file's pixel depth (Do not convert). A special note about loading 12 and 16-bit grayscale images.
1 to 8	The specified bits per pixel in the resultant bitmap
12	12 bits per pixel in the resultant bitmap.
16	16 bits per pixel in the resultant bitmap
24	24 bits per pixel in the resultant bitmap
32	32 bits per pixel in the resultant bitmap
48	48 bits per pixel in the resultant bitmap
64	64 bits per pixel in the resultant bitmap

L_INT nOrder

The desired color order. Possible values are:

Value	Meaning
ORDER_RGB	[0] Red-green-blue order.
ORDER_BGR	[1] Blue-green-red order.
ORDER_GRAY	[2] 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are only supported in the Document/Medical toolkits.
ORDER_RGBORGRAY	[3] Load the image as red, green, blue OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical toolkits only.
ORDER_BGRORGRAY	[4] Load the image as blue, green, red OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical toolkits only.
0	The data is 8 bits per pixel or less.

L_UINT uFlags

Binary flags that determine the behavior of [LFile:LoadFile. You can specify one or more of the following values:

Value	Meaning
LOADFILE_ALLOCATE	[0x0001] The function allocates memory for the specified bitmap. (This takes place in addition to the actions of your callback function.)
LOADFILE_STORE	[0x0002] The function loads data into the specified bitmap. (This takes place in addition to the actions of your callback function.)
LOADFILE_FIXEDPALETTE	[0x0004] This flag will force a palletized image to be dithered to a fixed palette.
LOADFILE_NOINTERLACE	[0x0008] The function passes image data in the order that is displayed, regardless of how it is stored in the file. (Set this flag if your program does not handle interlaced file formats.)
LOADFILE_ALLPAGES	[0x0010] The function loads all pages of a multipage file. Use this flag only if you are creating a bitmap list using the LPlayback::Append function.
LOADFILE_NOINITBITMAP	[0x0020] The function does not initialize the bitmap handle when it loads the file. Use this flag only if you are supplying all of the required information in the BITMAPHANDLE structure.
LOADFILE_COMPRESSED	[0x0040] (Document/Medical only) If possible, load the file as a 1-bit RLE-compressed image. For more information, refer to Speeding Up 1-Bit Documents.
LOADFILE_SUPERCOMPRESSED	[0x0080] (Document/Medical only) Load 1-bit, 8-bit, and 24-bit images as super compressed. This flag is ignored if the bitmaps are not loaded as 1-bit, 8-bit, or 24-bit. Please note that 8-bit images will be loaded as grayscale, even if the source image is color.
LOADFILE_TILED	[0x0200] Create tiled bitmap first. Allocates the memory for bitmaps in tiles.
LOADFILE_NOTILED	[0x0400] Do not use tiled bitmaps.
LOADFILE_DISK	[0x0800] Use Disk (if possible). Allocates the memory for bitmaps using hard disk space.
LOADFILE_NODISK	[0x1000] Do not use disk.
LOADFILE_MULTITHREADED	[0x00002000] Use Multithreaded load

L_INT nPage

The number of the page to load.

pLOADFILEOPTION pLoadFileOption

Pointer to the LOADFILEOPTION structure to be updated with the current extended values.

pFILEINFO pFileInfo

Pointer to a FILEINFO structure. This structure may contain file information used in loading an image, or it may be updated with information about the file being loaded.

If nothing is known about the file, pass NULL for this parameter, or declare a variable of type FILEINFO and set the FILEINFO.Flags to 0, then pass the address of the FILEINFO structure in this parameter. In this case, if the address of a FILEINFO structure is passed, the FILEINFO structure will be updated with the results of LFile::GetInfo.

If only the file type is known, set pFileInfo.Format to the file type and set pFileInfo.Flags to FILEINFO_FORMATVALID. This can also be done if LFile::GetInfo has been called previously, but values that affect the size of the image loaded have been changed (for example, by calling LFileSettings::SetPCDResolution or LFileSettings::SetWMFResolution). In this case the FILEINFO structure pointed to by pFileInfo will be updated with the results of LFile::GetInfo.

If LFile::GetInfo has been called prior to calling this function, and no changes have been made to the contents of the structure filled by LFile::GetInfo, then the address of the filled FILEINFO structure can be passed for this parameter. In this case, the FILEINFO.Flags member should be set to FILEINFO_INFOVALID. The LFile::GetInfo function will set the FILEINFO.Flags to FILEINFO_INFOVALID. In this case the load will be faster since this function does not have to query the file filters for the file type.

Returns

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

Comments

This function supports the LFile::LoadFileCallBack virtual function.

Note: More options are available in the LOADFILEOPTION structure.

Support for 12 and 16-bit grayscale images is only available in the Document/Medical toolkits.

For supported formats, refer to Files To Be Included With Your Application.

Before calling this function, you may need to get or set file information, such as the page number of a multipage file or the resolution of a PCD file. Refer to Getting and Setting File Information.

Notes:

For information on loading and saving large TIFF files faster, refer to Loading and Saving Large TIFF/BigTIFF Files.
You should never pass an uninitialized FILEINFO structure to this 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

class LUserFileLF : public LFile  
{ 
   public: 
      HDC m_hDC ; 
 
   public: 
      LUserFileLF () ; 
      virtual ~LUserFileLF () ; 
      virtual L_INT LoadFileCallBack(pFILEINFO pFileInfo, 
            LBitmapBase * pLBitmap, 
            LBuffer * pLBuffer, 
            L_UINT uFlags, 
            L_INT nRow, 
            L_INT nLines); 
      virtual L_INT SaveFileCallBack(LBitmapBase * pLBitmap, 
            LBuffer * pLBuffer, 
            L_UINT uRow, 
            L_UINT uLines); 
}; 
 
LUserFileLF::LUserFileLF () 
{ 
} 
 
LUserFileLF::~LUserFileLF () 
{ 
} 
 
L_INT LUserFileLF::LoadFileCallBack(pFILEINFO pFileInfo, 
                                  LBitmapBase * pLBitmap, 
                                  LBuffer * pLBuffer, 
                                  L_UINT uFlags, 
                                  L_INT nRow, 
                                  L_INT nLines) 
{ 
   UNREFERENCED_PARAMETER(pFileInfo); 
 
   UNREFERENCED_PARAMETER(uFlags); 
 
   UNREFERENCED_PARAMETER(nLines); 
 
   pLBitmap->Paint()->SetDC(m_hDC) ; 
   pLBitmap->Paint()->PaintDCBuffer( *pLBuffer, nRow); 
 
   return SUCCESS ; 
} 
 
L_INT LUserFileLF::SaveFileCallBack(LBitmapBase * pLBitmap, 
                                  LBuffer * pLBuffer, 
                                  L_UINT uRow, 
                                  L_UINT uLines) 
{ 
   UNREFERENCED_PARAMETER(pLBitmap); 
 
   UNREFERENCED_PARAMETER(pLBuffer); 
 
   L_UINT i; // Row counter  
   L_UINT uRowLast = uRow + uLines; // Used when counting rows  
   L_TCHAR szMessage [50] ; 
 
   // Put the required rows in the buffer  
   for (i = uRow; i < uRowLast; i++) 
   { 
      wsprintf(szMessage, TEXT("Row no. %u\n"),uRow);  
      MessageBox(NULL, szMessage, TEXT("Row"), MB_OK ); 
   } 
 
   return SUCCESS ; 
} 
 
L_INT LFile__LoadFileExample(HWND hWnd) 
{ 
   L_INT nRet; 
   LBitmapBase LeadBitmap ; 
   LUserFileLF UserLeadFile ; 
 
   UserLeadFile.SetBitmap(&LeadBitmap); 
   UserLeadFile.SetFileName(MAKE_IMAGE_PATH(TEXT("image1.cmp"))) ; 
   UserLeadFile.EnableCallBack(TRUE); 
 
   UserLeadFile.m_hDC = GetDC (hWnd); 
 
   nRet = UserLeadFile.LoadFile (24, ORDER_RGB, LOADFILE_ALLOCATE | LOADFILE_STORE); 
   if(nRet != SUCCESS) 
      return nRet; 
   /* or */ 
   /* UserLeadFile.LoadFile(24, ORDER_RGB, LOADFILE_ALLOCATE | LEADFILE_STORE, 0); */ 
 
 
   UserLeadFile.SetFileName (MAKE_IMAGE_PATH(TEXT("Test.bmp"))); 
   nRet = UserLeadFile.SaveFile (FILE_BMP, 8, 0, SAVEFILE_FIXEDPALETTE, NULL); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   ReleaseDC (hWnd, UserLeadFile.m_hDC); 
   return SUCCESS ; 
}