1 out of 1 rated this helpful - Rate this topic

IFsrmClassificationManager::ClearFileProperty method

Attempts to remove the specified property from the file or folder.

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

Syntax


HRESULT ClearFileProperty(
  [in]  BSTR filePath,
  [in]  BSTR propertyName
);

Parameters

filePath [in]: The file that contains the property that you want to remove. You must specify an absolute path to the file. You cannot specify a file share.
propertyName [in]: The name of the property to remove from the file.

Return value

The method returns the following return values.

Return code	Description
S_OK	Success.
FSRM_E_NOT_FOUND	The specified property was not found.
FSRM_E_SET_PROPERTY_FAILED	The specified property could not be removed. To get extended error information, call the GetErrorInfo function.
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.

Remarks

The property is removed from the file if the storage module is able to remove the property; otherwise, the property's value is cleared using the values in the following table.

Property type	Cleared value
Boolean
Date
Hierarchy
Integer
Multiple choice list
Single choice list
Multi-string
Ordered list
String	Empty string

Requirements

Minimum supported client	Windows 8
Minimum supported server	Windows Server 2008 R2
Header	FsrmPipeline.h (include FsrmPipeline.h or FsrmTlb.h)
DLL	SrmLib.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

Community Additions

ADD