static L_INT LFileSettings::GetComment(uType, pComment, uLength)
Gets a current field that is ready to be saved as a comment in a file. This lets you see the field that was specified with the LFileSettings::SetComment function.
The type of comment. For a list of available types, refer to Types of File Comments.
Pointer to the buffer that will hold the comment field. You can pass NULL if you only want to get the length of the field (the return value).
The size of the buffer that will hold the comment field.
|>=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 LFileSettings::SetComment function to specify the comments to be saved.
The LFileSettings::GetComment function lets you get any of the current comments that are ready to be saved, for example, if you want to let the user review the comments before saving a file. Before getting a comment, you must allocate a buffer for the field. If you do not know how big the buffer needs to be, you can call this function twice: the first time to get the length of the field (the return value), and the second time to actually get the field.
Note: More options are available in the LOADFILEOPTION structure.
For a list of functions that use either the LOADFILEOPTION structure or the SAVEFILEOPTION structure, refer to Functions Utilizing the LOADFILEOPTION or SAVEFILEOPTION Structures.
For an example, refer to LFile::ReadComment.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries