LEADTOOLS Image File Support (Leadtools.Codecs assembly)

ReadCommentAsync Method

Show in webframe







A Leadtools.ILeadStream containing the input file data.
1-based index of the page from which to read the comment.
The type of comment. Refer to Types of File Comments.
Gets a comment field from a stream.
Syntax
public IAsyncOperation<RasterCommentMetadata> ReadCommentAsync( 
   ILeadStream stream,
   int pageNumber,
   RasterCommentMetadataType type
)
'Declaration
 
Public Function ReadCommentAsync( _
   ByVal stream As ILeadStream, _
   ByVal pageNumber As Integer, _
   ByVal type As RasterCommentMetadataType _
) As IAsyncOperation(Of RasterCommentMetadata)
'Usage
 
Dim instance As RasterCodecs
Dim stream As ILeadStream
Dim pageNumber As Integer
Dim type As RasterCommentMetadataType
Dim value As IAsyncOperation(Of RasterCommentMetadata)
 
value = instance.ReadCommentAsync(stream, pageNumber, type)
public IAsyncOperation<RasterCommentMetadata> ReadCommentAsync( 
   ILeadStream stream,
   int pageNumber,
   RasterCommentMetadataType type
)

            

            
 function Leadtools.Codecs.RasterCodecs.ReadCommentAsync( 
   stream ,
   pageNumber ,
   type 
)
public:
IAsyncOperation<RasterCommentMetadata^>^ ReadCommentAsync( 
   ILeadStream^ stream,
   int pageNumber,
   RasterCommentMetadataType type
) 

Parameters

stream
A Leadtools.ILeadStream containing the input file data.
pageNumber
1-based index of the page from which to read the comment.
type
The type of comment. Refer to Types of File Comments.

Return Value

When this method completes, it returns a Leadtools.RasterCommentMetadata object containing the comment field information. If no such comment is found in the file, this method will return a null reference (Nothing in Visual Basic).
Remarks

Some file formats can contain comments, and some cannot, and each file format has its own set of comment types. When you save a file, the comments in the Leadtools.RasterImage object can be saved in the file. The index into the array (specified using a constant) determines the type of comment.

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

To read all the comments stored in a file, use ReadComments(String,Int32).

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 GIF Features
Implementing TIFF Comments and Tags

 

 


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