FsrmFileScreenManagerClass.EnumFileScreens Method (String, _FsrmEnumOptions)

 

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

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

Syntax

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

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

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

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

Parameters

• Path
  Type: System.String

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

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

Return Value

Type: Microsoft.Storage.IFsrmCommittableCollection

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

Implements

IFsrmFileScreenManager.EnumFileScreens(String, _FsrmEnumOptions)

See Also

IFsrmFileScreenManager
FsrmFileScreenManager
FsrmFileScreenManagerClass Class
Microsoft.Storage Namespace

Return to top