GetInfoAsync Method

Summary

Gets information about the specified annotation file.

Syntax

WinRT C#

public Task<AnnCodecsInfo> GetInfoAsync(  
   StorageFile file 
)

Public Function GetInfoAsync( _ 
   ByVal file As StorageFile _ 
) As Task(Of AnnCodecsInfo)

public Task<AnnCodecsInfo> GetInfoAsync(  
   StorageFile file 
)

 function Leadtools.Annotations.Core.AnnCodecs.GetInfoAsync(  
   file  
)

file
Windows Runtime StorageFile containing annotations data previously saved with SaveAsync. This value cannot be null.

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

Remarks

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

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

Requirements