FsrmClassificationManagerClass.EnumFileProperties Method (String, _FsrmGetFilePropertyOptions)

Article
10/10/2016

Enumerates the properties of the specified file.

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

Syntax

public virtual IFsrmCollection EnumFileProperties(
    string filePath,
    _FsrmGetFilePropertyOptions options = _FsrmGetFilePropertyOptions.FsrmGetFilePropertyOptions_None
)

public:
virtual IFsrmCollection^ EnumFileProperties(
    String^ filePath,
    _FsrmGetFilePropertyOptions options = _FsrmGetFilePropertyOptions::FsrmGetFilePropertyOptions_None
)

abstract EnumFileProperties : 
        filePath:string *
        options:_FsrmGetFilePropertyOptions = _FsrmGetFilePropertyOptions.FsrmGetFilePropertyOptions_None -> IFsrmCollection
override EnumFileProperties : 
        filePath:string *
        options:_FsrmGetFilePropertyOptions = _FsrmGetFilePropertyOptions.FsrmGetFilePropertyOptions_None -> IFsrmCollection

Public Overridable Function EnumFileProperties (
    filePath As String,
    options As _FsrmGetFilePropertyOptions
) As IFsrmCollection

Parameters

filePath
Type: System.String

The file that contains the properties that you want to enumerate. You must specify an absolute path to the file. You cannot specify a file share.

options
Type: Microsoft.Storage._FsrmGetFilePropertyOptions

The option to use for enumerating the file's properties. For possible values, see the _FsrmGetFilePropertyOptions enumeration.

Return Value

Type: Microsoft.Storage.IFsrmCollection

Returns a IFsrmCollection containing a collection of file properties. Each item in the collection is a VARIANT of type VT_DISPATCH. Query the pdispVal member of the variant for the IFsrmProperty interface.

Implements

IFsrmClassificationManager2.EnumFileProperties(String, _FsrmGetFilePropertyOptions)

Remarks

FSRM asks the specified storage modules (see the options parameter) to return all the properties for the file for which they are responsible. For storage modules that embed the properties in the file, the list will include all properties embedded in the file (not just those defined by FSRM).

If the options parameter is set to FsrmGetFilePropertyOptions_None, FSRM reruns classification on the file to ensure the correct value is returned.

Partager via