LEADTOOLS Image File Support (Leadtools.Codecs assembly)
LEAD Technologies, Inc

EnumTagsAsync Method






A Leadtools.ILeadStream containing the input file image data.
1-based index of the page from which to enumerate the tags.
Enumerates all the tags in a stream. .NET support WinRT support
Syntax
public IAsyncAction EnumTagsAsync( 
   ILeadStream stream,
   int pageNumber
)
'Declaration
 
Public Function EnumTagsAsync( _
   ByVal stream As ILeadStream, _
   ByVal pageNumber As Integer _
) As IAsyncAction
'Usage
 
Dim instance As RasterCodecs
Dim stream As ILeadStream
Dim pageNumber As Integer
Dim value As IAsyncAction
 
value = instance.EnumTagsAsync(stream, pageNumber)
public IAsyncAction EnumTagsAsync( 
   ILeadStream stream,
   int pageNumber
)
 function Leadtools.Codecs.RasterCodecs.EnumTagsAsync( 
   stream ,
   pageNumber 
)
public:
IAsyncAction^ EnumTagsAsync( 
   ILeadStream^ stream,
   int pageNumber
) 

Parameters

stream
A Leadtools.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 multipage 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(String,Int32).

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

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

Do not attempt to use DeleteTag(String,Int32,Int32) 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(String,Int32), you can delete all the tags from the list.

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

Example
For an example, refer to EnumTags(String,Int32).
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

RasterCodecs Class
RasterCodecs Members

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.