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

ReadTagsAsync Method






A Leadtools.ILeadStream containing the input image data.
1-based index of the page from which to read the tags.
Reads all the tags stored in a TIFF file. .NET support WinRT support
Syntax
public IAsyncOperation<IVector<RasterTagMetadata>> ReadTagsAsync( 
   ILeadStream stream,
   int pageNumber
)
'Declaration
 
Public Function ReadTagsAsync( _
   ByVal stream As ILeadStream, _
   ByVal pageNumber As Integer _
) As IAsyncOperation(Of IVector(Of RasterTagMetadata))
'Usage
 
Dim instance As RasterCodecs
Dim stream As ILeadStream
Dim pageNumber As Integer
Dim value As IAsyncOperation(Of IVector(Of RasterTagMetadata))
 
value = instance.ReadTagsAsync(stream, pageNumber)
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 Leadtools.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 Leadtools.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(String,Int32,Int32), and to enumerate all the tag ids (but not the data) stored in a file use EnumTags(String,Int32).

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(String,Int32).

Example
For an example, refer to ReadTags(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
TagsSupported Method
ReadTag(String,Int32,Int32) Method
EnumTags(String,Int32) Method
CommentsSupported Method
GeoKeysSupported Method
Tags Property
RasterImage.Tags
Working with Markers
Implementing TIFF Comments and Tags
TIFF File Comments
Implementing GeoKeys (GeoTIFF tags)
Leadtools.RasterCommentMetadataType

 

 


Products | Support | Contact Us | Copyright Notices

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