C#
VB
WinRT C#
C++
←Select platform
ReadCommentsAsync Method
Summary
Gets all the comment fields stored in a stream.
Syntax
public IAsyncOperation<IVector<RasterCommentMetadata>> ReadCommentsAsync(ILeadStream stream,int pageNumber)
Public Function ReadCommentsAsync( _ByVal stream As ILeadStream, _ByVal pageNumber As Integer _) As IAsyncOperation(Of IVector(Of RasterCommentMetadata))
public IAsyncOperation<IVector<RasterCommentMetadata>> ReadCommentsAsync(ILeadStream stream,int pageNumber)
function Leadtools.Codecs.RasterCodecs.ReadCommentsAsync(stream ,pageNumber)
public:IAsyncOperation<IVector<RasterCommentMetadata^>^>^ ReadCommentsAsync(ILeadStream^ stream,int pageNumber)
Parameters
stream
A ILeadStream containing the input image data.
pageNumber
1-based index of the page from which to read the comments.
Return Value
When this method completes, it returns a collection of RasterTagMetadata containing all the comment fields information found in the file. If the file does not contain any comments, an empty collection will be returned. If the file format does not support comment fields, an exception will be thrown.
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.
To read a specific comment field stored in a file, use ReadComment.
This method will throw an exception if the file format does not support comments fields. To determine whether a file format supports comment fields, use CommentsSupported. You can also automatically load all the comment fields stored in a file during a load operation by setting the CodecsLoadOptions.Comments property to true. The comment fields data will be stored in the resulting image RasterImage.Comments collection.
To load all the comments stored in a disk file, use ReadComments.
Requirements
See Also
Reference
ReadComment(String,Int32,RasterCommentMetadataType) Method
Implementing TIFF Comments and Tags
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
Leadtools.Codecs Assembly
