IFsrmPropertyDefinition Interface

 

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

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

<GuidAttribute("EDE0150F-E9A3-419C-877C-01FE5D24C5D3")>
Public Interface IFsrmPropertyDefinition
	Inherits IFsrmObject

NameDescription
System_CAPS_pubpropertyDescription

Gets and sets the Description property.

System_CAPS_pubpropertyid

Gets the id property.

System_CAPS_pubpropertyName

Sets or retrieves name of the property.

System_CAPS_pubpropertyParameters

Retrieves or sets the parameters for the property definition.

System_CAPS_pubpropertyPossibleValues

Retrieves or sets the possible values to which the property can be set.

System_CAPS_pubpropertyType

Retrieves or sets the type of data that the property contains.

System_CAPS_pubpropertyValueDescriptions

Retrieves or sets the descriptions for each of the possible values specified in the PossibleValues property.

NameDescription
System_CAPS_pubmethodCommit()

Saves the property definition object in the server's list of objects.

System_CAPS_pubmethodDelete()

Removes the property definition object from the server's list of objects.

To create this interface, call the CreatePropertyDefinition method.

The following methods return this interface:

  1. EnumPropertyDefinitions

  2. GetPropertyDefinition

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

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

Return to top

Community Additions

ADD
Show: