This documentation is archived and is not being maintained.

MutexRights Enumeration

Specifies the access control rights that can be applied to named system mutex objects.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace:  System.Security.AccessControl
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
<FlagsAttribute> _
Public Enumeration MutexRights
'Usage
Dim instance As MutexRights

Member nameDescription
ModifyThe right to release a named mutex.
DeleteThe right to delete a named mutex.
ReadPermissionsThe right to open and copy the access rules and audit rules for a named mutex.
ChangePermissionsThe right to change the security and audit rules associated with a named mutex.
TakeOwnershipThe right to change the owner of a named mutex.
SynchronizeThe right to wait on a named mutex.
FullControlThe right to exert full control over a named mutex, and to modify its access rules and audit rules.

Use the MutexRights enumeration to specify access control rights when you create MutexSecurity objects. To apply access rights to a named system mutex, use MutexSecurity objects with the Mutex(Boolean, String, Boolean, MutexSecurity) constructor and the Mutex.SetAccessControl method.

NoteNote:

Security on synchronization objects is not supported for Windows 98 or Windows Millennium Edition.

The following code example demonstrates the use of MutexRights values when creating and using MutexAccessRule objects. The example creates an MutexSecurity object, adds rules that allow and deny various rights for the current user, and displays the resulting pair of rules. The example then allows new rights for the current user and displays the result, showing that the new rights are merged with the existing AccessControlType.Allow rule.

NoteNote:

This example does not attach the security object to a Mutex object; see MutexSecurity, Mutex.GetAccessControl method, and Mutex.SetAccessControl.

Imports System
Imports System.Threading
Imports System.Security.AccessControl
Imports System.Security.Principal

Public Class Example

    Public Shared Sub Main()

        ' Create a string representing the current user. 
        Dim user As String = Environment.UserDomainName _ 
            & "\" & Environment.UserName

        ' Create a security object that grants no access. 
        Dim mSec As New MutexSecurity()

        ' Add a rule that grants the current user the  
        ' right to enter or release the mutex. 
        Dim rule As New MutexAccessRule(user, _
            MutexRights.Synchronize _
            Or MutexRights.Modify, _
            AccessControlType.Allow)
        mSec.AddAccessRule(rule)

        ' Add a rule that denies the current user the  
        ' right to change permissions on the mutex.
        rule = New MutexAccessRule(user, _
            MutexRights.ChangePermissions, _
            AccessControlType.Deny)
        mSec.AddAccessRule(rule)

        ' Display the rules in the security object.
        ShowSecurity(mSec)

        ' Add a rule that allows the current user the  
        ' right to read permissions on the mutex. This rule 
        ' is merged with the existing Allow rule.
        rule = New MutexAccessRule(user, _
            MutexRights.ReadPermissions, _
            AccessControlType.Allow)
        mSec.AddAccessRule(rule)

        ShowSecurity(mSec)

    End Sub  

    Private Shared Sub ShowSecurity(ByVal security As MutexSecurity)
        Console.WriteLine(vbCrLf & "Current access rules:" & vbCrLf)

        For Each ar As MutexAccessRule In _
            security.GetAccessRules(True, True, GetType(NTAccount))

            Console.WriteLine("        User: {0}", ar.IdentityReference)
            Console.WriteLine("        Type: {0}", ar.AccessControlType)
            Console.WriteLine("      Rights: {0}", ar.MutexRights)
            Console.WriteLine()
        Next 

    End Sub 
End Class  

'This code example produces output similar to following: 

'Current access rules: 

'        User: TestDomain\TestUser 
'        Type: Deny 
'      Rights: ChangePermissions 

'        User: TestDomain\TestUser 
'        Type: Allow 
'      Rights: Modify, Synchronize 


'Current access rules: 

'        User: TestDomain\TestUser 
'        Type: Deny 
'      Rights: ChangePermissions 

'        User: TestDomain\TestUser 
'        Type: Allow 
'      Rights: Modify, ReadPermissions, Synchronize

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: