SecurityRoleAttribute Class
 

Configures a role for an application or component. This class cannot be inherited.

Namespace:   System.EnterpriseServices
Assembly:  System.EnterpriseServices (in System.EnterpriseServices.dll)

SystemObject
   SystemAttribute
    System.EnterpriseServicesSecurityRoleAttribute

[AttributeUsageAttribute(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Interface, 
	Inherited = true, AllowMultiple = true)]
[ComVisibleAttribute(false)]
public sealed class SecurityRoleAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Assembly | AttributeTargets::Class | AttributeTargets::Method | AttributeTargets::Interface, 
	Inherited = true, AllowMultiple = true)]
[ComVisibleAttribute(false)]
public ref class SecurityRoleAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Method | AttributeTargets.Interface,
    Inherited = true, AllowMultiple = true)>]
[<ComVisibleAttribute(false)>]
type SecurityRoleAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Assembly Or AttributeTargets.Class Or AttributeTargets.Method Or AttributeTargets.Interface,
	Inherited := True, AllowMultiple := True)>
<ComVisibleAttribute(False)>
Public NotInheritable Class SecurityRoleAttribute
	Inherits Attribute
NameDescription
System_CAPS_pubmethod SecurityRoleAttribute

Initializes a new instance of the SecurityRoleAttribute class and sets the property.

System_CAPS_pubmethod SecurityRoleAttribute

Initializes a new instance of the SecurityRoleAttribute class and sets the and properties.

NameDescription
System_CAPS_pubproperty

Gets or sets the role description.

System_CAPS_pubproperty

Gets or sets the security role.

System_CAPS_pubproperty

Sets a value indicating whether to add the Everyone user group as a user.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethod Equals

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod IsDefaultAttribute

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

You can use the SecurityRoleAttribute to add roles to an application, and to associate them with components. When SecurityRoleAttribute is applied to an assembly as a whole, it ensures that the role exists in the application configuration (COM+ catalog). You can add members of the role using the COM+ Explorer.

When applied to a component, the SecurityRoleAttribute ensures that the role exists in the application configuration, and associates the target component with the role.

By default, created roles have no members. If the property is set to true, the Everyone user group is automatically added to the role. This is best for all-access type roles that are given minimal control over the system.

Security roles can be specified at the component level, per interface and per method. As with other method attributes, security configuration is not currently shared between interface definition and method implementation.

The following code example demonstrates the use of this attribute to associate a role with an assembly that contains ServicedComponent classes.

// Create a security role for the component.
[assembly: SecurityRole("Manager")]
' Create a security role for the component.
<Assembly: SecurityRole("Manager")> 
// Create a security role for the component.
[assembly:SecurityRole("Manager")];
.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top