ReadFileCommentOffset method (ILEADRasterIO)

Visual Basic Example

Visual C++ 5.0 example

 

Syntax

short ReadFileCommentOffset(BSTR bstrFileName, long nOffsetBegin, long nBytesToLoad, long uType, ILEADRasterVariant * pVarComment);

Overview

Refer to Maintaining File Comments

Remarks

Reads a comment from a file and lets you specify the location of the image data within the file. This enables you to read comments from an image file that is embedded in another file.

Like the ReadComment method, this method lets you read comments that are already saved in a file header. The only difference between the ReadComment method and this method is that this method allows you to specify an offset for the image data. For more information refer to the Comment property.

The location of the image is specified as shown in the following simple illustration:

image\loadoff.gif

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, which LEADTOOLS maintains in a global array, are saved in the file. The index into the array (specified using a constant) determines the type of comment, as described in Types of File Comments.

Before saving a file, set the Comment property to specify the comments to be saved.

See Also

Elements:

ReadComment method, SaveOffset method, Comment property

Topics

Raster Images: Getting and Setting File Information

 

Raster Images: Maintaining File Comments