←Select platform

ReadTagsAsync Method

Summary

Reads all the tags stored in a TIFF file.

Syntax

WinRT C#

C++

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

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

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

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

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

Parameters

stream
A ILeadStream containing the input image data.

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

Return Value

When this method completes, it returns a collection of RasterTagMetadata containing all the tags found in the file. If the file does not contain any tags, an empty collection will be returned. If the file format does not support tags, an exception will be thrown.

Remarks

To read a specific tag stored in a file use ReadTag, and to enumerate all the tag ids (but not the data) stored in a file use EnumTags.

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

To load all the tags stored in a disk file, use ReadTags.

Requirements

Target Platforms