Click or drag to resize
IFileTypeDefinitionSniffFile Method
Called by the file type manager to perform file sniffing in order to determine whether the file can be supported by this file type definition.

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)
Syntax
SniffInfo SniffFile(
	string nativeFilePath,
	Language suggestedSourceLanguage,
	Codepage suggestedCodepage,
	INativeTextLocationMessageReporter messageReporter,
	ISettingsBundle settingsBundle
)

Parameters

nativeFilePath
Type: SystemString

[Missing <param name="nativeFilePath"/> documentation for "M:Sdl.FileTypeSupport.Framework.IntegrationApi.IFileTypeDefinition.SniffFile(System.String,Sdl.Core.Globalization.Language,Sdl.Core.Globalization.Codepage,Sdl.FileTypeSupport.Framework.NativeApi.INativeTextLocationMessageReporter,Sdl.Core.Settings.ISettingsBundle)"]

suggestedSourceLanguage
Type: Language

[Missing <param name="suggestedSourceLanguage"/> documentation for "M:Sdl.FileTypeSupport.Framework.IntegrationApi.IFileTypeDefinition.SniffFile(System.String,Sdl.Core.Globalization.Language,Sdl.Core.Globalization.Codepage,Sdl.FileTypeSupport.Framework.NativeApi.INativeTextLocationMessageReporter,Sdl.Core.Settings.ISettingsBundle)"]

suggestedCodepage
Type: Codepage

[Missing <param name="suggestedCodepage"/> documentation for "M:Sdl.FileTypeSupport.Framework.IntegrationApi.IFileTypeDefinition.SniffFile(System.String,Sdl.Core.Globalization.Language,Sdl.Core.Globalization.Codepage,Sdl.FileTypeSupport.Framework.NativeApi.INativeTextLocationMessageReporter,Sdl.Core.Settings.ISettingsBundle)"]

messageReporter
Type: Sdl.FileTypeSupport.Framework.NativeApiINativeTextLocationMessageReporter
Optional message reporter; if specified, it may be used by the file sniffer to report peculiarities detected in the file
settingsBundle
Type: ISettingsBundle
This settings bundle may be used by the file type Definition implementation to retrieve a settings group, and pass it to the file sniffer through the ISettingsAware implementation.

Return Value

Type: SniffInfo

[Missing <returns> documentation for "M:Sdl.FileTypeSupport.Framework.IntegrationApi.IFileTypeDefinition.SniffFile(System.String,Sdl.Core.Globalization.Language,Sdl.Core.Globalization.Codepage,Sdl.FileTypeSupport.Framework.NativeApi.INativeTextLocationMessageReporter,Sdl.Core.Settings.ISettingsBundle)"]

See Also
Community
Edit
Be the first to Edit the community content of this topic.
Comments