IFsrmPipelineModuleDefinition interface (fsrmpipeline.h)
Defines a module that is used to classify files or store and retrieve properties from files.
To create a module definition, call the IFsrmClassificationManager::CreateModuleDefinition method.
The following methods return this interface:
This is the base class for module definition interfaces. Query this interface to get the interface for the module type specified in the ModuleType property. For example, if ModuleType is FsrmPipelineModuleType_Classifier, query this interface for the IFsrmClassifierModuleDefinition interface.Inheritance
The IFsrmPipelineModuleDefinition interface inherits from the IFsrmObject interface.
Methods
The IFsrmPipelineModuleDefinition interface has these methods.
| IFsrmPipelineModuleDefinition::get_Account The account to use when running the module. (Get) |
| IFsrmPipelineModuleDefinition::get_Company The name of the company that created the classification or storage module. (Get) |
| IFsrmPipelineModuleDefinition::get_Enabled Determines whether the module is enabled. (Get) |
| IFsrmPipelineModuleDefinition::get_ModuleClsid A string representation specifying the COM class identifier for the class that implements the module defined by this module definition. (Get) |
| IFsrmPipelineModuleDefinition::get_ModuleType The type of module. |
| IFsrmPipelineModuleDefinition::get_Name The name of the module definition. (Get) |
| IFsrmPipelineModuleDefinition::get_NeedsFileContent Determines whether the module needs to read the contents of the file. (Get) |
| IFsrmPipelineModuleDefinition::get_Parameters The optional parameters to pass to the module. (Get) |
| IFsrmPipelineModuleDefinition::get_SupportedExtensions The list of file extensions supported by this module. (Get) |
| IFsrmPipelineModuleDefinition::get_Version The version of the module definition. (Get) |
| IFsrmPipelineModuleDefinition::put_Account The account to use when running the module. (Put) |
| IFsrmPipelineModuleDefinition::put_Company The name of the company that created the classification or storage module. (Put) |
| IFsrmPipelineModuleDefinition::put_Enabled Determines whether the module is enabled. (Put) |
| IFsrmPipelineModuleDefinition::put_ModuleClsid A string representation specifying the COM class identifier for the class that implements the module defined by this module definition. (Put) |
| IFsrmPipelineModuleDefinition::put_Name The name of the module definition. (Put) |
| IFsrmPipelineModuleDefinition::put_NeedsFileContent Determines whether the module needs to read the contents of the file. (Put) |
| IFsrmPipelineModuleDefinition::put_Parameters The optional parameters to pass to the module. (Put) |
| IFsrmPipelineModuleDefinition::put_SupportedExtensions The list of file extensions supported by this module. (Put) |
| IFsrmPipelineModuleDefinition::put_Version The version of the module definition. (Put) |
Remarks
The name and module type identify a unique module (a classifier module and storage module can use the same name).
When de-registering a module programmatically (calling Delete followed by Commit), the developer should ensure that there are no active classification rules that use that module. If this is not properly performed, the rules will produce errors during classification runs and the UI will reflect a module that is no longer available.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2008 R2 |
| Target Platform | Windows |
| Header | fsrmpipeline.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, FsrmScreen.h) |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for