EventWaitHandle.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 événement de synchronisation nommé spécifié, s'il existe déjà, et retourne une valeur indiquant si l'opération a réussi.
Surcharges
| TryOpenExisting(String, EventWaitHandle) |
Ouvre l’événement de synchronisation nommé spécifié, s’il existe déjà, et retourne une valeur indiquant si l’opération a réussi. |
| TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle) |
Ouvre l'événement de synchronisation 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, EventWaitHandle)
- Source:
- EventWaitHandle.cs
- Source:
- EventWaitHandle.cs
- Source:
- EventWaitHandle.cs
Ouvre l’événement de synchronisation 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::EventWaitHandle ^ % result);[System.Security.SecurityCritical]
public static bool TryOpenExisting (string name, out System.Threading.EventWaitHandle result);[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static bool TryOpenExisting (string name, out System.Threading.EventWaitHandle? result);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[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member TryOpenExisting : string * EventWaitHandle -> boolstatic member TryOpenExisting : string * EventWaitHandle -> boolPublic Shared Function TryOpenExisting (name As String, ByRef result As EventWaitHandle) As BooleanParamètres
- name
- String
Nom de l’objet de synchronisation à ouvrir et à 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
- EventWaitHandle
Quand cette méthode est retournée, contient un objet EventWaitHandle qui représente l'événement de synchronisation nommé 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 l’événement de synchronisation 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.
L’événement nommé existe mais l’utilisateur ne dispose de l’accès de sécurité nécessaire.
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 l’événement système alors qu’il n’existe pas encore, utilisez l’un EventWaitHandle des constructeurs qui a un name paramètre.
Si vous ne savez pas s’il existe un événement de synchronisation nommé, utilisez cette surcharge de méthode au lieu de la surcharge de méthode OpenExisting(String) , ce qui lève une exception si l’événement de synchronisation n’existe pas.
Cette surcharge de méthode équivaut à appeler la TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle) surcharge de méthode et à spécifier EventWaitHandleRights.Synchronize des droits et EventWaitHandleRights.Modify , combinés à l’aide de l’opération OR au niveau du bit. La spécification de l’indicateur EventWaitHandleRights.Synchronize permet à un thread d’attendre sur l’événement système nommé, et la spécification de l’indicateur EventWaitHandleRights.Modify permet à un thread d’appeler les Set méthodes et Reset .
Plusieurs appels à cette méthode qui utilisent la même valeur pour name ne retournent pas nécessairement le même EventWaitHandle objet, même si les objets retournés représentent le même événement système nommé.
S’applique à
TryOpenExisting(String, EventWaitHandleRights, EventWaitHandle)
Ouvre l'événement de synchronisation 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::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 -> boolPublic Shared Function TryOpenExisting (name As String, rights As EventWaitHandleRights, ByRef result As EventWaitHandle) As BooleanParamètres
- name
- String
Nom de l’objet de synchronisation à ouvrir et à 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
- EventWaitHandleRights
Combinaison d'opérations de bits des valeurs d'énumération qui représentent l'accès de sécurité voulu.
- result
- EventWaitHandle
Quand cette méthode est retournée, contient un objet EventWaitHandle qui représente l'événement de synchronisation nommé 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 l’événement de synchronisation 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.
L’événement nommé existe mais l’utilisateur ne dispose de l’accès de sécurité nécessaire.
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 l’événement système alors qu’il n’existe pas encore, utilisez l’un EventWaitHandle des constructeurs qui a un name paramètre.
Si vous ne savez pas s’il existe un événement de synchronisation nommé, utilisez cette surcharge de méthode au lieu de la surcharge de méthode OpenExisting(String, EventWaitHandleRights) , ce qui lève une exception si l’événement de synchronisation n’existe pas.
Le rights paramètre doit inclure l’indicateur EventWaitHandleRights.Synchronize pour permettre aux threads d’attendre sur l’événement, et l’indicateur EventWaitHandleRights.Modify pour autoriser les threads à appeler les Set méthodes et Reset .
Plusieurs appels à cette méthode qui utilisent la même valeur pour name ne retournent pas nécessairement le même EventWaitHandle objet, même si les objets retournés représentent le même événement système nommé.
