L_CommentsSupported

#include "l_bitmap.h"

L_LTFIL_API L_BOOL L_CommentsSupported(nFormat)

Checks whether the given file format supports comment fields.

Parameters

L_INT nFormat

Input file format. For valid values, refer toFiles To Be Included With Your Application.

Returns

Value Meaning
TRUE The format supports comment fields.
FALSE The format does not support comment fields.

Comments

This is a helper function that can be used to detect if a certain raster file format supports comment fields. For example, L_ReadFileComment and L_ReadFileComments functions can be used to read the comments stored in a file. If the file format supports comments, such as JPEG or TIFF, then these methods will successfully return the comments stored.

However, if the format does not support comments, such as BMP, an error will be returned by these functions. You can use the L_CommentsSupported function to check if the file supports comments and only call the read comments methods if the return value is TRUE.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

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

LEADTOOLS Raster Imaging C API Help