C#
VB
Java
Objective-C
WinRT C#
C++
Leadtools.Codecs Namespace > Classes > RasterCodecs > Methods > ReadComment Method > ReadComment(Stream,Int32,RasterCommentMetadataType) Method
←Select platform
ReadComment(Stream,Int32,RasterCommentMetadataType) Method
Summary
Gets a comment field from a stream.
Syntax
public Leadtools.RasterCommentMetadata ReadComment(Stream stream,int pageNumber,Leadtools.RasterCommentMetadataType type)
Public Overloads Function ReadComment( _ByVal stream As Stream, _ByVal pageNumber As Integer, _ByVal type As Leadtools.RasterCommentMetadataType _) As Leadtools.RasterCommentMetadata
public Leadtools.RasterCommentMetadata ReadComment(Stream stream,int pageNumber,Leadtools.RasterCommentMetadataType type)
- (nullable LTRasterCommentMetadata *)readCommentFromStream:(LTLeadStream *)streampageNumber:(NSInteger)pageNumbertype:(LTRasterCommentMetadataType)typeerror:(NSError **)error
public RasterCommentMetadata readComment(ILeadStream stream, int pageNumber, RasterCommentMetadataType type) function Leadtools.Codecs.RasterCodecs.ReadComment(Stream,Int32,RasterCommentMetadataType)(stream ,pageNumber ,type)
public:Leadtools.RasterCommentMetadata^ ReadComment(Stream^ stream,int pageNumber,Leadtools.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
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
