IFsrmFileScreenManager interface (fsrmscreen.h)
Used to manage file screen objects.
To get this interface, call the
CoCreateInstanceEx function. Use
CLSID_FsrmFileScreenManager as the class identifier and
__uuidof(IFsrmFileScreenManager) as the interface identifier.
For an example, see Defining a File Screen.
Inheritance
The IFsrmFileScreenManager interface inherits from the IDispatch interface. IFsrmFileScreenManager also has these types of members:
Methods
The IFsrmFileScreenManager interface has these methods.
| IFsrmFileScreenManager::CreateFileScreen Creates a file screen object. |
| IFsrmFileScreenManager::CreateFileScreenCollection Creates an empty collection to which you can add file screens. |
| IFsrmFileScreenManager::CreateFileScreenException Creates a file screen exception object. |
| IFsrmFileScreenManager::EnumFileScreenExceptions Enumerates the file screen exceptions for the specified directory and its subdirectories. |
| IFsrmFileScreenManager::EnumFileScreens Enumerates the file screens for the specified directory and its subdirectories. |
| IFsrmFileScreenManager::get_ActionVariableDescriptions Retrieves the descriptions for the macros contained in the IFsrmFileScreenManager::ActionVariables property. |
| IFsrmFileScreenManager::get_ActionVariables Retrieves a list of macros that you can specify in action property values. (IFsrmFileScreenManager.get_ActionVariables) |
| IFsrmFileScreenManager::GetFileScreen Retrieves the specified file screen. |
| IFsrmFileScreenManager::GetFileScreenException 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.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2008 |
| Target Platform | Windows |
| Header | fsrmscreen.h (include FsrmScreen.h, FsrmTlb.h) |