MSFT_FSRMFileScreenTemplate class

Used to configure templates from which new file screens can be derived. Templates are identified by a name and are used to simplify configuration of file screens.

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

Syntax

[dynamic, provider("FSRMWmiProvider")]
class MSFT_FSRMFileScreenTemplate
{
  string          Name;
  string          Description;
  string          IncludeGroup[];
  boolean         Active;
  MSFT_FSRMAction Notification[];
  boolean         UpdateDerived;
  boolean         UpdateDerivedMatching;
};

Members

The MSFT_FSRMFileScreenTemplate class has these types of members:

Properties

The MSFT_FSRMFileScreenTemplate 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

A string up to 1KB in size. Optional. The default value is an empty string.

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. The total combined length of the strings must be under 10KB. This parameter is required.

Name

Data type: string

Access type: Read/write

Qualifiers: key

The name of the file screen template.

Notification

Data type: MSFT_FSRMAction array

Access type: Read/write

Qualifiers: EmbeddedInstance ("MSFT_FSRMAction")

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

UpdateDerived

Data type: boolean

Access type: Read/write

Apply changes to all derived file screens, whether their properties match the templates or not.

UpdateDerivedMatching

Data type: boolean

Access type: Read/write

Applies changes to derived file screens only if the file screen's properties match the file screen template's properties.

Note that the comparison is made against the file screen template as it exists in the database, not a local copy that has not been committed.

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