IFsrmClassificationManager::RunClassification method

[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

context [in]

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.

reserved [in]

Must be NULL.

Return value

The method returns the following return values.

Return codeDescription
S_OK

Success

FSRM_E_REPORT_JOB_ALREADY_RUNNING

The classification is already running or is queued to run.

E_INVALIDARG

The context is not valid.

 

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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

Header

FsrmPipeline.h (include FsrmPipeline.h or FsrmTlb.h)

DLL

SrmSvc.dll

CLSID

CLSID_FsrmClassificationManager is defined as b15c0e47-c391-45b9-95c8-eb596c853f3a

IID

IID_IFsrmClassificationManager is defined as d2dc89da-ee91-48a0-85d8-cc72a56f7d04

IID_IFsrmClassificationManager2 is defined as 0004c1c9-127e-4765-ba07-6a3147bca112

See also

IFsrmClassificationManager2
IFsrmClassificationManager
FsrmClassificationManager
MSFT_FSRMClassification

 

 

Show:
© 2014 Microsoft. All rights reserved.