←Select platform

ReadCommentAsync Method

Summary

Gets a comment field from a stream.

Syntax

WinRT C#

C++

public IAsyncOperation<RasterCommentMetadata> ReadCommentAsync(  
   ILeadStream stream, 
   int pageNumber, 
   Leadtools.RasterCommentMetadataType type 
)

Public Function ReadCommentAsync( _ 
   ByVal stream As ILeadStream, _ 
   ByVal pageNumber As Integer, _ 
   ByVal type As Leadtools.RasterCommentMetadataType _ 
) As IAsyncOperation(Of RasterCommentMetadata)

public IAsyncOperation<RasterCommentMetadata> ReadCommentAsync(  
   ILeadStream stream, 
   int pageNumber, 
   Leadtools.RasterCommentMetadataType type 
)

 function Leadtools.Codecs.RasterCodecs.ReadCommentAsync(  
   stream , 
   pageNumber , 
   type  
)

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

Parameters

stream
A 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 RasterCommentMetadata object containing the comment field information. If no such comment is found in the file, this method will return a null reference.

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 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.

Requirements

Target Platforms