ReadComment method (Main Control)

C++ Builder example

Delphi example

 

Builder Syntax

System::Variant ReadComment (System::AnsiString sFile, int iPage, Cardinal nIndex);

Delphi Syntax

ReadComment (sFile : String ; iPage: Integer; nIndex: Cardinal): Variant;

Overview

Refer to Maintaining File Comments.

Remarks

Returns the value of the specified comment in an image file.

Some file formats can contain comments, and some cannot, and each file format has its own set of comment types. With the ReadComment method, you can get the value of any comment in the file. The index into the array of comments determines the type of comment, as described in Types of File Comments.

The Comment property specifies the comments to be saved when you save an image in a file. If you want to preserve existing comments in the file when you save the image, you must use the ReadComment method to update the Comment property array.

See Also

Elements:

Comment property, WriteComment method

Topics:

Raster Images: Getting and Setting File Information