Mutex.TryOpenExisting Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Ouvre un mutex nommé spécifié, s'il existe déjà, et retourne une valeur indiquant si l'opération a réussi.
Surcharges
TryOpenExisting(String, Mutex) |
Ouvre le mutex nommé spécifié, s'il existe déjà, et retourne une valeur indiquant si l'opération a réussi. |
TryOpenExisting(String, MutexRights, Mutex) |
Ouvre le mutex nommé spécifié, s'il existe déjà, avec l'accès de sécurité souhaité, puis retourne une valeur indiquant si l'opération a réussi. |
TryOpenExisting(String, Mutex)
- Source:
- Mutex.cs
- Source:
- Mutex.cs
- Source:
- Mutex.cs
Ouvre le mutex nommé spécifié, s'il existe déjà, et retourne une valeur indiquant si l'opération a réussi.
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
Paramètres
- name
- String
Nom de l’objet de synchronisation à partager avec d’autres processus. Le nom respecte la casse. Le caractère de barre oblique inverse (\) est réservé et ne peut être utilisé que pour spécifier un espace de noms. Pour plus d’informations sur les espaces de noms, consultez la section remarques. Il peut y avoir d’autres restrictions sur le nom en fonction du système d’exploitation. Par exemple, sur les systèmes d’exploitation Unix, le nom après l’exclusion de l’espace de noms doit être un nom de fichier valide.
- result
- Mutex
Quand cette méthode est retournée, contient un objet Mutex qui représente la structure mutex nommée si l'appel a réussi, ou null
si l'appel a échoué. Ce paramètre est traité comme étant non initialisé.
Retours
true
si le mutex nommé a été ouvert ; sinon, false
. Il peut arriver que false
soit retourné en raison d’un nom non valide.
- Attributs
Exceptions
name
est une chaîne vide.
- ou -
.NET Framework uniquement : name
est plus long que MAX_PATH (260 caractères).
name
est null
.
name
n'est pas valide. Il peut y avoir diverses raisons à cela, notamment des restrictions placées par le système d’exploitation (par exemple, un préfixe inconnu ou des caractères non valides). Notez que le nom et les préfixes communs « Global\ » et « Local\ » respectent la casse. Il peut arriver que la méthode retourne plutôt false
en raison d’un nom non valide.
- ou -
Il y a eu une autre erreur. La propriété HResult
est susceptible de fournir plus d’informations.
name
est trop long. Les restrictions de longueur peuvent dépendre du système d’exploitation ou de la configuration.
Le mutex nommé existe, mais l’utilisateur ne dispose pas de l’accès de sécurité nécessaire pour l’utiliser.
Remarques
Le name
peut être préfixé avec Global\
ou Local\
pour spécifier un espace de noms. Lorsque l’espace Global
de noms est spécifié, l’objet de synchronisation peut être partagé avec n’importe quel processus sur le système. Lorsque l’espace Local
de noms est spécifié, qui est également la valeur par défaut lorsqu’aucun espace de noms n’est spécifié, l’objet de synchronisation peut être partagé avec des processus dans la même session. Sur Windows, une session est une session de connexion et les services s’exécutent généralement dans une autre session non interactive. Sur les systèmes d’exploitation de type Unix, chaque interpréteur de commandes a sa propre session. Les objets de synchronisation locale de session peuvent convenir à la synchronisation entre des processus avec une relation parent/enfant où ils s’exécutent tous dans la même session. Pour plus d’informations sur les noms d’objets de synchronisation sur Windows, consultez Noms d’objets.
Si un objet de synchronisation du type demandé existe dans l’espace de noms, l’objet de synchronisation existant est ouvert. Si un objet de synchronisation n’existe pas dans l’espace de noms ou s’il existe un objet de synchronisation d’un autre type dans l’espace de noms, false
est retourné.
Pour créer le mutex système lorsqu’il n’existe pas encore, utilisez l’un Mutex des constructeurs qui a un name
paramètre.
Si vous n’êtes pas certain qu’un mutex nommé existe, utilisez cette surcharge de méthode au lieu de la surcharge de méthode OpenExisting(String) , ce qui lève une exception si le mutex n’existe pas.
Plusieurs appels à cette méthode qui utilisent la même valeur pour name
ne retournent pas nécessairement le même Mutex objet, même si les objets retournés représentent le même mutex système nommé.
Cette surcharge de méthode équivaut à appeler la TryOpenExisting(String, MutexRights, Mutex) surcharge de méthode et à spécifier MutexRights.Synchronize des droits et MutexRights.Modify , combinés à l’aide de l’opération OR au niveau du bit. La spécification de l’indicateur MutexRights.Synchronize permet à un thread d’attendre sur le mutex, et la spécification de l’indicateur MutexRights.Modify permet à un thread d’appeler la ReleaseMutex méthode.
Cette méthode ne demande pas la propriété du mutex.
S’applique à
TryOpenExisting(String, MutexRights, Mutex)
Ouvre le mutex nommé spécifié, s'il existe déjà, avec l'accès de sécurité souhaité, puis retourne une valeur indiquant si l'opération a réussi.
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
Paramètres
- name
- String
Nom de l’objet de synchronisation à partager avec d’autres processus. Le nom respecte la casse. Le caractère de barre oblique inverse (\) est réservé et ne peut être utilisé que pour spécifier un espace de noms. Pour plus d’informations sur les espaces de noms, consultez la section remarques. Il peut y avoir d’autres restrictions sur le nom en fonction du système d’exploitation. Par exemple, sur les systèmes d’exploitation Unix, le nom après l’exclusion de l’espace de noms doit être un nom de fichier valide.
- rights
- MutexRights
Combinaison d'opérations de bits des valeurs d'énumération qui représentent l'accès de sécurité voulu.
- result
- Mutex
Quand cette méthode est retournée, contient un objet Mutex qui représente la structure mutex nommée si l'appel a réussi, ou null
si l'appel a échoué. Ce paramètre est traité comme étant non initialisé.
Retours
true
si le mutex nommé a été ouvert ; sinon, false
. Il peut arriver que false
soit retourné en raison d’un nom non valide.
- Attributs
Exceptions
name
est une chaîne vide.
- ou -
.NET Framework uniquement : name
est plus long que MAX_PATH (260 caractères).
name
est null
.
name
n'est pas valide. Il peut y avoir diverses raisons à cela, notamment des restrictions placées par le système d’exploitation (par exemple, un préfixe inconnu ou des caractères non valides). Notez que le nom et les préfixes communs « Global\ » et « Local\ » respectent la casse. Il peut arriver que la méthode retourne plutôt false
en raison d’un nom non valide.
- ou -
Il y a eu une autre erreur. La propriété HResult
est susceptible de fournir plus d’informations.
name
est trop long. Les restrictions de longueur peuvent dépendre du système d’exploitation ou de la configuration.
Le mutex nommé existe, mais l’utilisateur ne dispose pas de l’accès de sécurité nécessaire pour l’utiliser.
Remarques
Le name
peut être préfixé avec Global\
ou Local\
pour spécifier un espace de noms. Lorsque l’espace Global
de noms est spécifié, l’objet de synchronisation peut être partagé avec n’importe quel processus sur le système. Lorsque l’espace Local
de noms est spécifié, qui est également la valeur par défaut lorsqu’aucun espace de noms n’est spécifié, l’objet de synchronisation peut être partagé avec des processus dans la même session. Sur Windows, une session est une session de connexion et les services s’exécutent généralement dans une autre session non interactive. Sur les systèmes d’exploitation de type Unix, chaque interpréteur de commandes a sa propre session. Les objets de synchronisation locale de session peuvent convenir à la synchronisation entre des processus avec une relation parent/enfant où ils s’exécutent tous dans la même session. Pour plus d’informations sur les noms d’objets de synchronisation sur Windows, consultez Noms d’objets.
Si un objet de synchronisation du type demandé existe dans l’espace de noms, l’objet de synchronisation existant est ouvert. Si un objet de synchronisation n’existe pas dans l’espace de noms ou s’il existe un objet de synchronisation d’un autre type dans l’espace de noms, false
est retourné.
Pour créer le mutex système lorsqu’il n’existe pas encore, utilisez l’un Mutex des constructeurs qui a un name
paramètre.
Si vous n’êtes pas certain qu’un mutex nommé existe, utilisez cette surcharge de méthode au lieu de la surcharge de méthode OpenExisting(String, MutexRights) , ce qui lève une exception si le mutex n’existe pas.
Le rights
paramètre doit inclure l’indicateur MutexRights.Synchronize pour permettre aux threads d’attendre sur le mutex, et l’indicateur MutexRights.Modify pour autoriser les threads à appeler la ReleaseMutex méthode.
Plusieurs appels à cette méthode qui utilisent la même valeur pour name
ne retournent pas nécessairement le même Mutex objet, même si les objets retournés représentent le même mutex système nommé.
Cette méthode ne demande pas la propriété du mutex.