IFsrmClassificationManager::EnumFileProperties method (fsrmpipeline.h)

Article
10/13/2021

Enumerates the properties of the specified file.

Syntax

HRESULT EnumFileProperties(
  [in]  BSTR                       filePath,
  [in]  FsrmGetFilePropertyOptions options,
  [out] IFsrmCollection            **fileProperties
);

Parameters

[in] filePath

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.

[in] options

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

[out] fileProperties

An IFsrmCollection interface that contains 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.

Return value

The method returns the following return values.

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.

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