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

Visual Basic (Usage)	Copy Code
Dim instance As RasterCodecs Dim stream As Stream Dim pageNumber As Integer Dim type As RasterCommentMetadataType Dim value As RasterCommentMetadata   value = instance.ReadComment(stream, pageNumber, type)

public RasterCommentMetadata ReadComment( 
   Stream 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

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 RasterCodecs.CommentsSupported to check if a certain file format supports tags.

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

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Reference