Public Overloads Function ReadComments( _
   ByVal stream As Stream, _
   ByVal pageNumber As Integer _
) As RasterCollection(Of RasterCommentMetadata)

Visual Basic (Usage)	Copy Code
Dim instance As RasterCodecs Dim stream As Stream Dim pageNumber As Integer Dim value As RasterCollection(Of RasterCommentMetadata)   value = instance.ReadComments(stream, pageNumber)

public RasterCollection<RasterCommentMetadata> ReadComments( 
   Stream stream,
   int pageNumber
)

public:
RasterCollection<RasterCommentMetadata> ReadComments( 
   Stream^ stream,
   int pageNumber
) 

Parameters

stream

A Stream containing the input image data.

pageNumber

1-based index of the page from which to read the 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.

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 check if a file format supports comment fields, use RasterCodecs.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 result image RasterImage.Comments collection.

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

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

Reference