|
44 | 44 | <param name="initialState"> |
45 | 45 | <see langword="true" /> to set the initial state to signaled if the named event is created as a result of this call; <see langword="false" /> to set it to non-signaled.</param> |
46 | 46 | <param name="mode">One of the enum values that determines whether the event resets automatically or manually.</param> |
47 | | - <param name="name">The name, if the event is to be shared with other processes; otherwise, <see langword="null" /> or an empty string.</param> |
| 47 | + <param name="name">The name, if the synchronization object is to be shared with other processes; otherwise, <see langword="null" /> or an empty string. The name is case-sensitive.</param> |
48 | 48 | <param name="createdNew">When this method returns, this argument is always set to <see langword="true" /> if a local event is created; that is, when <paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />. If <paramref name="name" /> has a valid, non-empty value, this argument is set to <see langword="true" /> when the system event is created, or it is set to <see langword="false" /> if an existing system event is found with that name.</param> |
49 | 49 | <param name="eventSecurity">The optional Windows access control security to apply.</param> |
50 | 50 | <summary>Gets or creates an <see cref="T:System.Threading.EventWaitHandle" /> instance, allowing a <see cref="T:System.Security.AccessControl.EventWaitHandleSecurity" /> instance to be optionally specified to set it during the event creation.</summary> |
|
53 | 53 | <format type="text/markdown"><. |
56 | 57 |
|
57 | | -If a `name` is passed and the system event already exists, the existing event is returned. If `name` is `null` or <xref:System.String.Empty>, a new process-local event is created. |
| 58 | + If a `name` is provided and a synchronization object of the requested type already exists in the namespace, the existing synchronization object is opened. If a synchronization object of a different type already exists in the namespace, a `WaitHandleCannotBeOpenedException` is thrown. Otherwise, a new synchronization object is created. |
58 | 59 |
|
59 | 60 | ]]></format> |
60 | 61 | </remarks> |
61 | | - <exception cref="T:System.ArgumentException">.NET Framework only: The <paramref name="name" /> length is beyond MAX_PATH (260 characters). |
| 62 | + <exception cref="T:System.ArgumentException"> |
| 63 | + The <paramref name="mode" /> enum value was out of legal range. |
62 | 64 |
|
63 | 65 | -or- |
64 | 66 |
|
65 | | -.NET Framework only: The <paramref name="mode" /> enum value was out of legal range.</exception> |
66 | | - <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="mode" /> enum value was out of legal range.</exception> |
67 | | - <exception cref="T:System.IO.DirectoryNotFoundException">Could not find a part of the path specified in <paramref name="name" />.</exception> |
68 | | - <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A system-wide synchronization event with the provided <paramref name="name" /> was not found. |
69 | | - -or- An <see cref="T:System.Threading.EventWaitHandle" /> with system-wide name <paramref name="name" /> cannot be created. An <see cref="T:System.Threading.EventWaitHandle" /> of a different type might have the same name.</exception> |
| 67 | +.NET Framework only: <paramref name="name" /> is longer than MAX_PATH (260 characters).</exception> |
| 68 | + <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="mode" /> enum value was out of legal range. In some cases <see cref="T:System.ArgumentException"/> is thrown instead.</exception> |
| 69 | + <exception cref="T:System.IO.IOException"> |
| 70 | + <paramref name="name" /> is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global\" and "Local\" are case-sensitive. |
| 71 | + |
| 72 | +-or- |
| 73 | + |
| 74 | +There was some other error. The `HResult` property may provide more information.</exception> |
| 75 | + <exception cref="T:System.IO.DirectoryNotFoundException">Windows only: <paramref name="name" /> specified an unknown namespace. See [Object Names](https://docs.microsoft.com/windows/win32/sync/object-names) for more information.</exception> |
| 76 | + <exception cref="T:System.IO.PathTooLongException">The <paramref name="name" /> is too long. Length restrictions may depend on the operating system or configuration.</exception> |
| 77 | + <exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A synchronization object with the provided <paramref name="name" /> cannot be created. A synchronization object of a different type might have the same name.</exception> |
| 78 | + <exception cref="T:System.UnauthorizedAccessException">The named event exists, but the user does not have the desired security access.</exception> |
70 | 79 | </Docs> |
71 | 80 | </Member> |
72 | 81 | </Members> |
|
0 commit comments