Windows Dev Center

IFsrmFileManagementJob::Run method

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

Runs the job.

Syntax


HRESULT Run(
  [in] FsrmReportGenerationContext context
);

Parameters

context [in]

Specifies to which subdirectory the reports or logging are written, if enabled. For possible values, see the FsrmReportGenerationContext enumeration.

Return value

The method returns the following return values.

Return codeDescription
S_OK

Success

FSRM_E_REPORT_JOB_ALREADY_RUNNING

The report job is already running or is queued to run.

E_INVALIDARG

The context is not valid.

 

Remarks

Since the file management job consumes the results of classification, running the file management job also runs classification.

The jobs are run asynchronously. Jobs that run in the scheduled context remain in the queue for five minutes before they are run; jobs that run in the other contexts remain in the queue for 30 seconds. To block your code until the job completes, calling the IFsrmFileManagementJob::WaitForCompletion method. Calling WaitForCompletion removes the job from the queue and runs it immediately.

If you call this method and the job is already queued or running, the method returns an error. To determine the status of the job, access the IFsrmReportJob::RunningStatus property.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

DLL

SrmSvc.dll

IID

IID_IFsrmFileManagementJob is defined as 0770687e-9f36-4d6f-8778-599d188461c9

See also

IFsrmFileManagementJob
MSFT_FSRMFileManagementJob

 

 

Show:
© 2015 Microsoft