IFsrmClassificationManager2 Interface

 

Manages file classification. Use this interface to define properties to use in classification, add classification rules for classifying files, define classification and storage modules, and enable classification reporting.

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

Syntax

[GuidAttribute("0004C1C9-127E-4765-BA07-6A3147BCA112")]
public interface IFsrmClassificationManager2 : IFsrmClassificationManager
[GuidAttribute("0004C1C9-127E-4765-BA07-6A3147BCA112")]
public interface class IFsrmClassificationManager2 : IFsrmClassificationManager
[<GuidAttribute("0004C1C9-127E-4765-BA07-6A3147BCA112")>]
type IFsrmClassificationManager2 = 
    interface
        interface IFsrmClassificationManager
    end
<GuidAttribute("0004C1C9-127E-4765-BA07-6A3147BCA112")>
Public Interface IFsrmClassificationManager2
    Inherits IFsrmClassificationManager

Properties

Name Description
System_CAPS_pubproperty ClassificationLastError

Gets the ClassificationLastError property.

System_CAPS_pubproperty ClassificationLastReportPathWithoutExtension

Gets the ClassificationLastReportPathWithoutExtension property.

System_CAPS_pubproperty ClassificationReportEnabled

Gets and sets the ClassificationReportEnabled property.

System_CAPS_pubproperty ClassificationReportFormats

Gets and sets the ClassificationReportFormats property.

System_CAPS_pubproperty ClassificationReportMailTo

Gets and sets the ClassificationReportMailTo property.

System_CAPS_pubproperty ClassificationRunningStatus

Gets the ClassificationRunningStatus property.

System_CAPS_pubproperty Logging

Gets and sets the Logging property.

Methods

Name Description
System_CAPS_pubmethod CancelClassification()

Cancels classification if it is running.

System_CAPS_pubmethod ClassifyFiles(Object[], Object[], Object[], _FsrmGetFilePropertyOptions)

This method is used to perform bulk enumeration, setting, and clearing of file properties.

System_CAPS_pubmethod ClearFileProperty(String, String)

Attempts to remove the specified property from the file or folder.

System_CAPS_pubmethod CreateModuleDefinition(_FsrmPipelineModuleType)

Creates a module definition of the specified type.

System_CAPS_pubmethod CreatePropertyDefinition()

Creates a property definition.

System_CAPS_pubmethod CreateRule(_FsrmRuleType)

Creates a rule of the specified type.

System_CAPS_pubmethod EnumFileProperties(String, _FsrmGetFilePropertyOptions)

Enumerates the properties of the specified file.

System_CAPS_pubmethod EnumModuleDefinitions(_FsrmPipelineModuleType, _FsrmEnumOptions)

Enumerates the module definitions of the specified type.

System_CAPS_pubmethod EnumPropertyDefinitions(_FsrmEnumOptions)

Enumerates the property definitions.

System_CAPS_pubmethod EnumRules(_FsrmRuleType, _FsrmEnumOptions)

Enumerates the rules of the specified type.

System_CAPS_pubmethod GetFileProperty(String, String, _FsrmGetFilePropertyOptions)

Retrieves the specified property from the file or folder.

System_CAPS_pubmethod GetModuleDefinition(String, _FsrmPipelineModuleType)

Retrieves the specified module definition.

System_CAPS_pubmethod GetPropertyDefinition(String)

Retrieves the specified property definition.

System_CAPS_pubmethod GetRule(String, _FsrmRuleType)

Retrieves the specified rule.

System_CAPS_pubmethod RunClassification(_FsrmReportGenerationContext, String)

Runs classification rules and generates the classification report.

System_CAPS_pubmethod SetFileProperty(String, String, String)

Sets the value of the specified property in the file or folder.

System_CAPS_pubmethod WaitForClassificationCompletion(Int32)

Waits for the specified period of time or until classification has finished running.

Remarks

To get this interface, call the CoCreateInstanceEx function. Use CLSID_FsrmClassificationManager as the class identifier and __uuidof(IFsrmClassificationManager2) as the interface identifier or use the use the "Fsrm.FsrmClassificationManager" program identifier.

For an example that demonstrates this interface see Classifying Files.

See Also

FsrmClassificationManager
Microsoft.Storage Namespace

Return to top