This documentation is archived and is not being maintained.

SemaphoreRights Enumeration

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

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

'Declaration
<ComVisibleAttribute(False)> _
<FlagsAttribute> _
Public Enumeration SemaphoreRights
'Usage
Dim instance As SemaphoreRights

/** @attribute ComVisibleAttribute(false) */ 
/** @attribute FlagsAttribute() */ 
public enum SemaphoreRights
ComVisibleAttribute(false) 
FlagsAttribute 
public enum SemaphoreRights

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

Use the SemaphoreRights enumeration to specify access control rights when you create SemaphoreSecurity objects. To apply access rights to a named system semaphore, use SemaphoreSecurity objects with the System.Threading.Semaphore constructor and the Semaphore.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 SemaphoreRights values when creating and using SemaphoreAccessRule objects. The example creates a SemaphoreSecurity 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 an Semaphore object; see SemaphoreSecurity, Semaphore.GetAccessControl method, and Semaphore.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 SemaphoreSecurity()

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

        ' Add a rule that denies the current user the 
        ' right to change permissions on the semaphore.
        rule = New SemaphoreAccessRule(user, _
            SemaphoreRights.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 semaphore. This 
        ' rule is merged with the existing Allow rule.
        rule = New SemaphoreAccessRule(user, _
            SemaphoreRights.ReadPermissions, _
            AccessControlType.Allow)
        mSec.AddAccessRule(rule)

        ShowSecurity(mSec)

    End Sub 

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

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

            Console.WriteLine("        User: {0}", ar.IdentityReference)
            Console.WriteLine("        Type: {0}", ar.AccessControlType)
            Console.WriteLine("      Rights: {0}", ar.SemaphoreRights)
            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 Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: