3.2.4.2.45.11 ClassificationRunningStatus (get) (Opnum 17)

  • Article

The ClassificationRunningStatus (get) method retrieves the current running status of the running classification task, if present, 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_CLASSIFICATION_MANAGER|0x07))] HRESULT ClassificationRunningStatus(
   [out, retval] FsrmReportRunningStatus* runningStatus
 );

runningStatus:  A pointer to a variable that upon completion contains the current running status of the running classification task.

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 this parameter:

  • Verify that runningStatus is not NULL.

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

The server MUST set runningStatus to the Default Classification Job's current running status.