3.2.4.2.35.8 SetFilter (Opnum 14)

  • Article

The SetFilter method sets the value of the specified report filter for the report object. The filter value will override the default value set by using the IFsrmReportManager::SetDefaultFilter (section 3.2.4.2.33.8) method.

 [id(FSRM_DISPID_REPORT | 0x02)] HRESULT SetFilter(
   [in] FsrmReportFilter filter,
   [in] VARIANT filterValue
 );

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

filterValue: 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 filter parameter is not a valid FsrmReportFilter (section 2.2.1.2.16) value.

  • An attempt was made to set the FsrmReportFilter_Property filter value with a supplied value that is not in a valid property name format, or the property does not exist.

  • The variant does not have the correct member set for the filter.

  • The string filter values are not valid characters.

Upon receiving this message, the server MUST validate parameters:

  • Verify that filter contains a valid FsrmReportFilter value.

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

If filter is FsrmReportFilter_Property, the server MUST perform the following actions:

The server MUST set the value of the specified filter for the report object to filterValue or return a nonzero error code.