IFsrmClassificationManager2.GetFileProperty Method (String, String, _FsrmGetFilePropertyOptions)

Article
10/10/2016

Retrieves the specified property from the file or folder.

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

Syntax

IFsrmProperty GetFileProperty(
    string filePath,
    string PropertyName,
    _FsrmGetFilePropertyOptions options = _FsrmGetFilePropertyOptions.FsrmGetFilePropertyOptions_None
)

IFsrmProperty^ GetFileProperty(
    String^ filePath,
    String^ PropertyName,
    _FsrmGetFilePropertyOptions options = _FsrmGetFilePropertyOptions::FsrmGetFilePropertyOptions_None
)

abstract GetFileProperty : 
        filePath:string *
        PropertyName:string *
        options:_FsrmGetFilePropertyOptions = _FsrmGetFilePropertyOptions.FsrmGetFilePropertyOptions_None -> IFsrmProperty

Function GetFileProperty (
    filePath As String,
    PropertyName As String,
    options As _FsrmGetFilePropertyOptions
) As IFsrmProperty

Parameters

filePath
Type: System.String

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

PropertyName
Type: System.String

The name of the property to retrieve. The name must not exceed 100 characters in length.

options
Type: Microsoft.Storage._FsrmGetFilePropertyOptions

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

Return Value

Type: Microsoft.Storage.IFsrmProperty

Returns a IFsrmProperty interface to the retrieved property.

Implements

IFsrmClassificationManager.GetFileProperty(String, String, _FsrmGetFilePropertyOptions)

Remarks

FSRM asks the specified storage modules (see the options parameter) to retrieve the property from the file. If the options parameter is set to FsrmGetFilePropertyOptions_None, FSRM reruns classification on the file to ensure the correct value is returned.