L_CommentsSupported

#include "l_bitmap.h"

L_LTFIL_API L_BOOL L_CommentsSupported(nFormat)

L_INT nFormat;

/* file format */

Checks whether the given file format supports comment fields.

Parameter

Description

nFormat

Input file format. For valid values, refer to Summary of All Supported Image File Formats.

Returns

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

LTFIL

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64, Mobile.

See Also

Functions:

L_ReadFileComment, L_WriteFileComment, L_SetComment, L_GetComment, L_ReadFileComments

Topics:

Raster Image Functions: Input and Output

Example

For a short example, refer to L_ReadFileTags.