3.2.4.2.48.19 Formats (put) (Opnum 29)

  • Article

The Formats (put) method sets the list of report formats that the file management job will create when the file management job is run and returns S_OK upon successful completion.

 [propput, id(FSRM_PROPERTY(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x0a))] HRESULT Formats(
   [in] SAFEARRAY(VARIANT) formats
 );

formats: Contains the array of report formats that will be created when the file management job is run.

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

Return value/code

Description

0x80070057

E_INVALIDARG

One or more values specified in the formats parameter is not a valid FsrmReportFormat (section 2.2.1.2.14) value.

Upon receiving this message, the server MUST validate parameters:

  • Verify that formats contains valid FsrmReportFormat (section 2.2.1.2.14) values. If any one of the formats is FsrmReportFormat_Unknown, the parameter MUST be considered an invalid value.

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

 The server MUST set the File Management Job.Formats list on the file management job object.