ReadComment(Stream,int,RasterCommentMetadataType) Method

Summary

Gets a comment field from a stream.

Syntax

Objective-C

C++

Java

public RasterCommentMetadata ReadComment( 
   Stream stream, 
   int pageNumber, 
   RasterCommentMetadataType type 
)

Public Overloads Function ReadComment( _ 
   ByVal stream As Stream, _ 
   ByVal pageNumber As Integer, _ 
   ByVal type As RasterCommentMetadataType _ 
) As RasterCommentMetadata

- (nullable LTRasterCommentMetadata *)readCommentFromStream:(LTLeadStream *)stream  
                                                 pageNumber:(NSInteger)pageNumber  
                                                       type:(LTRasterCommentMetadataType)type  
                                                      error:(NSError **)error

public RasterCommentMetadata readComment(ILeadStream stream, int pageNumber, RasterCommentMetadataType type)

public: 
RasterCommentMetadata^ ReadComment(  
   Stream^ stream, 
   int pageNumber, 
   RasterCommentMetadataType type 
)

Parameters

stream
A Stream 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

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.

Example

For an example, refer to ReadComment.

Requirements

Target Platforms