Collapse All Expand All

L_GeoKeysSupported

#include "l_bitmap.h"

L_LTFIL_API L_BOOL L_GeoKeysSupported(nFormat)

L_INT nFormat;

/* file format */

Checks whether the given file format supports Geo TIFF key tags.

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

Returns

TRUE	If the format supports geo keys.
FALSE	If the format does not support geo keys.

Comments

This is a helper function that can be used to detect if a certain raster file format supports geo keys. For example, L_ReadFileGeoKey, L_ReadFileGeoKeys and L_EnumFileGeoKeys function scan be used to read the geo keys stored in a file. If the file format supports tags, such as GeoTIFF, then these methods will successfully return the geo keys stored.

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

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

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, Linux.

See Also

Functions:	L_ReadFileGeoKey, L_WriteFileGeoKey, L_SetGeoKey, L_GetGeoKey, L_EnumFileGeoKeys, L_ReadFileGeoKeys, L_ReadFileGeoKeys
Topics:	Implementing TIFF Comments and Tags
	Implementing GeoKeys (GeoTIFF tags)

Example

For a short example, refer to L_ReadFileTags.