LEADTOOLS Image File Support (Leadtools.Codecs assembly)

WriteCommentAsync Method

Show in webframe







A Leadtools.ILeadStream that contains the file data.
1-based index of the page at which to write the comment.
A Leadtools.RasterCommentMetadata object containing the comment data.
Writes a comment to an existing stream.
Syntax
public IAsyncAction WriteCommentAsync( 
   ILeadStream stream,
   int pageNumber,
   RasterCommentMetadata comment
)
'Declaration
 
Public Function WriteCommentAsync( _
   ByVal stream As ILeadStream, _
   ByVal pageNumber As Integer, _
   ByVal comment As RasterCommentMetadata _
) As IAsyncAction
'Usage
 
Dim instance As RasterCodecs
Dim stream As ILeadStream
Dim pageNumber As Integer
Dim comment As RasterCommentMetadata
Dim value As IAsyncAction
 
value = instance.WriteCommentAsync(stream, pageNumber, comment)
public IAsyncAction WriteCommentAsync( 
   ILeadStream stream,
   int pageNumber,
   RasterCommentMetadata comment
)

            

            
 function Leadtools.Codecs.RasterCodecs.WriteCommentAsync( 
   stream ,
   pageNumber ,
   comment 
)
public:
IAsyncAction^ WriteCommentAsync( 
   ILeadStream^ stream,
   int pageNumber,
   RasterCommentMetadata^ comment
) 

Parameters

stream
A Leadtools.ILeadStream that contains the file data.
pageNumber
1-based index of the page at which to write the comment.
comment
A Leadtools.RasterCommentMetadata object containing the comment data.
Remarks
An asynchronous write operation on a RasterCodecs object.

This function only applies to TIF, uncompressed EXIF, or FPX files.

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 comment. See the Loading And Saving Large TIFF Files and Types of File Comments topics for more information.

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

Target Platforms

See Also

Reference

RasterCodecs Class
RasterCodecs Members
Implementing Extended FlashPix Support
Implementing Exif Features
Implementing TIFF Comments and Tags
Working with Markers

 

 


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