←Select platform

GetInfo(Stream) Method

Summary

Gets information about the specified annotation file stored in a stream.

Syntax

C#
VB
WinRT C#
C++
public AnnCodecsInfo GetInfo( 
   Stream stream 
) 
Public Overloads Function GetInfo( _ 
   ByVal stream As Stream _ 
) As Leadtools.Annotations.Core.AnnCodecsInfo 
 function Leadtools.Annotations.Core.AnnCodecs.GetInfo(Stream)(  
   stream  
) 
public:  
   AnnCodecsInfo^ GetInfo( 
      Stream^ stream 
   ) 

Parameters

stream
Stream containing annotations data previously saved with AnnCodecs.Save. This value cannot be null.

Return Value

An AnnCodecsInfo object that will be updated with information about the specified annotation file.

Remarks

If stream contains valid LEADTOOLS annotations data, then this method will return an instance of AnnCodecsInfo containing the following:

Member Description
Format

Set to AnnFormat.Annotations

Version

Set to the version of the LEADTOOLS Annotations file format. Currently, this will be 1.0

Pages

Set to an array of integer values containing the page numbers of the annotations containers found in the data.

If stream does not contain valid LEADTOOLS annotations data, then this method will return instance of AnnCodecsInfo with Format set to AnnFormat.Unknown.

If stream is null or does not contain valid annotations XML data, then an exception will be thrown.

Example

For an example, refer to AnnCodecs

Requirements

Target Platforms

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Core Assembly