IFsrmClassificationManager::RunClassification method (fsrmpipeline.h)

Article
10/13/2021

[This method is supported for compatibility but it's recommended to use the FSRM WMI Classes to manage FSRM. Please see the MSFT_FSRMClassification class.]

Runs classification rules and generates the classification report.

Syntax

HRESULT RunClassification(
  [in] FsrmReportGenerationContext context,
  [in] BSTR                        reserved
);

Parameters

[in] context

Specifies the report subdirectory to which the classification report is written. For possible values, see the FsrmReportGenerationContext enumeration. To set the report directory, call the IFsrmReportManager::SetOutputDirectory method.

[in] reserved

Must be NULL.

Return value

The method returns the following return values.

Remarks

To run classification, there must be at least one property defined, at least one rule that references one of the defined properties, and a registered classification module.

If you call this method and the classification is already queued or running, the method returns an error. To determine whether classification is running, access the IFsrmClassificationManager.ClassificationRunningStatus property. To determine whether classification was successful, access the ClassificationLastError property.

Classification generates the classification report only if reporting is enabled (see the IFsrmClassificationManager.ClassificationReportEnabled property).

To run classification on a schedule, use the Task Scheduler. Create a version 1.0 task. The command to run is C:\Windows\System32\StorRept.exe. Specify "classification run" as the arguments to StorRept.exe. StorRept.exe uses the FsrmReportGenerationContext_ScheduledReport reporting context.

FSRM does not apply the classification rule if the rule, file, and cache are valid and have not changed.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2
Target Platform	Windows
Header	fsrmpipeline.h (include FsrmPipeline.h, FsrmTlb.h)
DLL	SrmSvc.dll