Export (0) Print
Expand All

IFsrmFileScreenManager::CreateFileScreen method

Creates a file screen object.

Syntax


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

Parameters

path [in]

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

fileScreen [out]

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.

Return codeDescription
S_OK

Success

E_INVALIDARG

The fileScreen parameter cannot be NULL.

FSRM_E_INVALID_PATH

The path cannot be empty or NULL. Also returned if the path is not valid.

FSRM_E_ALREADY_EXISTS

A file screen already exists for the specified directory.

FSRM_E_PATH_NOT_FOUND

The specified path does not exist.

 

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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmScreen.h

DLL

SrmSvc.dll

IID

IID_IFsrmFileScreenManager is defined as ff4fa04e-5a94-4bda-a3a0-d5b4d3c52eba

See also

IFsrmFileScreenManager
FsrmFileScreenManager

 

 

Show:
© 2014 Microsoft