Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
ReadTags(Stream,Int32) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > ReadTags Method : ReadTags(Stream,Int32) Method



stream
A Stream containing the input image data.
pageNumber
1-based index of the page from which to read the tags.
Reads all the tags stored in a TIFF file.

Syntax

Visual Basic (Declaration) 
Public Overloads Function ReadTags( _
   ByVal stream As Stream, _
   ByVal pageNumber As Integer _
) As RasterCollection(Of RasterTagMetadata)
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim stream As Stream
Dim pageNumber As Integer
Dim value As RasterCollection(Of RasterTagMetadata)
 
value = instance.ReadTags(stream, pageNumber)
C# 
public RasterCollection<RasterTagMetadata> ReadTags( 
   Stream stream,
   int pageNumber
)
C++/CLI 
public:
RasterCollection<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.

Example

For an example, refer to RasterCodecs.ReadTags(String,Int32).

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 check if a file format supports tags, use RasterCodecs.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 result image RasterImage.Tags collection.

To load all the tags stored in a disk file, use RasterCodecs.ReadTags(String,Int32).

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also