IFsrmClassificationManager::ClearFileProperty method (fsrmpipeline.h)

Article
10/13/2021

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 property
);

Parameters

[in] filePath

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.

[in] property

The name of the property to remove from the file.

Return value

The method returns the following return values.

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 list.

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

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