IFsrmFileScreenManager::EnumFileScreens method

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

Syntax


HRESULT EnumFileScreens(
  [in]   BSTR path,
  [in]   FsrmEnumOptions options,
  [out]  IFsrmCommittableCollection **fileScreens
);

Parameters

path [in]

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

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

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

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

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

options [in]

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

fileScreens [out]

An IFsrmCommittableCollection interface that contains a collection of file screens.

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

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

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

Return value

The method returns the following return values.

Return codeDescription
S_OK

Success

E_INVALIDARG

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

FSRM_E_NOT_FOUND

A file screen 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