Mutex.TryOpenExisting 方法

定義

開啟指定的具名 mutex (如果已經存在),並傳回值,指出作業是否成功。

多載

TryOpenExisting(String, Mutex)

開啟指定的具名 mutex (如果已經存在),並傳回值,指出作業是否成功。

TryOpenExisting(String, MutexRights, Mutex)

使用所需的安全性存取權,開啟指定的具名 mutex (如果已經存在),並傳回值,指出作業是否成功。

TryOpenExisting(String, Mutex)

Source:
Mutex.cs
Source:
Mutex.cs
Source:
Mutex.cs

開啟指定的具名 mutex (如果已經存在),並傳回值,指出作業是否成功。

public:
 static bool TryOpenExisting(System::String ^ name, [Runtime::InteropServices::Out] System::Threading::Mutex ^ % result);
[System.Security.SecurityCritical]
public static bool TryOpenExisting (string name, out System.Threading.Mutex result);
public static bool TryOpenExisting (string name, out System.Threading.Mutex? result);
public static bool TryOpenExisting (string name, out System.Threading.Mutex result);
[<System.Security.SecurityCritical>]
static member TryOpenExisting : string * Mutex -> bool
static member TryOpenExisting : string * Mutex -> bool
Public Shared Function TryOpenExisting (name As String, ByRef result As Mutex) As Boolean

參數

name
String

要與其他處理序共用之同步物件的名稱。 名稱區分大小寫。 反斜線字元 (\) 是保留的,而且只能用來指定命名空間。 如需命名空間的詳細資訊,請參閱一節。 視作業系統而定,名稱可能會有進一步的限制。 例如,在 Unix 作業系統上,排除命名空間之後的名稱必須是有效的檔案名。

result
Mutex

當這個方法傳回時,如果呼叫成功,則包含代表具名 Mutex 的 Mutex 物件;如果呼叫失敗,則為 null。 這個參數會被視為未初始化。

傳回

如果已成功開啟具名 Mutex,則為true ,否則為 false。 在某些情況下,可能會因為名稱無效而傳回 false

屬性

例外狀況

name 為空字串。

-或-

僅限 .NET Framework:name 的長度超過 MAX_PATH (260 個字元)。

name 上所宣告的預設值是 null

name 無效。 這可能基於數種原因,其中包括可能由作業系統設定的一些限制,例如未知前置詞或無效字元。 請注意,名稱和通用前置詞 「Global\」 和 「Local\」 會區分大小寫。 針對某些無效的名稱,方法可能會改為傳回 false

-或-

發生一些其他錯誤。 HResult 屬性可提供詳細資訊。

name 太長。 長度限制可能會取決於作業系統或設定。

具名的 Mutex 已存在,但使用者沒有使用它所需的安全性存取權。

備註

name前面可能會加上 Global\Local\ ,以指定命名空間。 Global指定命名空間時,同步處理物件可能會與系統上的任何進程共用。 Local指定命名空間時,這也是未指定命名空間時的預設值,同步處理物件可能會與相同會話中的進程共用。 在 Windows 上,會話是登入會話,而服務通常會在不同的非互動式會話中執行。 在類似 Unix 的作業系統上,每個殼層都有自己的會話。 會話本機同步處理物件可能適用于在進程與父子關聯性之間同步處理,而它們全都在相同的會話中執行。 如需 Windows 上同步處理物件名稱的詳細資訊,請參閱 物件名稱

如果命名空間中有要求類型的同步處理物件,則會開啟現有的同步處理物件。 如果命名空間中沒有同步處理物件,或命名空間中存在不同類型的同步處理物件, false 則會傳回 。

若要在系統 Mutex 不存在時建立,請使用其中一個 name 具有 參數的 Mutex 建構函式。

如果您不確定具名 Mutex 是否存在,請使用這個方法多載,而不是 OpenExisting(String) 方法多載,如果 mutex 不存在,則會擲回例外狀況。

對這個方法使用相同值的 name 多次呼叫不一定傳回相同的物件,即使傳回的物件代表相同的 Mutex 具名系統 Mutex 也一樣。

