←Select platform

EnumTagsAsync Method

Summary

Enumerates all the tags in a stream.

Syntax

WinRT C#

C++

public IAsyncAction EnumTagsAsync(  
   ILeadStream stream, 
   int pageNumber 
)

Public Function EnumTagsAsync( _ 
   ByVal stream As ILeadStream, _ 
   ByVal pageNumber As Integer _ 
) As IAsyncAction

public IAsyncAction EnumTagsAsync(  
   ILeadStream stream, 
   int pageNumber 
)

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

public: 
IAsyncAction^ EnumTagsAsync(  
   ILeadStream^ stream, 
   int pageNumber 
)

Parameters

stream
A ILeadStream containing the input file image data.

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

Return Value

An asynchronous enumeration operation on a RasterCodecs object.

Remarks

This method will fire the TagFound event for each tag found in the stream.

Currently, only TIFF and Exif files contain tags.

For multi-page TIFF files, you can enumerate the tags from a particular page. Specify the page number whose tags to enumerate.

This method enumerates the standard TIFF tags and the user tags. Standard TIFF tags are less than 32767. User TIFF tags are usually between 32768 and 65535.

To enumerate the tags stored in a disk file, use EnumTags.

To read a tag value, use ReadTag and to read all the tags in a file, use ReadTags.

For general information about TIFF tags, refer to Implementing TIFF Comments and Tags.

Do not attempt to use DeleteTag to delete tags from inside the TagFound event. If you want to delete tags that you enumerate, use this event to add the tags to a list. Upon returning from EnumTags, you can delete all the tags from the list.

You can use TagsSupported to determine whether a certain file format supports tags.

Requirements

Target Platforms

Reference

RasterCodecs Class

RasterCodecs Members

Help Version 19.0.2017.10.27

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies