Click or drag to resize
INativeFileParser Interface
This interface is implemented by all native file parsers. The framework uses this interface to operate the parser.

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
public interface INativeFileParser : INativeFileTypeComponent, 
	IParser, IDisposable

The INativeFileParser type exposes the following members.

Methods
  NameDescription
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodParseNext
This method is called repeatedly by the framework to process the next chunk of input. The implementation should parse a suitable (preferably not too large) chunk of the input, and return a boolean value that indicates whether there is more work to be done before this file is completely parsed.
(Inherited from IParser.)
Top
Properties
  NameDescription
Public propertyMessageReporter
The framework will set this property as part of initialization of the file type component. File type components use this interface to report any non-critical issues to the framework. (Critical issues are reported by throwing a FileTypeSupportException or a derived type.)
(Inherited from INativeFileTypeComponent.)
Public propertyOutput
The framework sets this property before the first call to ParseNext in order to specify the component that will process the output from the parser. The parser implementation should send the whole output to this object.
Public propertyPropertiesFactory
The framework will set this property as part of the initialization of the file type component. File type components should use this factory to create the property objects that are used when outputting to the INativeExtractionContentHandler.
(Inherited from INativeFileTypeComponent.)
Top
Events
  NameDescription
Public eventProgress
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.
(Inherited from IParser.)
Top
Remarks
The parser must retrieve the name of the input file to be processed by implementing the INativeContentCycleAware interface. The input file name can be retrieved from the OriginalFilePath property of the file conversion properties object passed to the component by the framework through the SetFileProperties(IFileProperties) method.
See Also
Community
Edit
Be the first to Edit the community content of this topic.
Comments