IFsrmPropertyDefinition interface (fsrmpipeline.h)

Article
02/16/2023

Defines a property that you want to use to classify files.

To create this interface, call the IFsrmClassificationManager::CreatePropertyDefinition method.

The following methods return this interface:

Inheritance

The IFsrmPropertyDefinition interface inherits from the IFsrmObject interface.

Methods

The IFsrmPropertyDefinition interface has these methods.


IFsrmPropertyDefinition::get_Name The name of the property. (IFsrmPropertyDefinition.get_Name)
IFsrmPropertyDefinition::get_Parameters The parameters for the property definition. (Get)
IFsrmPropertyDefinition::get_PossibleValues The possible values to which the property can be set. (Get)
IFsrmPropertyDefinition::get_Type The type of data that the property contains. (Get)
IFsrmPropertyDefinition::get_ValueDescriptions Descriptions for each of the possible values specified in the PossibleValues property. (Get)
IFsrmPropertyDefinition::put_Name The name of the property. (IFsrmPropertyDefinition.put_Name)
IFsrmPropertyDefinition::put_Parameters The parameters for the property definition. (Put)
IFsrmPropertyDefinition::put_PossibleValues The possible values to which the property can be set. (Put)
IFsrmPropertyDefinition::put_Type The type of data that the property contains. (Put)
IFsrmPropertyDefinition::put_ValueDescriptions Descriptions for each of the possible values specified in the PossibleValues property. (Put)

Remarks

The name and type properties define a unique property; you cannot rename a property or change its type.

You cannot delete a property definition that is referenced by a classification rule or report. The classification rule uses the IFsrmRule::PropertyAffected property to reference the property definition.

You cannot delete a property that is referenced by a file management job property condition. To determine if a property condition is holding a reference, look for property conditions that have the "name" property of the condition equal to the name of the property definition that is being deleted.

Reports use the property definition only as a filter in the report type FsrmReportType_FilesByProperty.

Examples

For examples in C# and PowerShell see Accessing Classification Properties.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2
Target Platform	Windows
Header	fsrmpipeline.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, FsrmScreen.h)