Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
ReadGeoKeys(String,Int32) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > ReadGeoKeys Method : ReadGeoKeys(String,Int32) Method



fileName
A String containing the input file name.
pageNumber
1-based index of the page from which to read the GeoKey tags.
Read all the GeoKey data found in a TIFF file.

Syntax

Visual Basic (Declaration) 
Public Overloads Function ReadGeoKeys( _
   ByVal fileName As String, _
   ByVal pageNumber As Integer _
) As RasterCollection(Of RasterTagMetadata)
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim fileName As String
Dim pageNumber As Integer
Dim value As RasterCollection(Of RasterTagMetadata)
 
value = instance.ReadGeoKeys(fileName, pageNumber)
C# 
public RasterCollection<RasterTagMetadata> ReadGeoKeys( 
   string fileName,
   int pageNumber
)
C++/CLI 
public:
RasterCollection<RasterTagMetadata> ReadGeoKeys( 
   String^ fileName,
   int pageNumber
) 

Parameters

fileName
A String containing the input file name.
pageNumber
1-based index of the page from which to read the GeoKey tags.

Return Value

A collection of RasterTagMetadata containing all the GeoKey tags found in the file. If the file does not contain any geo keys, an empty collection will be returned. If the file format does not support geo keys, an exception will be thrown.

Example

For an example, refer to RasterCodecs.ReadTags(String,Int32).

Remarks

To read a specific geo key stored in a file, use ReadGeoKey and to enumerate all the geo keys stored in a file use EnumGeoKeys.

This method will throw an exception if the file format does not support geo keys. To check if a file format supports geo keys, use RasterCodecs.GeoKeysSupported. You can also automatically load all the geo keys stored in a file during a load operation by setting the CodecsLoadOptions.GeoKeys property to true. The geo keys data will be stored in the result image RasterImage.GeoKeys collection.

To load all the geo keys stored in a stream containing the image data, use ReadGeoKeys.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also