IFsrmFileScreenManager.EnumFileScreens Method (String, _FsrmEnumOptions)

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

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

Syntax

IFsrmCommittableCollection EnumFileScreens(
    string Path = "",
    _FsrmEnumOptions options = _FsrmEnumOptions.FsrmEnumOptions_None
)

IFsrmCommittableCollection^ EnumFileScreens(
    String^ Path = "",
    _FsrmEnumOptions options = _FsrmEnumOptions::FsrmEnumOptions_None
)

abstract EnumFileScreens : 
        Path:string = "" *
        options:_FsrmEnumOptions = _FsrmEnumOptions.FsrmEnumOptions_None -> IFsrmCommittableCollection

Function EnumFileScreens (
    Path As String,
    options As _FsrmEnumOptions
) As IFsrmCommittableCollection

Parameters

• Path
  Type: System.String

  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
  Type: Microsoft.Storage._FsrmEnumOptions

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

Return Value

Type: Microsoft.Storage.IFsrmCommittableCollection

Returns a 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.

See Also

FsrmFileScreenManager
IFsrmFileScreenManager Interface
Microsoft.Storage Namespace

Return to top