IFsrmReport.SetFilter Method (_FsrmReportFilter, Object)

 

Sets the current value of the specified report filter.

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

Syntax

void SetFilter(
    _FsrmReportFilter filter,
    object filterValue
)

void SetFilter(
    _FsrmReportFilter filter,
    Object^ filterValue
)

abstract SetFilter : 
        filter:_FsrmReportFilter *
        filterValue:Object -> unit

Sub SetFilter (
    filter As _FsrmReportFilter,
    filterValue As Object
)

Parameters

• filter
  Type: Microsoft.Storage._FsrmReportFilter

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

• filterValue
  Type: System.Object

  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 (:).

Remarks

The filter value overrides the default value set using the 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 IsFilterValidForReportType method.The following table 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

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

See Also

IFsrmReport Interface
Microsoft.Storage Namespace

Return to top