From 5d0d01be36da125b1330b0383115416198229f7a Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Tue, 21 Apr 2020 13:22:01 -0700 Subject: [PATCH 1/3] Auto port System.Threading ACL comments --- xml/System.Threading/EventWaitHandleAcl.xml | 32 +++++++++++++++------ xml/System.Threading/MutexAcl.xml | 17 ++++++----- xml/System.Threading/SemaphoreAcl.xml | 24 ++++++++++------ 3 files changed, 49 insertions(+), 24 deletions(-) diff --git a/xml/System.Threading/EventWaitHandleAcl.xml b/xml/System.Threading/EventWaitHandleAcl.xml index 5fd28598b9d..f7e89d180c9 100644 --- a/xml/System.Threading/EventWaitHandleAcl.xml +++ b/xml/System.Threading/EventWaitHandleAcl.xml @@ -1,4 +1,4 @@ - + @@ -41,14 +41,28 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + + to set the initial state to signaled if the named event is created as a result of this call; to set it to non-signaled. + One of the enum values that determines whether the event resets automatically or manually. + The name, if the event is a system-wide synchronization event; otherwise, or an empty string. + When this method returns, this argument is always set to if a local event is created; that is, when is or . If has a valid, non-empty value, this argument is set to when the system event is created, or it is set to if an existing system event is found with that name. This parameter is passed uninitialized. + The optional Windows access control security to apply. + Gets or creates an instance, allowing a instance to be optionally specified to set it during the event creation. + An object that represents a system event wait handle, if named, or a local event wait handle, if nameless. + + , a new local event is always created. + + ]]> + + .NET Framework only: The length is beyond MAX_PATH (260 characters). + The enum value was out of legal range. + Could not find a part of the path specified in . + A system-wide synchronization event with the provided was not found. + -or- An with system-wide name cannot be created. An of a different type might have the same name. diff --git a/xml/System.Threading/MutexAcl.xml b/xml/System.Threading/MutexAcl.xml index c4d89ce2676..1d8c0f8214e 100644 --- a/xml/System.Threading/MutexAcl.xml +++ b/xml/System.Threading/MutexAcl.xml @@ -1,4 +1,4 @@ - + @@ -40,13 +40,16 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + + to give the calling thread initial ownership of the named system mutex if the named system mutex is created as a result of this call; otherwise, . + The optional name of the system mutex. If this argument is set to or , a local mutex is created. + When this method returns, this argument is always set to if a local mutex is created; that is, when is or . If has a valid non-empty value, this argument is set to when the system mutex is created, or it is set to if an existing system mutex is found with that name. This parameter is passed uninitialized. + The optional mutex access control security to apply. + Gets or creates instance, allowing a to be optionally specified to set it during the mutex creation. + An object that represents a system mutex, if named, or a local mutex, if nameless. To be added. + .NET Framework only: The length of the name exceeds the maximum limit. + A mutex handle with system-wide cannot be created. A mutex handle of a different type might have the same name. diff --git a/xml/System.Threading/SemaphoreAcl.xml b/xml/System.Threading/SemaphoreAcl.xml index e77c358bcc0..1051097fffc 100644 --- a/xml/System.Threading/SemaphoreAcl.xml +++ b/xml/System.Threading/SemaphoreAcl.xml @@ -1,4 +1,4 @@ - + @@ -41,14 +41,22 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The initial number of requests for the semaphore that can be satisfied concurrently. + The maximum number of requests for the semaphore that can be satisfied concurrently. + Optional argument to create a system semaphore. Set to or to create a local semaphore. + When this method returns, this argument is always set to if a local semaphore is created; that is, when is or . If has a valid, non-empty value, this argument is set to when the system semaphore is created, or it is set to if an existing system semaphore is found with that name. This parameter is passed uninitialized. + The optional semaphore access control security to apply. + Gets or creates an instance, allowing a instance to be optionally specified to set it during the event creation. + An object that represents a system semaphore, if named, or a local semaphore, if nameless. To be added. + + is a negative number. + -or- + + is not a positive number. + + is greater than . + A semaphore handle with the system-wide name '' cannot be created. A semaphore handle of a different type might have the same name. From 959e060947cdcc4bf546b1ef51dfab98df2b2d67 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 21 Apr 2020 19:47:29 -0700 Subject: [PATCH 2/3] Apply suggestions from code review Co-Authored-By: Koundinya Veluri --- xml/System.Threading/EventWaitHandleAcl.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Threading/EventWaitHandleAcl.xml b/xml/System.Threading/EventWaitHandleAcl.xml index f7e89d180c9..fc67c1a2fcc 100644 --- a/xml/System.Threading/EventWaitHandleAcl.xml +++ b/xml/System.Threading/EventWaitHandleAcl.xml @@ -45,7 +45,7 @@ to set the initial state to signaled if the named event is created as a result of this call; to set it to non-signaled. One of the enum values that determines whether the event resets automatically or manually. The name, if the event is a system-wide synchronization event; otherwise, or an empty string. - When this method returns, this argument is always set to if a local event is created; that is, when is or . If has a valid, non-empty value, this argument is set to when the system event is created, or it is set to if an existing system event is found with that name. This parameter is passed uninitialized. + When this method returns, this argument is always set to if a local event is created; that is, when is or . If has a valid, non-empty value, this argument is set to when the system event is created, or it is set to if an existing system event is found with that name. The optional Windows access control security to apply. Gets or creates an instance, allowing a instance to be optionally specified to set it during the event creation. An object that represents a system event wait handle, if named, or a local event wait handle, if nameless. @@ -54,7 +54,7 @@ ## Remarks -If a `name` is passed and the system event already exists, the existing event is returned. If `name` is `null` or , a new local event is always created. +If a `name` is passed and the system event already exists, the existing event is returned. If `name` is `null` or , a new process-local event is created. ]]> From e6314829e09623635e00512236dde6553a1f3e5c Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Fri, 24 Apr 2020 16:28:14 -0700 Subject: [PATCH 3/3] Apply suggestions from code review Co-Authored-By: Koundinya Veluri --- xml/System.Threading/EventWaitHandleAcl.xml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/xml/System.Threading/EventWaitHandleAcl.xml b/xml/System.Threading/EventWaitHandleAcl.xml index fc67c1a2fcc..9696ccde8d2 100644 --- a/xml/System.Threading/EventWaitHandleAcl.xml +++ b/xml/System.Threading/EventWaitHandleAcl.xml @@ -44,11 +44,11 @@ to set the initial state to signaled if the named event is created as a result of this call; to set it to non-signaled. One of the enum values that determines whether the event resets automatically or manually. - The name, if the event is a system-wide synchronization event; otherwise, or an empty string. + The name, if the event is to be shared with other processes; otherwise, or an empty string. When this method returns, this argument is always set to if a local event is created; that is, when is or . If has a valid, non-empty value, this argument is set to when the system event is created, or it is set to if an existing system event is found with that name. The optional Windows access control security to apply. Gets or creates an instance, allowing a instance to be optionally specified to set it during the event creation. - An object that represents a system event wait handle, if named, or a local event wait handle, if nameless. + An object that represents an event wait handle as requested. - .NET Framework only: The length is beyond MAX_PATH (260 characters). + .NET Framework only: The length is beyond MAX_PATH (260 characters). + +-or- + +.NET Framework only: The enum value was out of legal range. The enum value was out of legal range. Could not find a part of the path specified in . A system-wide synchronization event with the provided was not found.