WriteComment(string,int,RasterCommentMetadata) Method

Summary

Writes a comment to an existing file.

Syntax

Objective-C

C++

public void WriteComment( 
   string fileName, 
   int pageNumber, 
   RasterCommentMetadata comment 
)

Public Overloads Sub WriteComment( _ 
   ByVal fileName As String, _ 
   ByVal pageNumber As Integer, _ 
   ByVal comment As RasterCommentMetadata _ 
)

- (BOOL)writeComment:(nullable LTRasterCommentMetadata *)comment  
              toFile:(NSString *)file  
          pageNumber:(NSInteger)pageNumber  
               error:(NSError **)error

public: 
void WriteComment(  
   String^ fileName, 
   int pageNumber, 
   RasterCommentMetadata^ comment 
)

Parameters

fileName
A String that contains the file name.

pageNumber
1-based index of the page at which to write the comment.

comment
A RasterCommentMetadata object containing the comment data.

Remarks

This function only applies to TIF, EXIF, JPEG, JPEG 2000, or FPX files.

When you add or remove tags, the tags array at the end of the file is re-written. When you modify existing tags, the new tag value is added to the file and the IFD is modified as necessary. In all of these cases, there is no image recompression.

Some restrictions apply to this function if you use an IFD to indicate to which page to write the comment. See the Loading and Saving Large TIFF / BigTIFF Files and Types of File Comments topics for more information.

Example

For an example, refer to ReadComment.

Requirements

Target Platforms