LEADTOOLS Image File Support (Leadtools.Codecs assembly)

ReadTagAsync Method

Show in webframe







A Leadtools.ILeadStream containing the input file image data.
1-based index of the page from which to read the tag.

Tag to identify the data in the TIFF file. Use the same tag that you specified in the WriteTag(String,Int32,RasterTagMetadata). Examples of registered tags are:

Value Meaning
0x8298 Copyright comment
0x8769 General Exif comments
0x8825 Exif GPS comments
0x80A4 Annotation TIFF tag
Gets the specified tagged data from a TIFF stream.
Syntax
public IAsyncOperation<RasterTagMetadata> ReadTagAsync( 
   ILeadStream stream,
   int pageNumber,
   int id
)
'Declaration
 
Public Function ReadTagAsync( _
   ByVal stream As ILeadStream, _
   ByVal pageNumber As Integer, _
   ByVal id As Integer _
) As IAsyncOperation(Of RasterTagMetadata)
'Usage
 
Dim instance As RasterCodecs
Dim stream As ILeadStream
Dim pageNumber As Integer
Dim id As Integer
Dim value As IAsyncOperation(Of RasterTagMetadata)
 
value = instance.ReadTagAsync(stream, pageNumber, id)
public IAsyncOperation<RasterTagMetadata> ReadTagAsync( 
   ILeadStream stream,
   int pageNumber,
   int id
)

            

            
 function Leadtools.Codecs.RasterCodecs.ReadTagAsync( 
   stream ,
   pageNumber ,
   id 
)
public:
IAsyncOperation<RasterTagMetadata^>^ ReadTagAsync( 
   ILeadStream^ stream,
   int pageNumber,
   int id
) 

Parameters

stream
A Leadtools.ILeadStream containing the input file image data.
pageNumber
1-based index of the page from which to read the tag.
id

Tag to identify the data in the TIFF file. Use the same tag that you specified in the WriteTag(String,Int32,RasterTagMetadata). Examples of registered tags are:

Value Meaning
0x8298 Copyright comment
0x8769 General Exif comments
0x8825 Exif GPS comments
0x80A4 Annotation TIFF tag

Return Value

When this method completes, it returns the tag data.
Remarks

This method is provided to support TIFF tags that you define. If no such tag exists in the image, this method will return a null reference (Nothing in Visual Basic).

To read all the tags stored in a file, use ReadTags(String,Int32)

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

Example
For an example, refer to DeleteTag.
Requirements

Target Platforms

See Also

Reference

RasterCodecs Class
RasterCodecs Members
Implementing TIFF Comments and Tags
EnumTags(string, int) Method
EnumTags(Stream, int) Method

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.