3.2.4.2.33.7 GetDefaultFilter (Opnum 13)

  • 2 minutes to read

The GetDefaultFilter method returns the current value of the specified report filter for the specified report type.

 [id(FSRM_DISPID_REPORT_MANAGER | 0x07)] HRESULT GetDefaultFilter(
   [in] FsrmReportType reportType,
   [in] FsrmReportFilter filter,
   [out, retval] VARIANT* filterValue
 );

reportType: Contains the value from the FsrmReportType (section 2.2.1.2.10) enumeration.

filter: Contains the value from the FsrmReportFilter (section 2.2.1.2.16) enumeration.

filterValue: Pointer to a variable that upon completion contains the value of the specified filter for the specified report type.

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

Return value/code

Description

0x80070057

E_INVALIDARG

This code is returned for the following reasons:

  • The reportType parameter is not a valid FsrmReportType (section 2.2.1.2.10) value.

  • The filter parameter is not a valid FsrmReportFilter (section 2.2.1.2.16) value.

  • The filterValue parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that filterValue is not NULL.

  • Verify that reportType contains a valid FsrmReportType value. If reportType is FsrmReportType_Unknown, the parameter MUST be considered an invalid value.

  • Verify that filter contains a valid FsrmReportFilter value.

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

The server MUST set filterValue to the current filter value for the specified report filter and report type.