L_ReadFileComment

Summary

Gets a comment field from a file.

Syntax

#include "l_bitmap.h"

L_LTFIL_API L_INT L_ReadFileComment(pszFile, uType, pComment, uLength, pLoadOptions)

Parameters

L_TCHAR* pszFile

Character string containing the input file name.

L_UINT uType

The type of comment. Refer to Types of File Comments.

L_UCHAR* pComment

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).

L_UINT uLength

The size of your buffer that will hold the comment field.

pLOADFILEOPTION pLoadOptions

Pointer to optional extended load options. Pass NULL to use the default load options.

Returns

Value Meaning
>=0 Length of the comment field.
< 0 An error occurred. Refer to Return Codes.

Comments

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

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

For an example, refer to L_SetComment.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.