3.2.4.2.48.18 Formats (get) (Opnum 28)

  • Article

The Formats (get) method retrieves an array of report formats that will be created when the file management job is run and returns S_OK upon successful completion.

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x0a))] HRESULT Formats(
   [out, retval] SAFEARRAY(VARIANT)* formats
 );

formats: Pointer to a variable that upon completion 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

The formats parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that formats is not NULL.

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

 The server MUST set the formats array to the File Management Job.Formats list that the file management job will create when it is run.