←Select platform

ReadGeoKeysAsync Method

Summary

Reads all the GeoKey data found in a stream.

Syntax

WinRT C#

C++

public IAsyncOperation<IVector<RasterTagMetadata>> ReadGeoKeysAsync(  
   ILeadStream stream, 
   int pageNumber 
)

Public Function ReadGeoKeysAsync( _ 
   ByVal stream As ILeadStream, _ 
   ByVal pageNumber As Integer _ 
) As IAsyncOperation(Of IVector(Of RasterTagMetadata))

public IAsyncOperation<IVector<RasterTagMetadata>> ReadGeoKeysAsync(  
   ILeadStream stream, 
   int pageNumber 
)

 function Leadtools.Codecs.RasterCodecs.ReadGeoKeysAsync(  
   stream , 
   pageNumber  
)

public: 
IAsyncOperation<IVector<RasterTagMetadata^>^>^ ReadGeoKeysAsync(  
   ILeadStream^ stream, 
   int pageNumber 
)

Parameters

stream
A ILeadStream containing the input TIFF image data.

pageNumber
1-based index of the page from which to read the GeoKey tags.

Return Value

When this method completes it returns 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 geo key 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.

Requirements

Target Platforms