Share via


SPRole.Description Property

NOTE: This API is now obsolete.

Use the new SPRoleDefinition and SPRoleAssignment classes instead, to define roles and to assign users to them. For more information, see Authorization Object Model. (In Windows SharePoint Services 2.0, the Description property returned or set the description for the role and is maintained for backward compatibility.)

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<ObsoleteAttribute("Use the SPRoleDefinition class instead")> _
Public Property Description As String
    Get
    Set
'Usage
Dim instance As SPRole
Dim value As String

value = instance.Description

instance.Description = value
[ObsoleteAttribute("Use the SPRoleDefinition class instead")]
public string Description { get; set; }

Property Value

Type: System.String
A string that contains the description.

Remarks

The Description property requires use of the Update method to effect changes in the database.

See Also

Reference

SPRole Class

SPRole Members

Microsoft.SharePoint Namespace