EventWaitHandle.TryOpenExisting メソッド

定義

既に存在する場合は、指定した名前付き同期イベントを開き操作が成功したかどうかを示す値を返します。Opens a specified named synchronization event, if it already exists, and returns a value that indicates whether the operation succeeded.

オーバーロード

TryOpenExisting(String, EventWaitHandle)

既に存在する場合は、指定した名前付き同期イベントを開き操作が成功したかどうかを示す値を返します。Opens the specified named synchronization event, if it already exists, and returns a value that indicates whether the operation succeeded.

TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle)

既に存在する場合は、必要なセキュリティ アクセスを使って指定した名前付き同期イベントを開き、操作が成功したかどうかを示す値を返します。Opens the specified named synchronization event, if it already exists, with the desired security access, and returns a value that indicates whether the operation succeeded.

TryOpenExisting(String, EventWaitHandle)

既に存在する場合は、指定した名前付き同期イベントを開き操作が成功したかどうかを示す値を返します。Opens the specified named synchronization event, if it already exists, and returns a value that indicates whether the operation succeeded.

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);
static member TryOpenExisting : string * EventWaitHandle -> bool
Public Shared Function TryOpenExisting (name As String, ByRef result As EventWaitHandle) As Boolean

パラメーター

name
String

開くシステム同期イベントの名前。The name of the system synchronization event to open.

result
EventWaitHandle

このメソッドから制御が戻るときに、呼び出しに成功した場合は名前付き同期イベントを表す EventWaitHandle オブジェクトが格納されます。呼び出しに失敗した場合は null が格納されます。When this method returns, contains a EventWaitHandle object that represents the named synchronization event if the call succeeded, or null if the call failed. このパラメーターは初期化前として処理されます。This parameter is treated as uninitialized.

戻り値

名前付きの同期イベントが正常に開かれた場合は true。それ以外の場合は falsetrue if the named synchronization event was opened successfully; otherwise, false.

属性

例外

name が空の文字列です。name is an empty string.

または-or- name が 260 文字を超えています。name is longer than 260 characters.

namenull です。name is null.

Win32 エラーが発生しました。A Win32 error occurred.

名前付きイベントは存在しますが、必要なセキュリティ アクセスがユーザーにありません。The named event exists, but the user does not have the desired security access.

注釈

名前付き同期イベントが存在しない場合、このメソッドは作成しません。If the named synchronization event does not exist, this method does not create it. システムイベントがまだ存在しない場合に作成するには、name パラメーターを持つ EventWaitHandle コンストラクターのいずれかを使用します。To create the system event when it does not already exist, use one of the EventWaitHandle constructors that has a name parameter.

名前付き同期イベントが存在するかどうか不明な場合は、OpenExisting(String) メソッドオーバーロードではなく、このメソッドオーバーロードを使用します。これにより、同期イベントが存在しない場合に例外がスローされます。If you are uncertain whether a named synchronization event exists, use this method overload instead of the OpenExisting(String) method overload, which throws an exception if the synchronization event does not exist.

このメソッドオーバーロードは、ビットごとの OR 演算を使用して、TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle) メソッドオーバーロードを呼び出し、EventWaitHandleRights.Synchronize および EventWaitHandleRights.Modify 権限を指定することと同じです。This method overload is equivalent to calling the TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle) method overload and specifying EventWaitHandleRights.Synchronize and EventWaitHandleRights.Modify rights, combined by using the bitwise OR operation. EventWaitHandleRights.Synchronize フラグを指定すると、スレッドは名前付きシステムイベントを待機できます。また、EventWaitHandleRights.Modify フラグを指定すると、スレッドは Set および Reset メソッドを呼び出すことができます。Specifying the EventWaitHandleRights.Synchronize flag allows a thread to wait on the named system event, and specifying the EventWaitHandleRights.Modify flag allows a thread to call the Set and Reset methods.

