IFsrmClassificationManager::GetFileProperty method (fsrmpipeline.h)

Article
02/22/2024

Retrieves the specified property from the file or folder.

Windows Server 2008 R2: Only files are supported until Windows Server 2012.

Syntax

HRESULT GetFileProperty(
  [in]  BSTR                       filePath,
  [in]  BSTR                       propertyName,
  [in]  FsrmGetFilePropertyOptions options,
  [out] IFsrmProperty              **property
);

Parameters

[in] filePath

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.

[in] propertyName

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

[in] options

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

[out] property

An IFsrmProperty interface to the retrieved property.

Return value

The method returns the following return values.

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.

Examples

For examples in C# and PowerShell see Accessing Classification Properties.

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2008 R2
Target Platform	Windows
Header	fsrmpipeline.h (include FsrmPipeline.h, FsrmTlb.h)
DLL	SrmSvc.dll