LFile::GetInfo

Show in webframe

#include "ltwrappr.h"

virtual L_INT LFile::GetInfo(pFileInfo, uStructSize, uFlags=FILEINFO_TOTALPAGES, pLoadFileOption=NULL)

pFILEINFO pFileInfo;	/* pointer to a FILEINFO structure to be filled */
L_UINT uStructSize;	/* size in bytes, of the structure pointed to by pFileInfo */
L_UINT uFlags;	/* flag that indicates whether to update the TotalPages field in the FILEINFO structure */
pLOADFILEOPTION pLoadFileOption;	/* pointer to optional extended load options */

Gets information about the specified file and fills the specified FILEINFO structure with the information.

Parameter	Description
pFileInfo	Pointer to the FILEINFO structure to be filled. For more information, see FILEINFO structure.
uStructSize	Size in bytes, of the structure pointed to by pFileInfo. Use sizeof(FILEINFO).
uFlags	Flag that indicates whether to update the TotalPages field in the FILEINFO structure. Possible values are:
	Value	Meaning
	FILEINFO_TOTALPAGES	[0x0001] Update the pFileInfo->TotalPages field with the total number of pages in the file.
	0	Do not update the pFileInfo->TotalPages field.
pLoadFileOption	Pointer to optional extended load options. Pass NULL to use the default load options.

Returns

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

Comments

To use this function, do the following:

1.	Declare a variable with the datatype of FILEINFO.
2.	Declare and assign a character string variable for the file name.
3.	If you are getting information about a multipage file (which can contain more than one image), use the LOADFILEOPTION structure to specify the page number. The information that you get will be for the image on the specified page.
4.	Set the filename by calling LFile::SetFileName.
5.	Initialize the FILEINFO structure to zero values.
6.	Call the LFile::GetInfo function, passing the address of the FILEINFO variable as parameters.
7.	Get the image information from the fields described in FILEINFO structure.

For a summary of file information functions, refer to Getting and Setting File Information.

Note:	More options are available in the LOADFILEOPTION structure.
Note:	For information on loading and saving large TIFF files faster, refer to Loading and Saving Large TIFF Files.
Note:	For information about loading PDF files, refer to PDF Features.

Note: 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.

Win32, x64.

Functions:	LFile::Compact, LFileSettings::SetPDFOptions, Class Members
Topics:	Raster Image Functions: Input and Output
	Loading and Saving Images