3.2.4.2.48.17 ReportEnabled (put) (Opnum 27)

The ReportEnabled (put) method sets the report enabled property of the file management job. The report enabled property determines if the file management job will generate a report when it is run.

 [propput, id(FSRM_PROPERTY(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x09))] HRESULT ReportEnabled(
   [in] VARIANT_BOOL reportEnabled
 );

reportEnabled: Contains a Boolean value for the report enabled property for this 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 reportEnabled parameter is not a valid variant type. Variant type is considered invalid if it not of type VT_BOOL, either VT_TRUE or VT_FALSE.

Upon receiving this message, the server MUST validate parameters:

  • Verify that reportEnabled is of type VT_BOOL and is set to either VT_TRUE or VT_FALSE.

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

The server must set the report enabled property of the file management task to true if reportEnabled equals VARIANT_TRUE and false otherwise.