L_LTFIL_API L_INT L_ReadFileComment(pszFile, uType, pComment, uLength, pLoadOptions)
Gets a comment field from a file.
Character string containing the input file name.
The type of comment. Refer to Types of File Comments.
Pointer to your buffer that will hold the comment field, including the terminating NULL. You can pass NULL if you only want to get the length of the field (the return value).
The size of your buffer that will hold the comment field.
Pointer to optional extended load options. Pass NULL to use the default load options.
|>=0||Length of the comment field.|
|< 0||An error occurred. Refer to Return Codes.|
Some file formats can contain comments, and some cannot, and each file format has its own set of comment types. When you save a file, the comments, which LEADTOOLS maintains in a global array, are saved in the file. The index into the array (specified using a constant) determines the type of comment, as described in Types of File Comments.
Before saving a file, you use the L_SetComment function to specify the comments to be saved.
The L_ReadFileComment function lets you read comments that are already saved in a file header. For more information refer to the L_SetComment function.
Note: More options are available in the LOADFILEOPTION structure.
Required DLLs and Libraries
Win32, x64, Linux.
For a list of functions that utilize the LOADFILEOPTION or SAVEFILEOPTION structures, refer to Functions Utilizing the LOADFILEOPTION or SAVEFILEOPTION structures
For an example, refer to L_SetComment.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries