←Select platform

GetInfoFromString Method

Summary

Gets information about the specified annotation xml data.

Syntax
C#
VB
Objective-C
C++
Java
public AnnCodecsInfo GetInfoFromString( 
   string xmlData 
) 
Public Function GetInfoFromString( _ 
   ByVal xmlData As String _ 
) As AnnCodecsInfo 
-(LTAnnInfo*) getInfoFromString:(NSString*)xmlData; 
public AnnCodecsInfo getInfoFromString(string xmlData) 
public:  
   AnnCodecsInfo^ GetInfoFromString( 
      String^ xmlData 
   ) 

Parameters

xmlData
String annotations data previously saved with AnnCodecs.SaveToString. This value cannot be null.

Return Value

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

Remarks

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

If xmlData 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

See Also

Reference

AnnCodecs Class

AnnCodecs Members

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

Leadtools.Annotations.Engine Assembly