name に同じ値を使用するこのメソッドを複数回呼び出すことは、返されるオブジェクトが同じ名前付きシステムイベントを表す場合でも、必ずしも同じ EventWaitHandle オブジェクトを返すとは限りません。Multiple calls to this method that use the same value for name do not necessarily return the same EventWaitHandle object, even though the objects that are returned represent the same named system event.

セキュリティ

SecurityCriticalAttribute
直前の呼び出し元に完全信頼が必要です。requires full trust for the immediate caller. このメンバーは、部分的に信頼されているコードまたは透過的なコードでは使用できません。This member cannot be used by partially trusted or transparent code.

TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle)

既に存在する場合は、必要なセキュリティ アクセスを使って指定した名前付き同期イベントを開き、操作が成功したかどうかを示す値を返します。Opens the specified named synchronization event, if it already exists, with the desired security access, and returns a value that indicates whether the operation succeeded.

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);
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

開くシステム同期イベントの名前。The name of the system synchronization event to open.

rights
EventWaitHandleRights

必要なセキュリティ アクセス権を表す列挙値のビットごとの組み合わせ。A bitwise combination of the enumeration values that represent the desired security access.

result
EventWaitHandle

このメソッドから制御が戻るときに、呼び出しに成功した場合は名前付き同期イベントを表す EventWaitHandle オブジェクトが格納されます。呼び出しに失敗した場合は null が格納されます。When this method returns, contains a EventWaitHandle object that represents the named synchronization event if the call succeeded, or null if the call failed. このパラメーターは初期化前として処理されます。This parameter is treated as uninitialized.

戻り値

名前付きの同期イベントが正常に開かれた場合は true。それ以外の場合は falsetrue if the named synchronization event was opened successfully; otherwise, false.

属性

例外

name が空の文字列です。name is an empty string.

または-or- name が 260 文字を超えています。name is longer than 260 characters.

namenull です。name is null.

Win32 エラーが発生しました。A Win32 error occurred.

名前付きイベントは存在しますが、必要なセキュリティ アクセスがユーザーにありません。The named event exists, but the user does not have the desired security access.

注釈

名前付き同期イベントが存在しない場合、このメソッドは作成しません。If the named synchronization event does not exist, this method does not create it. システムイベントがまだ存在しない場合に作成するには、name パラメーターを持つ EventWaitHandle コンストラクターのいずれかを使用します。To create the system event when it does not already exist, use one of the EventWaitHandle constructors that has a name parameter.

名前付き同期イベントが存在するかどうか不明な場合は、OpenExisting(String, EventWaitHandleRights) メソッドオーバーロードではなく、このメソッドオーバーロードを使用します。これにより、同期イベントが存在しない場合に例外がスローされます。If you are uncertain whether a named synchronization event exists, use this method overload instead of the OpenExisting(String, EventWaitHandleRights) method overload, which throws an exception if the synchronization event does not exist.

rights パラメーターには、スレッドがイベントを待機できるようにするための EventWaitHandleRights.Synchronize フラグと、スレッドが Set および Reset メソッドを呼び出せるようにするための EventWaitHandleRights.Modify フラグを含める必要があります。The rights parameter must include the EventWaitHandleRights.Synchronize flag to allow threads to wait on the event, and the EventWaitHandleRights.Modify flag to allow threads to call the Set and Reset methods.

name に同じ値を使用するこのメソッドを複数回呼び出すことは、返されるオブジェクトが同じ名前付きシステムイベントを表す場合でも、必ずしも同じ EventWaitHandle オブジェクトを返すとは限りません。Multiple calls to this method that use the same value for name do not necessarily return the same EventWaitHandle object, even though the objects that are returned represent the same named system event.

セキュリティ

SecurityCriticalAttribute
直前の呼び出し元に完全信頼が必要です。requires full trust for the immediate caller. このメンバーは、部分的に信頼されているコードまたは透過的なコードでは使用できません。This member cannot be used by partially trusted or transparent code.

適用対象