3.2.4.2.33.3 GetReportJob (Opnum 9)

  • Article

The GetReportJob method returns the report job associated with the specified task name from the List of Persisted Report Jobs (section 3.2.1.5).

 [id(FSRM_DISPID_REPORT_MANAGER | 0x03)] HRESULT GetReportJob(
   [in] BSTR taskName,
   [out, retval] IFsrmReportJob** reportJob
 );

taskName: Contains the task name for which the server will return the associated report job object. The maximum length of this string MUST be 230 characters.

reportJob: Pointer to an IFsrmReportJob interface pointer (section 3.2.4.2.34) that upon completion contains a pointer to the report job object for the task name specified. The caller MUST release the report job when the caller is done with it.

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

Return value/code

Description

0x80045301

FSRM_E_NOT_FOUND

The specified report job could not be found.

0x80070057

E_INVALIDARG

This code is returned for the following reasons:

  • The taskName parameter is NULL.

  • The reportJob parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that taskName is not NULL.

  • Verify that reportJob is not NULL.

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

Upon successful validation of parameters, the server MUST perform the following actions or return a nonzero error code.

If a report job does not exist that is associated with the specified task name, the server MUST return FSRM_E_NOT_FOUND.