ReadGeoKeys(Stream,int) Method

Summary

Reads all the GeoKey data found in a stream.

Syntax

Objective-C

C++

Java

public IList<RasterTagMetadata> ReadGeoKeys( 
   Stream stream, 
   int pageNumber 
)

Public Overloads Function ReadGeoKeys( _ 
   ByVal stream As Stream, _ 
   ByVal pageNumber As Integer _ 
) As IList(Of RasterTagMetadata)

- (nullable NSArray<LTRasterTagMetadata *> *)readGeoKeysFromStream:(LTLeadStream *)stream  
                                                        pageNumber:(NSInteger)pageNumber  
                                                             error:(NSError **)error

public List<RasterTagMetadata> readGeoKeys(ILeadStream stream, int pageNumber)

public: 
IList<RasterTagMetadata^>^ ReadGeoKeys(  
   Stream^ stream, 
   int pageNumber 
)

Parameters

stream
A Stream containing the input TIFF image data.

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 GeoKeys, an empty collection will be returned. If the file format does not support GeoKeys, an exception will be thrown.

Remarks

To read a specific GeoKey stored in a file, use ReadGeoKey and to enumerate all the GeoKeys stored in a file use EnumGeoKeys.

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

To load all the GeoKeys stored in a disk file, use ReadGeoKeys.

Example

For an example, refer to ReadTags.

Requirements

Target Platforms