This documentation is archived and is not being maintained.
GenericPrincipal Class
Visual Studio 2010
Represents a generic principal.
Assembly: mscorlib (in mscorlib.dll)
The GenericPrincipal type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | GenericPrincipal | Initializes a new instance of the GenericPrincipal class from a user identity and an array of role names to which the user represented by that identity belongs. |
| Name | Description | |
|---|---|---|
![]() | Identity | Gets the GenericIdentity of the user represented by the current GenericPrincipal. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsInRole | Determines whether the current GenericPrincipal belongs to the specified role. |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
This class represents the roles of the current user.
| Topic | Location |
|---|---|
| How to: Create GenericPrincipal and GenericIdentity Objects | .NET Framework: Security |
| How to: Create GenericPrincipal and GenericIdentity Objects | .NET Framework: Security |
The following example shows the use of members of the GenericPrincipal class.
Imports System Imports System.Security.Principal Public Class Form1 Inherits System.Windows.Forms.Form ' Event handler for Run button. Private Sub Button1_Click( _ ByVal sender As System.Object, _ ByVal e As System.EventArgs) Handles Button1.Click tbxOutput.Cursor = Cursors.WaitCursor tbxOutput.Text = "" ' Retrieve a GenericPrincipal that is based on the current user's ' WindowsIdentity. Dim genericPrincipal As GenericPrincipal = GetGenericPrincipal() ' Retrieve the generic identity of the GenericPrincipal object. Dim principalIdentity As GenericIdentity = _ CType(genericPrincipal.Identity, GenericIdentity) ' Display identity name and authentication type. If (principalIdentity.IsAuthenticated) Then WriteLine(principalIdentity.Name) WriteLine("Type:" + principalIdentity.AuthenticationType) End If ' Verify that the generic principal has been assigned the ' NetworkUser role. If (genericPrincipal.IsInRole("NetworkUser")) Then WriteLine("User belongs to the NetworkUser role.") End If WriteLine("This sample completed successfully; " + _ " press Exit to continue.") tbxOutput.Cursor = Cursors.Default End Sub ' Create generic principal based on values from the current ' WindowsIdentity. Private Function GetGenericPrincipal() As GenericPrincipal ' Use values from the current WindowsIdentity to construct ' a set of GenericPrincipal roles. Dim roles(10) As String Dim windowsIdentity As WindowsIdentity = windowsIdentity.GetCurrent() If (windowsIdentity.IsAuthenticated) Then ' Add custom NetworkUser role. roles(0) = "NetworkUser" End If If (windowsIdentity.IsGuest) Then ' Add custom GuestUser role. roles(1) = "GuestUser" End If If (windowsIdentity.IsSystem) Then ' Add custom SystemUser role. roles(2) = "SystemUser" End If ' Construct a GenericIdentity object based on the current Windows ' identity name and authentication type. Dim authenticationType As String = windowsIdentity.AuthenticationType Dim userName As String = windowsIdentity.Name Dim genericIdentity = _ New GenericIdentity(userName, authenticationType) ' Construct a GenericPrincipal object based on the generic identity ' and custom roles for the user. Dim genericPrincipal As New GenericPrincipal(genericIdentity, roles) Return genericPrincipal End Function ' Write out message with linefeed and carriage return. Private Sub WriteLine(ByVal message As String) tbxOutput.AppendText(message + vbCrLf) End Sub ' Event handler for Exit button. Private Sub Button2_Click( _ ByVal sender As System.Object, _ ByVal e As System.EventArgs) Handles Button2.Click Application.Exit() End Sub #Region " Windows Form Designer generated code " Public Sub New() MyBase.New() 'This call is required by the Windows Form Designer. InitializeComponent() 'Add any initialization after the InitializeComponent() call End Sub 'Form overrides dispose to clean up the component list. Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean) If disposing Then If Not (components Is Nothing) Then components.Dispose() End If End If MyBase.Dispose(disposing) End Sub 'Required by the Windows Form Designer Private components As System.ComponentModel.IContainer 'NOTE: The following procedure is required by the Windows Form Designer 'It can be modified using the Windows Form Designer. 'Do not modify it using the code editor. Friend WithEvents Panel2 As System.Windows.Forms.Panel Friend WithEvents Panel1 As System.Windows.Forms.Panel Friend WithEvents Button1 As System.Windows.Forms.Button Friend WithEvents Button2 As System.Windows.Forms.Button Friend WithEvents tbxOutput As System.Windows.Forms.RichTextBox <System.Diagnostics.DebuggerStepThrough()> _ Private Sub InitializeComponent() Me.Panel2 = New System.Windows.Forms.Panel Me.Button1 = New System.Windows.Forms.Button Me.Button2 = New System.Windows.Forms.Button Me.Panel1 = New System.Windows.Forms.Panel Me.tbxOutput = New System.Windows.Forms.RichTextBox Me.Panel2.SuspendLayout() Me.Panel1.SuspendLayout() Me.SuspendLayout() ' 'Panel2 ' Me.Panel2.Controls.Add(Me.Button1) Me.Panel2.Controls.Add(Me.Button2) Me.Panel2.Dock = System.Windows.Forms.DockStyle.Bottom Me.Panel2.DockPadding.All = 20 Me.Panel2.Location = New System.Drawing.Point(0, 320) Me.Panel2.Name = "Panel2" Me.Panel2.Size = New System.Drawing.Size(616, 64) Me.Panel2.TabIndex = 1 ' 'Button1 ' Me.Button1.Dock = System.Windows.Forms.DockStyle.Right Me.Button1.Font = New System.Drawing.Font( _ "Microsoft Sans Serif", _ 9.0!, _ System.Drawing.FontStyle.Regular, _ System.Drawing.GraphicsUnit.Point, _ CType(0, Byte)) Me.Button1.Location = New System.Drawing.Point(446, 20) Me.Button1.Name = "Button1" Me.Button1.Size = New System.Drawing.Size(75, 24) Me.Button1.TabIndex = 2 Me.Button1.Text = "&Run" ' 'Button2 ' Me.Button2.Dock = System.Windows.Forms.DockStyle.Right Me.Button2.Font = New System.Drawing.Font( _ "Microsoft Sans Serif", _ 9.0!, _ System.Drawing.FontStyle.Regular, _ System.Drawing.GraphicsUnit.Point, _ CType(0, Byte)) Me.Button2.Location = New System.Drawing.Point(521, 20) Me.Button2.Name = "Button2" Me.Button2.Size = New System.Drawing.Size(75, 24) Me.Button2.TabIndex = 3 Me.Button2.Text = "E&xit" ' 'Panel1 ' Me.Panel1.Controls.Add(Me.tbxOutput) Me.Panel1.Dock = System.Windows.Forms.DockStyle.Fill Me.Panel1.DockPadding.All = 20 Me.Panel1.Location = New System.Drawing.Point(0, 0) Me.Panel1.Name = "Panel1" Me.Panel1.Size = New System.Drawing.Size(616, 320) Me.Panel1.TabIndex = 2 ' 'tbxOutput ' Me.tbxOutput.AccessibleDescription = _ "Displays output from application." Me.tbxOutput.AccessibleName = "Output textbox." Me.tbxOutput.Dock = System.Windows.Forms.DockStyle.Fill Me.tbxOutput.Location = New System.Drawing.Point(20, 20) Me.tbxOutput.Name = "tbxOutput" Me.tbxOutput.Size = New System.Drawing.Size(576, 280) Me.tbxOutput.TabIndex = 1 Me.tbxOutput.Text = "Click the Run button to run the application." ' 'Form1 ' Me.AutoScaleBaseSize = New System.Drawing.Size(6, 15) Me.ClientSize = New System.Drawing.Size(616, 384) Me.Controls.Add(Me.Panel1) Me.Controls.Add(Me.Panel2) Me.Name = "Form1" Me.Text = "GenericPrincipal" Me.Panel2.ResumeLayout(False) Me.Panel1.ResumeLayout(False) Me.ResumeLayout(False) End Sub #End Region End Class
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show:
