3.2.4.2.48.35 RunningStatus (get) (Opnum 45)

The RunningStatus (get) method returns the current running status of the file management job as defined in the FsrmReportRunningStatus (section 2.2.1.2.13) enumeration and returns S_OK upon successful completion.

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x13))] HRESULT RunningStatus(
   [out, retval] FsrmReportRunningStatus* runningStatus
 );

runningStatus: A pointer to a variable that upon completion contains the current running status of the file management job.

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

Return value/code

Description

0x80070057

E_INVALIDARG

The runningStatus parameter is NULL.

Upon receiving this message, the server MUST validate the parameters:

  • Verify that runningStatus is not NULL.

If any validation fails, the server MUST terminate processing and return a nonzero error code.

The parent instance of the Running Job in the Running File Management Job Queue whose Name is equivalent to the Name of this instance will be referred to as the associated file management task.

The server MUST do one of the following or return a nonzero error code:

  • Set runningStatus to FsrmReportRunningStatus_Running if there is an associated file management task for the file management job.

  • Set runningStatus to the file management job's current running status if there is no associated file management task.