GetInfo(string) Method

Summary

Gets information about the specified annotation file.

Syntax

Objective-C

C++

Java

public AnnCodecsInfo GetInfo( 
   string fileName 
)

Public Overloads Function GetInfo( _ 
   ByVal fileName As String _ 
) As AnnCodecsInfo

-(LTAnnInfo*) getInfo:(NSString*)fileName;

public AnnCodecsInfo getInfo(String xmlData)

public:  
   AnnCodecsInfo^ GetInfo( 
      String^ fileName 
   )

fileName
Name of the file containing annotations data previously saved with AnnCodecs.Save. This value cannot be null.

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

Remarks

If fileName 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 fileName does not contain valid LEADTOOLS annotations data, then this method will return instance of AnnCodecsInfo with Format set to AnnFormat.Unknown.

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

Example

For an example, refer to AnnCodecs

Requirements