virtual L_INT LFile::GetInfo(pFileInfo, uStructSize, uFlags=FILEINFO_TOTALPAGES, pLoadFileOption=NULL)
Gets information about the specified file and fills the specified FILEINFO structure with the information.
Pointer to the FILEINFO structure to be filled. For more information, refer to FILEINFO.
NOTE: Uninitialized pFileInfo should not pass to this function.
Size in bytes, of the structure pointed to by pFileInfo. Use sizeof(FILEINFO).
Flag indicating which members to update in the FILEINFO structure, if any. The FILEINFO_TOTALPAGES and FILEINFO_USEFILTERDATA values can be OR-ed together, in which case both values are retrieved. Possible values are:
|FILEINFO_TOTALPAGES||[0x0001] Update the pFileInfo->TotalPages field with the total number of pages in the file.|
|FILEINFO_USEFILTERDATA||[0x0002] Use filter data information to speed up loading.|
|0||Do not update the pFileInfo->TotalPages field.|
Pointer to optional extended load options. Pass NULL to use the default load options.
|SUCCESS||The function was successful.|
|< 1||An error occurred. Refer to Return Codes.|
To use this function, do the following:
The parallelogram values retrieved by LFile::GetInfo may not be always correct because it depends on the file saved data. The function does not load file objects but reads the file dimensions which may be not saved within the file.
For a summary of file information functions, refer to Getting and Setting File Information.
For an example, refer to LFile::ReadLoadResolutions.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries