EventWaitHandle.TryOpenExisting 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
打开指定的命名同步事件(如果已存在),并返回一个值,该值指示操作是否成功。
重载
| 名称 | 说明 |
|---|---|
| TryOpenExisting(String, EventWaitHandle) |
打开指定的命名同步事件(如果已存在),并返回一个值,该值指示操作是否成功。 |
| TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle) |
使用所需的安全访问打开指定的命名同步事件(如果已存在),并返回一个值,该值指示操作是否成功。 |
TryOpenExisting(String, EventWaitHandle)
打开指定的命名同步事件(如果已存在),并返回一个值,该值指示操作是否成功。
public:
static bool TryOpenExisting(System::String ^ name, [Runtime::InteropServices::Out] System::Threading::EventWaitHandle ^ % result);
[System.Security.SecurityCritical]
public static bool TryOpenExisting(string name, out System.Threading.EventWaitHandle result);
public static bool TryOpenExisting(string name, out System.Threading.EventWaitHandle result);
[<System.Security.SecurityCritical>]
static member TryOpenExisting : string * EventWaitHandle -> bool
static member TryOpenExisting : string * EventWaitHandle -> bool
Public Shared Function TryOpenExisting (name As String, ByRef result As EventWaitHandle) As Boolean
参数
- name
- String
要与其他进程打开和共享的同步对象的名称。 名称区分大小写。 反斜杠字符 (\) 是保留的,只能用于指定命名空间。 有关命名空间的详细信息,请参阅“备注”部分。 根据操作系统,名称可能会有进一步的限制。 例如,在基于 Unix 的操作系统上,排除命名空间后的名称必须是有效的文件名。
- result
- EventWaitHandle
此方法返回时,包含一个 EventWaitHandle 对象,该对象表示调用成功或 null 调用失败时的命名同步事件。 此参数被视为未初始化。
返回
true 如果已成功打开命名同步事件,则为 ;否则,为 false. 在某些情况下, false 可能会返回无效名称。
- 属性
例外
name 是 null。
name 无效。 这可能是出于各种原因,包括操作系统可能放置的一些限制,例如未知前缀或无效字符。 请注意,名称和通用前缀“Global\”和“Local\”区分大小写。 对于某些无效的名称,该方法可能会改为返回 false 。
-或-
还有其他一些错误。 该 HResult 属性可能提供更多信息。
name 太长。 长度限制可能取决于操作系统或配置。
命名事件存在,但用户没有所需的安全访问权限。
注解
name可以是前缀Global\Local\,也可以指定命名空间。
Global指定命名空间后,可以与系统上的任何进程共享同步对象。
Local指定命名空间时,这也是未指定命名空间时的默认命名空间,同步对象可以与同一会话中的进程共享。 在Windows,会话是登录会话,服务通常在不同的非交互式会话中运行。 在类似 Unix 的操作系统上,每个 shell 都有自己的会话。 会话本地同步对象可能适合在进程与父/子关系之间同步,其中它们都在同一会话中运行。 有关Windows上的同步对象名称的详细信息,请参阅 Object Names。
如果命名空间中存在所请求类型的同步对象,则会打开现有同步对象。 如果命名空间中不存在同步对象,或者命名空间中存在不同类型的同步对象, false 则返回该对象。
若要在系统事件不存在时创建系统事件,请使用具有参数的构造函数之 EventWaitHandle 一 name 。
如果不确定命名同步事件是否存在,请使用此方法重载而不是 OpenExisting(String) 方法重载,如果同步事件不存在,则会引发异常。
此方法重载等效于使用按位 OR 操作调用 TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle) 方法重载和指定 EventWaitHandleRights.Synchronize 和 EventWaitHandleRights.Modify 权限。 指定 EventWaitHandleRights.Synchronize 标志允许线程等待命名系统事件,并指定 EventWaitHandleRights.Modify 标志允许线程调用 Set 和 Reset 方法。
对此方法使用相同值的 name 多次调用不一定返回相同的 EventWaitHandle 对象,即使返回的对象表示相同的命名系统事件。
适用于
TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle)
使用所需的安全访问打开指定的命名同步事件(如果已存在),并返回一个值,该值指示操作是否成功。
public:
static bool TryOpenExisting(System::String ^ name, System::Security::AccessControl::EventWaitHandleRights rights, [Runtime::InteropServices::Out] System::Threading::EventWaitHandle ^ % result);
[System.Security.SecurityCritical]
public static bool TryOpenExisting(string name, System.Security.AccessControl.EventWaitHandleRights rights, out System.Threading.EventWaitHandle result);
[<System.Security.SecurityCritical>]
static member TryOpenExisting : string * System.Security.AccessControl.EventWaitHandleRights * EventWaitHandle -> bool
Public Shared Function TryOpenExisting (name As String, rights As EventWaitHandleRights, ByRef result As EventWaitHandle) As Boolean
参数
- name
- String
要与其他进程打开和共享的同步对象的名称。 名称区分大小写。 反斜杠字符 (\) 是保留的,只能用于指定命名空间。 有关命名空间的详细信息,请参阅“备注”部分。 根据操作系统,名称可能会有进一步的限制。 例如,在基于 Unix 的操作系统上,排除命名空间后的名称必须是有效的文件名。
- rights
- EventWaitHandleRights
表示所需安全访问的枚举值的按位组合。
- result
- EventWaitHandle
此方法返回时,包含一个 EventWaitHandle 对象,该对象表示调用成功或 null 调用失败时的命名同步事件。 此参数被视为未初始化。
返回
true 如果已成功打开命名同步事件,则为 ;否则,为 false. 在某些情况下, false 可能会返回无效名称。
- 属性
例外
name 是 null。
name 无效。 这可能是出于各种原因,包括操作系统可能放置的一些限制,例如未知前缀或无效字符。 请注意,名称和通用前缀“Global\”和“Local\”区分大小写。 对于某些无效的名称,该方法可能会改为返回 false 。
-或-
还有其他一些错误。 该 HResult 属性可能提供更多信息。
name 太长。 长度限制可能取决于操作系统或配置。
命名事件存在,但用户没有所需的安全访问权限。
注解
name可以是前缀Global\Local\,也可以指定命名空间。
Global指定命名空间后,可以与系统上的任何进程共享同步对象。
Local指定命名空间时,这也是未指定命名空间时的默认命名空间,同步对象可以与同一会话中的进程共享。 在Windows,会话是登录会话,服务通常在不同的非交互式会话中运行。 在类似 Unix 的操作系统上,每个 shell 都有自己的会话。 会话本地同步对象可能适合在进程与父/子关系之间同步,其中它们都在同一会话中运行。 有关Windows上的同步对象名称的详细信息,请参阅 Object Names。
如果命名空间中存在所请求类型的同步对象,则会打开现有同步对象。 如果命名空间中不存在同步对象,或者命名空间中存在不同类型的同步对象, false 则返回该对象。
若要在系统事件不存在时创建系统事件,请使用具有参数的构造函数之 EventWaitHandle 一 name 。
如果不确定命名同步事件是否存在,请使用此方法重载而不是 OpenExisting(String, EventWaitHandleRights) 方法重载,如果同步事件不存在,则会引发异常。
参数 rights 必须包含 EventWaitHandleRights.Synchronize 标志,以允许线程等待事件,以及 EventWaitHandleRights.Modify 允许线程调用 Set 和 Reset 方法的标志。
对此方法使用相同值的 name 多次调用不一定返回相同的 EventWaitHandle 对象,即使返回的对象表示相同的命名系统事件。