Edit

IFsrmFileScreenManager::EnumFileScreens method (fsrmscreen.h)

  • Article

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

Syntax

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

Parameters

[in] path

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.

[in] options

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

[out] fileScreens

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.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008
Target Platform Windows
Header fsrmscreen.h
DLL SrmSvc.dll

See also

FsrmFileScreenManager

IFsrmFileScreenManager