LEADTOOLS Image File Support (Leadtools.Codecs assembly)

ReadGeoKey(String,Int32,Int32) Method

Show in webframe







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

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
public RasterTagMetadata ReadGeoKey( 
   string fileName,
   int pageNumber,
   int id
)
'Declaration
 
Public Overloads Function ReadGeoKey( _
   ByVal fileName As String, _
   ByVal pageNumber As Integer, _
   ByVal id As Integer _
) As RasterTagMetadata
'Usage
 
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)
public RasterTagMetadata ReadGeoKey( 
   string fileName,
   int pageNumber,
   int id
)

            

            
 function Leadtools.Codecs.RasterCodecs.ReadGeoKey(String,Int32,Int32)( 
   fileName ,
   pageNumber ,
   id 
)
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.
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).

Example
Refer to EnumGeoKeys(String,Int32).
Requirements

Target Platforms

See Also

Reference

RasterCodecs Class
RasterCodecs Members
Overload List
Implementing GeoKeys (GeoTIFF tags)
Implementing TIFF Comments and Tags

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.