3.2.4.2.48.6 Enabled (get) (Opnum 16)

The Enabled (get) method retrieves a value that indicates whether the file management job is enabled and returns S_OK upon successful completion.

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x03))] HRESULT Enabled(
   [out, retval] VARIANT_BOOL* enabled
 );

enabled: Pointer to a variable that upon completion contains the Boolean indication of whether the file management job is enabled.

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

Return value/code

Description

0x80070057

E_INVALIDARG

The enabled parameter is NULL

Upon receiving this message, the server MUST validate parameters:

  • Verify that enabled is not NULL.

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

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

  • Set enabled to the value VARIANT_TRUE if Enabled/disabled is set to enabled for the file management job.

  • Set enabled to the value VARIANT_FALSE if Enabled/disabled is set to disabled for the file management job.