Share via


MSFT_FSRMFileScreen class

Used to configure a file screen that blocks groups of files from being saved to the specified directory.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[dynamic, provider("FSRMWmiProvider")]
class MSFT_FSRMFileScreen
{
  string          Path;
  string          Description;
  string          IncludeGroup[];
  boolean         Active;
  MSFT_FSRMAction Notification[];
  string          Template;
  boolean         MatchesTemplate;
};

Members

The MSFT_FSRMFileScreen class has these types of members:

Methods

The MSFT_FSRMFileScreen class has these methods.

Method Description
Reset The indicated file screen will have all its default settings for all parameters reset with those from the specified template.

Properties

The MSFT_FSRMFileScreen class has these properties.

Active

Data type: boolean

Access type: Read/write

If True, the server will fail any IO operation that violates the file screen. If False, the server will not fail violating IO operations but will still run any action associated with the file screen.

Description

Data type: string

Access type: Read/write

The description of the file screen.

IncludeGroup

Data type: string array

Access type: Read/write

An array of strings containing the names of the file groups that contain the file name patterns used to specify the files that are blocked by this screen.

MatchesTemplate

Data type: boolean

Access type: Read-only

If True, the property values of this file screen match those values of the template from which it was derived.

Notification

Data type: MSFT_FSRMAction array

Access type: Read/write

Qualifiers: EmbeddedInstance ("MSFT_FSRMAction")

An array of instance of the MSFT_FSRMAction class that represents the actions performed when the file screen is violated.

Path

Data type: string

Access type: Read/write

Qualifiers: key

The path of the directory to which the file screen object applies.

Template

Data type: string

Access type: Read/write

The name of the file screen template that will be applied to this file screen. The string is limited to 4,000 characters.

Remarks

A file screen limits the types of files that the system or any user can store in a directory. When a restricted file is detected, the FSRM server performs the specified actions (see IFsrmFileScreenBase::CreateAction).

The file screen applies to future files the screen is not applied retroactively. To list the files in the directory that violate the screen, create a report job that lists files by type.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\Microsoft\Windows\FSRM
MOF
MSFT_FSRM.mof
DLL
SrmSvc.dll

See also

FSRM WMI Classes