IFsrmFileScreenManager::CreateFileScreen method (fsrmscreen.h)

Creates a file screen object.

Syntax

HRESULT CreateFileScreen(
  [in]  BSTR            path,
  [out] IFsrmFileScreen **fileScreen
);

Parameters

[in] path

The local directory path to which the file screen applies. The string is limited to 260 characters.

[out] fileScreen

An IFsrmFileScreen interface of the newly created file screen. To add the file screen to FSRM, call the IFsrmFileScreen::Commit method.

Return value

The method returns the following return values.

Remarks

The screen applies to the directory and all its subdirectories (recursively). For example, a screen on P:\directory that blocks *.mp3 also blocks MP3 files on P:\directory\subdirectory.

If you create a file screen on P:\directory\subdirectory, the screen that you created on P:\directory still applies to P:\directory\subdirectory. If you do not want the screen on P:\directory to apply to P:\directory\subdirectory, you need to create a file screen exception.

Examples

For an example, see Defining a File Screen.

Requirements

See also

FsrmFileScreenManager

IFsrmFileScreenManager