| IFileTypeManagerGetAllMatchingFileTypeDefinitions Method |
Returns the file type definitions that can operate on the specified file.
Each file type definition is evaluated in order to determine if it can process the file,
which may involve invoking the corresponding file sniffer.
Only file type definitions that are enabled and not hidden are evaluated.
Namespace: Sdl.FileTypeSupport.Framework.IntegrationApiAssembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
SyntaxIEnumerable<Pair<IFileTypeDefinition, SniffInfo>> GetAllMatchingFileTypeDefinitions(
string nativeFilePath,
EventHandler<MessageEventArgs> messageHandler
)
Function GetAllMatchingFileTypeDefinitions (
nativeFilePath As String,
messageHandler As EventHandler(Of MessageEventArgs)
) As IEnumerable(Of Pair(Of IFileTypeDefinition, SniffInfo))
IEnumerable<Pair<IFileTypeDefinition^, SniffInfo^>^>^ GetAllMatchingFileTypeDefinitions(
String^ nativeFilePath,
EventHandler<MessageEventArgs^>^ messageHandler
)
abstract GetAllMatchingFileTypeDefinitions :
nativeFilePath : string *
messageHandler : EventHandler<MessageEventArgs> -> IEnumerable<Pair<IFileTypeDefinition, SniffInfo>>
Parameters
- nativeFilePath
- Type: SystemString
The path to the file which is 'sniffed' in order to determine applicable file type definitions. - messageHandler
- Type: SystemEventHandlerMessageEventArgs
Optional handler for messages reported by any file sniffers invoked in the process.
You may pass null for this parameter.
Return Value
Type:
IEnumerablePairIFileTypeDefinition,
SniffInfoFile type definitions that can operate on the file specified, and the information
from their file sniffers
Remarks
If more than one file type definition is returned, the order corresponds to the order
in which the definitions appear in the manager.
If all file types are enabled, the first file type definition
returned is the one that is used if calling one of the GetConverter overloads.
Any messages generated during file sniffing are reported to the optional messageHandler.
See Also
Comments