SniffInfo Class

SniffInfo Class

Information returned from Sniff(String, Language, Codepage, INativeTextLocationMessageReporter, ISettingsGroup). This class also allows you to store key/value pairs that the parser may need to read during parsing.

Inheritance Hierarchy

SystemObject
Sdl.FileTypeSupport.Framework.NativeApiSniffInfo

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

Syntax

C++

Copy

[SerializableAttribute]
public class SniffInfo : IMetaDataContainer, ICloneable, 
	ISupportsPersistenceId

<SerializableAttribute>
Public Class SniffInfo
	Implements IMetaDataContainer, ICloneable, ISupportsPersistenceId

[SerializableAttribute]
public ref class SniffInfo : IMetaDataContainer, 
	ICloneable, ISupportsPersistenceId

[<SerializableAttribute>]
type SniffInfo =  
    class
        interface IMetaDataContainer
        interface ICloneable
        interface ISupportsPersistenceId
    end

The SniffInfo type exposes the following members.

Constructors

	Name	Description
	SniffInfo	Default constructor, creates an uninitialized object where IsSupported is false and DetectedEncoding is null.
	SniffInfo(SniffInfo)	Copy constructor used by the Clone() method. Performs a deep clone of the other object.

Top

Properties

	Name	Description
	DetectedEncoding	If the file sniffer detects or guesses which encoding is used in the file, it may communicate this to the other parser components by setting this property.
	DetectedSourceLanguage	If the file sniffer detects or guesses the source language in the file, it can be communicated to the framework by setting this property.
	DetectedTargetLanguage	If the file sniffer detects or guesses the target language of a bilingual file, it can be communicated to the framework by setting this property.
	HasMetaData	True if there are any key/value pairs of metadata in the sniff info
	IsSupported	The file sniffer sets this property to true in order to indicate that the corresponding file type definition can be used for processing this file.
	Item	Convenience getter and setter for metadata using indexer syntax. The getter functionality is equivalent to calling SetMetaData(String, String), the setter functionality is equivalent to GetMetaData(String).
	MetaData	Iterator for all metadata key/value pairs
	MetaDataCount	Number of key/value pairs of metadata
	PersistenceId	The persistence ID associated with an object may be used by implementations during operations such as serialization and de-serialization of the object model.
	SuggestedTargetEncoding	The file sniffer's suggestion on what type of encoding would be suitable when generating a translated version of this file.

Top

Methods

	Name	Description
	ClearMetaData	Removes all metadata key/value pairs.
	Clone	Deep clone this object
	Equals	True if all properties and values are equal. (Overrides ObjectEquals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Computed by combining all properties and values (Overrides ObjectGetHashCode.)
	GetMetaData	Retrieves the metadata value for the specified key
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MetaDataContainsKey	Determines if a metadata value exists for the specified key
	RemoveMetaData	Removes the metadata value for the specified key from the collection. If no value exists for this key, nothing will happen.
	SetMetaData	Sets the metadata value for the specified key
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Communicates whether the file is considered valid by the file sniffer; may contain additional information such as the detected source and target languages, encoding of the file, etc.

Custom metadata can also be stored and accessed via the IMetaDataContainer implementation.

If the file type is supported and further processed, this information is passed to all file processing components that implement INativeContentCycleAware as the FileSnifferInfo when the framework calls SetFileProperties(IFileProperties).

Reference

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 https://community.sdl.com/developers/language-developers/