IParser.Progress Event

IParserProgress Event

The parser fires this event at regular intervals in order to report the progress so that interested parties can ascertain whether the parsing process is indeed in progress and has not hung. That way users get an idea about how fast the parsing job is progressing. Framework consumers should typically not connect directly to this event, but rather connect to the corresponding event on the IFileConverter instance.

Namespace: Sdl.FileTypeSupport.Framework.NativeApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)

Syntax

C++

Copy

event EventHandler<ProgressEventArgs> Progress

Event Progress As EventHandler(Of ProgressEventArgs)

 event EventHandler<ProgressEventArgs^>^ Progress {
	void add (EventHandler<ProgressEventArgs^>^ value);
	void remove (EventHandler<ProgressEventArgs^>^ value);
}

abstract Progress : IEvent<EventHandler<ProgressEventArgs>,
    ProgressEventArgs>

Value

Type: SystemEventHandlerProgressEventArgs

Remarks

Progress is reported in integer percentage values. It is not an error when a parser reports the same percentage number in subsequent events. This just indicates to the listeners that the progress is slow but the component is still working on it. It is unusual (but not unthinkable) that a percentage value can decrease. This could happen if the parser gets a better estimate of the job size (e.g. when it needs to parse dependency files, too). It is customary for a parser to fire this event with a percentage value of 0 when parsing is about to begin and with a percentage value of 100 when parsing is finished.

Reference

IParser Interface

Sdl.FileTypeSupport.Framework.NativeApi Namespace

Community

Edit

Be the first to Edit the community content of this topic.

Comments

Send comments on this topic to sdk-feedback@sdl.com