L_BOOL LFile::IsValid()
Determines whether the LFile object is ready to be used.
Value | Meaning |
---|---|
TRUE | The LFile object is ready to be used. |
FALSE | The LFile object is not ready to be used. |
Before you can use some of the file functions, a bitmap and a filename must be associated with the class object. Until you have associated a bitmap and a filename with the LFile object, the object is considered invalid.
The function will return TRUE only if both the filename and the bitmap have been set and are valid.
The following table describes the functions that require either the bitmap, filename, or both to be set:
Functions | Requirements |
---|---|
LFile::GetInfo | requires the filename to be set |
LFile::DeletePage | requires the filename to be set |
LFile::ReadLoadResolutions | requires the filename to be set |
LFile::ReadFileTransforms | requires the filename to be set |
LFile::WriteFileTransforms | requires the filename to be set |
LFile::GetCommentSize | requires the filename to be set |
LFile::GetPCDResolution | requires the filename to be set |
LFile::LoadBitmapList | requires the filename to be set |
LFile::LoadOffset | requires the bitmap to be set |
LFile::ReadComment | requires the filename to be set |
LFile::ReadCommentExt | requires the filename to be set |
LFile::ReadTag | requires the filename to be set |
LFile::SaveList | requires the filename to be set |
LFile::SaveOffset | requires the bitmap to be set |
LFile::WriteComment | requires the filename to be set |
LFile::FileConvert | does not require either filename or bitmap to be set |
Win32, x64.
L_INT LFile__IsValidExample()
{
LBitmapBase LeadBitmap;
LFile LeadFile;
if (LeadFile.IsValid() == FALSE)
LeadFile.SetBitmap(&LeadBitmap);
return SUCCESS ;
}
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document