LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
ReadGeoKey(String,Int32,Int32) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > ReadGeoKey Method : ReadGeoKey(String,Int32,Int32) Method



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

GeoKey ID. Values of the GeoKey ID range between 0 and 65535. Possible ranges are:

Range Meaning
0..1023 Do not use; reserved for future use.
1024..2047 GeoTIFF Configuration Keys.
2048..3071 Geographic/Geocentric CS Parameter Keys.
3072..4095 Projected CS Parameter Keys.
4096..5119 Vertical CS Parameter Keys.
5120..32767 Reserved.
32768..65535 Private use - use to store your own data.

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

GeoKey ID. Values of the GeoKey ID range between 0 and 65535. Possible ranges are:

Range Meaning
0..1023 Do not use; reserved for future use.
1024..2047 GeoTIFF Configuration Keys.
2048..3071 Geographic/Geocentric CS Parameter Keys.
3072..4095 Projected CS Parameter Keys.
4096..5119 Vertical CS Parameter Keys.
5120..32767 Reserved.
32768..65535 Private use - use to store your own data.

Gets the specified GeoKey data from a TIFF file.

Syntax

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

Parameters

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

GeoKey ID. Values of the GeoKey ID range between 0 and 65535. Possible ranges are:

Range Meaning
0..1023 Do not use; reserved for future use.
1024..2047 GeoTIFF Configuration Keys.
2048..3071 Geographic/Geocentric CS Parameter Keys.
3072..4095 Projected CS Parameter Keys.
4096..5119 Vertical CS Parameter Keys.
5120..32767 Reserved.
32768..65535 Private use - use to store your own data.

Return Value

The GeoKey data.

Example

Remarks

You can use this method to obtain the GeoKey data from a particular file.

If no such GeoKey exists in the image, this method will return a null reference (Nothing in Visual Basic).

The most efficient way of reading the GeoKeys in a file is to enumerate them with EnumGeoKeys(String,Int32) and then read each GeoKey with ReadGeoKey(String,Int32,Int32).

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also