這個方法多載相當於呼叫 TryOpenExisting(String, MutexRights, Mutex) 方法多載,並指定 MutexRights.SynchronizeMutexRights.Modify 許可權,並使用位 OR 作業結合。 指定 MutexRights.Synchronize 旗標可讓執行緒在 Mutex 上等候,而指定 MutexRights.Modify 旗標可讓執行緒呼叫 ReleaseMutex 方法。

這個方法不會要求 mutex 的擁有權。

適用於

TryOpenExisting(String, MutexRights, Mutex)

使用所需的安全性存取權,開啟指定的具名 mutex (如果已經存在),並傳回值,指出作業是否成功。

public:
 static bool TryOpenExisting(System::String ^ name, System::Security::AccessControl::MutexRights rights, [Runtime::InteropServices::Out] System::Threading::Mutex ^ % result);
[System.Security.SecurityCritical]
public static bool TryOpenExisting (string name, System.Security.AccessControl.MutexRights rights, out System.Threading.Mutex result);
[<System.Security.SecurityCritical>]
static member TryOpenExisting : string * System.Security.AccessControl.MutexRights * Mutex -> bool
Public Shared Function TryOpenExisting (name As String, rights As MutexRights, ByRef result As Mutex) As Boolean

參數

name
String

要與其他處理序共用之同步物件的名稱。 名稱區分大小寫。 反斜線字元 (\) 是保留的,而且只能用來指定命名空間。 如需命名空間的詳細資訊,請參閱一節。 視作業系統而定,名稱可能會有進一步的限制。 例如,在 Unix 作業系統上,排除命名空間之後的名稱必須是有效的檔案名。

rights
MutexRights

列舉值的位元組合,表示所需的安全性存取。

result
Mutex

當這個方法傳回時,如果呼叫成功,則包含代表具名 Mutex 的 Mutex 物件;如果呼叫失敗,則為 null。 這個參數會被視為未初始化。

傳回

如果已成功開啟具名 Mutex,則為true ,否則為 false。 在某些情況下,可能會因為名稱無效而傳回 false

屬性

例外狀況

name 為空字串。

-或-

僅限 .NET Framework:name 的長度超過 MAX_PATH (260 個字元)。

name 上所宣告的預設值是 null

name 無效。 這可能基於數種原因,其中包括可能由作業系統設定的一些限制,例如未知前置詞或無效字元。 請注意,名稱和通用前置詞 「Global\」 和 「Local\」 會區分大小寫。 針對某些無效的名稱,方法可能會改為傳回 false

-或-

發生一些其他錯誤。 HResult 屬性可提供詳細資訊。

name 太長。 長度限制可能會取決於作業系統或設定。

具名的 Mutex 已存在,但使用者沒有使用它所需的安全性存取權。

備註

name前面可能會加上 Global\Local\ ,以指定命名空間。 Global指定命名空間時,同步處理物件可能會與系統上的任何進程共用。 Local指定命名空間時,這也是未指定命名空間時的預設值,同步處理物件可能會與相同會話中的進程共用。 在 Windows 上,會話是登入會話,而服務通常會在不同的非互動式會話中執行。 在類似 Unix 的作業系統上,每個殼層都有自己的會話。 會話本機同步處理物件可能適用于在進程與父子關聯性之間同步處理,而它們全都在相同的會話中執行。 如需 Windows 上同步處理物件名稱的詳細資訊,請參閱 物件名稱

如果命名空間中有要求類型的同步處理物件,則會開啟現有的同步處理物件。 如果命名空間中沒有同步處理物件,或命名空間中存在不同類型的同步處理物件, false 則會傳回 。

若要在系統 Mutex 不存在時建立,請使用其中一個 name 具有 參數的 Mutex 建構函式。

如果您不確定具名 Mutex 是否存在,請使用這個方法多載,而不是 OpenExisting(String, MutexRights) 方法多載,如果 mutex 不存在,則會擲回例外狀況。

參數 rights 必須包含 MutexRights.Synchronize 旗標,以允許執行緒在 Mutex 上等候,以及 MutexRights.Modify 允許執行緒呼叫 方法的 ReleaseMutex 旗標。

對這個方法使用相同值的 name 多次呼叫不一定傳回相同的物件,即使傳回的物件代表相同的 Mutex 具名系統 Mutex 也一樣。

這個方法不會要求 mutex 的擁有權。

適用於