FsrmReportFilter enumeration

Defines the filters that you can use to limit the files that are included in a report.

Syntax


typedef enum _FsrmReportFilter { 
  FsrmReportFilter_MinSize        = 1,
  FsrmReportFilter_MinAgeDays     = 2,
  FsrmReportFilter_MaxAgeDays     = 3,
  FsrmReportFilter_MinQuotaUsage  = 4,
  FsrmReportFilter_FileGroups     = 5,
  FsrmReportFilter_Owners         = 6,
  FsrmReportFilter_NamePattern    = 7,
  FsrmReportFilter_Property       = 8
} FsrmReportFilter;

Constants

FsrmReportFilter_MinSize

The report will show only files that meet a minimum size.

Applies to the FsrmReportType_LargeFiles report type.

FsrmReportFilter_MinAgeDays

The report will show only files that were accessed more than a minimum number of days ago.

Applies to the FsrmReportType_LeastRecentlyAccessed and FsrmReportType_FileScreenAudit report types.

FsrmReportFilter_MaxAgeDays

The report will show only files that were accessed prior to a maximum number of days ago.

Applies to the FsrmReportType_MostRecentlyAccessed report type.

FsrmReportFilter_MinQuotaUsage

The report will show only quotas that meet a certain disk space usage level.

Applies to the FsrmReportType_QuotaUsage report type.

FsrmReportFilter_FileGroups

The report will show only files from a specified set of file groups.

Applies to the FsrmReportType_FilesByType report type.

FsrmReportFilter_Owners

The report will show only files that belong to specified owners. The format of the owner string can be either the user principal name ("UserName@Domain" or "Domain\UserName") or a SID in string format.

Applies to the FsrmReportType_FilesByOwner report type.

FsrmReportFilter_NamePattern

The report will show only files with names that match the specified pattern.

Applies to the FsrmReportType_LargeFiles, FsrmReportType_MostRecentlyAccessed, FsrmReportType_LeastRecentlyAccessed, FsrmReportType_FilesByOwner, and FsrmReportType_FilesByProperty report types. For these report types, multiple filters could exist. For example, for the FsrmReportType_LargeFiles report type, both the FsrmReportFilter_MinSize and FsrmReportFilter_NamePattern filters could exist.

FsrmReportFilter_Property

The report will show only files that contain the specified property.

Applies to the FsrmReportType_FilesByProperty and FsrmReportType_FoldersByProperty report types.

Remarks

The value for the filter is specified when you call the IFsrmReport::SetFilter or IFsrmReportManager::SetDefaultFilter method to specify the filter. For example, you set the filterValue parameter to the filter's value when calling SetFilter.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmEnums.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, or FsrmScreen.h)

See also

IFsrmReport::GetFilter
IFsrmReport::SetFilter
IFsrmReportManager::GetDefaultFilter
IFsrmReportManager::IsFilterValidForReportType
IFsrmReportManager::SetDefaultFilter

 

 

Show: