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




stream
A Stream containing the input file data.
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:

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

Gets the specified GeoKey data from a TIFF stream.

Syntax

Visual Basic (Declaration) 
Overloads Public Function ReadGeoKey( _
   ByVal stream As Stream, _
   ByVal pageNumber As Integer, _
   ByVal id As Integer _
) As RasterTagMetadata
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim stream As Stream
Dim pageNumber As Integer
Dim id As Integer
Dim value As RasterTagMetadata
 
value = instance.ReadGeoKey(stream, pageNumber, id)
C# 
public RasterTagMetadata ReadGeoKey( 
   Stream stream,
   int pageNumber,
   int id
)
Managed Extensions for C++ 
public: RasterTagMetadata ReadGeoKey( 
   Stream* stream,
   int pageNumber,
   int id
) 
C++/CLI 
public:
RasterTagMetadata ReadGeoKey( 
   Stream^ stream,
   int pageNumber,
   int id
) 

Parameters

stream
A Stream containing the input file data.
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:

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

Return Value

The GeoKey data.

Example

For an example, refer to ReadGeoKey.

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 and then read each GeoKey with ReadGeoKey.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also