Add Windows-only support notes to ACL security types #12283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

gewarren merged 2 commits into main from copilot/add-windows-support-remarks

Feb 6, 2026

+97 −13

xml/System.Security.AccessControl/EventWaitHandleAccessRule.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -46,7 +46,11 @@ @@
         <remarks>
           <format type="text/markdown"><![CDATA[
-    ## Remarks
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      The <xref:System.Security.AccessControl.EventWaitHandleAccessRule> class is one of a set of classes that the .NET Framework provides for managing Windows access control security on named system events. For an overview of these classes, and their relationship to the underlying Windows access control structures, see <xref:System.Security.AccessControl.EventWaitHandleSecurity>.
     > [!NOTE]
@@ Expand Down @@

xml/System.Security.AccessControl/EventWaitHandleAuditRule.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -42,7 +42,11 @@ @@
         <remarks>
           <format type="text/markdown"><![CDATA[
-    ## Remarks
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      The <xref:System.Security.AccessControl.EventWaitHandleAuditRule> class is one of a set of classes that the .NET Framework provides for managing Windows access control security on named system events. For an overview of these classes and their relationship to the underlying Windows access control structures, see <xref:System.Security.AccessControl.EventWaitHandleSecurity>.
     > [!NOTE]
@@ Expand Down @@

xml/System.Security.AccessControl/EventWaitHandleRights.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -45,7 +45,11 @@ @@
         <remarks>
           <format type="text/markdown"><![CDATA[
-    ## Remarks
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      Use the <xref:System.Security.AccessControl.EventWaitHandleRights> enumeration to specify access control rights when you create <xref:System.Security.AccessControl.EventWaitHandleAccessRule> objects. To apply access rights to a named system event, first add <xref:System.Security.AccessControl.EventWaitHandleAccessRule> objects to an <xref:System.Security.AccessControl.EventWaitHandleSecurity> object, then attach the <xref:System.Security.AccessControl.EventWaitHandleSecurity> object to the named system event using the <xref:System.Threading.EventWaitHandle.%23ctor%28System.Boolean%2CSystem.Threading.EventResetMode%2CSystem.String%2CSystem.Boolean%40%2CSystem.Security.AccessControl.EventWaitHandleSecurity%29?displayProperty=nameWithType> constructor or the <xref:System.Threading.EventWaitHandle.SetAccessControl%2A?displayProperty=nameWithType> method.
     ## Examples
@@ Expand Down @@

xml/System.Security.AccessControl/EventWaitHandleSecurity.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -47,6 +47,10 @@ @@
           <format type="text/markdown"><![CDATA[
     ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      An <xref:System.Security.AccessControl.EventWaitHandleSecurity> object specifies access rights for a named system wait handle, and also specifies the way access attempts are audited. Access rights to the wait handle are expressed as rules, with each access rule represented by an <xref:System.Security.AccessControl.EventWaitHandleAccessRule> object. Each auditing rule is represented by an <xref:System.Security.AccessControl.EventWaitHandleAuditRule> object.
      This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. An <xref:System.Security.AccessControl.EventWaitHandleAccessRule> or <xref:System.Security.AccessControl.EventWaitHandleAuditRule> object might represent more than one ACE.
@@ Expand Down @@

xml/System.Security.AccessControl/MutexAccessRule.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -46,7 +46,11 @@ @@
         <remarks>
           <format type="text/markdown"><![CDATA[
-    ## Remarks
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      The <xref:System.Security.AccessControl.MutexAccessRule> class is one of a set of classes that the .NET Framework provides for managing Windows access control security on named system mutexes. For an overview of these classes, and their relationship to the underlying Windows access control structures, see <xref:System.Security.AccessControl.MutexSecurity>.
     > [!NOTE]
@@ Expand Down @@

xml/System.Security.AccessControl/MutexAuditRule.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -42,7 +42,11 @@ @@
         <remarks>
           <format type="text/markdown"><![CDATA[
-    ## Remarks
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      The <xref:System.Security.AccessControl.MutexAuditRule> class is one of a set of classes that the .NET Framework provides for managing Windows access control security on named system mutexes. For an overview of these classes and their relationship to the underlying Windows access control structures, see <xref:System.Security.AccessControl.MutexSecurity>.
     > [!NOTE]
@@ Expand Down @@

xml/System.Security.AccessControl/MutexRights.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -45,7 +45,11 @@ @@
         <remarks>
           <format type="text/markdown"><![CDATA[
-    ## Remarks
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      Use the <xref:System.Security.AccessControl.MutexRights> enumeration to specify access control rights when you create <xref:System.Security.AccessControl.MutexSecurity> objects. To apply access rights to a named system mutex, use <xref:System.Security.AccessControl.MutexSecurity> objects with the <xref:System.Threading.Mutex.%23ctor%28System.Boolean%2CSystem.String%2CSystem.Boolean%40%2CSystem.Security.AccessControl.MutexSecurity%29> constructor and the <xref:System.Threading.Mutex.SetAccessControl%2A?displayProperty=nameWithType> method.
     ## Examples
@@ Expand Down @@

xml/System.Security.AccessControl/MutexSecurity.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -47,6 +47,10 @@ @@
           <format type="text/markdown"><![CDATA[
     ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      A <xref:System.Security.AccessControl.MutexSecurity> object specifies access rights for a named system mutex, and also specifies how access attempts are audited. Access rights to the mutex are expressed as rules, with each access rule represented by a <xref:System.Security.AccessControl.MutexAccessRule> object. Each auditing rule is represented by a <xref:System.Security.AccessControl.MutexAuditRule> object.
      This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A <xref:System.Security.AccessControl.MutexAccessRule> or <xref:System.Security.AccessControl.MutexAuditRule> object might represent more than one ACE.
@@ Expand Down @@

xml/System.Security.AccessControl/SemaphoreAccessRule.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -50,7 +50,11 @@ @@
         <remarks>
           <format type="text/markdown"><![CDATA[
-    ## Remarks
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      The <xref:System.Security.AccessControl.SemaphoreAccessRule> class is one of a set of classes that the .NET Framework provides for managing Windows access control security on named system semaphores. For an overview of these classes, and their relationship to the underlying Windows access control structures, see <xref:System.Security.AccessControl.SemaphoreSecurity>.
     > [!NOTE]
@@ Expand Down @@

xml/System.Security.AccessControl/SemaphoreAuditRule.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -46,7 +46,11 @@ @@
         <remarks>
           <format type="text/markdown"><![CDATA[
-    ## Remarks
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      The <xref:System.Security.AccessControl.SemaphoreAuditRule> class is one of a set of classes that the .NET Framework provides for managing Windows access control security on named system semaphores. For an overview of these classes and their relationship to the underlying Windows access control structures, see <xref:System.Security.AccessControl.SemaphoreSecurity>.
     > [!NOTE]
@@ Expand Down @@

xml/System.Security.AccessControl/SemaphoreRights.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -49,7 +49,11 @@ @@
         <remarks>
           <format type="text/markdown"><![CDATA[
-    ## Remarks
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      Use the <xref:System.Security.AccessControl.SemaphoreRights> enumeration to specify access control rights when you create <xref:System.Security.AccessControl.SemaphoreSecurity> objects. To apply access rights to a named system semaphore, use <xref:System.Security.AccessControl.SemaphoreSecurity> objects with the <xref:System.Threading.Semaphore.%23ctor%28System.Int32%2CSystem.Int32%2CSystem.String%2CSystem.Boolean%40%2CSystem.Security.AccessControl.SemaphoreSecurity%29?displayProperty=nameWithType> constructor and the <xref:System.Threading.Semaphore.SetAccessControl%2A?displayProperty=nameWithType> method.
      For the numeric values of the underlying Windows access rights, see [Synchronization Object Security and Access Rights (Windows)](https://go.microsoft.com/fwlink/p/?LinkId=243073).
@@ Expand Down @@

xml/System.Security.AccessControl/SemaphoreSecurity.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -51,6 +51,10 @@ @@
           <format type="text/markdown"><![CDATA[
     ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
      A <xref:System.Security.AccessControl.SemaphoreSecurity> object specifies access rights for a named system semaphore, and also specifies how access attempts are audited. Access rights to the semaphore are expressed as rules, with each access rule represented by a <xref:System.Security.AccessControl.SemaphoreAccessRule> object. Each auditing rule is represented by a <xref:System.Security.AccessControl.SemaphoreAuditRule> object.
      This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A <xref:System.Security.AccessControl.SemaphoreAccessRule> or <xref:System.Security.AccessControl.SemaphoreAuditRule> object might represent more than one ACE.
@@ Expand Down @@

xml/System.Threading/EventWaitHandleAcl.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -28,7 +28,16 @@ @@
       </Attributes>
       <Docs>
         <summary>Provides a Windows-specific extension method for creating <see cref="T:System.Threading.EventWaitHandle" /> objects with specific access control list (ACL) security.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
+    ]]></format>
+        </remarks>
       </Docs>
       <Members>
         <Member MemberName="Create">
@@ Expand Down @@

xml/System.Threading/MutexAcl.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -28,7 +28,16 @@ @@
       </Attributes>
       <Docs>
         <summary>Provides a Windows-specific extension method for creating <see cref="T:System.Threading.Mutex" /> objects with specific access control list (ACL) security.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
+    ]]></format>
+        </remarks>
       </Docs>
       <Members>
         <Member MemberName="Create">
@@ Expand Down @@

xml/System.Threading/SemaphoreAcl.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -28,7 +28,16 @@ @@
       </Attributes>
       <Docs>
         <summary>Provides a Windows-specific extension method for creating <see cref="T:System.Threading.Semaphore" /> objects with specific access control list (ACL) security.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
+    ]]></format>
+        </remarks>
       </Docs>
       <Members>
         <Member MemberName="Create">
@@ Expand Down @@

xml/System.Threading/ThreadingAclExtensions.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -36,7 +36,16 @@ @@
       </Attributes>
       <Docs>
         <summary>Provides Windows-specific extension methods for managing the access control list (ACL) security descriptors for <see cref="T:System.Threading.EventWaitHandle" />, <see cref="T:System.Threading.Mutex" />, and <see cref="T:System.Threading.Semaphore" />.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+    ## Remarks
+    > [!NOTE]
+    > This type is only supported on Windows.
+    ]]></format>
+        </remarks>
       </Docs>
       <Members>
         <Member MemberName="GetAccessControl">
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Windows-only support notes to ACL security types #12283

Diff view

Diff view

There are no files selected for viewing

Add Windows-only support notes to ACL security types #12283

Add Windows-only support notes to ACL security types #12283

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing