SecurityRoleAttribute Class

Reference

Definition

Namespace:: System.EnterpriseServices

Assembly:: System.EnterpriseServices.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class SecurityRoleAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Interface | System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)]
[System.Runtime.InteropServices.ComVisible(false)]
public sealed class SecurityRoleAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Assembly | System.AttributeTargets.Class | System.AttributeTargets.Interface | System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)>]
[<System.Runtime.InteropServices.ComVisible(false)>]
type SecurityRoleAttribute = class
    inherit Attribute

Public NotInheritable Class SecurityRoleAttribute
Inherits Attribute

Inheritance: Object

Attribute
SecurityRoleAttribute

Attributes: AttributeUsageAttribute ComVisibleAttribute

Examples

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")>

Remarks

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

Constructors

SecurityRoleAttribute(String, Boolean)	Initializes a new instance of the SecurityRoleAttribute class and sets the Role and SetEveryoneAccess properties.
SecurityRoleAttribute(String)	Initializes a new instance of the SecurityRoleAttribute class and sets the Role property.

Properties

Description	Gets or sets the role description.
Role	Gets or sets the security role.
SetEveryoneAccess	Sets a value indicating whether to add the Everyone user group as a user.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
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)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)

Applies to

Share via