IFsrmPropertyDefinition Interface

 

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

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

Syntax

[GuidAttribute("EDE0150F-E9A3-419C-877C-01FE5D24C5D3")]
public interface IFsrmPropertyDefinition : IFsrmObject

[GuidAttribute("EDE0150F-E9A3-419C-877C-01FE5D24C5D3")]
public interface class IFsrmPropertyDefinition : IFsrmObject

[<GuidAttribute("EDE0150F-E9A3-419C-877C-01FE5D24C5D3")>]
type IFsrmPropertyDefinition = 
    interface
        interface IFsrmObject
    end

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

Properties

	Name	Description
	Description	Gets and sets the Description property.
	id	Gets the id property.
	Name	Sets or retrieves name of the property.
	Parameters	Retrieves or sets the parameters for the property definition.
	PossibleValues	Retrieves or sets the possible values to which the property can be set.
	Type	Retrieves or sets the type of data that the property contains.
	ValueDescriptions	Retrieves or sets the descriptions for each of the possible values specified in the PossibleValues property.

Methods

	Name	Description
	Commit()	Saves the property definition object in the server's list of objects.
	Delete()	Removes the property definition object from the server's list of objects.

Remarks

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.

See Also

IFsrmProperty
Microsoft.Storage Namespace

Return to top