LFile::ReadGeoKeys

#include "ltwrappr.h"

L_INT LFile::ReadGeoKeys(uFlags, puGeoKeyCount, ppGeoKeys, puDataSize, ppData, pLoadOptions)

L_UINT uFlags;

/* control flags */

L_UINT *puGeoKeyCount;

/* number of Geo keys found */

pLEADFILETAG *ppGeoKeys;

/* array Geo key data */

L_SIZE_T *puDataSize;

/* the overall size of the Geo keys data */

L_UCHAR ** ppData;

/* the overall Geo keys data */

pLOADFILEOPTION pLoadOptions;

/* pointer to optional extended load options */

Gets all the TIFF Geo keys stored in a file.

Parameter

Description

uFlags

Flag that determines whether to read the tag overall data. You can combine values when appropriate by using a bitwise OR ( | ):

 

Flag

Meaning

 

READFILEMETADATA_NOMEMORY

[0x01] Do not read the tag overall data. If this flag is set, then puDataSize and ppData will not be used and the function will not read the Geo key overall data.

puGeoKeyCount

Address of the variable to be updated with the number of Geo keys found in the file.

ppGeoKeys

Pointer to an array of LEADFILETAG structures. Each element of the array contains data for one Geo key field found in the file. The number of elements in ppGeoKeys is puGeoKeyCount. When this array is no longer needed pass it to the LFile::FreeTags function to free the allocated memory.

puDataSize

Address of the variable to be updated with the size in bytes of the overall Geo key fields data.

ppData

Address of the variable to be updated with a pointer to the overall Geo key fields data. The size of this pointer in bytes is puDataSize. Each LEADFILETAG item found contains an offset to where the data for this item is stored in ppData.

pLoadOptions

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

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

You must free the data allocated with this function using the LFile::FreeTags function.

For more information about GeoKeys, refer to Implementing GeoKeys (GeoTIFF tags).

Required DLLs and Libraries

LTFIL

LFTIF

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.

See Also

Functions:

LFile::SetGeoKey, LFile::GetGeoKey, LFile::WriteGeoKey, LFile::EnumGeoKeys, LFile::ReadGeoKey

Topics:

Implementing GeoKeys (GeoTIFF tags)

 

Implementing TIFF Comments and Tags

 

Raster Image Functions: Working with GeoKeys

Example

For a short example, refer to LFile::ReadTags.