L_TagsSupported

Summary

Checks whether the given file format supports tags.

Syntax

#include "l_bitmap.h"

L_LTFIL_API L_BOOL L_TagsSupported(nFormat)

Parameters

L_INT nFormat

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

Returns

Value Meaning
TRUE The format supports tags.
FALSE The format does not support tags.

Comments

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

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

For general information about TIFF tags, refer to Implementing TIFF Comments and Tags.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

For an example, refer to L_ReadFileTags.

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.