Export (0) Print
Expand All

IFsrmReportManager::SetDefaultFilter method

Sets the default report filter value to use with the specified report type.

Syntax


HRESULT SetDefaultFilter(
  [in]  FsrmReportType   reportType,
  [in]  FsrmReportFilter filter,
  [in]  VARIANT          filterValue
);

Parameters

reportType [in]

The report type. For possible values, see the FsrmReportType enumeration.

filter [in]

The report filter. For possible values, see the FsrmReportFilter enumeration.

filterValue [in]

The default report filter value.

Return value

The method returns the following return values.

Return codeDescription
S_OK

Success

E_INVALIDARG

The filter is not valid or is not valid for the specified report type.

 

Remarks

This value is used if the IFsrmReport::SetFilter method was not called to specify a filter value for the report.

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

The following table lists the variant types associated with the FsrmReportFilter enumeration values used for the filterValue parameter.

Filter typeVariant 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.

 

The default filter values are used for report actions.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmReports.h (include FsrmReports.h or FsrmTlb.h)

DLL

SrmSvc.dll

CLSID

CLSID_FsrmReportManager is defined as 0058ef37-aa66-4c48-bd5b-2fce432ab0c8

IID

IID_IFsrmReportManager is defined as 27b899fe-6ffa-4481-a184-d3daade8a02b

See also

IFsrmReportManager
FsrmReportManager

 

 

Show:
© 2015 Microsoft