WriteTag(string,int,RasterTagMetadata) Method

Summary

Writes or changes a tag to an existing file.

Syntax

Objective-C

C++

public void WriteTag( 
   string fileName, 
   int pageNumber, 
   RasterTagMetadata tag 
)

Public Overloads Sub WriteTag( _ 
   ByVal fileName As String, _ 
   ByVal pageNumber As Integer, _ 
   ByVal tag As RasterTagMetadata _ 
)

- (BOOL)writeTag:(nullable LTRasterTagMetadata *)tag  
          toFile:(NSString *)file  
      pageNumber:(NSInteger)pageNumber  
           error:(NSError **)error

public: 
void WriteTag(  
   String^ fileName, 
   int pageNumber, 
   RasterTagMetadata^ tag 
)

Parameters

fileName
A String that contains the file name.

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

tag
Tag to identify the data in the TIFF file.

Remarks

This method writes tags into an existing file or changes tags in an existing file.

This method works only with TIFF files.

Note: Use this method carefully. LEADTOOLS will not restrict the tags that you write. If you write bad tags, the file might become corrupted. Consult the TIFF documentation for a list of predefined tags. It is recommended that you write only the user-defined tags (the tags between 0x8000 and 0xFFFF).

See the TIFF documentation for a complete list of the TIFF tags and types.

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 topic for more information.

Example

For an example, refer to DeleteTag.

Requirements

Target Platforms