Edit

IFsrmReport::SetFilter method (fsrmreports.h)

  • Article

Sets the current value of the specified report filter.

Syntax

HRESULT SetFilter(
  [in] FsrmReportFilter filter,
  [in] VARIANT          filterValue
);

Parameters

[in] filter

The filter used to limit the files listed in a report. For possible values, see the FsrmReportFilter enumeration.

[in] filterValue

The filter value to use for the specified report filter. The filter value cannot contain the following: slash mark (/), backslash (\), greater than sign (>), less than sign (<), vertical bar (|), double quote ("), or colon (:).

Return value

The method returns the following return values.

Remarks

The filter value overrides the default value set using the IFsrmReportManager::SetDefaultFilter method.

Note that each report type supports a specific set of filters. To determine if the filter is valid for the report type, call the IFsrmReportManager::IsFilterValidForReportType method.

The following list lists the variant types associated with the FsrmReportFilter enumeration values used for the filter parameter.

Filter type Variant type
FsrmReportFilter_FileGroups VT_BSTR | VT_ARRAY. Set the parray member of the variant.
FsrmReportFilter_MinAgeDays VT_I4. Set the lVal member of the variant.
FsrmReportFilter_MaxAgeDays VT_I4. Set the lVal member of the variant.
FsrmReportFilter_MinQuotaUsage VT_I4. Set the lVal member of the variant.
FsrmReportFilter_MinSize VT_I8. Set the llVal member of the variant.
FsrmReportFilter_NamePattern VT_BSTR. Set the bstrVal member of the variant.
FsrmReportFilter_Owners VT_BSTR | VT_ARRAY. Set the parray member of the variant.
FsrmReportFilter_Property VT_BSTR. Set the bstrVal member of the variant.
 

Examples

For an example, see Adding a Report to a Job.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008
Target Platform Windows
Header fsrmreports.h
DLL SrmSvc.dll

See also

IFsrmReport