Stop method of the MSFT_FSRMStorageReport class

Stops the execution of the provided storage report on the server.

If the provided storage report is:

  • Not currently actively running on the server: Returns success.
  • Currently canceling on the server: Returns success.
  • Currently running on the server: Upon successfully starting the cancellation of the report, returns success.
  • Currently queued on the server: Upon successfully removing the report from the queue, returns success.

If a running or queued storage report on the server is unable to be stopped, the following error will be returned: "The report running against <paths> could not be stopped."

Syntax

uint64 Stop(
  [out] MSFT_FSRMStorageReport StorageReport
);

Parameters

StorageReport [out]

Returns an instance of the MSFT_FSRMStorageReport class representing the storage report.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\Microsoft\Windows\FSRM
MOF
MSFT_FSRM.mof
DLL
SrmSvc.dll

See also

MSFT_FSRMStorageReport