←Select platform

ReadTags(Stream,int) Method

Summary

Reads all the tags stored in a TIFF file.

Syntax
C#
VB
Objective-C
C++
Java
public IList<RasterTagMetadata> ReadTags( 
   Stream stream, 
   int pageNumber 
) 
Public Overloads Function ReadTags( _ 
   ByVal stream As Stream, _ 
   ByVal pageNumber As Integer _ 
) As IList(Of RasterTagMetadata) 
- (nullable NSArray<LTRasterTagMetadata *> *)readTagsFromStream:(LTLeadStream *)stream  
                                                     pageNumber:(NSInteger)pageNumber  
                                                          error:(NSError **)error 
public List<RasterTagMetadata> readTags(ILeadStream stream, int pageNumber) 
public: 
IList<RasterTagMetadata^>^ ReadTags(  
   Stream^ stream, 
   int pageNumber 
)  

Parameters

stream
A Stream containing the input image data.

pageNumber
1-based index of the page from which to read the tags.

Return Value

A collection of RasterTagMetadata containing all the tags found in the file. If the file does not contain any tags, an empty collection will be returned. If the file format does not support tags, an exception will be thrown.

Remarks

To read a specific tag stored in a file, use ReadTag and to enumerate all the tag ids (but not the data) stored in a file use EnumTags.

This method will throw an exception if the file format does not support tags. To determine whether a file format supports tags, use TagsSupported. You can also automatically load all the tags stored in a file during a load operation by setting the CodecsLoadOptions.Tags property to true. The tags data will be stored in the resulting image RasterImage.Tags collection.

To load all the tags stored in a disk file, use ReadTags.

Example

For an example, refer to ReadTags.

Requirements

Target Platforms

Help Version 20.0.2019.12.5
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Codecs Assembly