IFsrmFileScreenManager::EnumFileScreenExceptions method

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

Syntax


HRESULT EnumFileScreenExceptions(
  [in]   BSTR path,
  [in]   FsrmEnumOptions options,
  [out]  IFsrmCommittableCollection **fileScreenExceptions
);

Parameters

path [in]

The local directory path associated with the file screen exception that you want to retrieve.

If the path ends with "\*", retrieve all exceptions associated with the immediate subdirectories of the path (does not include the exceptions associated with the path).

If the path ends with "\...", retrieve the exception for the path and all exceptions associated with the immediate subdirectories of the path (recursively).

If the path does not end in "\*" or "\...", retrieve the exception for the path only.

If path is null or empty, the method returns all file screen exceptions.

options [in]

The options to use when enumerating the exceptions. For possible values, see the FsrmEnumOptions enumeration.

fileScreenExceptions [out]

An IFsrmCommittableCollection interface that contains a collection of file screen exceptions.

Each item of the collection is a VARIANT of type VT_DISPATCH. Query the pdispVal member of the variant for the IFsrmFileScreenException interface.

The collection contains only committed exceptions; the collection will not contain newly created exceptions that have not been committed.

The collection is empty if the path does not contain file screen exceptions.

Return value

The method returns the following return values.

Return codeDescription
S_OK

Success

E_INVALIDARG

The fileScreenExceptions parameter cannot be NULL. Also, the FsrmEnumOptions_Asynchronous option is not supported.

FSRM_E_NOT_FOUND

A file screen exception has not been applied to the specified directories.

 

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