Export (0) Print
Expand All

IFsrmClassificationManager::GetFileProperty method

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

filePath [in]

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

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

options [in]

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

property [out]

An IFsrmProperty interface to the retrieved property.

Return value

The method returns the following return values.

Return codeDescription
S_OK

Success.

E_INVALIDARG

The specified name is too long.

FSRM_E_NOT_FOUND

The specified property was not found.

FSRM_E_PATH_NOT_FOUND

The specified file is not found.

FSRM_E_INVALID_PATH

The specified path is invalid.

FSRM_E_INVALID_NAME

The specified name is empty or NULL.

FSRM_E_PARTIAL_CLASSIFICATION_PROPERTY_NOT_FOUND

The requested property was not found, but the file may only have partial classification 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 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

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::EnumFileProperties
IFsrmClassificationManager::SetFileProperty
FsrmClassificationManager
MSFT_FSRMClassification

 

 

Show:
© 2014 Microsoft