IFsrmPipelineModuleDefinition interface

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.

Members

The IFsrmPipelineModuleDefinition interface inherits from IFsrmObject. IFsrmPipelineModuleDefinition also has these types of members:

Properties

The IFsrmPipelineModuleDefinition interface has these properties.

PropertyAccess typeDescription

Account

Read/write

The account to use when running the classification module.

Company

Read/write

The name of the company that created the classification or storage module.

Enabled

Read/write

Determines whether the module is enabled.

ModuleClsid

Read/write

A string representation specifying the COM class identifier for the class that implements the module defined by this module definition.

ModuleType

Read-only

The type of module.

Name

Read/write

The name of the module definition.

NeedsFileContent

Read/write

Determines whether the module needs access to the contents of the file.

Parameters

Read/write

The parameters for the pipeline module definition.

SupportedExtensions

Read/write

The list of file extensions that this module supports.

Version

Read/write

The version of the module definition.

 

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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

Header

Fsrm.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, or FsrmScreen.h)

DLL

SrmSvc.dll

IID

IID_IFsrmPipelineModuleDefinition is defined as 515c1277-2c81-440e-8fcf-367921ed4f59

See also

IFsrmClassifierModuleDefinition
IFsrmStorageModuleDefinition

 

 

Show:
© 2014 Microsoft