Share via


IFsrmFileScreenManager Interface

 

Used to manage file screen objects.

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

Syntax

[GuidAttribute("FF4FA04E-5A94-4BDA-A3A0-D5B4D3C52EBA")]
public interface IFsrmFileScreenManager
[GuidAttribute("FF4FA04E-5A94-4BDA-A3A0-D5B4D3C52EBA")]
public interface class IFsrmFileScreenManager
[<GuidAttribute("FF4FA04E-5A94-4BDA-A3A0-D5B4D3C52EBA")>]
type IFsrmFileScreenManager = interface end
<GuidAttribute("FF4FA04E-5A94-4BDA-A3A0-D5B4D3C52EBA")>
Public Interface IFsrmFileScreenManager

Properties

Name Description
System_CAPS_pubproperty ActionVariableDescriptions

Retrieves the descriptions for the macros contained in the IFsrmFileScreenManager.ActionVariables property.

System_CAPS_pubproperty ActionVariables

Retrieves a list of macros that you can specify in action property values.

Methods

Name Description
System_CAPS_pubmethod CreateFileScreen(String)

Creates a file screen object.

System_CAPS_pubmethod CreateFileScreenCollection()

Creates an empty collection to which you can add file screens.

System_CAPS_pubmethod CreateFileScreenException(String)

Creates a file screen exception object.

System_CAPS_pubmethod EnumFileScreenExceptions(String, _FsrmEnumOptions)

Enumerates the file screen exceptions for the specified directory and its subdirectories.

System_CAPS_pubmethod EnumFileScreens(String, _FsrmEnumOptions)

Enumerates the file screens for the specified directory and its subdirectories.

System_CAPS_pubmethod GetFileScreen(String)

Retrieves the specified file screen.

System_CAPS_pubmethod GetFileScreenException(String)

Retrieves the specified file screen exception.

Remarks

file screen restricts the types of files that can be stored in a specific directory and its subdirectories. For each file screen, there is a configurable list of blocked file groups that define a set of patterns (that are based on file name) that will be restricted. When a file is created or renamed, the server evaluates whether the file name matches a pattern in any file group configured on a parent portion of the path. If a match is found, the file is blocked and a set of actions are initiated.

In addition to configuring file screens, you can create a file screen exception that defines a list of file groups that are specifically allowed in a specific directory and its subdirectories. Typically, you will configure a file screen exception on a directory that is in the subtree of a directory with a file screen. In this case, the file screen exception list takes precedence when evaluating screening rules; files with names that match the name patterns in the allowed file groups will not be blocked.

You can create a file screen or a file screen template. The template is used to modify properties in bulk by applying the changes to file screens that derive from the file screen template.

To create this object from a script, use the "Fsrm.FsrmFileScreenManager" program identifier.

See Also

FsrmFileScreenManager
Microsoft.Storage Namespace

Return to top