GetFilter (Opnum 13)

The GetFilter method returns the current value of the specified report filter for the report object.

 [id(FSRM_DISPID_REPORT | 0x01)] HRESULT GetFilter(
   [in] FsrmReportFilter filter,
   [out, retval] VARIANT* filterValue

filter: Contains the value from the FsrmReportFilter (section enumeration of the filter to get.

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




This code is returned for the following reasons:

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

  • The filterValue parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that filterValue is not NULL.

  • 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 value for the specified report filter.