This documentation is archived and is not being maintained.

EventWaitHandleRights Enumeration

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

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

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

/** @attribute FlagsAttribute() */ 
public enum EventWaitHandleRights
FlagsAttribute 
public enum EventWaitHandleRights

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

Use the EventWaitHandleRights enumeration to specify access control rights when you create EventWaitHandleAccessRule objects. To apply access rights to a named system event, first add EventWaitHandleAccessRule objects to an EventWaitHandleSecurity object, then attach the EventWaitHandleSecurity object to the named system event using the System.Threading.EventWaitHandle constructor or the EventWaitHandle.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 EventWaitHandleRights values when creating and using EventWaitHandleAccessRule objects. The example creates an EventWaitHandleSecurity 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 EventWaitHandle object; see EventWaitHandleSecurity, EventWaitHandle.GetAccessControl method, and EventWaitHandle.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 EventWaitHandleSecurity()

        ' Add a rule that grants the current user the 
        ' right to wait on or signal the event.
        Dim rule As New EventWaitHandleAccessRule(user, _
            EventWaitHandleRights.Synchronize _
            Or EventWaitHandleRights.Modify, _
            AccessControlType.Allow)
        mSec.AddAccessRule(rule)

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

        ShowSecurity(mSec)

    End Sub 

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

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

            Console.WriteLine("        User: {0}", ar.IdentityReference)
            Console.WriteLine("        Type: {0}", ar.AccessControlType)
            Console.WriteLine("      Rights: {0}", ar.EventWaitHandleRights)
            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: