LEADTOOLS Image File Support (Leadtools.Codecs assembly)

WriteTagAsync Method

Show in webframe







A Leadtools.ILeadStream that contains the file data.
1-based index of the page at which to write the tag.
Tag to identify the data in the TIFF file.
Writes or changes a tag to an existing stream.
Syntax
public IAsyncAction WriteTagAsync( 
   ILeadStream stream,
   int pageNumber,
   RasterTagMetadata tag
)
'Declaration
 
Public Function WriteTagAsync( _
   ByVal stream As ILeadStream, _
   ByVal pageNumber As Integer, _
   ByVal tag As RasterTagMetadata _
) As IAsyncAction
'Usage
 
Dim instance As RasterCodecs
Dim stream As ILeadStream
Dim pageNumber As Integer
Dim tag As RasterTagMetadata
Dim value As IAsyncAction
 
value = instance.WriteTagAsync(stream, pageNumber, tag)
public IAsyncAction WriteTagAsync( 
   ILeadStream stream,
   int pageNumber,
   RasterTagMetadata tag
)

            

            
 function Leadtools.Codecs.RasterCodecs.WriteTagAsync( 
   stream ,
   pageNumber ,
   tag 
)
public:
IAsyncAction^ WriteTagAsync( 
   ILeadStream^ stream,
   int pageNumber,
   RasterTagMetadata^ tag
) 

Parameters

stream
A Leadtools.ILeadStream that contains the file data.
pageNumber
1-based index of the page at which to write the tag.
tag
Tag to identify the data in the TIFF file.
Remarks

This method writes tags into an existing file or changes tags in an existing file.

This method works only with TIFF files.

Note: Use this method carefully. LEADTOOLS will not restrict the tags that you write. If you write bad tags, the file might become corrupted. Consult the TIFF documentation for a list of predefined tags. It is recommended that you write only the user-defined tags (the tags between 0x8000 and 0xFFFF).

See the TIFF documentation for a complete list of the TIFF tags and types.

When you add or remove tags, the tags array at the end of the file is re-written. When you modify existing tags, the new tag value is added to the file and the IFD is modified as necessary. In all of these cases, there is no image recompression.

Some restrictions apply to this function if you use an IFD to indicate to which page to write the tag. See the Loading And Saving Large TIFF Files topic for more information.

Example
For an example, refer to DeleteTag.
Requirements

Target Platforms

See Also

Reference

RasterCodecs Class
RasterCodecs Members
Implementing TIFF Comments and Tags
Working with Markers

 

 


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