Export (0) Print
Expand All

IFsrmClassificationManager::EnumFileProperties method

Enumerates the properties of the specified file.

Syntax


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

Parameters

filePath [in]

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 [in]

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

fileProperties [out]

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.

Return codeDescription
S_OK

Success.

FSRM_E_PATH_NOT_FOUND

The specified file is not found.

FSRM_E_ENUM_PROPERTIES_FAILED

The properties could not be enumerated because a failure occurred while loading or classifying the file properties. To get extended error information, call the GetErrorInfo function.

FSRM_S_PARTIAL_CLASSIFICATION

The enumerated properties may not be completely classified because a failure occurred while loading or classifying the file properties. To get extended error information, call the GetErrorInfo function.

 

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

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2008 R2

Header

FsrmPipeline.h (include FsrmPipeline.h or FsrmTlb.h)

DLL

SrmSvc.dll

CLSID

CLSID_FsrmClassificationManager is defined as b15c0e47-c391-45b9-95c8-eb596c853f3a

IID

IID_IFsrmClassificationManager is defined as d2dc89da-ee91-48a0-85d8-cc72a56f7d04

IID_IFsrmClassificationManager2 is defined as 0004c1c9-127e-4765-ba07-6a3147bca112

See also

IFsrmClassificationManager2
IFsrmClassificationManager
IFsrmClassificationManager::ClearFileProperty
IFsrmClassificationManager::SetFileProperty
IFsrmClassificationManager::GetFileProperty
FsrmClassificationManager
MSFT_FSRMClassification

 

 

Show:
© 2014 Microsoft