L_TCHAR * pszFileName;

/* name of the file to load */

L_INT nBitsPerPixel;

/* resulting bitmaps pixel depth */

L_INT nColorOrder;

/* the color order */

L_INT nPage;

/* the page number of the first image to be loaded */

pLOADFILEOPTION pLoadFileOption;

/* pointer to optional extended load options */

pFILEINFO pFileInfo;

/* pointer to a structure */

Parameter

Description

pszFileName

Character string containing the name of the file to load.

nBitsPerPixel

Resulting bitmap pixel depth. The following are valid values:

Value

Meaning

0

Keep the original file's pixel depth (Do not convert).

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

nColorOrder

Color order for 16-, 24-, 32-, 48-, and 64-bit bitmaps. If the resultant bitmaps are less than 16 bits per pixel, this will have no effect since palletized images have no order. Possible values are:

Value

Meaning

ORDER_RGB

[0] Red, green, and blue color order

ORDER_BGR

[1] Blue, green, and red color order

ORDER_GRAY

[2] 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are only supported in the Document/Medical toolkits only.

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.

nPage

The page number (for multipage files) that contains the first image to be loaded. If the file is not a multipage file, pass 0.

pLoadFileOption

Pointer to optional extended load options. Pass NULL to use the default load options.

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.

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

LTDIS
LTDLG
LTEFX
LTFIL
LTIMG
LTSCR
LTTWN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Functions:

Class Members, LBitmapBase::GetLoadStatus

Topics:

Raster Image Functions: Loading Files

Raster Image Functions: Redirecting Input and Output

Raster Image Functions: Input and Output